Change Filters to String for buy-api search / add sorting / add gtin search (#19)

* change filter handling for buy-api search to simply use a string

* clean some console.logs out

* add sorting to buy-api query

* Add gtin and sort as queryParams / allow gtin as top level search option

Author: smulder

README.md

@@ -5,7 +5,7 @@ Ebay API Client for node js.
 The intent is to simplify the request process by handling the tedious logic. It's a thin wrapper around eBay Api.
 
 [![npm version](https://badge.fury.io/js/ebay-node-api.svg)](https://badge.fury.io/js/ebay-node-api)
-[![Build Status](https://travis-ci.org/ajay2507/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api) 
+[![Build Status](https://travis-ci.org/ajay2507/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api)
 
 
 ## Table of Contents
@@ -47,15 +47,15 @@ npm install ebay-node-api
 let eBay = require('ebay-node-api')
 
 let ebay = new eBay({
-    clientID: "-- Client APP ID ----", 
+    clientID: "-- Client APP ID ----",
     // options  - optional HTTP request timeout to apply to all requests.
 })
 ```
 Creates a new `Ebay` instance.
 
 ### Getting Client ID:
 
-Join eBay developers program. 
+Join eBay developers program.
 Register your app here https://go.developer.ebay.com/quick-start-guide.
 
 #### Options
@@ -193,7 +193,8 @@ ebay.getAccessToken()
         ebay.searchItems({
             keyword: "drone",
             limit: 3,
-            filter: { maxDeliveryCost: 0 }
+            // filter: { maxDeliveryCost: 0 } old object based filter method
+		  filter: 'maxDeliveryCost:0' // new string based filter method. Format here: https://developer.ebay.com/api-docs/buy/static/ref-buy-browse-filters.html#conditionIds
         }).then((data) => {
             console.log(data);
             // Data is in format of JSON
@@ -209,7 +210,8 @@ ebay.getAccessToken()
         ebay.searchItems({
             keyword: "iphone",
             limit: 3,
-            filter: { price: "[300..800]", priceCurrency: "USD", conditions: "NEW" }
+            // filter: { price: "[300..800]", priceCurrency: "USD", conditions: "NEW" } old object based filter method
+		  filter: 'price:[300..800],priceCurrency:USD,conditions{NEW}' // new string based filter method. Format here: https://developer.ebay.com/api-docs/buy/static/ref-buy-browse-filters.html#conditionIds
         }).then((data) => {
             console.log(data);
             // Data is in format of JSON
@@ -265,5 +267,5 @@ Willing to share your idea or ready to contribute, check [here](https://github.c
 MIT.
 
 ## Examples:
-I have mentioned the examples here 
+I have mentioned the examples here
 https://github.com/ajay2507/ebay-node-api/tree/master/demo.

src/buy-api.js

@@ -43,15 +43,17 @@ const getItemByItemGroup = function (itemGroupId) {
 
 const searchItems = function (searchConfig) {
     if (!searchConfig) throw new Error("Error --> Missing or invalid input parameter to search");
-    if (!searchConfig.keyword && !searchConfig.categoryId) throw new Error("Error --> Keyword or category id is required in query param");
+    if (!searchConfig.keyword && !searchConfig.categoryId && !searchConfig.gtin) throw new Error("Error --> Keyword or category id is required in query param");
     if (!this.options.access_token) throw new Error("Error -->Missing Access token, Generate access token");
     const auth = "Bearer " + this.options.access_token;
     let queryParam = searchConfig.keyword ? "q=" + searchConfig.keyword : "";
+    queryParam = queryParam + (searchConfig.gtin ? "&gtin=" + searchConfig.gtin : '');
     queryParam = queryParam + (searchConfig.categoryId ? "&category_ids=" + searchConfig.categoryId : '');
     queryParam = queryParam + (searchConfig.limit ? "&limit=" + searchConfig.limit : "");
+    queryParam = queryParam + (searchConfig.sort ? "&sort=" + searchConfig.sort : "");
     if (searchConfig.fieldgroups != undefined) queryParam = queryParam + "&fieldgroups=" + searchConfig.fieldgroups.toString();
-    if (searchConfig.filter != undefined) queryParam = queryParam + "&filter=" + JSON.stringify(searchConfig.filter).replace(/[{}]/g, "").replace(/[""]/g, "");
-    console.log(queryParam);
+    if (searchConfig.filter != undefined) queryParam = queryParam + "&filter=" + encodeURIComponent(searchConfig.filter);
+    // console.log(queryParam);
     return new Promise((resolve, reject) => {
         makeRequest('api.ebay.com', `/buy/browse/v1/item_summary/search?${queryParam}`, 'GET', this.options.body, auth).then((result) => {
             resolve(result);

src/request.js

@@ -20,7 +20,7 @@ let getRequest = function getRequest(url) {
 
 let makeRequest = function postRequest(hostName, endpoint, methodName, data, token) {
     methodName == "POST" ? dataString = qs.stringify(data) : '';
-    console.log(endpoint);
+    // console.log(endpoint);
     const options = {
         "hostname": hostName,
         "path": endpoint,
@@ -57,4 +57,4 @@ let base64Encode = (encodeData) => {
     return buff.toString('base64');
 }
 
-module.exports = { getRequest, makeRequest, base64Encode };
+module.exports = { getRequest, makeRequest, base64Encode };