ebay-api 1.13.7 → 6.2.0

package/lib/xml-request.js

@@ -1,207 +0,0 @@
-var
-  _ = require('lodash'),
-  debug = require('debug')('ebay:request'),
-  timer = require('debug')('ebay:timer'),
-  request = require('request'),
-  util = require('util'),
-  async = require('async'),
-  xmlBuilder = require('xml'),
-  buildRequestUrl = require('./urls').buildRequestUrl,
-  getDefaultHeaders = require('./defaults').getDefaultHeaders,
-  convertXmlToJson = require('./xml-converter').convertXmlToJson,
-  parseResponseJson = require('./json-parser').parseResponseJson,
-  deepToArray = require('./deep-to-array').deepToArray,
-  EbayClientError = require('./errors').EbayClientError;
-
-
-/*
-build XML input for XML requests (POST).
-@param {object} options: request context. see `xmlRequest()` docs.
-for repeatable fields, use an array value (see below).
-*/
-function buildXmlInput(options) {
-  debug('buildXmlInput', options);
-
-  var data = {}, root;
-  var params = options.params || {};
-
-  root = data[options.opType + 'Request'] = [];   // e.g. <GetOrdersRequest>
-
-  if (options.serviceName === 'Finding') {
-    root.push({'_attr': {'xmlns': 'http://www.ebay.com/marketplace/search/v1/services'}});
-  }
-  else {
-    root.push({'_attr': {'xmlns': 'urn:ebay:apis:eBLBaseComponents'}});
-  }
-
-  if (options.authToken) {
-    root.push({ 'RequesterCredentials': [ { 'eBayAuthToken' : options.authToken } ] });
-  }
-
-  // concat
-  root.push.apply(root, deepToArray(params));
-
-  debug('Converting to XML', data);
-
-  var xmlBody =
-    '<?xml version="1.0" encoding="UTF-8"?>\n' +
-    xmlBuilder([data], true);
-
-  debug('XML body', xmlBody);
-
-  return xmlBody;
-}
-
-
-/*
-@param {object} @options:
- @option {object} reqOptions: passed to request
-
- @option {string} appId
- @option {string} opType
- @option {string} version
-
- @option {string} devId
- @option {string} certId
- @option {string} authToken
-
- @option {string} globalId
- @option {string} siteId
-
- @option {object} params: this gets converted to an XML body with request parameters.
-   - all filters go in here. use nested objects where appropriate. see the API docs.
-
- @option {int} parseDepth: how many levels down to try to parse/interpret the response.
-   - see `parseResponseJson()` and its tests.
-   - higher number can make app-level code easier, but is riskier;
-     lower number here shifts the parsing burden to the application.
-
- ...
-
- note, `options` may be modified by ref.
-
-@param {function} callback: gets response
-*/
-exports.xmlRequest = function(options, callback) {
-  var _startTime = Date.now();
-
-  debug('XML request', options);
-  options = options || {};
-
-  if (! options.serviceName) return callback(new Error("Missing serviceName"));
-  if (! options.opType) return callback(new Error("Missing opType"));
-
-  options.xmlConverter = options.xmlConverter || convertXmlToJson;
-  options.parser = options.parser || parseResponseJson;
-
-  // for default parser
-  options.parseDepth = options.parseDepth != null ? options.parseDepth : -1;  // default parse all the way
-
-  options.reqOptions = options.reqOptions || {};
-  options.reqOptions.headers = options.reqOptions.headers || {};
-  _.defaults(options.reqOptions.headers, getDefaultHeaders(options));
-
-  // allow options to override default url (and body) if they want to.
-  options.reqOptions = _.extend({
-    url: buildRequestUrl(options),
-    body: buildXmlInput(options),
-    // As of 3/22/2016, the eBay API has several servers that can only
-    // negotiate TLS v1.0 sessions, and several servers that can negotiate TLS
-    // v1.0, v1.1 and v1.2. Node/OpenSSL get confused by this, and occasionally
-    // attempt to parse a v1.2 response using TLS v1.0 and vice versa. The
-    // error you get back from the request looks something like this:
-    //
-    // { [Error: write EPROTO 140113357338496:error:1408F10B:SSL
-    //    routines:SSL3_GET_RECORD:wrong version number:../deps/openssl/openssl/ssl/s3_pkt.c:362:
-    //    ] code: 'EPROTO',
-    //    errno: 'EPROTO',
-    //    syscall: 'write' }
-    //
-    // As far as I can tell, this isn't patched yet, in Node or OpenSSL. But
-    // setting the following options forces all connections to be negotiated
-    // with TLS v1.0, effectively fixing the issue.
-    //
-    // More reading:
-    //
-    // https://github.com/aws/aws-sdk-js/issues/862
-    // https://github.com/nodejs/node/issues/3692
-    // https://www.ssllabs.com/ssltest/analyze.html?d=api.ebay.com
-    agentOptions: {
-      ciphers: 'ALL',
-      secureProtocol: 'TLSv1_method',
-    },
-  }, options.reqOptions);
-
-  debug('XML request options', options.reqOptions);
-  timer('time to initiate request', Date.now() - _startTime);
-
-  request.post(options.reqOptions, function(error, response) {
-
-    debug('response', error ? {error: error} : {statusCode: response.statusCode, body: response.body});
-    timer('time to response', Date.now() - _startTime);
-
-    if (error) {
-      return callback(error);
-    }
-
-    // this is tricky -- API should return 200 with body in every valid scenario,
-    // so a non-200 probably means something's wrong on the client side with the request.
-    // so expect an EbayClientError.
-    if (response.statusCode !== 200) {
-      return callback(new EbayClientError(
-        util.format("Bad response status code", response.statusCode, (response.body ? response.body.toString() : null))
-      ));
-    }
-
-    // raw XML wanted?
-    if (options.raw) {
-      return callback(null, response.body);
-    }
-
-    async.waterfall([
-      // convert xml to json
-      function _toJson(next) {
-        options.xmlConverter(response.body, options, function(error, data) {
-          if (error) return next(error);
-          debug('Parsed XML', data);
-          timer('time to parsed XML', Date.now() - _startTime);
-          next(null, data);
-        });
-      },
-
-      function _parseJson(data, next) {
-        // will pass error if response includes an error message,
-        // or if actually can't parse.
-        // `options.parseDepth` is very important here.
-        options.parser(data, options, next);
-      }
-    ],
-    function _done(error, data) {
-      timer('time to parsed JSON', Date.now() - _startTime);
-      var extraErrorProps = {};
-
-      if (error) {
-        // as much context as possible for forensic debugging.
-        // (includes `serviceName`, `reqOptions`, etc; not functions.)
-        extraErrorProps.requestContext = _.omit(options, _.functions(options));
-        extraErrorProps.requestContext.response = _.pick(response, ['statusCode', 'body']);
-
-        if (/Ebay/i.test(error.name)) {
-          // already differentiated into custom error classes.
-          _.extend(error, extraErrorProps);
-          callback(error, data);
-        }
-        else {
-          // some other parsing error
-          // @review - is the original stack trace lost here?
-          error = new EbayClientError("Error parsing JSON: " + error.message, extraErrorProps);
-          callback(error, data);
-        }
-      }
-      else {
-        callback(null, data);
-      }
-    });
-
-  });
-};

