Added deals api support (#119)

pajaydev · web-flow · commit ceb4a703fe9f · 2020-08-12T18:52:57.000-07:00
* v2.7.7

* 2.8.7

* adding deals

* adding deals api

* update readme

* adde get deals support

* updated readme

* 2.8.9

* update package json
diff --git a/README.md b/README.md
@@ -41,20 +41,22 @@ let ebay = new eBay({
     }
 })
 ```
+For Country Code and Marketplace id [check here](https://developer.ebay.com/DevZone/finding/CallRef/Enums/GlobalIdList.html)
 
 ## Starter Guide
 
 Check out the [Starter Guide](https://pajaydev.github.io/ebay-node-api) documentation with examples to get started.
 
 ## Using Express js
-You can consume these ebay node api's using [Express](https://expressjs.com/). You can checkout the sample app [here](). 
+You can consume these ebay node api's using [Express](https://expressjs.com/). You can checkout the sample app [here](https://github.com/pajaydev/ebay-node-api/tree/master/demo/node-express). 
 
 ## API details
 
 ### Without Auth flow
 
 HTTP Method | Methods           | Description |   Usage | Offical doc
 ----------- | ------------------ | ----------- | ---------------- | --------------------------------
+GET         | getDeals       | Get details about the deals across eBay.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/deals.js) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
 GET         | findItemsByKeywords       | Searches for items on eBay by a keyword query.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L21) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
 GET         | findCompletedItems       | 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.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40) | [doc](https://developer.ebay.com/devzone/finding/callref/findCompletedItems.html)
 GET         | findItemsByProduct       | Searches for items on eBay using specific eBay product values.| [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L55) | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)
@@ -127,7 +129,6 @@ ebay.findItemsAdvanced({
     console.log(error);
 });
 ```
-
 [More Examples](https://pajaydev.github.io/ebay-node-api)
 
 ## Test
diff --git a/demo/deals.js b/demo/deals.js
@@ -0,0 +1,27 @@
+const Ebay = require('../src/index');
+const { clientId, clientSecret } = require('./credentials/index');
+
+let ebay = new Ebay({
+    clientID: clientId,
+    clientSecret: clientSecret,
+    body: {
+        grant_type: 'client_credentials',
+        scope: 'https://api.ebay.com/oauth/api_scope'
+
+    }
+});
+
+    // get top ten deals in US.
+    ebay.getDeals().then((data) => {
+        console.log(data);
+    });
+
+
+    // get deals for specific country code and category
+    ebay.getDeals({
+        limit: 50, // no of deals per request
+        countryCode:'ebay-de', 
+        eBayCatId: '1234' // deal for specific category id
+    }).then((data) => {
+        console.log(data);
+    });
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ebay-node-api",
-  "version": "2.8.8",
+  "version": "2.8.9",
   "description": "Ebay node api client",
   "main": "./src/index.js",
   "homepage": "https://github.com/pajaydev/ebay-node-api",
@@ -10,7 +10,8 @@
     "docs": "docsify init ./docs",
     "serve-docs": "docsify serve docs",
     "docs-publish": "gh-pages --dist docs --dotfiles --message 'chore: Publish docs'",
-    "prepublish": "npm run test"
+    "prepublish": "npm run test",
+    "release": "npm test && git commit -am $npm_package_version && git tag $npm_package_version && git push && git push --tags && npm publish"
   },
   "author": "Ajaykumar prathap",
   "keywords": [
@@ -21,7 +22,8 @@
     "Browse",
     "Category",
     "FindingApi",
-    "node-api"
+    "node-api",
+    "deals"
   ],
   "license": "MIT",
   "repository": {
@@ -32,6 +34,7 @@
     "extends": "ajay"
   },
   "dependencies": {
+    "axios": "^0.19.2",
     "eslint-config-ajay": "^1.0.6",
     "make-string": "^1.0.3"
   },
@@ -45,4 +48,4 @@
     "nock": "^9.2.3",
     "sinon": "^4.4.5"
   }
