peddler 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f67b925cce300aac503662925a525c2a926db0
-  data.tar.gz: c50b916f201204efff20ad84142b890f87f18db8
+  metadata.gz: 000b1310894c1927903fdf0e03c017ba423028ab
+  data.tar.gz: 67bb363245360947b26876012006f517c5a02adf
 SHA512:
-  metadata.gz: 7b7207770118f4af6786a4394bfd1138b0b89c311e9b20059b9818ae75a84c4ed25f2ea4fd102740e5f98ffa1847e78d8536509e6b73cddf5fc0f4b1fefa6394
-  data.tar.gz: 171a182338ae07f4e52ddbf846fd12e963ec2c4dce6c9c18b38e8fd8c95f8e3e3148a44b24d264a9b6165158b3a9908ad7531a63a5eacd836c3b569c42f4b31e
+  metadata.gz: 88b46c45a57029d3e5491f0d81dfbd840a0ebd5247b217d4b61ca3e8b2996c170436d6538e704aecf0a2a9a931ecd3bfbb6af4784d5b4a5b2f4072edce817f96
+  data.tar.gz: 36f0952ba933db954280775c3182acdc0be8c8eda111b81a3af36a483b8472403cd017f816c70456ddbeb37d6893c58aba25403c22461b31d773dcabb52c1ea4

data/README.md