package/scripts/parse-input-xml.js

@@ -1,41 +0,0 @@
-#! /usr/bin/env node
-
-/**
- * script for debugging: input XML from eBay,
- * gets run through xml->js converter and JSON parser,
- * and outputs JSON (as an app using this module would get when it calls `xmlRequest()`).
- *
- * use for example with XML retrieved from API via `curl`, or eBay's API test tool.
- *
- * usage: `cat ebay-response.xml | parse-input-xml.js > ebay-response-parsed.json`
- */
-
-var
-  async = require('async'),
-  convertXmlToJson = require('../lib/xml-converter').convertXmlToJson,
-  parseResponseJson = require('../lib/json-parser').parseResponseJson,
-  inputXml = '';
-
-process.stdin.on('data', function(chunk) {
-  inputXml += chunk.toString();
-});
-
-process.stdin.on('end', function() {
-  async.waterfall([
-    function(next) {
-      // (don't know the context of the request anymore,
-      //  so anything `options`-specific in the parser won't work.)
-      convertXmlToJson(inputXml, {}, next);
-    },
-    function(data, next) {
-      parseResponseJson(data, {}, next);
-    }
-  ],
-  function(error, parsedJson) {
-    if (error) {
-      console.log(error, error instanceof Error)
-      throw error;
-    }
-    process.stdout.write(JSON.stringify(parsedJson));
-  });
-});

package/test/deep-to-array.test.js

