peddler 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffb13ba94f5eab718c1f2cfc69623dd750881210
-  data.tar.gz: 9b14e23a9da75b89fecee7b8d6c240028af41c4c
+  metadata.gz: 480feed5c44724e4f6ef152ec3c1da23075f4a11
+  data.tar.gz: d1e0ddcb314cd41e28f143f3f0304706f25f0af3
 SHA512:
-  metadata.gz: 27c7939f8cc25e527e2c828807c319283b0e9ab60b0fa0aee4bda064a121b64e1f13f816f601b62c3838404f243f89dbf337185e02b05be2fb696ecfc7fd7e33
-  data.tar.gz: 62fc940d7d6c6a5ffe3231782bce08edc07267f4b663acbb09215261bbbb176d12d8a67e2b582a07413dc956cc70cb01f5929e9b5f867cee7a98787290bbf921
+  metadata.gz: 58305a7973578fb6ca7153a28319db391b5075f76d9efe988a9a14dfe16a4c576249e26de4ad7e28f31b1a6a7971a4228f7e804b1a24411eaaf1e78e52f1b768
+  data.tar.gz: 500bbaf3efcf364737439c20518a84b5191788a12f4f10bb25fb9636f86fdcf72a1720b5bf11a686fa338da07c4a0dc4adf9e498b090d956469fa8ca7de420fd

data/README.md

@@ -1,11 +1,12 @@
 # Peddler
 
-![Peddler][1]
+[![Build Status][travis]][badge]
 
-**Peddler** is a full-featured Ruby interface to the [Amazon Marketplace Web
-Service (MWS) APIs][2].
+![Peddler][mussels]
 
-## Usage
+**Peddler** is a full-featured Ruby interface to the [Amazon Marketplace Web Service (MWS) APIs][docs].
+
+## Configuration
 
 Require the library:
 
@@ -13,20 +14,19 @@ Require the library:
 require 'peddler'
 ```
 
-Alternatively, require a particular API only:
+Or require an individual API:
 
 ```ruby
 require 'mws/orders'
 ```
 
-Instantiate a client with the ISO 3166-1 two-letter country code of the
-marketplace and your seller credentials:
+Instantiate a client to a particular API with the ISO 3166-1 two-letter country code of the marketplace and your seller credentials:
 
 ```ruby
 client = MWS::Orders::Client.new('GB', 'key', 'secret', 'merchant_id')
 ```
 
-Alternatively, set your credentials as environment variables in your shell:
+You may also set the credentials as environment variables in your shell:
 
 ```sh
 export AWS_ACCESS_KEY_ID=key
@@ -40,69 +40,21 @@ Then, instantiate with the country code:
 client = MWS::Orders::Client.new('US')
 ```
 
-### Feeds
-
-The MWS Feeds API lets you upload inventory and order data to Amazon. You can
-also use this API to get information about the processing of feeds.
-
-[API methods are available on the client][3].
-
-Instantiate a client:
-
-```ruby
-client = MWS::Feeds::Client.new('GB')
-```
-
-#### Submit Feed
-
-Submit a feed:
-
-```ruby
-client.submit_feed(xml, '_POST_PRODUCT_DATA_')
-```
-
-#### Feed Submission List
-
-List past feed submissions:
-
-```ruby
-# See the API for all available parameters for this and other methods.
-client.get_feed_submissions
-```
-
-List the next page of feed submissions:
-
-```ruby
-client.get_feed_submissions_by_next_token
-```
-
-#### Feed Submission Count
+When developing, you may set the `EXCON_DEBUG` environment variable to debug the HTTP exchange.
 
-Get the feed submission count:
-
-```ruby
-client.get_feed_submission_count(submitted_from_date: 1.day.ago)
-```
-
-#### Feed Submission Result
-
-Get the processing report for a submitted feed:
-
-```ruby
-client.feed_submission_result('123456')
-```
+## Usage
 
-#### Feed Submissions
+### Feeds
 
-Cancel one or more feed submissions:
+The MWS Feeds API lets you upload inventory and order data to Amazon. You can also use this API to get information about the processing of feeds.
 
-```ruby
-client.cancel_feed_submissions(submitted_to_date: 1.day.ago)
-``
+[Read the client API methods.][feeds-api]
 
 ### Fulfillment Inbound Shipment
 
