peddler 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb811340d856df7c73b3ea07afd4532892500c8
-  data.tar.gz: 537798c7e2eff288ac0d8e16094a8a295f9e2daf
+  metadata.gz: 0ebc3731112b872c4fd188f5f2a670906d306deb
+  data.tar.gz: 6dd3f8389d2ab5837fd6a614da7f005fc74f35f9
 SHA512:
-  metadata.gz: ab7bc5600b29e18fe0968cd9dc874b9982ab50e4e6636b3390b0b46125b2e13eb1a1476e6064bdc2b4f889ede22fa97cd3d57c427530edc0e87c7d770e729594
-  data.tar.gz: 9a013902b6900d5e9cf6f0615a008816ec60e4761c758b8f8ba0ba10e3ec8e56547d8ad2f343695b38ab0cbb279ba03856364d2389bfbf9f77168d8a13128f7c
+  metadata.gz: bb1753e3b07215bc3749d7a49cca3441d7149b61bb1b76f024b0d938553c9a30d90129cfa785ad831b243637b6c4a32c79c1c4b1a72d24ab15b449baa0d92e61
+  data.tar.gz: d08981d7ee8b42ab481983ae999671619517be7d7e0df8e23c17731a62bbca01001c167943845cbcc8705e645c5527d2619f2b5aa030af4fec37625e0cc3c5ee

data/README.md

@@ -41,36 +41,38 @@ export AWS_SECRET_ACCESS_KEY=qux
 You can now instantiate a client.
 
 ```ruby
-client = MWS::Orders::Client.new
+client = MWS.orders
 ```
 
 Alternatively, you can set some or all credentials when or after creating the client.
 
 ```ruby
-client = MWS::Orders::Client.new(
+client = MWS.orders(
   primary_marketplace_id: "foo",
   merchant_id: "bar",
   aws_access_key_id: "baz",
   aws_secret_access_key: "qux"
 )
+client.primary_marketplace_id = "bar"
 ```
 
 If you are creating a client for another seller, pass the latter's `MWSAuthToken` to the client.
 
 ```ruby
+client = MWS.orders
 client.auth_token = "corge"
 ```
 
-Once you have a client with valid credentials, you should be able to make requests to the API.
+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 returns the response wrapped 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
 parser.parse # will return a Hash or CSV object
 ```
 
-You can swap the default parser with a purpose-built one.
+You can swap the default parser with a purpose-built abstraction.
 
 ```ruby
 MWS::Orders::Client.parser = MyParser

data/lib/mws/feeds/client.rb

@@ -27,7 +27,7 @@ module MWS
         run
       end
 
-      # List feed submissions
+      # Lists feed submissions
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionList.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
@@ -49,7 +49,7 @@ module MWS
         run
       end
 
-      # List the next page of feed submissions
+      # Lists the next page of feed submissions
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_GetFeedSubmissionListByNextToken.html
       # @param next_token [String]
@@ -80,7 +80,7 @@ module MWS
         run
       end
 
-      # Cancel one or more feed submissions
+      # Cancels one or more feed submissions
       #
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_CancelFeedSubmissions.html
       # @see http://docs.developer.amazonservices.com/en_US/feeds/Feeds_FeedType.html
@@ -93,6 +93,8 @@ module MWS
       def cancel_feed_submissions(opts = {})
         operation('CancelFeedSubmissions')
           .add(opts)
+          .structure!('FeedSubmissionIdList', 'Id')
+          .structure!('FeedTypeList', 'Type')
 
         run
       end

data/lib/mws/orders/client.rb

@@ -11,7 +11,8 @@ module MWS
       # Lists orders
       #
       # @note When calling this operation, you must specify a time frame using
-      #   either created_after or last_updated_after.
+      #   either created_after or last_updated_after. When requesting orders by
+      #   "Unshipped" status you must also request "PartiallyShipped" orders.
       # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html
       # @param opts [Hash]
       # @option opts [String, #iso8601] :created_after

data/lib/mws/reports/client.rb

@@ -170,7 +170,7 @@ module MWS
         run
       end
 
-      # List scheduled reports
+      # Lists scheduled reports
       #
       # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleList.html
       # @param report_type_list [*Array<String>]
