peddler 0.6.5 → 0.7.0

data/lib/peddler/client.rb

@@ -1,45 +1,33 @@
-require 'forwardable'
 require 'jeff'
+require 'peddler/operation'
+require 'peddler/parser'
 
 module Peddler
+  # @abstract Subclass to implement an MWS API section.
   class Client
-    extend Forwardable
     include Jeff
 
-    attr_accessor :default_country, :merchant_id
-
-    def initialize(default_country = nil, aws_access_key_id = nil, aws_secret_access_key = nil, merchant_id = nil)
-      @default_country = default_country
-      @aws_access_key_id = aws_access_key_id || ENV['AWS_ACCESS_KEY_ID']
-      @aws_secret_access_key = aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
-      @merchant_id = merchant_id || ENV['MERCHANT_ID']
-    end
+    BadMarketplaceId = Class.new(StandardError)
 
     HOSTS = {
-      'CA' => 'mws.amazonservices.ca',
-      'CN' => 'mws.amazonservices.com.cn',
-      'DE' => 'mws-eu.amazonservices.com',
-      'ES' => 'mws-eu.amazonservices.com',
-      'FR' => 'mws-eu.amazonservices.com',
-      'GB' => 'mws-eu.amazonservices.com',
-      'IN' => 'mws.amazonservices.in',
-      'IT' => 'mws-eu.amazonservices.com',
-      'JP' => 'mws.amazonservices.jp',
-      'US' => 'mws.amazonservices.com'
+      'A2EUQ1WTGCTBG2' => 'mws.amazonservices.ca',
+      'AAHKV2X7AFYLW'  => 'mws.amazonservices.com.cn',
+      'A1PA6795UKMFR9' => 'mws-eu.amazonservices.com',
+      'A1RKKUPIHCS9HS' => 'mws-eu.amazonservices.com',
+      'A13V1IB3VIYZZH' => 'mws-eu.amazonservices.com',
+      'A1F83G8C2ARO7P' => 'mws-eu.amazonservices.com',
+      'A21TJRUUN4KGV'  => 'mws.amazonservices.in',
+      'APJ6JRA9NG5V4'  => 'mws-eu.amazonservices.com',
+      'A1VC38T7YXB528' => 'mws.amazonservices.jp',
+      'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
     }
 
-    MARKETPLACE_IDS = {
-      'CA' => 'A2EUQ1WTGCTBG2',
-      'CN' => 'AAHKV2X7AFYLW',
-      'DE' => 'A1PA6795UKMFR9',
-      'ES' => 'A1RKKUPIHCS9HS',
-      'FR' => 'A13V1IB3VIYZZH',
-      'GB' => 'A1F83G8C2ARO7P',
-      'IN' => 'A21TJRUUN4KGV',
-      'IT' => 'APJ6JRA9NG5V4',
-      'JP' => 'A1VC38T7YXB528',
-      'US' => 'ATVPDKIKX0DER'
-    }
+    attr_writer :merchant_id, :marketplace_id
+    attr_reader :body
+
+    alias :configure :tap
+
+    params('SellerId' => -> { merchant_id })
 
     def self.path(path = nil)
       path ? @path = path : @path
@@ -49,14 +37,66 @@ module Peddler
       base.params(params)
     end
 
-    params('SellerId' => -> { merchant_id })
-
     def aws_endpoint