@@ -1,100 +0,0 @@
-require('./helpers');
-
-describe('`deepToArray`', function() {
-  var deepToArray = require('../lib/deep-to-array').deepToArray;
-
-  it('converts plain value to array', function() {
-    expect(deepToArray(5)).to.deep.equal([5]);
-  });
-
-  it('converts object to array', function() {
-    expect(deepToArray({
-      'a': '1',
-      'b': '2'
-    })).to.deep.equal(
-      [
-        {'a': ['1']},
-        {'b': ['2']}
-      ]
-    );
-  });
-
-  it('splits out array elements into objects', function() {
-    expect(deepToArray(
-      {
-        thing: ['a', 'b', 'c'],
-        itemFilter: [
-          {name: 'FreeShippingOnly', value: 'true'},
-          {name: 'MaxPrice', value: '150'},
-        ]
-      }
-    )).to.deep.equal(
-      [
-        {thing: ['a']},
-        {thing: ['b']},
-        {thing: ['c']},
-        {
-          itemFilter: [
-            {name: ['FreeShippingOnly']},
-            {value: ['true']},
-          ]
-        },
-        {
-          itemFilter: [
-            {name: ['MaxPrice']},
-            {value: ['150']},
-          ]
-        }
-      ]
-    );
-  });
-
-  it('converts everything recursively to arrays', function() {
-    expect(deepToArray({
-      'Thing': {
-        'Has': {
-          'Weird': 'Structure',
-          'Strange': 'Data'
-        }
-      },
-      'Things': [
-        {'foo': 'bar'}
-      ],
-      'More': 'Things',
-      'Finally': ['Thing1', 'Thing2'],
-      'Already': [{'An': 'Array'}]
-    }))
-      .to.deep.equal(
-      [
-        {
-          'Thing': [{
-            'Has': [
-              {'Weird': ['Structure']},
-              {'Strange': ['Data']}
-            ]
-          }]
-        },
-        {
-          'Things': [
-            {'foo': ['bar']}
-          ]
-        },
-        {
-          'More': ['Things']
-        },
-        {
-          'Finally': ['Thing1']
-        },
-        {
-          'Finally': ['Thing2']
-        },
-        {
-          'Already': [
-            {'An': ['Array']}
-          ]
-        }
-      ]
-    );
-  });
-
-});

package/test/errors.test.js

@@ -1,75 +0,0 @@
-require('./helpers');
-
-var
-  errors = require('../lib/errors'),
-  _ = require('lodash');
-
-
-describe('error classes', function() {
-
-  [
-    'EbayClientError',
-    'EbaySystemError',
-    'EbayRequestError',
-    'EbayAuthenticationError'
-  ]
-  .forEach(function(errorClassName) {
-    describe(errorClassName, function() {
-      var errorClass = errors[errorClassName];
-
-      it('exists', function() {
-        expect(errorClass).to.be.ok;
-      });
-
-      it('is an Error', function() {
-        var err = new errorClass('Test');
-        expect(err).to.be.instanceOf(Error);
-      });
-
-      it('is an EbayClientError', function() {
-        var err = new errorClass('Test');
-        expect(err).to.be.instanceOf(errors.EbayClientError);
-      });
-
-      it('can have a message', function() {
-        var err = new errorClass('Test');
-        expect(err).to.have.property('message', 'Test');
-      });
-
-      it('has a stack', function() {
-        var err = new errorClass('Test');
-        expect(err).to.have.property('stack');
-        var stackLines = err.stack.split('\n');
-        expect(stackLines[0]).to.equal(errorClassName + ': Test')
-        expect(stackLines[1]).to.contain(__dirname);
-      });
-
-      it('can have arbitrary properties assigned', function() {
-        var err = new errorClass('Test', {
-          foo: 'bar',
-          details: {errorCode: '123'},
-          errors: ['um', 'hm']
-        });
-
-        expect(_.pick(err, ['foo', 'details', 'errors'])).to.deep.equal({
-          foo: 'bar',
-          details: {errorCode: '123'},
-          errors: ['um', 'hm']
-        });
-      });
-
-      it('can\'t overwrite base properties with extra properties', function() {
-        var err = new errorClass('Original message', {
-          message: 'New message',
-          name: 'UhOh',
-          stack: 'ByeBye'
-        });
-
-        expect(err.message).to.equal('Original message');
-        expect(err.name).to.equal(errorClassName);
-        expect(err.stack).not.to.equal('ByeBye');
-      });
-
-    });
-  });
-});

