peddler 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62834a80dac2dbed397f77f2079c67b03e77b210
-  data.tar.gz: abaac02b413d76490fd2150477cdbaec192ab40d
+  metadata.gz: cfc50fce63ad3d1352ca442c1d29dcabb2f5ba5d
+  data.tar.gz: 72703e47d8dd0f04c1c96d5c754c3d8217183599
 SHA512:
-  metadata.gz: 6b35c2fb1aaebdfd8d52f5eaca1aa9a9b21aa169e63f058f70fb81834ac4631884b37a8e0bd60893a3df748a7c78af3afd0933be70b191fbc22970e53ece4aa5
-  data.tar.gz: 85c116fdf9f320edb63dce740e892c9f6c205e0fa92149d1ea15c97a300499bb60204dde3a585810dac479f888ce6c8183cbcbfc923a074b2a6d5b6fcbd765de
+  metadata.gz: 6d48814cee3986c8d9168bdf1a60ca128a5c1edcd81207c611b31286f1539343628ca0f99a94b29fd334491893f3016c9936595fe085dee781ad39cb27352a69
+  data.tar.gz: c8bee181bbb23d6906e15206a845535e09f1c99b7aab3954d63dcb4ddcffd35da712e8f5b2055f7613122f7a5faf2fce5bcc1f36d41547a7e40479adb7c1e5da

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2012 Paper Cavalier
+Copyright (c) 2013 Paper Cavalier
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,65 +1,22 @@
 # Peddler
 
-[![travis][1]][2]
+![Peddler][1]
 
-![Peddler][3]
+Peddler provides a light-weight wrapper around the [Amazon Marketplace Web
+Service (MWS) APIs][2].
 
-Peddler wraps the [Amazon Marketplace Web Service (MWS) APIs][4].
+## Usage
 
 ```ruby
-service = Peddler.new 'US'
-
-service.configure key:    'key',
-                  secret: 'secret',
-                  seller: 'seller'
-
-service.status # => "GREEN"
+client = Peddler::Products.new('US', 'aws_key', 'aws_secret, 'seller_id')
+params = {
+  'Marketplace' => client.marketplace_id('US'),
+  'Action'      => 'ListMatchingProducts',
+  'Query'       => 'Architecture'
+}
+
+res = client.get(query: params)
 ```
 
-## Feeds
-
-The Feeds API lets you upload inventory and order data to Amazon.
-
-## Fulfillment Inbound Shipment
-
-With the Fulfillment Inbound Shipment API, you can create and update inbound
-shipments of inventory in the Amazon Fulfillment Network. You can also request
-lists of inbound shipments or inbound shipment items based on criteria that you
-specify.
-
-## Fulfillment Inventory
-
-The Fulfillment Inventory API lets you see what is available in your inventory.
-It's a real-time reporting mechanism that returns your current or
-recently-changed inventory supply in the Amazon fulfillment network.
-
-## Fulfillment Outbound Shipment
-
-The Fulfillment Outbound Shipment API is designed to help you integrate
-Fulfillment by Amazon with any payment processing application or inventory
-management system currently in use.
-
-## Orders
-
-The Orders API helps you build simple applications that retrieve only the order
-information that you need.
-
-## Products
-
-The Products API helps you get information to match your products to existing
-product listings on Amazon Marketplace websites and to make sourcing and
-pricing decisions for listing those products on Amazon Marketplace websites.
-
-## Reports
-
-The Reports API lets you request reports about your inventory and orders.
-
-## Sellers
-
-The Sellers API lets sellers retrieve information about their seller account,
-such as the marketplaces they participate in.
-
-[1]: https://secure.travis-ci.org/papercavalier/peddler.png
-[2]: http://travis-ci.org/papercavalier/peddler
-[3]: http://f.cl.ly/items/0W3V0A1Z110Q0x461b3H/mussels.jpeg
-[4]: https://developer.amazonservices.com/gp/mws/docs.html
+[1]: http://f.cl.ly/items/0W3V0A1Z110Q0x461b3H/mussels.jpeg
+[2]: https://developer.amazonservices.com/gp/mws/docs.html

data/lib/peddler.rb

@@ -1,6 +1 @@
-%w(
-  feeds fulfillment_inbound_shipment fulfillment_inventory
-  fulfillment_outbound_shipment orders products reports sellers
-).each do |service|
-  require "peddler/#{service}"
-end
+require 'peddler/apis'

data/lib/peddler/apis.rb

