peddler 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5537d0a71a142b77a5d4e7c75f28782ccaa61174
-  data.tar.gz: bb52e6a9cb17b2eef6eead010d236d0c4c47f619
+  metadata.gz: f9b31544fe3d9183ca13cfaf52fc46b17b63bd7c
+  data.tar.gz: 812917ae3a325ea06882348325ac001057bc3335
 SHA512:
-  metadata.gz: 3f4d91eeab8827b397da404a9d7be300adf8ee2180613bfbc19a23ce4c048c3a2b8a2adc0b571bbb562dac860de9b1114ac143d53203c0077407122c58bece1f
-  data.tar.gz: 2cd754fe9a2e94dd71dc61c98ac3afeb41b552370d51ce5ef2ffcb6c3b3a87412ddc7b14c4e66540a125c0b5b8752fe9bf8d3c7143bf47114325d7c619985e84
+  metadata.gz: 2cd7197ad9e27655e0f6c0554c12e2e703a9687e90d086d3330b76886bb30ac017e025e9f3ab328b2eb2098e2a0abb42492c35c9a4937f9174d92a3f93bc6cd6
+  data.tar.gz: 140a6b3e7091da63b3a42507749841803b10f1e215c956a9003f2f305126ff1335d60c107de305e15931b167a2fd5448bb444106d60b1bcb920db0a4f5b2615f

data/README.md

@@ -2,12 +2,12 @@
 
 [![Build Status][1]][2]
 
-![Peddler][3]
-
-**Peddler** is a Ruby interface to the [Amazon MWS API][4], a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
+**Peddler** is a Ruby interface to the [Amazon MWS API][3], a collection of web services that help Amazon sellers programmatically exchange data on their listings, orders, payments, reports, and more.
 
 To use Amazon MWS, you must have an eligible seller account.
 
+![Peddler][4]
+
 ## Configuration
 
 Require the entire library or a particular API section.
@@ -131,5 +131,5 @@ The Amazon MWS Subscriptions API section enables you to subscribe to receive not
 
 [1]: https://travis-ci.org/hakanensari/peddler.png
 [2]:https://travis-ci.org/hakanensari/peddler
-[3]: http://f.cl.ly/items/231z2m0r1Q2o2q1n0w1N/peddler.jpg
-[4]: https://developer.amazonservices.com/
+[3]: https://developer.amazonservices.com/
+[4]: http://f.cl.ly/items/231z2m0r1Q2o2q1n0w1N/peddler.jpg

data/lib/mws/fulfillment_inbound_shipment.rb

@@ -9,5 +9,89 @@ module MWS
   # @todo Not implemented
   class FulfillmentInboundShipment < ::Peddler::Client
     path '/FulfillmentInboundShipment/2010-10-01'
+
+    # Returns the information required to create an inbound shipment
+    def create_inbound_shipment_plan
+      raise NotImplementedError
+    end
+
+    # Creates an inbound shipment
+    def create_inbound_shipment
+      raise NotImplementedError
+    end
+
+    # Updates an existing inbound shipment
+    def update_inbound_shipment
+      raise NotImplementedError
+    end
+
+    # Sends transportation information to Amazon about an inbound shipment
+    def put_transport_content
+      raise NotImplementedError
+    end
+
+    # Requests an estimate of the shipping cost for an inbound shipment
+    def estimate_transport_request
+      raise NotImplementedError
+    end
+
+    # Confirms that you accept the Amazon-partnered shipping estimate and you
+    # request that the Amazon-partnered carrier ship your inbound shipment
+    def confirm_transport_request
+      raise NotImplementedError
+    end
+
+    # Returns current transportation information about an inbound shipment
+    def get_transport_content
+      raise NotImplementedError
+    end
+
+    # Voids a previously-confirmed request to ship your inbound shipment using
+    # an Amazon-partnered carrier
+    def void_transport_request
+      raise NotImplementedError
+    end
+
+    # Returns PDF document data for printing package labels for an inbound
+    # shipment
+    def get_package_labels
+      raise NotImplementedError
+    end
+
+    # Returns PDF document data for printing a bill of lading for an inbound
+    # shipment
+    def get_bill_of_lading
+      raise NotImplementedError
+    end
+
+    # Returns a list of inbound shipments based on criteria that you specify
+    def list_inbound_shipments
+      raise NotImplementedError
+    end
+
+    # Returns the next page of inbound shipments
+    def list_inbound_shipments_by_next_token
+      raise NotImplementedError
+    end
+
+    # Returns a list of items in a specified inbound shipment, or a list of
+    # items that were updated within a specified time frame
+    def list_inbound_shipment_items
+      raise NotImplementedError
+    end
+
+    # Returns the next page of inbound shipment items
+    def list_inbound_shipment_items_by_next_token
+      raise NotImplementedError
+    end
+
+    # Gets the operational status of the API
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_inbound/MWS_GetServiceStatus.html
+    # @return [Peddler::XMLParser]
+    def get_service_status
+      operation('GetServiceStatus')
+      run
+    end
   end
 end