-      "https://#{HOSTS.fetch(default_country)}/#{self.class.path}"
+      "https://#{host}/#{self.class.path}"
+    end
+
+    def marketplace_id
+      @marketplace_id ||= ENV['MWS_MARKETPLACE_ID']
+    end
+
+    def merchant_id
+      @merchant_id ||= ENV['MWS_MERCHANT_ID']
+    end
+
+    def headers
+      @headers ||= {}
+    end
+
+    def body=(str)
+      headers['Content-Type'] = content_type(str)
+      @body = str
+    end
+
+    def operation(action = nil)
+      action ? @operation = Operation.new(action) : @operation
+    end
+
+    def run(parser = Parser, &blk)
+      opts = { query: operation, headers: headers, expects: 200 }
+      opts.store(:body, body) if body
+      opts.store(:response_block, blk) if block_given?
+      res = post(opts)
+
+      parser.parse(res)
+    end
+
+    private
+
+    def content_type(str)
+      if str.start_with?('<?xml')
+        'text/xml'
+      else
+        "text/tab-separated-values; charset=#{host_encoding}"
+      end
+    end
+
+    def host_encoding
+      if host.end_with?('jp')
+        'Shift_JIS'
+      elsif host.end_with?('cn')
+        'UTF-16'
+      else
+        'ISO-8859-1'
+      end
+    end
+
+    def host
+      HOSTS.fetch(marketplace_id) { raise BadMarketplaceId }
     end
 
-    def marketplace_id(country = default_country)
-      MARKETPLACE_IDS.fetch(country)
+    def extract_options(args)
+      args.last.is_a?(Hash) ? args.pop : {}
     end
   end
 end

data/lib/peddler/csv_parser.rb

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

data/lib/peddler/operation.rb

@@ -0,0 +1,44 @@
+require 'delegate'
+require 'time'
+require 'peddler/structured_list'
+
+module Peddler
+  # @api private
+  class Operation < SimpleDelegator
+    def initialize(action)
+      super('Action' => action)
+    end
+
+    def structure!(*list_keys)
+      list_key = list_keys.first
+
+      if has_key?(list_key)
+        builder = StructuredList.new(*list_keys)
+        vals = delete(list_key)
+        update(builder.build(vals))
+      end
+
+      self
+    end
+
+    def store(key, val)
+      key = camelize(key) if key.is_a?(Symbol)
+      val = val.iso8601 if val.respond_to?(:iso8601)
+
+      __getobj__.store(key, val)
+    end
+
+    def update(hsh)
+      hsh.each { |key, val| store(key, val) }
+      self
+    end
+
+    alias :add :update
+
+    private
+
+    def camelize(sym)
+      sym.to_s.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/peddler/parser.rb

@@ -0,0 +1,21 @@
+require 'peddler/csv_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
+
+      case res.headers['Content-Type']
+      when 'text/xml'
+        XMLParser.new(res)
+      when 'application/octet-stream'
+        CSVParser.new(res)
+      else
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/peddler/structured_list.rb

@@ -0,0 +1,22 @@
+module Peddler
+  # @api private
+  class StructuredList
+    def initialize(*keys)
+      @keys = keys
+    end
+
+    def build(vals)
+      Array(vals)
+        .each_with_index
+        .reduce(Hash.new) { |hsh, (v, i)|
+          hsh.merge(compose_key(i + 1) => v)
+        }
+    end
+
+    private
+
+    def compose_key(index)
+      (@keys.dup << index).join('.')
+    end
+  end
+end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.6.5'
+  VERSION = '0.7.0'
 end

data/lib/peddler/xml_parser.rb

@@ -0,0 +1,25 @@
+require 'delegate'
+require 'multi_xml'
+
+module Peddler
+  # @api private
+  class XMLParser < SimpleDelegator
+    def next_token
+      parse.fetch('NextToken', false)
+    end
+
+    def parse
+      @result ||= find_result
+    end
+
+    def xml
+      MultiXml.parse(body)
+    end
+
+    private
+
+    def find_result
+      xml.values[0].find { |k, v| k.include?('Result') }.last
+    end
+  end
+end

data/lib/peddler.rb

@@ -1,3 +1,5 @@
+require 'mws/cart_information'
+require 'mws/customer_information'
 require 'mws/feeds'
 require 'mws/fulfillment_inbound_shipment'
 require 'mws/fulfillment_inventory'

data/test/helper.rb