@@ -0,0 +1,45 @@
+require 'peddler/service'
+
+module Peddler
+  class Feeds < Service
+  end
+
+  class FulfillmentInboundShipment < Service
+    path 'FulfillmentInboundShipment/2010-10-01'
+  end
+
+  class FulfillmentInventory < Service
+    path 'FulfillmentInventory/2010-10-01'
+  end
+
+  class FulfillmentOutboundShipment < Service
+    path 'FulfillmentOutboundShipment/2010-10-01'
+  end
+
+  class OffAmazonPayments < Service
+    path 'OffAmazonPayments/2013-01-01/'
+  end
+
+  class Orders < Service
+    path 'Orders/2011-01-01'
+  end
+
+  class Products < Service
+    path 'Products/2011-10-01'
+  end
+
+  class Recommendations < Service
+    path 'Recommendations/2013-04-01'
+  end
+
+  class Reports < Service
+  end
+
+  class Sellers < Service
+    path 'Sellers/2011-07-01'
+  end
+
+  class Subscriptions < Service
+    path 'Subscriptions/2013-07-01'
+  end
+end

data/lib/peddler/service.rb

@@ -1,25 +1,21 @@
 require 'jeff'
 
 module Peddler
-  BadLocale     = Class.new(ArgumentError)
-  MissingSeller = Class.new(ArgumentError)
-
-  # A wrapper around a Marketplace Web Services (MWS) endpoint.
-  class Service
+  # Service is an abstract wrapper around a Marketplace Web Services (MWS)
+  # endpoint.
+  #
+  # The initializer takes four arguments:
+  #
+  # country               - The String ISO 3166-1 two-letter country code of
+  #                         the base marketplace of the seller.
+  # aws_access_key_id     - The String AWS access key id.
+  # aws_secret_access_key - The String AWS secret access key.
+  # seller_id             - The String MWS merchant id.
+  #
+  # These arguments are optional and can be set individually later.
+  Service = Struct.new(:country, :aws_access_key_id, :aws_secret_access_key, :seller_id) do
     include Jeff
 
-    class << self
-      # Gets/Sets the path of the MWS endpoint.
-      #
-      # path - A String path (optional).
-      def path(path = nil)
-        @path = path if path
-        @path
-      end
-    end
-
-    params 'SellerId' => -> { seller }
-
     # A list of MWS hosts.
     HOSTS = {
       'CA' => 'mws.amazonservices.ca',
@@ -27,80 +23,53 @@ module Peddler
       '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',
-      'UK' => 'mws-eu.amazonservices.com',
       'US' => 'mws.amazonservices.com'
     }
 
