peddler 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ebc3731112b872c4fd188f5f2a670906d306deb
-  data.tar.gz: 6dd3f8389d2ab5837fd6a614da7f005fc74f35f9
+  metadata.gz: d7eb80f7f028b5464f42c29cb72ce60e2eda123d
+  data.tar.gz: 8a814e73f8695da5b01b0e14d62732beec970cd6
 SHA512:
-  metadata.gz: bb1753e3b07215bc3749d7a49cca3441d7149b61bb1b76f024b0d938553c9a30d90129cfa785ad831b243637b6c4a32c79c1c4b1a72d24ab15b449baa0d92e61
-  data.tar.gz: d08981d7ee8b42ab481983ae999671619517be7d7e0df8e23c17731a62bbca01001c167943845cbcc8705e645c5527d2619f2b5aa030af4fec37625e0cc3c5ee
+  metadata.gz: d736136aed3d96ebc1fc61be23638350ba84e82a7473e8ce62bf3f8086cac12e3640539895b3c25f41f739c41d7d76ff3a5193d38636932c323351967d5d9701
+  data.tar.gz: c03d025e24a676ab7150f685eef1db93b183f942f2b7259ba44e51f394dd77d195d335bbe92f2f8fd79ca9cc626a7be02ba8673d0ad0ec5911cc03ce58eed682

data/README.md

@@ -65,7 +65,7 @@ client.auth_token = "corge"
 
 Once you have a client with valid credentials, you should be able to make requests to the API. Clients map operation names in a flat structure. Methods have positional arguments for required input and keyword arguments for optional parameters. Both method and argument names are underscored but otherwise identical to the names of the corresponding operations and parameters documented in the API.
 