data/lib/mws/fulfillment_inventory.rb

@@ -11,5 +11,25 @@ module MWS
   # @todo Not implemented
   class FulfillmentInventory < ::Peddler::Client
     path '/FulfillmentInventory/2010-10-01'
+
+    # Returns information about the availability of a seller's inventory
+    def list_inventory_supply
+      raise NotImplementedError
+    end
+
+    # Returns the next page of information about the availability of a seller's
+    # inventory
+    def list_inventory_supply_by_next_token
+      raise NotImplementedError
+    end
+
+    # Gets the operational status of the API
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_inventory/MWS_GetServiceStatus.html
+    # @return [Peddler::XMLParser]
+    def get_service_status
+      operation('GetServiceStatus')
+      run
+    end
   end
 end

data/lib/mws/fulfillment_outbound_shipment.rb

@@ -13,5 +13,58 @@ module MWS
   # @todo Not implemented
   class FulfillmentOutboundShipment < ::Peddler::Client
     path '/FulfillmentOutboundShipment/2010-10-01'
+
+    # Lists fulfillment order previews
+    def get_fulfillment_preview
+      raise NotImplementedError
+    end
+
+    # Requests that Amazon ship items from the seller's Amazon Fulfillment
+    # Network inventory to a destination address
+    def create_fulfillment_order
+      raise NotImplementedError
+    end
+
+    # Updates and/or requests shipment for a fulfillment order with an order
+    # hold on it
+    def update_fulfillment_order
+      raise NotImplementedError
+    end
+
+    # Gets a fulfillment order
+    def get_fulfillment_order
+      raise NotImplementedError
+    end
+
+    # Returns a list of fulfillment orders fulfilled on or after a date
+    def list_all_fulfillment_orders
+      raise NotImplementedError
+    end
+
+    # Returns the next page of fulfillment orders
+    def list_all_fulfillment_orders_by_next_token
+      raise NotImplementedError
+    end
+
+    # Returns delivery tracking information for a package in an outbound
+    # shipment for a Multi-Channel Fulfillment order
+    def get_package_tracking_details
+      raise NotImplementedError
+    end
+
+    # Requests that Amazon stop attempting to fulfill an existing fulfillment
+    # order
+    def cancel_fulfillment_order
+      raise NotImplementedError
+    end
+
+    # Gets the operational status of the API
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/MWS_GetServiceStatus.html
+    # @return [Peddler::XMLParser]
+    def get_service_status
+      operation('GetServiceStatus')
+      run
+    end
   end
 end

data/lib/mws/off_amazon_payments.rb

@@ -211,7 +211,7 @@ module MWS
       run
     end
 
-    # Returns the operational status of the API
+    # Gets the operational status of the API
     #
     # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetServiceStatus.html
     # @return [Peddler::XMLParser]

data/lib/peddler/client.rb

@@ -68,7 +68,7 @@ module Peddler
       opts.store(:response_block, blk) if block_given?
       res = post(opts)
 
-      parser.parse(res)
+      parser.parse(res, host_encoding)
     end
 
     private
@@ -83,6 +83,8 @@ module Peddler
 
     def host_encoding
       if host.end_with?('jp')
+        # 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'
       elsif host.end_with?('cn')
         'UTF-16'

data/lib/peddler/flat_file_parser.rb

@@ -0,0 +1,53 @@
+require 'delegate'
+require 'csv'
+require 'digest/md5'
+
+module Peddler
+  # @api private
+  class FlatFileParser < SimpleDelegator
+    # http://stackoverflow.com/questions/8073920/importing-csv-quoting-error-is-driving-me-nuts
+    OPTIONS = { col_sep: "\t", quote_char: "\x00", headers: true }
+
+    attr_reader :content, :summary, :encoding
+
+    def initialize(res, encoding)
+      super(res)
+      @encoding = encoding
+      extract_content
+    end
+
+    def parse
+      CSV.parse(scrub_content, OPTIONS) if content
+    end
+
+    def records_count
+      summarize if summary
+    end
+
+    def valid?
+      headers['Content-MD5'] == Digest::MD5.base64digest(body)
+    end
+
+    private
+
+    def extract_content
+      if has_summary?
+        @summary, @content = body.split("\n\n")
+      else
+        @content = body.dup
+      end
+    end
+
+    def scrub_content
+      content.force_encoding(encoding).encode('UTF-8')
+    end
+
+    def has_summary?
+      body.start_with?('Feed Processing Summary')
+    end
+
+    def summarize
+      Hash[summary.split("\n\t")[1, 2].map { |line| line.split("\t\t") }]
+    end
+  end
+end