@@ -183,7 +183,7 @@ module MWS
         run
       end
 
-      # List next page of scheduled reports
+      # Lists next page of scheduled reports
       #
       # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleListByNextToken.html
       # @raise [NotImplementedError]
@@ -191,7 +191,7 @@ module MWS
         fail NotImplementedError
       end
 
-      # Count scheduled reports
+      # Counts scheduled reports
       #
       # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleCount.html
       # @param report_type_list [Array<String>]
@@ -204,7 +204,7 @@ module MWS
         run
       end
 
-      # Update acknowledged status of one or more reports
+      # Updates acknowledged status of one or more reports
       #
       # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_UpdateReportAcknowledgements.html
       # @param acknowledged [Boolean]

data/lib/peddler/client.rb

@@ -133,7 +133,12 @@ module Peddler
 
     # @!parse attr_writer :body
     def body=(str)
-      headers['Content-Type'] = content_type(str)
+      if str
+        headers['Content-Type'] = content_type(str)
+      else
+        headers.delete('Content-Type')
+      end
+
       @body = str
     end
 

data/lib/peddler/flat_file_parser.rb

@@ -39,7 +39,9 @@ module Peddler
     end
 
     def scrub_content
-      content.force_encoding(encoding).encode('UTF-8')
+      content
+        .force_encoding(encoding)
+        .encode('UTF-8', undef: :replace, replace: '?')
     end
 
     def summary?

data/lib/peddler/marketplace.rb

@@ -27,15 +27,17 @@ module Peddler
       @host ||= find_host
     end
 
+    # Caveat: We use the supersets Windows-31J and CP1252 in place of Shift_JIS
+    # and ISO 8859-1 respectively to handle edge cases where latter will not
+    # support some characters. The supersets should be safe to use as drop-in
+    # replacements.
     def encoding
       if japanese?
-        # Caveat: I've had one instance in the past where Shift_JIS didn't
-        # work but Windows-31J did when parsing a report.
-        'Shift_JIS'
+        'Windows-31J'
       elsif chinese?
         'UTF-16'
       else
-        'ISO-8859-1'
+        'CP1252'
       end
     end
 

data/lib/peddler/parser.rb

@@ -8,7 +8,7 @@ module Peddler
     class << self
       # The inevitable-seeming messiness of massaging data produced by a motley
       # army of Amazon developers
-      def new(res, encoding = 'ISO-8859-1')
+      def new(res, encoding)
         # Don't parse if there's no body
         return res unless res.body
 

data/lib/peddler/test/vcr_matcher.rb

@@ -22,15 +22,22 @@ module Peddler
       private
 
       def compare_uri
-        req_1.uri == req_2.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(body)
-        params = ::CGI.parse(body)
+      def extract_params(string)
+        return {} unless string
+
+        params = ::CGI.parse(string)
         TRANSIENT_PARAMS.each do |k|
           params.delete(k)
         end

data/lib/peddler/version.rb

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

data/lib/peddler/xml_response_parser.rb

@@ -10,10 +10,11 @@ module Peddler
     private
 
     def find_data
-      results = xml.values.first.find { |k, _| k.include?('Result') } ||
-                xml.values.first.find { |k, _| k == 'Message' }
+      payload = xml.values.first
+      found = payload.find { |k, _| k.include?('Result') } ||
+              payload.find { |k, _| k == 'Message' }
 
-      results ? results.last : nil
+      found.last if found
     end
   end
 end

data/test/integration/test_feeds.rb

@@ -15,4 +15,22 @@ class TestFeeds < IntegrationTest
       refute_empty res.parse
     end
   end
+
+  def test_submits_feeds
+    content = "sku\tprice\tquantity\nwidget\t\t0\n"
+    type = '_POST_FLAT_FILE_PRICEANDQUANTITYONLY_UPDATE_DATA_'
+
+    clients.each do |client|
+      res = client.submit_feed(content, type)
+      id = res.parse['FeedSubmissionInfo']['FeedSubmissionId']
+      refute_nil id
+
+      # Clean up
+      client.body = nil
+      client.cancel_feed_submissions(
+        feed_submission_id: id,
+        feed_type_list: type
+      )
+    end
+  end
 end