-}
+}
diff --git a/src/constants.js b/src/constants.js
@@ -3,6 +3,7 @@
 module.exports = {
     PROD_OAUTHENVIRONMENT_WEBENDPOINT: 'https://auth.ebay.com/oauth2/authorize',
     SANDBOX_OAUTHENVIRONMENT_WEBENDPOINT: 'https://auth.sandbox.ebay.com/oauth2/authorize',
+    DEALS_BASE_URL: 'http://www.ebay.com/rps/feed/v1.1/',
     PROD_BASE_URL: 'api.ebay.com',
     SANDBOX_BASE_URL: 'api.sandbox.ebay.com',
     BASE_SVC_URL: 'svcs.ebay.com',
diff --git a/src/credentials.js b/src/credentials.js
@@ -13,10 +13,10 @@ const getAccessToken = function () {
     if (!this.options.clientID) throw new Error('Missing Client ID');
     if (!this.options.clientSecret) throw new Error('Missing Client Secret or Cert Id');
     if (!this.options.body) throw new Error('Missing Body, required Grant type');
-    let scopesParam = this.options.body.scopes
-        ? Array.isArray(this.options.body.scopes)
-            ? this.options.body.scopes.join('%20')
-            : this.options.body.scopes
+    let scopesParam = this.options.body.scope
+        ? Array.isArray(this.options.body.scope)
+            ? this.options.body.scope.join('%20')
+            : this.options.body.scope
         : DEFAULT_API_SCOPE;
     this.options.data = qs.stringify({
         grant_type: 'client_credentials',
diff --git a/src/deals.js b/src/deals.js
@@ -0,0 +1,22 @@
+'use strict';
+
+const axios = require('axios');
+const { parseObj } = require('./common-utils/index');
+const { DEALS_BASE_URL } = require('./constants');
+
+module.exports = {
+
+    /**
+        * @method getDeals {Function}
+        * get deals based on site, category across ebay like (Today's top ten deals)
+        * @param {Object} options (optional)
+    */
+    getDeals: async function (options) {
+        if (!this.options.clientID) throw new Error('Missing App id or client id');
+        if (!options) options = {};
+        const countryCode = options.countryCode ? options.countryCode : this.options.globalID;
+        const qs = parseObj(options);
+        const response = await axios.get(`${DEALS_BASE_URL}${countryCode}?${qs}`);
+        return response.data;
+    }
+};
diff --git a/src/index.js b/src/index.js
@@ -3,8 +3,9 @@ const ebayBuyApi = require('./buy-api');
 const shoppingApi = require('./shopping');
 const taxonomyApi = require('./taxonomy-api');
 const ebayFindingApi = require('./finding');
+const dealsApi = require('./deals');
 const commonUtils = require('./common-utils');
-const { getSimilarItems, getMostWatchedItems } = require('./merchandising');
+const merchandisingApi = require('./merchandising');
 const {
     getAccessToken,
     getUserAuthorizationUrl,
@@ -63,13 +64,13 @@ Ebay.prototype = {
     getUserTokenByRefresh,
     setUserAccessToken,
     setAppAccessToken,
-    getMostWatchedItems,
-    getSimilarItems,
+    ...merchandisingApi,
     ...commonUtils,
     ...shoppingApi,
     ...ebayBuyApi,
     ...taxonomyApi,
-    ...ebayFindingApi
+    ...ebayFindingApi,
+    ...dealsApi
 };
 
 module.exports = Ebay;
diff --git a/yarn.lock b/yarn.lock
@@ -1187,6 +1187,13 @@ atob@^2.1.2:
   resolved "https://registry.yarnpkg.com/atob/-/atob-2.1.2.tgz#6d9517eb9e030d2436666651e86bd9f6f13533c9"
   integrity sha512-Wm6ukoaOGJi/73p/cl2GvLjTI5JM1k/O14isD73YML8StrH/7/lRFgmg8nICZgD3bZZvjwCGxtMOD3wWNAu8cg==
 
+axios@^0.19.2:
+  version "0.19.2"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.19.2.tgz#3ea36c5d8818d0d5f8a8a97a6d36b86cdc00cb27"
+  integrity sha512-fjgm5MvRHLhx+osE2xoekY70AhARk3a6hkN+3Io1jc00jtquGvxYlKlsFUhmUET0V5te6CcZI7lcv2Ym61mjHA==
+  dependencies:
+    follow-redirects "1.5.10"
+
 babel-plugin-dynamic-import-node@^2.3.0:
   version "2.3.0"
   resolved "https://registry.yarnpkg.com/babel-plugin-dynamic-import-node/-/babel-plugin-dynamic-import-node-2.3.0.tgz#f00f507bdaa3c3e3ff6e7e5e98d90a7acab96f7f"
@@ -1588,7 +1595,7 @@ de-indent@^1.0.2:
   resolved "https://registry.yarnpkg.com/de-indent/-/de-indent-1.0.2.tgz#b2038e846dc33baa5796128d0804b455b8c1e21d"
   integrity sha1-sgOOhG3DO6pXlhKNCAS0VbjB4h0=
 
-debug@3.1.0:
+debug@3.1.0, debug@=3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/debug/-/debug-3.1.0.tgz#5bb5a0672628b64149566ba16819e61518c67261"
   dependencies:
@@ -2129,6 +2136,13 @@ flush-write-stream@^1.0.2:
     inherits "^2.0.3"
     readable-stream "^2.3.6"
 
+follow-redirects@1.5.10:
+  version "1.5.10"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.5.10.tgz#7b7a9f9aea2fdff36786a94ff643ed07f4ff5e2a"
+  integrity sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==
+  dependencies:
+    debug "=3.1.0"
+
 for-in@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80"
@@ -2432,6 +2446,21 @@ highlight.js@^9.15.5:
   resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.18.1.tgz#ed21aa001fe6252bb10a3d76d47573c6539fe13c"
   integrity sha512-OrVKYz70LHsnCgmbXctv/bfuvntIKDz177h0Co37DQ5jamGZLVmoCVMtjMtNZY3X9DrCcKfklHPNeA0uPZhSJg==
 
+hoek@5.x.x:
+  version "5.0.4"
+  resolved "https://registry.yarnpkg.com/hoek/-/hoek-5.0.4.tgz#0f7fa270a1cafeb364a4b2ddfaa33f864e4157da"
+  integrity sha512-Alr4ZQgoMlnere5FZJsIyfIjORBqZll5POhDsF4q64dPuJR6rNxXdDxtHSQq8OXRurhmx+PWYEE8bXRROY8h0w==
+
+hoek@6.x.x:
+  version "6.1.3"
+  resolved "https://registry.yarnpkg.com/hoek/-/hoek-6.1.3.tgz#73b7d33952e01fe27a38b0457294b79dd8da242c"
+  integrity sha512-YXXAAhmF9zpQbC7LEcREFtXfGq5K1fmd+4PHkBq8NUqmzW3G+Dq10bI/i0KucLRwss3YYFQ0fSfoxBZYiGUqtQ==
+
+hoek@^4.2.1:
+  version "4.2.1"
+  resolved "https://registry.yarnpkg.com/hoek/-/hoek-4.2.1.tgz#9634502aa12c445dd5a7c5734b572bb8738aacbb"
+  integrity sha512-QLg82fGkfnJ/4iy1xZ81/9SIJiq1NGFUMGs6ParyjBZr6jW2Ufj/snDqTHixNlHdPNwN2RLVD0Pi3igeK9+JfA==
+
 hosted-git-info@^2.1.4:
   version "2.8.8"
   resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.8.8.tgz#7539bd4bc1e0e0a895815a2e0262420b12858488"
@@ -2766,6 +2795,13 @@ isarray@1.0.0, isarray@~1.0.0:
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
   integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=
 
+isemail@3.x.x:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/isemail/-/isemail-3.2.0.tgz#59310a021931a9fb06bbb51e155ce0b3f236832c"
+  integrity sha512-zKqkK+O+dGqevc93KNsbZ/TqTUFd46MwWjYOoMrjIMZ51eU7DtQG3Wmd9SQQT7i7RVnuTPEiYEWHU3MSbxC1Tg==
+  dependencies:
+    punycode "2.x.x"
+
 isexe@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10"
@@ -2782,6 +2818,15 @@ isobject@^3.0.0, isobject@^3.0.1:
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
   integrity sha1-TkMekrEalzFjaqH5yNHMvP2reN8=
 
+joi@^13.1.2:
+  version "13.7.0"
+  resolved "https://registry.yarnpkg.com/joi/-/joi-13.7.0.tgz#cfd85ebfe67e8a1900432400b4d03bbd93fb879f"
+  integrity sha512-xuY5VkHfeOYK3Hdi91ulocfuFopwgbSORmIwzcwHKESQhC7w1kD5jaVSPnqDxS2I8t3RZ9omCKAxNwXN5zG1/Q==
+  dependencies:
+    hoek "5.x.x"
+    isemail "3.x.x"
+    topo "3.x.x"
+
 "js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
@@ -3181,6 +3226,11 @@ nan@^2.12.1:
   resolved "https://registry.yarnpkg.com/nan/-/nan-2.14.0.tgz#7818f722027b2459a86f0295d434d1fc2336c52c"
   integrity sha512-INOFj37C7k3AfaNTtX8RhsTw7qRy7eLET14cROi9+5HAVbbHuIWUHEauBv5qT4Av2tWasiTY1Jw6puUNqRJXQg==
 
+nan@^2.13.2:
+  version "2.14.1"
+  resolved "https://registry.yarnpkg.com/nan/-/nan-2.14.1.tgz#d7be34dfa3105b91494c3147089315eff8874b01"
+  integrity sha512-isWHgVjnFjh2x2yuJ/tj3JbwoHu3UC2dX5G/88Cm24yB6YopVgxvBObDY7n5xW6ExmFhJpSEQqFPvq9zaXc8Jw==
+
 nanomatch@^1.2.9:
   version "1.2.13"
   resolved "https://registry.yarnpkg.com/nanomatch/-/nanomatch-1.2.13.tgz#b87a8aa4fc0de8fe6be88895b38983ff265bd119"
@@ -3230,6 +3280,14 @@ nock@^9.2.3:
     qs "^6.5.1"
     semver "^5.5.0"
 
+node-expat@^2.3.18:
+  version "2.3.18"
+  resolved "https://registry.yarnpkg.com/node-expat/-/node-expat-2.3.18.tgz#d9e6949cecda15e131f14259b73dc7b9ed7bc560"
+  integrity sha512-9dIrDxXePa9HSn+hhlAg1wXkvqOjxefEbMclGxk2cEnq/Y3U7Qo5HNNqeo3fQ4bVmLhcdt3YN1TZy7WMZy4MHw==
+  dependencies:
+    bindings "^1.5.0"
+    nan "^2.13.2"
+
 node-releases@^1.1.50:
   version "1.1.50"
   resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.1.50.tgz#803c40d2c45db172d0410e4efec83aa8c6ad0592"
@@ -3293,12 +3351,6 @@ number-is-nan@^1.0.0:
   resolved "https://registry.yarnpkg.com/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d"
   integrity sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=
 
-oauth-ebay@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/oauth-ebay/-/oauth-ebay-1.0.0.tgz#dc04c9f325eb346439280b08aac7c743d3e5d94e"
-  dependencies:
-    querystring "^0.2.0"
-
 object-assign@^4.0.1, object-assign@^4.1.0:
   version "4.1.1"
   resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863"
@@ -3646,7 +3698,7 @@ pumpify@^1.3.5:
     inherits "^2.0.3"
     pump "^2.0.0"
 
-punycode@^2.1.0:
+punycode@2.x.x, punycode@^2.1.0:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec"
 
@@ -3667,10 +3719,6 @@ query-string@^4.1.0:
     object-assign "^4.1.0"
     strict-uri-encode "^1.0.0"
 
-querystring@^0.2.0:
-  version "0.2.0"
-  resolved "https://registry.yarnpkg.com/querystring/-/querystring-0.2.0.tgz#b209849203bb25df820da756e747005878521620"
-
 raw-body@~1.1.0:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-1.1.7.tgz#1d027c2bfa116acc6623bca8f00016572a87d425"
@@ -4478,6 +4526,13 @@ to-through@^2.0.0:
   dependencies:
     through2 "^2.0.3"
 
+topo@3.x.x:
+  version "3.0.3"
+  resolved "https://registry.yarnpkg.com/topo/-/topo-3.0.3.tgz#d5a67fb2e69307ebeeb08402ec2a2a6f5f7ad95c"
+  integrity sha512-IgpPtvD4kjrJ7CRA3ov2FhWQADwv+Tdqbsf1ZnPUSAtCJ9e1Z44MmoSGDXGk4IppoZA7jd/QRkNddlLJWlUZsQ==
+  dependencies:
+    hoek "6.x.x"
+
 trim-lines@^1.0.0:
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/trim-lines/-/trim-lines-1.1.3.tgz#839514be82428fd9e7ec89e35081afe8f6f93115"
@@ -4878,6 +4933,15 @@ x-is-string@^0.1.0:
   resolved "https://registry.yarnpkg.com/x-is-string/-/x-is-string-0.1.0.tgz#474b50865af3a49a9c4657f05acd145458f77d82"
   integrity sha1-R0tQhlrzpJqcRlfwWs0UVFj3fYI=
 
+xml2json@^0.12.0:
+  version "0.12.0"
+  resolved "https://registry.yarnpkg.com/xml2json/-/xml2json-0.12.0.tgz#b2ae450b267033b76d896f86e022fa7bff678572"
+  integrity sha512-EPJHRWJnJUYbJlzR4pBhZODwWdi2IaYGtDdteJi0JpZ4OD31IplWALuit8r73dJuM4iHZdDVKY1tLqY2UICejg==
+  dependencies:
+    hoek "^4.2.1"
+    joi "^13.1.2"
+    node-expat "^2.3.18"
+
 xtend@^4.0.0, xtend@^4.0.1, xtend@~4.0.0, xtend@~4.0.1:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54"