-This API is not implemented yet. You can still use the raw client like so:
+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.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::FulfillmentInboundShipment::Client.new('GB')
@@ -112,7 +64,9 @@ Pull requests are welcome!
 
 ### Fulfillment Inventory
 
-This API is not implemented yet. You can still use the raw client like so:
+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.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::FulfillmentInventory::Client.new('GB')
@@ -122,7 +76,9 @@ Pull requests are welcome!
 
 ### Fulfillment Outbound Shipment
 
-This API is not implemented yet. You can still use the raw client like so:
+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.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::FulfillmentOutboundShipment::Client.new('GB')
@@ -132,7 +88,9 @@ Pull requests are welcome!
 
 ### Off Amazon Payments
 
-This API is not implemented yet. You can still use the raw client like so:
+The Off-Amazon Payments API helps you to process payments for purchases made by buyers using Amazon Payments on your website. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account and to authorize, capture, and refund funds to enable a variety of payments scenarios.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::OffAmazonPayments::Client.new('GB')
@@ -142,70 +100,15 @@ Pull requests are welcome!
 
 ### Orders
 
-With the MWS Orders API, you can list orders created or updated during a time
-frame you specify or retrieve information about specific orders.
-
-[API methods are available on the client][4].
+With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
 
-Instantiate a client:
-
-```ruby
-client = MWS::Orders::Client.new('GB')
-```
-
-#### Orders
-
-List orders:
-
-```ruby
-# See the API for all available parameters.
-client.list_orders(
-  created_after: 1.week.ago,
-  order_status: %w(Pending Unshipped)
-)
-```
-
-List the next page of orders:
-
-```ruby
-client.list_orders_by_next_token
-```
-
-Get one or more orders based on their order numbers:
-
-```ruby
-client.get_order('123-1234567-1234567')
-```
-
-All above queries will return an enumerable list of orders.
-
-#### Order Items
-
-List order items based on an order number you specify:
-
-```ruby
-client.list_order_items('123-1234567-1234567')
-```
-
-List the next page of order items:
-
-```ruby
-client.list_order_items_by_next_token
-```
-
-All above queries will return an enumerable list of order items.
-
-#### Service Status
-
-Check the operational status of the API:
-
-```ruby
-client.get_service_status
-```
+[Read the client API methods.][orders-api]
 
 ### Products
 
-This API is not implemented yet. You can still use the raw client like so:
+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.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::Products::Client.new('GB')
@@ -215,7 +118,9 @@ Pull requests are welcome!
 
 ### Recommendations
 
-This API is not implemented yet. You can still use the raw client like so:
+The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::Recommendations::Client.new('GB')
@@ -225,27 +130,21 @@ Pull requests are welcome!
 
 ### Reports
 
-This API is not implemented yet. You can still use the raw client like so:
+The Reports API lets you request reports about your inventory and orders.
 
-```ruby
-client = MWS::Reports::Client.new('GB')
-```
-
-Pull requests are welcome!
+[Read the client API methods.][reports-api]
 
 ### Sellers
 
-This API is not implemented yet. You can still use the raw client like so:
+The Sellers API lets sellers retrieve information about their seller account, such as the marketplaces they participate in.
 
-```ruby
-client = MWS::Sellers::Client.new('GB')
-```
-
-Pull requests are welcome!
+[Read the client API methods.][sellers-api]
 
 ### Subscriptions
 