package/test/helpers.js

@@ -1,22 +0,0 @@
-/**
- * test helpers. run once.
- */
-
-module.exports = (function() {
-
-  var chai = require('chai');
-  global.expect = chai.expect;
-
-  global.sinon = require('sinon');
-
-  chai.use(require("sinon-chai"));
-
-  beforeEach('sandbox', function() {
-    this.sinon = sinon.sandbox.create();
-  });
-
-  afterEach('unstub', function() {
-    this.sinon.restore();
-  });
-
-})();

package/test/mocha.opts

@@ -1 +0,0 @@
---reporter spec

package/test/mocks/GetMultipleItems.xml

@@ -1,115 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<GetMultipleItemsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
-    <Timestamp>2015-10-13T15:00:00.000Z</Timestamp>
-    <Ack>Success</Ack>
-    <Version>939</Version>
-    <Build>E939_CORE_APIXO_17691495_R1</Build>
-    <Item>
-        <ItemID>222222222222</ItemID>
-        <BestOfferEnabled>false</BestOfferEnabled>
-        <EndTime>2015-11-09T00:00:00.000Z</EndTime>
-        <StartTime>2015-10-10T00:00:00.000Z</StartTime>
-        <ViewItemURLForNaturalSearch>http://www.ebay.com/itm/Mason-Jars-/222222222222</ViewItemURLForNaturalSearch>
-        <ListingType>FixedPriceItem</ListingType>
-        <Location>San Francisco, California</Location>
-        <PaymentMethods>PayPal</PaymentMethods>
-        <GalleryURL>http://thumbs1.ebaystatic.com/pict/2222222222228080_1.jpg</GalleryURL>
-        <PictureURL>http://i.ebayimg.com/00/s/MTAwMFg3NTA=/z/WSIAAWSIAAWSIAA/$_12.JPG?set_id=880000500F</PictureURL>
-        <PictureURL>http://i.ebayimg.com/00/s/MTAwMFg3NTA=/z/WSIAAWSIAAWSIAA-/$_12.JPG?set_id=880000500F</PictureURL>
-        <PostalCode>99999</PostalCode>
-        <PrimaryCategoryID>20696</PrimaryCategoryID>
-        <PrimaryCategoryName>Home &amp; Garden:Kitchen, Dining &amp; Bar:Glassware</PrimaryCategoryName>
-        <Quantity>12</Quantity>
-        <Seller>
-            <UserID>test_user</UserID>
-            <FeedbackRatingStar>None</FeedbackRatingStar>
-            <FeedbackScore>0</FeedbackScore>
-            <PositiveFeedbackPercent>0.0</PositiveFeedbackPercent>
-        </Seller>
-        <BidCount>0</BidCount>
-        <ConvertedCurrentPrice currencyID="USD">3.0</ConvertedCurrentPrice>
-        <CurrentPrice currencyID="USD">3.0</CurrentPrice>
-        <ListingStatus>Active</ListingStatus>
-        <QuantitySold>3</QuantitySold>
-        <ShipToLocations>US</ShipToLocations>
-        <ShipToLocations>CA</ShipToLocations>
-        <ShipToLocations>GB</ShipToLocations>
-        <ShipToLocations>DK</ShipToLocations>
-        <ShipToLocations>RO</ShipToLocations>
-        <ShipToLocations>SK</ShipToLocations>
-        <ShipToLocations>BG</ShipToLocations>
-        <ShipToLocations>CZ</ShipToLocations>
-        <ShipToLocations>FI</ShipToLocations>
-        <ShipToLocations>HU</ShipToLocations>
-        <ShipToLocations>LV</ShipToLocations>
-        <ShipToLocations>LT</ShipToLocations>
-        <ShipToLocations>MT</ShipToLocations>
-        <ShipToLocations>EE</ShipToLocations>
-        <ShipToLocations>AU</ShipToLocations>
-        <ShipToLocations>GR</ShipToLocations>
-        <ShipToLocations>PT</ShipToLocations>
-        <ShipToLocations>CY</ShipToLocations>
-        <ShipToLocations>SI</ShipToLocations>
-        <ShipToLocations>JP</ShipToLocations>
-        <ShipToLocations>CN</ShipToLocations>
-        <ShipToLocations>SE</ShipToLocations>
-        <ShipToLocations>KR</ShipToLocations>
-        <ShipToLocations>ID</ShipToLocations>
-        <ShipToLocations>TW</ShipToLocations>
-        <ShipToLocations>TH</ShipToLocations>
-        <ShipToLocations>BE</ShipToLocations>
-        <ShipToLocations>FR</ShipToLocations>
-        <ShipToLocations>HK</ShipToLocations>
-        <ShipToLocations>IE</ShipToLocations>
-        <ShipToLocations>NL</ShipToLocations>
-        <ShipToLocations>PL</ShipToLocations>
-        <ShipToLocations>ES</ShipToLocations>
-        <ShipToLocations>IT</ShipToLocations>
-        <ShipToLocations>DE</ShipToLocations>
-        <ShipToLocations>AT</ShipToLocations>
-        <ShipToLocations>RU</ShipToLocations>
-        <ShipToLocations>IL</ShipToLocations>
-        <ShipToLocations>MX</ShipToLocations>
-        <ShipToLocations>NZ</ShipToLocations>
-        <ShipToLocations>PH</ShipToLocations>
-        <ShipToLocations>SG</ShipToLocations>
-        <ShipToLocations>CH</ShipToLocations>
-        <ShipToLocations>NO</ShipToLocations>
-        <ShipToLocations>SA</ShipToLocations>
-        <ShipToLocations>UA</ShipToLocations>
-        <ShipToLocations>AE</ShipToLocations>
-        <ShipToLocations>QA</ShipToLocations>
-        <ShipToLocations>KW</ShipToLocations>
-        <ShipToLocations>BH</ShipToLocations>
-        <ShipToLocations>HR</ShipToLocations>
-        <ShipToLocations>MY</ShipToLocations>
-        <ShipToLocations>CL</ShipToLocations>
-        <ShipToLocations>CO</ShipToLocations>
-        <ShipToLocations>CR</ShipToLocations>
-        <ShipToLocations>DO</ShipToLocations>
-        <ShipToLocations>PA</ShipToLocations>
-        <ShipToLocations>TT</ShipToLocations>
-        <ShipToLocations>GT</ShipToLocations>
-        <ShipToLocations>SV</ShipToLocations>
-        <ShipToLocations>HN</ShipToLocations>
-        <ShipToLocations>JM</ShipToLocations>
-        <Site>US</Site>
-        <TimeLeft>P27DT6H1M31S</TimeLeft>
-        <Title>Mason Jars</Title>
-        <HitCount>14</HitCount>
-        <PrimaryCategoryIDPath>11700:20625:20696</PrimaryCategoryIDPath>
-        <Country>US</Country>
-        <ReturnPolicy>
-            <ReturnsAccepted>ReturnsNotAccepted</ReturnsAccepted>
-        </ReturnPolicy>
-        <AutoPay>false</AutoPay>
-        <IntegratedMerchantCreditCardEnabled>false</IntegratedMerchantCreditCardEnabled>
-        <HandlingTime>2</HandlingTime>
-        <ConditionID>3000</ConditionID>
-        <ConditionDisplayName>Used</ConditionDisplayName>
-        <GlobalShipping>true</GlobalShipping>
-        <ConditionDescription>Used but clean, no tops.</ConditionDescription>
-        <QuantitySoldByPickupInStore>0</QuantitySoldByPickupInStore>
-        <NewBestOffer>false</NewBestOffer>
-    </Item>
-</GetMultipleItemsResponse>​

package/test/mocks/GetOrders-empty.xml

@@ -1,17 +0,0 @@
-<!-- mock empty orders (user has no recently-modified order) -->
-<?xml version="1.0" encoding="UTF-8"?>
-<GetOrdersResponse xmlns="urn:ebay:apis:eBLBaseComponents">
-    <Timestamp>2015-10-11T15:01:00.222Z</Timestamp>
-    <Ack>Success</Ack>
-    <Version>939</Version>
-    <Build>E939_CORE_APIXO_17691495_R1</Build>
-    <PaginationResult>
-        <TotalNumberOfPages>0</TotalNumberOfPages>
-        <TotalNumberOfEntries>0</TotalNumberOfEntries>
-    </PaginationResult>
-    <HasMoreOrders>false</HasMoreOrders>
-    <OrderArray></OrderArray>
-    <OrdersPerPage>100</OrdersPerPage>
-    <PageNumber>1</PageNumber>
-    <ReturnedOrderCountActual>0</ReturnedOrderCountActual>
-</GetOrdersResponse>