Add Affiliates connect Amazon in the main module

Affiliates_connect_browser, Affiliates_connect_searchpage etc are the submodules of affiliate_connect. For affiliate_connect_amazon better to create another project. But again all the mentors need to subscribe that project. So if it is okay for others then I will create another project. And if its not okay then we can include 2-3 submodules as example initially in this project itself.

@dbjpanda,

I guess it would be ok to include few submodules as part of this project itself as for the initial phase it concerns only three sub modules for Amazon, Flipkart and eBay.

Assigning myself to this issue.

Don't work on it still we listen from others. And it is not a good idea to include those inside this module. Ask to @borisson_ or gvso what they are saying.

@dbjpanda, okay open for discussion.

I'm not sure if we should include all of them in the main module. I figure we should start by using the most common provider (probably amazon) as an example and create other drupal.org projects for others in the future. That way we can keep this module as easy as possible to start.

My suggestion will be to have it as a base project on which the other affiliate modules will be dependent upon. As an end user I may be an affiliate to one, none in the list or all the affiliates. So it'll be good we keep the affiliate projects different. Users/developers can install them on the fly.

Also we can have plugins like Affiliates_connect_browser and search which will be a good idea to keep it in the base project as dbjpanda #2 suggested above.

We can list the other modules in the Related module list in the description of this project.

@borrison_ sounds like a good plan. So should I add the code for the amazon plugin here for a start then and post a patch for the plugin for review?

Sounds good @chiranjeeb2410.

Okay. Thats fine. For simplicity, lets include modules/affilaites_connect_amazon inside the base module for now. Later on we will shift it to a separate project.

Okay, cool then I'll post the patch for the affiliates_connect_amazon sub-module by tonight for review :)

@borrison_, @thedrupalkid, @dbjpanda, the basic structure for the amazon sub-module is almost done with. However, I seem to have a confusion regarding the plugin form as to whether it should inherit directly from the main config form created earlier for affiliates_connect module or should the data storage part for the amazon plugin form be taken from the main config form manually and modified accordingly.

@borrison_, @thedrupalkid please provide some quick suggestions.

@chiranjeeb2410 : Posting it again so that it will be better for anyone who reviews it:

Change:
You need to first create Amazon Associates at @affiliate-marketing
to
If you are not an Amazon Associate, Please Sign up for Amazon Associate program here: @affiliate-marketing

Enable to use Affiliate Marketing using tracking ID to Enable Affiliate Marketing using tracking ID

Please also see here Amazon provided an Access Key ID and Secret Key...

Change : keys : native_affiliate_id to native_access_key_id : title: Affiliate Tracking ID to Access Key ID
Same for native_affiliate_token : native_affiliate_secret_key : title: Affiliate Tracking Token: Secret key

@thedrupalkid, @borrison_, @dbjpanda,

Patch contains the code for the amazon plugin sub-module which seems to be working well as of now as per the screeshots attached below.

Also the data storage section from the main config form has been moved to the amazon plugin settings form as it would be convenient to have it in each plugin form for their specific functionalities. Additionally, the route and menu links for the main config form have been discarded for convenience as now the 'edit' button on the overview page redirects to the amazon settings page. So the existing amazon plugin for has its data storage section and also inherits the remaining common functionalities from the main config settings page.

Additionally, the suggestions made by @thedrupalkid in #16 have been addressed. However, the form validation required for the fields native_access_key_id and native_affiliate_secret_key hasnt been added as of now as they are not part of the main config form inheritance. and can be written once the testing is done by the devs.

Attached screenshots below.

Please review.

@ankitjain28may, I'll make the changes asap.

Also on the part about the plugin form, I understand you trying to say that the code in the main configuration form should be retained as it is and inherited by the each plugin form. But didn't properly get the part about saving its content in the plugin config forms. Could you please elaborate a bit on that?

Also quick suggestions on the above matter from @borrison_, @thedrupalkid and @dbjpanda would be appreciated.

@ankitjain28may, I have done the changes and it seems to work fine as of now. Attaching updated patch shortly.

@borrison_, @ankitjain28may, @thedrupalkid, @dbjpanda,

Following patch contains the complete code for the amazon plugin sub-module with all the changes suggested as in #16, #18 and #19.
I have also attached screenshots of the required working plugin form. Also modified the code and removed redundancy as suggested by @ankitjain28may.

Please review.

1. +++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.info.yml
   --- /dev/null
   +++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.links.menu.yml
   

   This shouldn't need it's own page, but rather be configured trough the plugin form already provided.