@@ -1,5 +1,5 @@
 $:<< File.expand_path('../../lib', __FILE__)
 
 require 'minitest/autorun'
-require 'minitest/pride'
+require 'minitest/emoji'
 require 'pry'

data/test/integration/test_feeds.rb

@@ -0,0 +1,18 @@
+require 'integration_helper'
+require 'mws/feeds'
+
+class FeedsTest < IntegrationTest
+  def test_gets_feed_submission_count
+    clients.each do |client|
+      res = client.get_feed_submission_count
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_feed_submission_list
+    clients.each do |client|
+      res = client.get_feed_submission_list
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration/test_orders.rb

@@ -0,0 +1,22 @@
+require 'integration_helper'
+require 'mws/orders'
+
+class OrdersTest < IntegrationTest
+  def a_year_ago
+    Date.today - 365
+  end
+
+  def test_lists_orders
+    clients.each do |client|
+      res = client.list_orders(created_after: a_year_ago)
+      refute_empty res.parse
+    end
+  end
+
+  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_products.rb

@@ -0,0 +1,53 @@
+require 'integration_helper'
+require 'mws/products'
+
+class ProductsTest < IntegrationTest
+  def test_lists_matching_products
+    clients.each do |client|
+      res = client.list_matching_products('architecture')
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_matching_product
+    clients.each do |client|
+      res = client.get_matching_product('1780935374')
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_matching_product_for_id
+    clients.each do |client|
+      res = client.get_matching_product_for_id('ISBN', '9781780935379')
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_competitive_pricing_for_asin
+    clients.each do |client|
+      res = client.get_competitive_pricing_for_asin('1780935374')
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_lowest_offer_listings_for_asin
+    clients.each do |client|
+      res = client.get_lowest_offer_listings_for_asin('1780935374')
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_product_categories_for_asin
+    clients.each do |client|
+      res = client.get_product_categories_for_asin('1780935374')
+      refute_empty res.parse
+    end
+  end
+
+  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_reports.rb

@@ -0,0 +1,47 @@
+require 'integration_helper'
+require 'mws/reports'
+
+class ReportsTest < IntegrationTest
+  def test_gets_report_request_count
+    clients.each do |client|
+      res = client.get_report_request_count
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_report_request_list
+    clients.each do |client|
+      res = client.get_report_request_list
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_report_schedule_count
+    clients.each do |client|
+      res = client.get_report_schedule_count
+      refute_empty res.parse
+    end
+  end
+
+  def test_lists_report_schedules
+    clients.each do |client|
+      res = client.get_report_schedule_list
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_report_count
+    skip("Some endpoints don't work")
+    clients.each do |client|
+      res = client.get_report_count
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_report_list
+    clients.each do |client|
+      res = client.get_report_list
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration/test_sellers.rb

@@ -0,0 +1,18 @@
+require 'integration_helper'
+require 'mws/sellers'
+
+class SellersTest < IntegrationTest
+  def test_lists_marketplace_participations
+    clients.each do |client|
+      res = client.list_marketplace_participations
+      refute_empty res.parse
+    end
+  end
+
+  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_subscriptions.rb

@@ -0,0 +1,26 @@
+require 'integration_helper'
+require 'mws/subscriptions'
+
+class SubscriptionsTest < IntegrationTest
+  def test_lists_registered_destinations
+    clients.each do |client|
+      res = client.list_registered_destinations
+      refute_empty res.parse
+    end
+  end
+
+
+  def test_lists_subscriptions
+    clients.each do |client|
+      res = client.list_subscriptions
+      refute_empty res.parse
+    end
+  end
+
+  def test_gets_service_status
+    clients.each do |client|
+      res = client.get_service_status
+      refute_empty res.parse
+    end
+  end
+end

data/test/integration_helper.rb

@@ -1,19 +1,52 @@
 require 'yaml'
+require 'vcr'
+
 require 'helper'
 