data/lib/peddler/parser.rb

@@ -1,20 +1,24 @@
-require 'peddler/csv_parser'
+require 'peddler/flat_file_parser'
 require 'peddler/xml_parser'
 
 module Peddler
   # @api private
   module Parser
-    def self.parse(res)
-      # Don't parse if there's no body
-      return res unless res.body
+    class << self
+      # The inevitable messiness of massaging data produced by a motley army of
+      # Amazon developers
+      def parse(res, encoding = 'ISO-8859-1')
+        # Don't parse if there's no body
+        return res unless res.body
 
-      case res.headers['Content-Type']
-      when 'text/xml'
-        XMLParser.new(res)
-      when 'application/octet-stream'
-        CSVParser.new(res)
-      else
-        raise NotImplementedError
+        case res.headers['Content-Type']
+        when 'text/xml'
+          XMLParser.new(res)
+        when 'application/octet-stream'
+          FlatFileParser.new(res, encoding)
+        else
+          raise NotImplementedError
+        end
       end
     end
   end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.7.5'
+  VERSION = '0.7.6'
 end

data/test/integration/test_fulfillment_inbound_shipment.rb

@@ -0,0 +1,11 @@
+require 'integration_helper'
+require 'mws/fulfillment_inbound_shipment'
+
+class FulfillmentInboundShipmentTest < IntegrationTest
+  def test_gets_service_status
+    clients.each do |client|
+      res = client.get_service_status
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration/test_fulfillment_inventory.rb

@@ -0,0 +1,11 @@
+require 'integration_helper'
+require 'mws/fulfillment_inventory'
+
+class FulfillmentInventoryTest < IntegrationTest
+  def test_gets_service_status
+    clients.each do |client|
+      res = client.get_service_status
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration/test_fulfillment_outbound_shipment.rb

@@ -0,0 +1,11 @@
+require 'integration_helper'
+require 'mws/fulfillment_outbound_shipment'
+
+class FulfillmentOutboundShipmentTest < IntegrationTest
+  def test_gets_service_status
+    clients.each do |client|
+      res = client.get_service_status
+      refute_empty res.parse
+    end
+  end
+end

data/test/unit/peddler/test_client.rb

@@ -4,7 +4,7 @@ require 'peddler/client'
 
 class ClientTest < MiniTest::Test
   module Parser
-    def self.parse(res); res; end
+    def self.parse(res, *); res; end
   end
 
   def setup

data/test/unit/peddler/{test_csv_parser.rb → test_flat_file_parser.rb}

@@ -1,13 +1,14 @@
 require 'helper'
-require 'peddler/parser'
+require 'peddler/flat_file_parser'
 
-class CSVParserTest < MiniTest::Test
+class FlatFileParserTest < MiniTest::Test
   def setup
     body = "Feed Processing Summary:\n\tNumber of records processed\t\t11006\n\tNumber of records successful\t\t11006\n\noriginal-record-number\tsku\terror-code\terror-type\terror-message\n1822\t85da472e-ba6c-11e3-95af-002590a74356\t5000\tWarning\tThe update for Sku '85da472e-ba6c-11e3-95af-002590a74356' was skipped because it is identical to the update in feed '9518995390'.\n"
+    body.encode!('ASCII-8BIT')
     headers = { 'Content-Type' => 'application/octet-stream', 'Content-MD5' => 'SmZIMTs2mCO8u8QzR5LE7Q==' }
     res = OpenStruct.new(body: body, headers: headers)
 
-    @parser = Peddler::Parser.parse(res)
+    @parser = Peddler::FlatFileParser.new(res, 'ISO-8859-1')
   end
 
   def test_parses_data
@@ -21,4 +22,21 @@ class CSVParserTest < MiniTest::Test
   def test_validates
     assert @parser.valid?
   end
+
+  def test_handles_reports_without_a_summary
+    res = OpenStruct.new(body: "Foo\nBar\n")
+    parser = Peddler::FlatFileParser.new(res, 'ISO-8859-1')
+
+    refute_empty parser.content
+  end
+
+  def test_handles_japanese_flat_files
+    body = "Foo\nこんにちは\n"
+    body.encode!('SHIFT_JIS')
+    body.force_encoding('ASCII-8BIT')
+    res = OpenStruct.new(body: body)
+    parser = Peddler::FlatFileParser.new(res, 'SHIFT_JIS')
+
+    assert_equal 'こんにちは', parser.parse[0]['Foo']
+  end
 end

data/test/unit/peddler/test_xml_parser.rb

@@ -1,12 +1,12 @@
 require 'helper'
-require 'peddler/parser'
+require 'peddler/xml_parser'
 
 class XMLParserTest < 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'})
 
-    @parser = Peddler::Parser.parse(res)
+    @parser = Peddler::XMLParser.new(res)
   end
 
   def test_parses_data