2. +++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.module
   --- /dev/null
   +++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.routing.yml
   
   +++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.routing.yml
   @@ -0,0 +1,10 @@
   +affiliates_connect_amazon.settings:
   

   ^

3. +++ b/modules/affiliates_connect_amazon/src/Form/AffiliatesAmazonSettingsForm.php
   @@ -0,0 +1,149 @@
   +/**
   + * @file
   + * Contains \Drupal\affiliates_connect\Form\AffiliatesAmazonSettingsForm.
   + */
   

   Docblock should be removed.

4. +++ b/modules/affiliates_connect_amazon/src/Form/AffiliatesAmazonSettingsForm.php
   @@ -0,0 +1,149 @@
   +  public function __construct(ConfigFactoryInterface $config_factory) {
   +    parent::__construct($config_factory);
   +  }
   

   Constructor is the same as the base class, can be removed.

5. +++ b/modules/affiliates_connect_amazon/src/Form/AffiliatesAmazonSettingsForm.php
   @@ -0,0 +1,149 @@
   +  public static function create(ContainerInterface $container) {
   

   Same here.

6. +++ b/modules/affiliates_connect_amazon/src/Plugin/AffiliatesNetwork/AffiliatesNetwork.php
   @@ -0,0 +1,42 @@
   +class AffiliatesNetwork implements  AffiliatesNetworkInterface {
   

   This class isn't named correctly. It should be AmazonConnect or something like that?

   It should probably also contain the form, instead of the form being added like it is currently.

@chiranjeb have you decided to write only form and schema, schema and form in the entire month. I don't find any mechanism to fetch data from amazon in this patch. Please keep posting updates in the same issue till achieve the complete goal. Don't wait for mentors review. Mentors will review when they become free from their work. But your first evaluation is knocking. So do your progress fast.

Hello @ankit @chiranjeeb & Mentor's, I think the approach of creating different plugins will have lot of unnecessary schema and redundant code. I'll be very open to any discussion and highly appreciate further improvisation to the below suggestions to make the solution scalable and reduce the amount of code we write in future. Please also help me validate my approach, so @dbjpanda & @borrison_ Please let me know your views on it.

We have different affiliates which have common attributes as an Entity in Drupal and they can further increase.

Why don't we create them as an bundles custom entity ?

We just need to create affiliate as an entity like this : https://www.drupal.org/docs/8/api/entity-api/creating-a-content-entity-t....

So we'll save lot of schema definitions, routes and further coding different forms for different affiliates.

Now Suppose I have created an Amazon affiliate it will have the AffiliateID, AffiliateToken and other attribute it requires, that can be handled easily if we have it as an entity like we have for Users or any other entity.

Also further when we are connected to an affiliate, we can have sub_modules for those affiliates which will provide us the Rest Resources, blocks and views in future as per the affiliates. We'll cover it as per the scope of the project defined for now and in future we can have more features in like Affiliate_Connect_Commerce... as it's based on the products and their inventory as well.

Cheers

@thedrupalkid if I am correctly getting you. Are you asking custom schema vs entity then may be this link answer it. And as per my understanding plugins are only to hold the methods of different affiliate apis. E.g amazon api have a diffefent product discovery method and ebay have another method to discover product from their respective databases. https://www.drupal.org/forum/support/post-installation/2013-09-10/custom...

And probably you are right to store the products as custom entity/nodes will add advantages.
@borisson can help us to take a right decession.

@borrison_, @ankitjain28may, thanks for the suggestions. Would be posting an updated patch right away.

@dbjpanda, regarding what you asked in #26, I just put up a patch with code for a whole sub-module and not just a form with its schema. The sole purpose of this patch and the contributed module is to integrate a vendor's affiliate API, in this case, the Amazon's affiliate API with D8. This would be carried out by affiliates_connect_amazon providing a plugin, native_api_amazon, specifically for this purpose, which would further be used to connect the Amazon Affiliate API with a D8 site.

So this patch the complete amazon sub-module structure to work with upon which the native_api_amazon plugin can be built

@borrison_, @ankitjain28may, @thedrupalkid, @dbjpanda,

Following patch contains the updated and complete code and addressed all issues as mentioned in #24 and #25. Also removed the .menu file for the amazon sub module as the plugin form would be routed through the 'overview' page itself thus removing its need, as said by @borrison_. However, keeping the .routing file for now, as I think keeping it wouldn't be an issue.

Also didn't understand the need to include the form within AffiliatesNetwork file as suggested by @borrison_ in 6. for #25, as the plugin form serves its purpose well and also the AffiliatesNetwork file would serve as the base for the implementation of native_api_amazon plugin for affiliates_connect_amazon sub-module. However, suggestion are welcome.

Ignore patch in #31 as it's not correct. Uploaded correct patch here alongwith proper interdiff containing all points addressed in #24 and #25 with all the important issues highlighted in #31. Patch contains complete code for amazon sub-module structure and a base for native_api_amazon to work upon.

Please review.

So, the way I was thinking this would work is similar to how Search API with their subforms work.

The part of the form shown here is from a plugin, not from the actual module.

I don't think it's going to be a good idea to create custom entities or bundles for all of the possible providers, that is much harder for others to write compared to plugins.

I don't think that the AffiliatesConnectSettingsForm should contain the form structure for the plugins. That way it's going to be easier to create new plugins for custom projects.

@borrison,

Understood the changes you suggested. So I would move the data storage section for the custom modules exclusively from the AffiliatesConnectSettingsForm to the AffiliatesAmazonSettingsForm so that the plugin modification could be done from there itself. The other common settings could be inherited from the parent form itself.

As far as I can understand I need to change only the amazon plugin form settings like the one stated above and get inputs from the Search API sub-module screenshot you referenced. Apart from that, what else do you suggest for the completion of this Amazon custom module?

That is my only suggestion. Otherwise this is already looking solid.

@borrison_,

Thanks a lot for the review. So just for confirmation again moving the plugin settings from AffiliatesConnectSettingsForm to the plugin form would do the trick right? No need to add further changes I suppose?

There might be additional code needed in the form to load the plugin form. But yes, that is the idea, moving the form to the plugin form.

@borrison_, didn't get you by what you meant by additional code to load plugin form?

@borrison_, the plugin form would be loaded though the Overview page itself, the code for which is committed in the issue https://www.drupal.org/project/affiliates_connect/issues/2975659. Making the changes you suggested and posting a patch now.

@borrison_,

Uploaded updated patch with interdiff incorporating the change you suggested as in #34 and moved plugin info solely to AffiliatesAmazonSettingsForm from AffiliatesAmazonSettingsForm. Other than that patch everything else works as desired and patch contains complete code for the amazon sub-module.

Attached screenshot below. Hope to go RTBC this time!

Please review.

Looks solid.

@borrison_,

Thanks for the review.

Sorry, marked as needs worked by accident

@ankitjain28may,

Added all changes as mentioned. Also included new key as amazon_access_key in AffiliateAmazonSettingsForm as per requirements of Product Advertising API and renamed existing keys as suggested by @thedrupalkid.

Attached patch with interdiff.

Small work here before commit.

+++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.info.yml
@@ -0,0 +1,6 @@
+package: 'Third-party Integration'

All the modules/ submodules should have same package: 'Affiliates Connect'

+++ b/config/schema/affiliates_connect.schema.yml
--- /dev/null
+++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.info.yml

Add Affiliate_connect as dependencies to this module.

+++ b/modules/affiliates_connect_amazon/affiliates_connect_amazon.info.yml
@@ -0,0 +1,6 @@
+description: 'Amazon Plugin'

Allows integration with Amazon Product Advertising API

@dbjpanda,

Made the changes. Please review and mark as fix if correct.

error: patch failed: affiliates_connect.links.menu.yml:11
error: affiliates_connect.links.menu.yml: patch does not apply
error: src/Form/AffiliatesConnectSettingsForm.php: No such file or directory

@dbjpanda,

Rerolled patch and added all changes as mentioned in #49 along with updated interdiff.

Up for review. Hope to go green.

This patch is green (hurray, but it does add some CS issues (see the results in https://www.drupal.org/pift-ci-job/990301). Let's fix those, so we can get this in and have green tests on the branch as well.

@ankitjain28may, @borisson, that would be a better option as the whole of the CS issues for the complete module could be addressed within a single issue rather than fixing it individually. Also as @ankitjain28may said the schemas already done for in the above patch.

@chiranjeeb2410: The current branch has no cs issues, and this one does. I would prefer to not introduce new cs problems with any new patch that we add to the module.

@borisson_,

Addressed all CS issues as of https://www.drupal.org/pift-ci-job/990301 in #56.

Uploaded new patch along with interdiff.

Up for review.

Tests are green, but we still have 18 more cs issues compared to the branch.

@borisson_, on it.

@borisson_,

Addressed all 18 cs issues.

Up for review.

Awesome, great work!

@borisson_, thanks for the review.

I am committing it for now. Lets work. And if we feel we are using the same form again and again then we will move the form to main module. We can't say it till we start working for both scaper and native api. Thanks to all.

Marking as fixed, because it has been committed.