data/test/integration/test_reports.rb

@@ -43,4 +43,13 @@ class TestReports < IntegrationTest
       refute_empty res.parse
     end
   end
+
+  def test_gets_report
+    clients.each do |client|
+      res = client.get_report_list(max_count: 1)
+      id = res.parse['ReportInfo']['ReportId']
+      res = client.get_report(id)
+      refute_empty res.parse || res.records_count
+    end
+  end
 end

data/test/unit/mws/test_feeds_client.rb

@@ -73,11 +73,16 @@ class TestMWSFeedsClient < MiniTest::Test
 
   def test_cancels_feed_submissions
     operation = {
-      'Action' => 'CancelFeedSubmissions'
+      'Action' => 'CancelFeedSubmissions',
+      'FeedTypeList.Type.1' => '1',
+      'FeedSubmissionIdList.Id.1' => '2'
     }
 
     @client.stub(:run, nil) do
-      @client.cancel_feed_submissions
+      @client.cancel_feed_submissions(
+        feed_type_list: '1',
+        feed_submission_id_list: '2'
+      )
     end
 
     assert_equal operation, @client.operation

data/test/unit/peddler/test_client.rb

@@ -78,7 +78,7 @@ class TestPeddlerClient < MiniTest::Test
     @client.body = 'foo'
     content_type = @client.headers.fetch('Content-Type')
 
-    assert_equal 'text/tab-separated-values; charset=ISO-8859-1', content_type
+    assert_equal 'text/tab-separated-values; charset=CP1252', content_type
   end
 
   def test_sets_content_type_header_for_chinese_flat_file_body
@@ -94,7 +94,7 @@ class TestPeddlerClient < MiniTest::Test
     @client.body = 'foo'
     content_type = @client.headers.fetch('Content-Type')
 
-    assert_equal 'text/tab-separated-values; charset=Shift_JIS', content_type
+    assert_equal 'text/tab-separated-values; charset=Windows-31J', content_type
   end
 
   def test_sets_content_type_header_for_xml_body

data/test/unit/peddler/test_flat_file_parser.rb

@@ -41,8 +41,37 @@ class TestPeddlerFlatFileParser < MiniTest::Test
     body.encode!('SHIFT_JIS')
     body.force_encoding('ASCII-8BIT')
     res = OpenStruct.new(body: body)
-    parser = Peddler::FlatFileParser.new(res, 'SHIFT_JIS')
+    parser = Peddler::FlatFileParser.new(res, 'Windows-31J')
 
     assert_equal 'こんにちは', parser.parse[0]['Foo']
   end
+
+  def test_handles_japanese_curly_braces
+    body = "Foo\n〝\n"
+    body.encode!('Windows-31J')
+    body.force_encoding('ASCII-8BIT')
+    res = OpenStruct.new(body: body)
+    parser = Peddler::FlatFileParser.new(res, 'Windows-31J')
+
+    assert_equal '〝', parser.parse[0]['Foo']
+  end
+
+  def test_handles_latin_1_flat_files
+    body = "Foo\n™\n"
+    body.encode!('Cp1252')
+    body.force_encoding('ASCII-8BIT')
+    res = OpenStruct.new(body: body)
+    parser = Peddler::FlatFileParser.new(res, 'Cp1252')
+
+    assert_equal '™', parser.parse['Foo'][0]
+  end
+
+  def test_handles_undefined_characters
+    body = "Foo\n\xFF\n"
+    body.force_encoding('ASCII-8BIT')
+    res = OpenStruct.new(body: body)
+    parser = Peddler::FlatFileParser.new(res, 'ASCII-8BIT')
+
+    assert_equal '?', parser.parse['Foo'][0]
+  end
 end

data/test/unit/peddler/test_parser.rb

@@ -8,7 +8,7 @@ class TestPeddlerParser < MiniTest::Test
         headers: { 'Content-Type' => content_type },
         body: body
       )
-      parser = Peddler::Parser.new(res)
+      parser = Peddler::Parser.new(res, 'Cp1252')
 
       assert_kind_of klass, parser
     end