@@ -1,4 +1,3 @@
-
 # Peddler
 
 [![Build Status](https://travis-ci.org/hakanensari/peddler.svg)](https://travis-ci.org/hakanensari/peddler)
@@ -39,29 +38,36 @@ client = MWS::Orders::Client.new(
   aws_access_key_id: "baz",
   aws_secret_access_key: "qux"
 )
+```
 
-Alternatively, you can set these globally in the shell.
+Alternatively, set these globally in the shell.
 
-```sh
+```bash
 export MWS_MARKETPLACE_ID=foo
 export MWS_MERCHANT_ID=bar
 export AWS_ACCESS_KEY_ID=baz
 export AWS_SECRET_ACCESS_KEY=qux
 ```
 
+You can now instantiate a client without passing credentials.
+
+```ruby
+client = MWS::Orders::Client.new
+```
+
 If you are creating a client for another seller, pass the latter's `MWSAuthToken` to the client.
 
 ```ruby
 client.auth_token = "corge"
 ```
 
-Once you have a client with credentials, you can make requests to the API.
+Once you have a client with valid credentials, you should be able to make requests to the API.
 
-Peddler returns the response wrapped in a simple parser that handles both XML documents and flat files.
+Peddler returns the response wrapped in a parser that handles both XML documents and flat files.
 
 ```ruby
 parser = client.get_service_status
-parser.parse # will return Hash or a CSV object
+parser.parse # will return a Hash or CSV object
 ```
 
 You can swap the default parser with a purpose-built one.
@@ -75,20 +81,21 @@ For a sample implementation, see my [MWS Orders](https://github.com/hakanensari/
 Finally, you can handle network errors caused by throttling or other transient issues by defining an error handler.
 
 ```ruby
-MWS::Orders::Client.on_error do |request, response|
-  if response.status == 503
-    logger.info "I was throttled"
+MWS::Orders::Client.on_error do |e|
+  if e.response.status == 503
+    logger.warn e.response.message
   end
 end
 ```
 
-Alternatively, you can simply rescue.
+Alternatively, rescue.
 
 ```ruby
 begin
   client.some_method
-rescue Excon::Errors::ServiceUnavailable
-  sleep 1 and retry
+rescue Excon::Errors::ServiceUnavailable => e
+  logger.warn e.response.message
+  retry
 end
 ```
 

data/lib/mws/recommendations/client.rb

@@ -28,7 +28,7 @@ module MWS
       # categories for a specific marketplace
       #
       # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendations.html
-      # @overload list_recommendations(opts = { marketplace_id: marketplace_id })
+      # @overload list_recommendations(opts = { marketplace_id: primary_marketplace_id })
       #   @param opts [Hash]
       #   @option opts [String] :marketplace_id
       #   @option opts [String] :recommendation_category

data/lib/mws/sellers/client.rb

@@ -31,22 +31,12 @@ module MWS
 
       # Gets the service status of the API
       #
-      # @see http://docs.developer.amazonservices.com/en_US/sellers/MWS_GetServiceStatus.html
+      # @see http://docs.developer.amazonservices.com/en_US/sellers/Sellers_GetServiceStatus.html
       # @return [Peddler::XMLParser]
       def get_service_status
         operation('GetServiceStatus')
         run
       end
-
-      # Gets the MWS Auth Token of the seller account
-      #
-      # @see http://docs.developer.amazonservices.com/en_US/auth_token/AuthToken_GetAuthToken.html
-      # @todo Remove this method after June 30, 2015 as it will no longer be available.
-      # @return [Peddler::XMLParser]
-      def get_auth_token
-        operation('GetAuthToken')
-        run
-      end
     end
   end
 end

data/lib/mws/webstore/client.rb

@@ -20,7 +20,7 @@ module MWS
       # including the items that are subscribed to
       #
       # @see http://docs.developer.amazonservices.com/en_US/webstore/Webstore_ListSubscriptionsCount.html
-      # @overload list_subscriptions_count(subscription_state, opts = { marketplace_id: marketplace_id })
+      # @overload list_subscriptions_count(subscription_state, opts = { marketplace_id: primary_marketplace_id })
       #   @param subscription_state [String]
       #   @param opts [Hash]
       #   @option opts [String] :marketplace_id

data/lib/peddler/client.rb

@@ -69,14 +69,16 @@ module Peddler
 
       def inherited(base)
         base.params(params)
-        base.on_error(&@error_handler) if @error_handler
+        base.on_error(&@error_handler)
       end
     end
 
+    @error_handler = -> (e) { fail e }
+
     # Creates a new client instance
     #
     # @param opts [Hash]
-    # @option opts [String] :marketplace_id
+    # @option opts [String] :primary_marketplace_id
     # @option opts [String] :merchant_id
     # @option opts [String] :aws_access_key_id
     # @option opts [String] :aws_secret_access_key
@@ -97,12 +99,12 @@ module Peddler
       @primary_marketplace_id ||= ENV['MWS_MARKETPLACE_ID']
     end
 
-    # @deprecated Use {#primary_marketplace_id} instead.
+    # @deprecated Use {#primary_marketplace_id}.
     def marketplace_id
       @primary_marketplace_id
     end
 
-    # @deprecated Use {#primary_marketplace_id=} instead.
+    # @deprecated Use {#primary_marketplace_id=}.
     def marketplace_id=(marketplace_id)
       @primary_marketplace_id = marketplace_id
     end
@@ -165,24 +167,14 @@ module Peddler
     end
 
     # @api private
-    # rubocop:disable AbcSize, MethodLength
     def run
-      opts = defaults.merge(query: operation, headers: headers)
-      opts.store(:body, body) if body
+      opts = build_options
       opts.store(:response_block, Proc.new) if block_given?
       res = post(opts)
 
       parser.new(res, encoding)
     rescue Excon::Errors::Error => e
-      handle_error(e) or raise
-    rescue NoMethodError => e
-      if e.message == "undefined method `new' for #{parser}"
-        warn "[DEPRECATION] `Parser.parse` is deprecated. "\
-             "Please use `Parser.new` instead."
-        parser.parse(res, encoding)
-      else
-        raise
-      end
+      handle_error(e)
     end
 
     private
@@ -207,9 +199,31 @@ module Peddler
       self.class.parser
     end
 
+    def build_options
+      opts = defaults.merge(query: operation, headers: headers)
+      body ? opts.update(body: body) : opts
+    end
+
     def handle_error(e)
-      return false unless error_handler
-      error_handler.call(e.request, e.response)
+      e = decorate_error(e)
+      error_handler.call(*deprecate_error_handler_arguments(e))
+    end
+
+    def decorate_error(e)
+      if e.is_a?(::Excon::Errors::HTTPStatusError)
+        e.instance_variable_set(:@response, ErrorParser.new(e.response))
+      end
+
+      e
+    end
+
+    def deprecate_error_handler_arguments(e)
+      if error_handler.parameters.size == 2
+        warn "[DEPRECATION] Error handler now expects exception as argument."
+        [e.request, e.response]
+      else
+        [e]
+      end
     end
   end
 end

data/lib/peddler/error_parser.rb

@@ -0,0 +1,26 @@
+require 'peddler/xml_parser'
+
+module Peddler
+  # @api private
+  class ErrorParser < XMLParser
+    def message
+      parse['Message']
+    end
+
+    def type
+      parse['Type']
+    end
+
+    def code
+      parse['Code']
+    end
+
+    private
+
+    def find_data
+      xml
+        .fetch('ErrorResponse', {})
+        .fetch('Error', {})
+    end
+  end
+end

data/lib/peddler/marketplace.rb

@@ -11,6 +11,7 @@ module Peddler
       'A21TJRUUN4KGV'  => 'mws.amazonservices.in',
       'APJ6JRA9NG5V4'  => 'mws-eu.amazonservices.com',
       'A1VC38T7YXB528' => 'mws.amazonservices.jp',
+      'A1AM78C64UM0Y8' => 'mws.amazonservices.com.mx',
       'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
     }
 

data/lib/peddler/parser.rb

@@ -1,19 +1,19 @@
 require 'peddler/flat_file_parser'
-require 'peddler/xml_parser'
+require 'peddler/xml_response_parser'
 
 module Peddler
   # @api private
   module Parser
     class << self
-      # The inevitable messiness of massaging data produced by a motley army of
-      # Amazon developers
+      # The inevitable-seeming messiness of massaging data produced by a motley
+      # army of Amazon developers
       def new(res, encoding = 'ISO-8859-1')
         # Don't parse if there's no body
         return res unless res.body
 
         content_type = res.headers['Content-Type']
         if content_type.start_with?('text/xml')
-          XMLParser.new(res)
+          XMLResponseParser.new(res)
         else
           # Amazon returns a variety of content types for flat files, so we
           # simply assume that anything not XML is a flat file rather than code

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/lib/peddler/xml_parser.rb

@@ -4,12 +4,8 @@ require 'multi_xml'
 module Peddler
   # @api private
   class XMLParser < SimpleDelegator
-    def next_token
-      parse.fetch('NextToken', false)
-    end
-
     def parse
-      @result ||= find_result
+      @data ||= find_data
     end
 
     def xml
@@ -17,14 +13,14 @@ module Peddler
     end
 
     def valid?
-      headers['Content-Length'].to_i == body.size if headers['Content-Length']
+      return unless headers['Content-Length']
+      headers['Content-Length'].to_i == body.size
     end
 
     private
 
-    def find_result
-      results = xml.values[0].find { |k, _| k.include?('Result') }
-      results ? results.last : nil
+    def find_data
+      fail NotImplementedError
     end
   end
 end

data/lib/peddler/xml_response_parser.rb

@@ -0,0 +1,17 @@
+require 'peddler/xml_parser'
+
+module Peddler
+  # @api private
+  class XMLResponseParser < XMLParser
+    def next_token
+      parse.fetch('NextToken', false)
+    end
+
+    private
+
+    def find_data
+      results = xml.values.first.find { |k, _| k.include?('Result') }
+      results ? results.last : nil
+    end
+  end
+end

data/test/unit/mws/test_sellers_client.rb

@@ -42,16 +42,4 @@ class TestMWSSellersClient < MiniTest::Test
 
     assert_equal operation, @client.operation
   end
-
-  def test_gets_auth_token
-    operation = {
-      'Action' => 'GetAuthToken'
-    }
-
-    @client.stub(:run, nil) do
-      @client.get_auth_token
-    end
-
-    assert_equal operation, @client.operation
-  end
 end

data/test/unit/peddler/test_client.rb

@@ -143,14 +143,12 @@ class TestPeddlerClient < MiniTest::Test
       @client.run
     end
 
-    @klass.on_error do |_, res|
-      assert_equal 503, res.status
+    @klass.on_error do |e|
+      assert_equal 503, e.response.status
     end
-
-    @client.run
+    @client.run # no longer raises
 
     Excon.stubs.clear
-    @klass.instance_variable_set(:@error_handler, nil)
   end
 
   def test_error_callback_on_instance
@@ -160,10 +158,9 @@ class TestPeddlerClient < MiniTest::Test
       @client.run
     end
 
-    @client.on_error do |_, res|
-      assert_equal 503, res.status
+    @client.on_error do |e|
+      assert_equal 503, e.response.status
     end
-
     @client.run
 
     Excon.stubs.clear
@@ -172,53 +169,54 @@ class TestPeddlerClient < MiniTest::Test
   def test_error_callback_on_client_ancestor
     Excon.stub({}, status: 503)
 
-    assert_raises(Excon::Errors::ServiceUnavailable) do
-      @client.run
-    end
-
-    Peddler::Client.on_error do |_, res|
-      assert_equal 503, res.status
+    @klass.on_error do |e|
+      assert_equal 503, e.response.status
     end
+    @client.run # no longer raises
 
     klass = Class.new(Peddler::Client)
     klass.parser = Parser
-    client = klass.new
-    client.aws_access_key_id = 'key'
-    client.aws_secret_access_key = 'secret'
-    client.merchant_id = 'seller'
-    client.primary_marketplace_id = 'ATVPDKIKX0DER' # US
-    client.operation('Foo')
-    client.run
+    other_client = klass.new
+    other_client.aws_access_key_id = 'key'
+    other_client.aws_secret_access_key = 'secret'
+    other_client.merchant_id = 'seller'
+    other_client.primary_marketplace_id = 'ATVPDKIKX0DER' # US
+    other_client.operation('Foo')
+    assert_raises(Excon::Errors::ServiceUnavailable) do
+      other_client.run
+    end
 
     Excon.stubs.clear
-    Peddler::Client.instance_variable_set(:@error_handler, nil)
   end
 
-  def test_deprecates_call_to_parser_parse
-    deprecated_parser = Module.new do
-      def self.parse(res, *)
-        res
-      end
-    end
-    @client.stub :warn, nil do
-      @klass.parser = deprecated_parser
-      res = @client.run
-      assert_equal @body, res.body
+  def test_decorates_error_response
+    res = {
+      body: '<ErrorResponse><Error>Foo</Error></ErrorResponse>',
+      status: 503
+    }
+    Excon.stub({}, res)
+    e = nil
+
+    begin
+      @client.run
+    rescue => e
+      assert e.response.parse
     end
+
+    assert e
   end
 
-  def test_raises_no_method_errors_not_related_to_deprecated_parser
-    bad_parser = Module.new do
-      def self.new(*)
-        fail NoMethodError, "foo"
-      end
+  def test_deprecated_error_callback
+    Excon.stub({}, status: 503)
+
+    @client.on_error do |_, res|
+      assert_equal 503, res.status
     end
-    @klass.parser = bad_parser
-    @client.stub :warn, nil do
-      assert_raises NoMethodError do
-        @client.run
-      end
+    assert_output nil, /DEPRECATION/ do
+      @client.run
     end
+
+    Excon.stubs.clear
   end
 
   def test_deprecated_marketplace_id_accessor

data/test/unit/peddler/test_error_parser.rb

@@ -0,0 +1,42 @@
+require 'helper'
+require 'peddler/error_parser'
+
+class TestPeddlerErrorParser < MiniTest::Test
+  def setup
+    body = <<-XML
+      <ErrorResponse>
+        <Error>
+          <Type>Foo</Type>
+          <Code>Bar</Code>
+          <Message>Baz</Message>
+        </Error>
+        <RequestID>123</RequestID>
+      </ErrorResponse>
+    XML
+    res = OpenStruct.new(
+      body: body,
+      headers: {
+        'Content-Type' => 'text/xml',
+        'Content-Length' => body.size.to_s
+      }
+    )
+
+    @parser = Peddler::ErrorParser.new(res)
+  end
+
+  def test_parses_data
+    assert @parser.parse
+  end
+
+  def test_has_a_message
+    assert @parser.message
+  end
+
+  def test_has_code
+    assert @parser.code
+  end
+
+  def test_has_type
+    assert @parser.type
+  end
+end

data/test/unit/peddler/test_xml_parser.rb

@@ -3,22 +3,23 @@ require 'peddler/xml_parser'
 
 class TestPeddlerXMLParser < MiniTest::Test
   def setup
-    body = '<Response><Result><NextToken>123</NextToken>'\
-           '<Foo>Bar</Foo></Result></Response>'
+    body = '<Foo>Bar</Foo>'
+
     res = OpenStruct.new(
       body: body,
-      headers: { 'Content-Type' => 'text/xml', 'Content-Length' => '78' }
+      headers: {
+        'Content-Type' => 'text/xml',
+        'Content-Length' => body.size.to_s
+      }
     )
 
     @parser = Peddler::XMLParser.new(res)
   end
 
-  def test_parses_data
-    assert_equal 'Bar', @parser.parse['Foo']
-  end
-
-  def test_next_token
-    assert_equal '123', @parser.next_token
+  def test_does_not_implement_parsing
+    assert_raises NotImplementedError do
+      @parser.parse
+    end
   end
 
   def test_validates

data/test/unit/peddler/test_xml_response_parser.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require 'peddler/xml_response_parser'
+
+class TestPeddlerXMLResponseParser < MiniTest::Test
+  def setup
+    body = '<Response><Result><NextToken>123</NextToken>'\
+           '<Foo>Bar</Foo></Result></Response>'
+    res = OpenStruct.new(
+      body: body,
+      headers: { 'Content-Type' => 'text/xml', 'Content-Length' => '78' }
+    )
+
+    @parser = Peddler::XMLResponseParser.new(res)
+  end
+
+  def test_parses_data
+    assert_equal 'Bar', @parser.parse['Foo']
+  end
+
+  def test_next_token
+    assert_equal '123', @parser.next_token
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -78,6 +78,7 @@ files:
 - lib/mws/webstore/client.rb
 - lib/peddler.rb
 - lib/peddler/client.rb
+- lib/peddler/error_parser.rb
 - lib/peddler/flat_file_parser.rb
 - lib/peddler/marketplace.rb
 - lib/peddler/operation.rb
@@ -85,6 +86,7 @@ files:
 - lib/peddler/structured_list.rb
 - lib/peddler/version.rb
 - lib/peddler/xml_parser.rb
+- lib/peddler/xml_response_parser.rb
 - test/helper.rb
 - test/integration/test_cart_information.rb
 - test/integration/test_customer_information.rb
@@ -116,12 +118,14 @@ files:
 - test/unit/mws/test_subscriptions_client.rb
 - test/unit/mws/test_webstore_client.rb
 - test/unit/peddler/test_client.rb
+- test/unit/peddler/test_error_parser.rb
 - test/unit/peddler/test_flat_file_parser.rb
 - test/unit/peddler/test_marketplace.rb
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb
 - test/unit/peddler/test_xml_parser.rb
+- test/unit/peddler/test_xml_response_parser.rb
 - test/unit/test_mws.rb
 - test/vcr_cassettes/CartInformation.yml
 - test/vcr_cassettes/CustomerInformation.yml
@@ -193,12 +197,14 @@ test_files:
 - test/unit/mws/test_subscriptions_client.rb
 - test/unit/mws/test_webstore_client.rb
 - test/unit/peddler/test_client.rb
+- test/unit/peddler/test_error_parser.rb
 - test/unit/peddler/test_flat_file_parser.rb
 - test/unit/peddler/test_marketplace.rb
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb
 - test/unit/peddler/test_xml_parser.rb
+- test/unit/peddler/test_xml_response_parser.rb
 - test/unit/test_mws.rb
 - test/vcr_cassettes/CartInformation.yml
 - test/vcr_cassettes/CustomerInformation.yml