+VCR.configure do |c|
+  c.hook_into :excon
+  c.cassette_library_dir = 'test/vcr_cassettes'
+
+  c.before_record do |interaction|
+    interaction.ignore! if interaction.response.status.code >= 400
+  end
+
+  nondeterministic_params = %w(
+    AWSAccessKeyId SellerId Signature Timestamp StartDate CreatedAfter
+    Destination.AttributeList.member.1.Value
+  )
+  matcher = VCR.request_matchers.uri_without_param(*nondeterministic_params)
+  c.default_cassette_options = {
+    match_requests_on: [:method, matcher],
+    record: :new_episodes
+  }
+end
+
 class IntegrationTest < MiniTest::Test
-  class << self
-    attr_accessor :api
+  def api_name
+    self.class.name.match(/(.*)Test/)[1]
   end
 
-  def accounts
-    skip if ENV['SKIP_INTEGRATION']
-    YAML.load_file(File.expand_path('../fixtures/mws.yml', __FILE__))
-  rescue Errno::ENOENT
-    skip('Credentials missing')
+  def clients
+    accounts = begin
+      YAML.load_file(File.expand_path('../mws.yml', __FILE__)).shuffle
+    rescue Errno::ENOENT
+      warn('Skipping integration tests')
+      []
+    end
+
+    accounts.map do |account|
+      MWS.const_get(api_name).new.configure do |c|
+        account.each { |k, v| c.send("#{k}=", v) }
+      end
+    end
   end
 
   def setup
-    @clients = accounts.map { |mws| self.class.api.const_get(:Client).new(*mws.values) }
+    VCR.insert_cassette(api_name)
+  end
+
+  def teardown
+    VCR.eject_cassette
   end
 end

data/test/mws.yml

@@ -0,0 +1,32 @@
+- marketplace_id: A2EUQ1WTGCTBG2
+  aws_access_key_id: AKIAITHQMZUJROSOP27Q
+  aws_secret_access_key: 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
+  merchant_id: A2A7WNXBU01UJW
+- marketplace_id: A1PA6795UKMFR9
+  aws_access_key_id: AKIAIORT7554FEBW7UBQ
+  aws_secret_access_key: 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
+  merchant_id: A7ZXDJZD3UIRG
+- marketplace_id: A1RKKUPIHCS9HS
+  aws_access_key_id: AKIAI6X4QZRXSHGHABJA
+  aws_secret_access_key: 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
+  merchant_id: A2NEU7G6RGUKF
+- marketplace_id: A13V1IB3VIYZZH
+  aws_access_key_id: AKIAI4ZNSD76DH7UBRDA
+  aws_secret_access_key: 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
+  merchant_id: A2DP6GIDYN6OTH
+- marketplace_id: A1F83G8C2ARO7P
+  aws_access_key_id: AKIAJJDQ2MJTMPXKJE4A
+  aws_secret_access_key: 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
+  merchant_id: A2D9DZ30GEWP6N
+- marketplace_id: APJ6JRA9NG5V4
+  aws_access_key_id: AKIAJLUHOXLR5S2L6A6A
+  aws_secret_access_key: 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
+  merchant_id: A2APQUVDBVWV7E
+- marketplace_id: A1VC38T7YXB528
+  aws_access_key_id: AKIAJ5RDDSRROM6GXQ5Q
+  aws_secret_access_key: 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
+  merchant_id: A7BU5WGNVGQ1I
+- marketplace_id: ATVPDKIKX0DER
+  aws_access_key_id: AKIAJ767ZET2BZR4UDDQ
+  aws_secret_access_key: rONa3ydPBTJ5JD0bxERTOX0Fv0fBK6Q986/cfMRO
+  merchant_id: A2H6NH4SQYFZ4M

data/test/mws.yml.example

@@ -0,0 +1,4 @@
+- marketplace_id: 123
+  merchant_id: 123
+  aws_access_key_id: 123
+  aws_secret_access_key: 123