-Peddler wraps successful responses in a parser that handles both XML documents and flat files.
+Peddler wraps successful responses in a parser that handles both XML documents and flat files:
 
 ```ruby
 parser = client.get_service_status

data/lib/peddler/client.rb

@@ -66,12 +66,14 @@ module Peddler
       private
 
       def inherited(base)
+        base.parser = parser
+        base.path(path)
         base.params(params)
         base.on_error(&@error_handler)
       end
     end
 
-    @error_handler = ->(e) { fail e }
+    @error_handler = proc { fail }
 
     # Creates a new client instance
     #

data/lib/peddler/vcr_matcher.rb

@@ -0,0 +1,83 @@
+module Peddler
+  class VCRMatcher
+    TRANSIENT_PARAMS = %w(
+      Signature Timestamp StartDate CreatedAfter QueryStartDateTime
+    )
+
+    SELLER_PARAMS = %w(
+      AWSAccessKeyId SellerId
+    )
+
+    class << self
+      def call(*requests)
+        new(*requests).compare
+      end
+
+      def ignored_params
+        @ignored_params ||= TRANSIENT_PARAMS
+      end
+
+      def ignore_seller!
+        ignored_params.concat(SELLER_PARAMS)
+      end
+    end
+
+    attr_reader :requests
+
+    def initialize(*requests)
+      @requests = requests
+    end
+
+    def compare
+      compare_uris && compare_bodies
+    end
+
+    private
+
+    def compare_uris
+      return false if hosts.reduce(:!=) || paths.reduce(:!=)
+      return true if queries.all?(&:empty?)
+
+      queries.reduce(:==)
+    end
+
+    def compare_bodies
+      bodies.reduce(:==)
+    end
+
+    def extract_params(string)
+      return {} unless string
+
+      params = ::CGI.parse(string)
+      self.class.ignored_params.each do |k|
+        params.delete(k)
+      end
+
+      params
+    end
+
+    def uris
+      requests.map { |r| URI.parse(r.uri) }
+    end
+
+    def hosts
+      uris.map(&:host)
+    end
+
+    def paths
+      uris.map(&:path)
+    end
+
+    def queries
+      uris.map { |uri| extract_params(uri.query) }
+    end
+
+    def bodies
+      if queries.all?(&:empty?)
+        requests.map { |request| extract_params(request.body) }
+      else
+        requests.map(&:body)
+      end
+    end
+  end
+end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/test/helper.rb

@@ -1,6 +1,6 @@
 require 'simplecov'
 require 'coveralls'
-require 'peddler/test/vcr_matcher'
+require 'peddler/vcr_matcher'
 
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
@@ -40,28 +40,31 @@ module Accounts
   end
 end
 
-# Sets up clients and bootstraps VCR for integration tests
-class IntegrationTest < MiniTest::Test
+# Bootstraps VCR
+module Recorder
   def setup
-    ENV['LIVE'] ? VCR.turn_off! : VCR.insert_cassette(api)
+    ENV['LIVE'] ? VCR.turn_off! : VCR.insert_cassette(test_name)
   end
 
   def teardown
     VCR.eject_cassette if VCR.turned_on?
   end
 
+  def test_name
+    self.class.name.sub('Test', '')
+  end
+end
+
+# Sets up clients for integration testing
+class IntegrationTest < MiniTest::Test
+  include Recorder
+
   def clients
     Accounts.map do |account|
-      klass = MWS.const_get("#{api}::Client")
+      klass = MWS.const_get("#{test_name}::Client")
       klass.new(account)
     end
   end
-
-  private
-
-  def api
-    self.class.name.sub('Test', '')
-  end
 end
 
 VCR.configure do |c|
@@ -74,7 +77,7 @@ VCR.configure do |c|
     interaction.ignore! if code >= 400 && code != 414
   end
   c.default_cassette_options = {
-    match_requests_on: [::Peddler::Test::VCRMatcher],
+    match_requests_on: [::Peddler::VCRMatcher],
     record: !ENV['RECORD'] ? :none : :new_episodes
   }
 

data/test/null_client.rb

@@ -0,0 +1,23 @@
+require 'peddler/client'
+require 'securerandom'
+
+::Peddler::VCRMatcher.ignore_seller!
+
+module Null
+  class Client < ::Peddler::Client
+    def configure_with_mock_data!
+      self.aws_access_key_id = SecureRandom.hex
+      self.aws_secret_access_key = SecureRandom.hex
+      self.merchant_id = SecureRandom.hex
+      self.primary_marketplace_id = 'ATVPDKIKX0DER'
+    end
+  end
+
+  module Parser
+    def self.new(res, *)
+      res
+    end
+  end
+
+  Client.parser = Parser
+end

data/test/unit/peddler/test_client.rb

@@ -1,26 +1,15 @@
 require 'helper'
-require 'excon'
-require 'peddler/client'
+require 'null_client'
 
 class TestPeddlerClient < MiniTest::Test
-  module Parser
-    def self.new(res, *)
-      res
-    end
-  end
-
   def setup
     @body = 'foo'
     Excon.defaults[:mock] = true
     Excon.stub({}, body: @body, status: 200)
 
-    @klass = Class.new(Peddler::Client)
-    @klass.parser = Parser
+    @klass = Class.new(Null::Client)
     @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.configure_with_mock_data!
     @client.operation('Foo')
   end
 
@@ -53,6 +42,14 @@ class TestPeddlerClient < MiniTest::Test
     assert_equal Peddler::Client.params, @klass.params
   end
 
+  def test_inherits_parents_path
+    assert_equal @klass.path, Class.new(@klass).path
+  end
+
+  def test_inherits_parents_parser
+    assert_equal @klass.parser, Class.new(@klass).parser
+  end
+
   def test_params_include_seller_id
     assert @klass.params.key?("SellerId")
   end
@@ -174,13 +171,9 @@ class TestPeddlerClient < MiniTest::Test
     end
     @client.run # no longer raises
 
-    klass = Class.new(Peddler::Client)
-    klass.parser = Parser
+    klass = Class.new(Null::Client)
     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.configure_with_mock_data!
     other_client.operation('Foo')
     assert_raises(Excon::Errors::ServiceUnavailable) do
       other_client.run

data/test/unit/peddler/test_vcr_matcher.rb

@@ -0,0 +1,47 @@
+require 'helper'
+require 'null_client'
+require 'peddler/vcr_matcher'
+
+class TestPeddlerVCRMatcher < MiniTest::Test
+  include Recorder
+
+  def test_matches_recorded_post_without_body
+    client.run
+  end
+
+  def test_wont_match_unrecorded_post_without_body
+    client.operation.add(foo: 'bar')
+    assert_raises(VCR::Errors::UnhandledHTTPRequestError) do
+      client.run
+    end
+  end
+
+  def test_matches_recorded_post_with_body
+    client.body = "content"
+    client.run
+  end
+
+  def test_wont_match_unrecorded_post_with_different_query_and_same_body
+    client.operation.add(foo: 'bar')
+    client.body = "content"
+    assert_raises(VCR::Errors::UnhandledHTTPRequestError) do
+      client.run
+    end
+  end
+
+  def test_wont_match_unrecorded_post_with_same_query_and_different_body
+    client.body = "other content"
+    assert_raises(VCR::Errors::UnhandledHTTPRequestError) do
+      client.run
+    end
+  end
+
+  def client
+    @client ||= begin
+      client = Class.new(Null::Client).new
+      client.configure_with_mock_data!
+      client.operation('Action')
+      client
+    end
+  end
+end

data/test/vcr_cassettes/PeddlerVCRMatcher.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://mws.amazonservices.com/
+    body:
+      encoding: US-ASCII
+      string: AWSAccessKeyId=123&Action=Action&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2016-01-06T18%3A21%3A12Z&Signature=123
+    headers:
+      User-Agent:
+      - Jeff/1.5.1 (Language=Ruby; Hakans-MacBook-Pro.local)
+  response:
+    status:
+      code: 200
+      message:
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version:
+  recorded_at: Sat, 28 Mar 2015 18:10:18 GMT
+- request:
+    method: post
+    uri: https://mws.amazonservices.com/?AWSAccessKeyId=123&Action=Action&SellerId=123&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2016-01-06T18%3A53%3A50Z&Signature=123
+    body:
+      encoding: US-ASCII
+      string: content
+    headers:
+      User-Agent:
+      - Jeff/1.5.1 (Language=Ruby; Hakans-MacBook-Pro.local)
+  response:
+    status:
+      code: 200
+      message:
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: OK
+    http_version:
+  recorded_at: Sat, 28 Mar 2015 18:10:18 GMT
+recorded_with: VCR 3.0.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -86,7 +86,7 @@ files:
 - lib/peddler/operation.rb
 - lib/peddler/parser.rb
 - lib/peddler/structured_list.rb
-- lib/peddler/test/vcr_matcher.rb
+- lib/peddler/vcr_matcher.rb
 - lib/peddler/version.rb
 - lib/peddler/xml_parser.rb
 - lib/peddler/xml_response_parser.rb
@@ -107,6 +107,7 @@ files:
 - test/integration/test_webstore.rb
 - test/mws.yml
 - test/mws.yml.example
+- test/null_client.rb
 - test/unit/mws/test_cart_information_client.rb
 - test/unit/mws/test_customer_information_client.rb
 - test/unit/mws/test_feeds_client.rb
@@ -129,6 +130,7 @@ files:
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb
+- test/unit/peddler/test_vcr_matcher.rb
 - test/unit/peddler/test_xml_parser.rb
 - test/unit/peddler/test_xml_response_parser.rb
 - test/unit/test_mws.rb
@@ -140,6 +142,7 @@ files:
 - test/vcr_cassettes/FulfillmentOutboundShipment.yml
 - test/vcr_cassettes/OffAmazonPayments.yml
 - test/vcr_cassettes/Orders.yml
+- test/vcr_cassettes/PeddlerVCRMatcher.yml
 - test/vcr_cassettes/Products.yml
 - test/vcr_cassettes/Recommendations.yml
 - test/vcr_cassettes/Reports.yml
@@ -166,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Wraps the Amazon MWS APIs
@@ -188,6 +191,7 @@ test_files:
 - test/integration/test_webstore.rb
 - test/mws.yml
 - test/mws.yml.example
+- test/null_client.rb
 - test/unit/mws/test_cart_information_client.rb
 - test/unit/mws/test_customer_information_client.rb
 - test/unit/mws/test_feeds_client.rb
@@ -210,6 +214,7 @@ test_files:
 - test/unit/peddler/test_operation.rb
 - test/unit/peddler/test_parser.rb
 - test/unit/peddler/test_structured_list.rb
+- test/unit/peddler/test_vcr_matcher.rb
 - test/unit/peddler/test_xml_parser.rb
 - test/unit/peddler/test_xml_response_parser.rb
 - test/unit/test_mws.rb
@@ -221,6 +226,7 @@ test_files:
 - test/vcr_cassettes/FulfillmentOutboundShipment.yml
 - test/vcr_cassettes/OffAmazonPayments.yml
 - test/vcr_cassettes/Orders.yml
+- test/vcr_cassettes/PeddlerVCRMatcher.yml
 - test/vcr_cassettes/Products.yml
 - test/vcr_cassettes/Recommendations.yml
 - test/vcr_cassettes/Reports.yml

data/lib/peddler/test/vcr_matcher.rb

@@ -1,49 +0,0 @@
-module Peddler
-  module Test
-    class VCRMatcher
-      TRANSIENT_PARAMS = %w( AWSAccessKeyId SellerId Signature Timestamp
-                             StartDate CreatedAfter QueryStartDateTime ).freeze
-
-      attr_reader :req_1, :req_2
-
-      def self.call(req_1, req_2)
-        new(req_1, req_2).compare
-      end
-
-      def initialize(req_1, req_2)
-        @req_1 = req_1
-        @req_2 = req_2
-      end
-
-      def compare
-        compare_uri && compare_body
-      end
-
-      private
-
-      def compare_uri
-        uri_1 = URI.parse(req_1.uri)
-        uri_2 = URI.parse(req_2.uri)
-
-        uri_1.host == uri_2.host &&
-          uri_1.path == uri_2.path &&
-          extract_params(uri_1.query) == extract_params(uri_2.query)
-      end
-
-      def compare_body
-        extract_params(req_1.body) == extract_params(req_2.body)
-      end
-
-      def extract_params(string)
-        return {} unless string
-
-        params = ::CGI.parse(string)
-        TRANSIENT_PARAMS.each do |k|
-          params.delete(k)
-        end
-
-        params
-      end
-    end
-  end
-end