fix affiliate in finding api (#68)

Author: pajaydev

demo/findingApi.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+'use strict';
 const Ebay = require('../src/index');
 const { clientId } = require('./credentials/index');
 
@@ -17,7 +19,11 @@ ebay.findItemsByKeywords({
     keywords: 'iphone',
     sortOrder: 'PricePlusShippingLowest', //https://developer.ebay.com/devzone/finding/callref/extra/fndcmpltditms.rqst.srtordr.html
     Condition: 3000,
-    SoldItemsOnly: false
+    SoldItemsOnly: false,
+    affiliate: {
+        networkId: 9,
+        trackingId: 1234567890
+    }
 }).then((data) => {
     console.log(data);
 }, (error) => {
@@ -28,7 +34,6 @@ ebay.findItemsByKeywords({
 /* This call searches for items whose listings are completed and are no longer available for
 sale by category (using categoryId), by keywords (using keywords), or a combination of the two.
 Keyword queries search the title and subtitle of the item; they do not search descriptions. */
-
 ebay.findCompletedItems({
     keywords: 'Garmin nuvi 1300 Automotive GPS Receiver',
     categoryId: '156955',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ebay-node-api",
-  "version": "2.7.4",
+  "version": "2.7.5",
   "description": "Ebay node api client",
   "main": "./src/index.js",
   "homepage": "https://github.com/pajaydev/ebay-node-api",

src/common-utils/index.js

@@ -50,5 +50,15 @@ module.exports = {
     encodeURLQuery(url) {
         return encodeURIComponent(url).replace(/'/g, '%27').replace(/"/g, '%22');
     },
+
+    // parses the object and converts it into query params.
+    parseObj(options, url = '') {
+        if (options) {
+            for (let key in options) {
+                url = `${url}&${key}=${options[key]}`
+            }
+        }
+        return url;
+    },
     base64Encode
 };

src/findingApi.js

@@ -102,6 +102,12 @@ const constructAdditionalParams = (options) => {
             else if (key === 'keywords' || key === 'categoryId' || key === 'productId' || key === 'sortOrder') {
                 params = `${params}${key}=${options[key]}&`;
             }
+            else if (key === 'affiliate') {
+                const innerParams = options[key];
+                for (let innerKey in innerParams) {
+                    params = `${params}${key}.${innerKey}=${innerParams[innerKey]}&`;
+                }
+            }
             else {
                 params = `${params}itemFilter(${count}).name=${key}&
                 itemFilter(${count}).value=${options[key]}&`;

src/merchandising.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { getRequest } = require('./request');
+const { parseObj } = require('./common-utils/index');
 const { MERCH_SRVC_NAME } = require('./constants');
 
 //https://developer.ebay.com/devzone/merchandising/docs/CallRef/getMostWatchedItems.html#Samples
@@ -12,9 +13,7 @@ const { MERCH_SRVC_NAME } = require('./constants');
   */
 const getMostWatchedItems = function (merchOptions) {
     if (!this.options.clientID) throw new Error('Missing App id or client id');
-    let url = '';
-    if (merchOptions && merchOptions.categoryId !== undefined) url = `&categoryId=${merchOptions.categoryId}`;
-    if (merchOptions && merchOptions.maxResults) url = `&maxResults=${merchOptions.maxResults}`;
+    const url = parseObj(merchOptions);
     return getRequest(`http://${this.options.baseSvcUrl}/${MERCH_SRVC_NAME}?OPERATION-NAME=getMostWatchedItems&SERVICE-NAME=${MERCH_SRVC_NAME}&SERVICE-VERSION=1.1.0&CONSUMER-ID=${this.options.clientID}&RESPONSE-DATA-FORMAT=JSON&REST-PAYLOAD${url}`).then((result) => {
         return JSON.parse(result);
     }).catch((error) => {
@@ -30,9 +29,8 @@ const getMostWatchedItems = function (merchOptions) {
   */
 const getSimilarItems = function (merchOptions) {
     if (!this.options.clientID) throw new Error('Missing App id or client id');
-    let url = '';
-    if (merchOptions && merchOptions.itemId) url = `&itemId=${merchOptions.itemId}`;
-    if (merchOptions && merchOptions.maxResults) url = `${url}&maxResults=${merchOptions.maxResults}`;
+    const url = parseObj(merchOptions);
+    console.log(`http://${this.options.baseSvcUrl}/${MERCH_SRVC_NAME}?OPERATION-NAME=getSimilarItems&SERVICE-NAME=${MERCH_SRVC_NAME}&SERVICE-VERSION=1.1.0&CONSUMER-ID=${this.options.clientID}&RESPONSE-DATA-FORMAT=JSON&REST-PAYLOAD${url}`);
     return getRequest(`http://${this.options.baseSvcUrl}/${MERCH_SRVC_NAME}?OPERATION-NAME=getSimilarItems&SERVICE-NAME=${MERCH_SRVC_NAME}&SERVICE-VERSION=1.1.0&CONSUMER-ID=${this.options.clientID}&RESPONSE-DATA-FORMAT=JSON&REST-PAYLOAD${url}`).then((result) => {
         return JSON.parse(result);
     }).catch((error) => {

test/common.test.js

@@ -0,0 +1,19 @@
+'use strict';
+const expect = require('chai').expect;
+const should = require('chai').should();
+const { parseObj } = require('../src/common-utils/index');
+
+describe('test common util methods', () => {
+    it('test parse object to query params', () => {
+        const expected_param = '&keywords=iphone&categoryId=111&sortOrder=PricePlusShippingLowest';
+        const options = {
+            keywords: 'iphone',
+            categoryId: '111',
+            sortOrder: 'PricePlusShippingLowest'
+        };
+        const emptyOptions = {};
+        expect(parseObj(options)).to.be.equal(expected_param);
+        expect(parseObj(emptyOptions)).to.be.equal('');
+        expect(parseObj(options, 'userName=ebay')).to.be.equal(`userName=ebay${expected_param}`);
+    });
+});

test/findingApi.test.js

@@ -35,6 +35,30 @@ describe('test ebay finding Api', () => {
             expect(constructAdditionalParams(emptyOptions)).to.be.equal('');
         });
 
+        it('test constructAdditionalParams with affiliate params', () => {
+            let expected_param_with_affiliate = 'keywords=iphone&categoryId=111&sortOrder=PricePlusShippingLowest&affiliate.trackingId=1234567899&affiliate.networkId=123';
+            let expected_param = 'keywords=iphone&categoryId=111&sortOrder=PricePlusShippingLowest';
+            const options = {
+                keywords: 'iphone',
+                categoryId: '111',
+                sortOrder: 'PricePlusShippingLowest',
+                affiliate: {
+                    trackingId: 1234567899,
+                    networkId: 123
+                }
+            };
+
+            const optionsWithNoAffiliate = {
+                keywords: 'iphone',
+                categoryId: '111',
+                sortOrder: 'PricePlusShippingLowest'
+            };
+            const emptyOptions = {};
+            expect(constructAdditionalParams(options)).to.be.equal(expected_param_with_affiliate);
+            expect(constructAdditionalParams(optionsWithNoAffiliate)).to.be.equal(expected_param);
+            expect(constructAdditionalParams(emptyOptions)).to.be.equal('');
+        });
+
         it('test constructAdditionalParams with additional params', () => {
             let expected_param = 'keywords=iphone&categoryId=111&sortOrder=PricePlusShippingLowest&itemFilter(0).name=Condition&itemFilter(0).value=3000&itemFilter(1).name=SoldItemsOnly&itemFilter(1).value=true';
             let expected_pag_param = 'keywords=iphone&categoryId=111&sortOrder=PricePlusShippingLowest&itemFilter(0).name=Condition&itemFilter(0).value=3000&itemFilter(1).name=SoldItemsOnly&itemFilter(1).value=true&paginationInput.entriesPerPage=2';