-This API is not implemented yet. You can still use the raw client like so:
+The Amazon MWS Subscriptions API enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed.
+
+While this API is not implemented yet, you may still use the raw client like so:
 
 ```ruby
 client = MWS::Subscriptions::Client.new('GB')
@@ -253,7 +152,11 @@ client = MWS::Subscriptions::Client.new('GB')
 
 Pull requests are welcome!
 
-[1]: http://f.cl.ly/items/0W3V0A1Z110Q0x461b3H/mussels.jpeg
-[2]: https://developer.amazonservices.com/gp/mws/docs.html
-[3]: https://github.com/papercavalier/peddler/blob/master/lib/mws/feeds/client.rb
-[4]: https://github.com/papercavalier/peddler/blob/master/lib/mws/orders/client.rb
+[travis]: https://travis-ci.org/papercavalier/peddler.png
+[badge]:https://travis-ci.org/papercavalier/peddler
+[mussels]: http://f.cl.ly/items/0W3V0A1Z110Q0x461b3H/mussels.jpeg
+[docs]: https://developer.amazonservices.com/gp/mws/docs.html
+[feeds-api]: https://github.com/papercavalier/peddler/blob/master/lib/mws/feeds/client.rb
+[orders-api]: https://github.com/papercavalier/peddler/blob/master/lib/mws/orders/client.rb
+[reports-api]: https://github.com/papercavalier/peddler/blob/master/lib/mws/reports/client.rb
+[sellers-api]: https://github.com/papercavalier/peddler/blob/master/lib/mws/sellers/client.rb

data/lib/mws/feeds/client.rb

@@ -7,6 +7,8 @@ require 'peddler/client'
 
 module MWS
   module Feeds
+    # The MWS Feeds API lets you upload inventory and order data to Amazon. You
+    # can also use this API to get information about the processing of feeds.
     class Client < ::Peddler::Client
       # Public: Upload a feed for processing by Amazon MWS.
       #
@@ -44,11 +46,15 @@ module MWS
 
       # Public: List the next page of the list of feed submissions.
       #
+      # token - A String token (default: The token returned in the last
+      #         request).
+      #
       # Examples
       #
       #   client.get_feed_submission_list_by_next_token
       #
-      # Returns an enumerable Feed Submission List.
+      # Returns an enumerable Feed Submission List or false if there are no more
+      # pages left.
       def_delegator :feed_submission_list, :get_by_next_token, :get_feed_submission_list_by_next_token
 
       # Public: Get a count of the feeds submitted during a specified time

data/lib/mws/feeds/parsers/feed.rb

@@ -1,12 +1,12 @@
 require 'peddler/parsers/model'
-require 'mws/feeds/parsers/feed_submission'
+require 'mws/feeds/parsers/feed_submission_info'
 
 module MWS
   module Feeds
     module Parsers
       class Feed < Peddler::Parsers::Model
-        value :submission do
-          FeedSubmission.new(document.xpath('xmlns:FeedSubmissionInfo').first)
+        value :submission_info do
+          FeedSubmissionInfo.new(at_xpath('FeedSubmissionInfo'))
         end
       end
     end

data/lib/mws/feeds/parsers/feed_submission_count.rb

@@ -1,12 +1,9 @@
-require 'peddler/parsers/model'
+require 'peddler/parsers/counter'
 
 module MWS
   module Feeds
     module Parsers
-      class FeedSubmissionCount < ::Peddler::Parsers::Model
-        value :count do
-          integer_at_xpath('Count')
-        end
+      class FeedSubmissionCount < ::Peddler::Parsers::Counter
       end
     end
   end

data/lib/mws/feeds/parsers/{feed_submission.rb → feed_submission_info.rb}

@@ -3,7 +3,7 @@ require 'peddler/parsers/model'
 module MWS
   module Feeds
     module Parsers
-      class FeedSubmission < ::Peddler::Parsers::Model
+      class FeedSubmissionInfo < ::Peddler::Parsers::Model
         value :id do
           text_at_xpath('FeedSubmissionId')
         end

data/lib/mws/feeds/parsers/feed_submission_list.rb

@@ -1,17 +1,20 @@
 require 'peddler/parsers/collection'
-require 'mws/feeds/parsers/feed_submission'
+require 'mws/feeds/parsers/feed_submission_info'
+require 'peddler/parsers/tokenable'
 
 module MWS
   module Feeds
     module Parsers
       class FeedSubmissionList < ::Peddler::Parsers::Collection
+        include ::Peddler::Parsers::Tokenable
+
         def each(&blk)
-          feed_submission_nodes.each { |node| yield FeedSubmission.new(node) }
+          feed_submission_info_nodes.each { |node| yield FeedSubmissionInfo.new(node) }
         end
 
         private
 
-        def feed_submission_nodes
+        def feed_submission_info_nodes
           xpath('FeedSubmissionInfo')
         end
       end

data/lib/mws/feeds/parsers/feed_submissions.rb

@@ -1,5 +1,5 @@
 require 'peddler/parsers/model'
-require 'mws/feeds/parsers/feed_submission'
+require 'mws/feeds/parsers/feed_submission_info'
 
 module MWS
   module Feeds
@@ -10,7 +10,7 @@ module MWS
         end
 
         def feed_submissions
-          xpath('FeedSubmissionInfo').map { |node| FeedSubmission.new(node) }
+          xpath('FeedSubmissionInfo').map { |node| FeedSubmissionInfo.new(node) }
         end
       end
     end

data/lib/mws/feeds/requests/feed_submission_list.rb

@@ -15,9 +15,11 @@ module MWS
           execute
         end
 
-        def get_by_next_token
+        def get_by_next_token(token = next_token)
+          return false unless token
+
           parameters(:get_feed_submission_list_by_next_token)
-            .update(next_token: next_token)
+            .update(next_token: token)
             .camelize_keys!
 
           execute

data/lib/mws/orders/client.rb

@@ -5,6 +5,8 @@ require 'peddler/client'
 
 module MWS
   module Orders
+    # With the MWS Orders API, you can list orders created or updated during a
+    # time frame you specify or retrieve information about specific orders.
     class Client < ::Peddler::Client
       path 'Orders/2011-01-01'
 
@@ -33,11 +35,15 @@ module MWS
 
       # Public: List the next page of orders using the NextToken parameter.
       #
+      # token - A String token (default: The token returned in the last
+      #         request).
+      #
       # Examples
       #
       #   client.list_orders_by_next_token
       #
-      # Returns an enumerable list of Orders.
+      # Returns an enumerable list of Orders or false if there are no more pages
+      # left.
       def_delegator :orders, :list_by_next_token, :list_orders_by_next_token
 
       # Public: List order items for an amazon order.
@@ -54,11 +60,15 @@ module MWS
       # Public: List the next page of order items using the NextToken
       # parameter.
       #
+      # token - A String token (default: The token returned in the last
+      #         request).
+      #
       # Examples
       #
       #   client.list_order_items_by_next_token
       #
-      # Returns an enumerable list of Order Items.
+      # Returns an enumerable list of Order Items or false if there are no more
+      # pages left.
       def_delegator :order_items, :list_by_next_token, :list_order_items_by_next_token
 
       # Public: Get the service status of the API.

data/lib/mws/orders/parsers/order_items.rb

@@ -1,10 +1,13 @@
 require 'mws/orders/parsers/order_item'
 require 'peddler/parsers/collection'
+require 'peddler/parsers/tokenable'
 
 module MWS
   module Orders
     module Parsers
       class OrderItems < ::Peddler::Parsers::Collection
+        include ::Peddler::Parsers::Tokenable
+
         def each(&blk)
           order_item_nodes.each { |node| yield OrderItem.new(node) }
         end

data/lib/mws/orders/parsers/orders.rb

@@ -1,18 +1,21 @@
 require 'mws/orders/parsers/order'
 require 'peddler/parsers/collection'
+require 'peddler/parsers/tokenable'
 
 module MWS
   module Orders
     module Parsers
       class Orders < ::Peddler::Parsers::Collection
-        extend Forwardable
+        include ::Peddler::Parsers::Tokenable
 
-        def_delegator :order_nodes, :each
+        def each(&blk)
+          order_nodes.each { |node| yield Order.new(node) }
+        end
 
         private
 
         def order_nodes
-          xpath('Orders/Order').map { |node| Order.new(node) }
+          xpath('Orders/Order')
         end
       end
     end

data/lib/mws/orders/requests/order_items.rb

@@ -13,9 +13,11 @@ module MWS
           execute
         end
 
-        def list_by_next_token
+        def list_by_next_token(token = next_token)
+          return unless token
+
           parameters(:list_order_items_by_next_token)
-            .update(next_token: next_token)
+            .update(next_token: token)
             .camelize_keys!
 
           execute

data/lib/mws/orders/requests/orders.rb

@@ -26,9 +26,11 @@ module MWS
           execute
         end
 
-        def list_by_next_token
+        def list_by_next_token(token = next_token)
+          return unless token
+
           parameters(:list_orders_by_next_token)
-            .update(next_token: next_token)
+            .update(next_token: token)
             .camelize_keys!
 
           execute