-    # A list of MWS marketplace ids.
-    MARKETPLACES = {
+    # A list of marketplace ids.
+    MARKETPLACE_IDS = {
       'CA' => 'A2EUQ1WTGCTBG2',
-      'CN' => nil,
+      'CN' => 'AAHKV2X7AFYLW',
       'DE' => 'A1PA6795UKMFR9',
       'ES' => 'A1RKKUPIHCS9HS',
       'FR' => 'A13V1IB3VIYZZH',
-      'IN' => nil,
+      'GB' => 'A1F83G8C2ARO7P',
+      'IN' => 'A21TJRUUN4KGV',
       'IT' => 'APJ6JRA9NG5V4',
       'JP' => 'A1VC38T7YXB528',
-      'UK' => 'A1F83G8C2ARO7P',
       'US' => 'ATVPDKIKX0DER'
     }
 
-    def self.inherited(base)
-      base.params(params)
-    end
-
-    # Create a new service endpoint for given locale.
+    # Gets/Sets the path of the MWS endpoint.
     #
-    # locale - The String MWS API locale.
-    #
-    # Raises a Bad Locale error if locale is not valid.
-    def initialize(locale)
-      @host = HOSTS[@locale = locale] or raise BadLocale
+    # path - A String path (default: nil).
+    def self.path(path = nil)
+      path ? @path = path : @path
     end
 
-    # Configure the MWS endpoint.
-    #
-    # credentials - The Hash credentials.
-    #               :key    - The String Amazon Web Services (AWS) key.
-    #               :secret - The String AWS secret.
-    #               :seller - The String MWS Seller Id.
-    #
-    # Returns nothing.
-    def configure(credentials)
-      credentials.each { |key, val| self.send("#{key}=", val) }
+    # So that subclasses can continue adding their params.
+    def self.inherited(base)
+      base.params(params)
     end
 
+    params('SellerId' => -> { seller_id })
+
     # Returns the String MWS endpoint.
     def endpoint
-      "https://#{@host}/#{self.class.path}"
+      "https://#{HOSTS.fetch(country)}/#{self.class.path}"
     end
 
-    # Returns a String Marketplace id.
+    # Get the marketplace id for a given country.
     #
-    # locale - The String MWS API locale (default: the locale of the service
-    #          endpoint).
-    def marketplace(locale = nil)
-      MARKETPLACES[locale || @locale] or raise BadLocale
-    end
-
-    # Gets the String MWS seller id.
+    # country - A String ISO 3166-1 two-letter country code.
     #
-    # Raises a Missing Seller error if seller id is missing.
-    def seller
-      @seller or raise MissingSeller
-    end
-
-    # Sets the String MWS seller id.
-    attr_writer :seller
-
-    # Gets the String service status.
-    def status
-      get(query: { 'Action' => 'GetServiceStatus' })
-        .body
-        .match(/GREEN_?I?|YELLOW|RED/)[0]
+    # Returns a String marketplace id.
+    def marketplace_id(country)
+      MARKETPLACE_IDS.fetch(country)
     end
   end
 end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/test/service_test.rb

@@ -0,0 +1,21 @@
+require_relative 'test_helper'
+
+class ServiceTest < MiniTest::Test
+  def setup
+    @klass = Class.new(Peddler::Service)
+    @service = @klass.new('US', 'key', 'secret', 'seller_id')
+  end
+
+  def test_configures_path
+    @klass.path('Foo')
+    assert @service.endpoint.match(/Foo$/)
+  end
+
+  def test_has_user_agent
+    refute @service.connection.data[:headers].empty?
+  end
+
+  def test_gets_marketplace_ids
+    refute_equal @service.marketplace_id('US'), @service.marketplace_id('GB')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'peddler'
+require 'minitest/autorun'

metadata

@@ -1,18 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Hakan Ensari
-- Ezekiel Templin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: jeff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -26,39 +39,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeff
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
-description: A wrapper to the Amazon Marketplace Web Service (MWS) API
+        version: '0'
+description: A light-weight wrapper to the Amazon Marketplace Web Service (MWS) API
 email:
-- code@papercavalier.com
+- hakan.ensari@papercavalier.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/peddler/feeds.rb
-- lib/peddler/fulfillment_inbound_shipment.rb
-- lib/peddler/fulfillment_inventory.rb
-- lib/peddler/fulfillment_outbound_shipment.rb
-- lib/peddler/orders.rb
-- lib/peddler/products.rb
-- lib/peddler/reports.rb
-- lib/peddler/sellers.rb
+- lib/peddler/apis.rb
 - lib/peddler/service.rb
 - lib/peddler/version.rb
 - lib/peddler.rb
 - LICENSE
 - README.md
+- test/service_test.rb
+- test/test_helper.rb
 homepage: http://github.com/papercavalier/peddler
 licenses: []
 metadata: {}
@@ -78,8 +86,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Wraps the Amazon Marketplace Web Service API
-test_files: []
+test_files:
+- test/service_test.rb
+- test/test_helper.rb

data/lib/peddler/feeds.rb

@@ -1,7 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Feeds API lets you upload inventory and order data to Amazon.
-  class Feeds < Service
-  end
-end

data/lib/peddler/fulfillment_inbound_shipment.rb

@@ -1,11 +0,0 @@
-require 'peddler/service'
-
-# With the Fulfillment Inbound Shipment API, you can create and update inbound
-# shipments of inventory in the Amazon Fulfillment Network. You can also
-# request lists of inbound shipments or inbound shipment items based on
-# criteria that you specify.
-module Peddler
-  class FulfillmentInboundShipment < Service
-    path 'FulfillmentInboundShipment/2010-10-01'
-  end
-end

data/lib/peddler/fulfillment_inventory.rb

@@ -1,10 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Fulfillment Inventory API lets you see what is available in your
-  # inventory. It's a real-time reporting mechanism that returns your current
-  # or recently-changed inventory supply in the Amazon fulfillment network.
-  class FulfillmentInventory < Service
-    path 'FulfillmentInventory/2010-10-01'
-  end
-end

data/lib/peddler/fulfillment_outbound_shipment.rb

@@ -1,10 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Fulfillment Outbound Shipment API is designed to help you integrate
-  # Fulfillment by Amazon with any payment processing application or inventory
-  # management system currently in use.
-  class FulfillmentOutboundShipment < Service
-    path 'FulfillmentOutboundShipment/2010-10-01'
-  end
-end

data/lib/peddler/orders.rb

@@ -1,9 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Orders API helps you build simple applications that retrieve only the
-  # order information that you need.
-  class Orders < Service
-    path 'Orders/2011-01-01'
-  end
-end

data/lib/peddler/products.rb

@@ -1,11 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Products API helps you get information to match your products to
-  # existing product listings on Amazon Marketplace websites and to make
-  # sourcing and pricing decisions for listing those products on Amazon
-  # Marketplace websites.
-  class Products < Service
-    path 'Products/2011-10-01'
-  end
-end

data/lib/peddler/reports.rb

@@ -1,7 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Reports API lets you request reports about your inventory and orders.
-  class Reports < Service
-  end
-end

data/lib/peddler/sellers.rb

@@ -1,9 +0,0 @@
-require 'peddler/service'
-
-module Peddler
-  # The Sellers API lets sellers retrieve information about their seller
-  # account, such as the marketplaces they participate in.
-  class Sellers < Service
-    path 'Sellers/2011-07-01'
-  end
-end