peddler 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b89bab8ffb0fcd4902068dbcdb8b47917eaed6d4
-  data.tar.gz: 8bfa9a382b50cb908099f69d50fd36d3f530e4dc
+  metadata.gz: 54909f8d993396b8132138eef8f201c75acebd89
+  data.tar.gz: 2db773a47532b898dc0e1227ada67e6ef3d343ba
 SHA512:
-  metadata.gz: 2062379662693c265f8d0884d92c341156db7303487e87e5ecd805bbefdf0fed425e033345a4965e72e53b75bfc51e5f3791a7ebfaca99b0438c35f04319bfcb
-  data.tar.gz: ae0055bc9d6d0977f73ca479537f38324dead20611dbfb17a259485b7ec7faf279a8dd55839f95539474a1300ee978a6e303a8f06e0521f3f50f769fd83171b2
+  metadata.gz: a028b4d07e66d3cf49078cc4b32c7ddff925f5524447e70043f3c88d4552a26d86ab1d08ae7763176a1968b23c3b0d942e827c8aa6bc15385d5513c1114c93a6
+  data.tar.gz: 1805a78cc4684b60d7a6f820f06a3b1a6a162773b79d27d8061a5507231ebbf57115b530ea9a1cc52fadf8bfa2bba028c4f48a0f5157b182e1a1da0c77019d70

data/README.md

@@ -2,21 +2,250 @@
 
 ![Peddler][1]
 
-Peddler provides a light-weight wrapper around the [Amazon Marketplace Web
+**Peddler** is a full-featured Ruby interface to the [Amazon Marketplace Web
 Service (MWS) APIs][2].
 
 ## Usage
 
+Require the library:
+
+```ruby
+require 'peddler'
+```
+
+Alternatively, require a particular API only:
+
+```ruby
+require 'mws/orders'
+```
+
+Instantiate a client 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:
+
+```sh
+export AWS_ACCESS_KEY_ID=key
+export AWS_SECRET_ACCESS_KEY=secret
+export MERCHANT_ID=merchant_id
+```
+
+Then, instantiate with the country code:
+
+```ruby
+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
+
+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')
+```
+
+### Fulfillment Inbound Shipment
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::FulfillmentInboundShipment::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Fulfillment Inventory
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::FulfillmentInventory::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Fulfillment Outbound Shipment
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::FulfillmentOutboundShipment::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Off Amazon Payments
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::OffAmazonPayments::Client.new('GB')
+```
+
+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].
+
+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
+```
+
+### Products
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::Products::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Recommendations
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+client = MWS::Recommendations::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Reports
+
+This API is not implemented yet. You can still use the raw client like so:
+
 ```ruby
-client = Peddler::Products.new('US', 'aws_key', 'aws_secret, 'seller_id')
-params = {
-  'Marketplace' => client.marketplace_id('US'),
-  'Action'      => 'ListMatchingProducts',
-  'Query'       => 'Architecture'
-}
+client = MWS::Reports::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Sellers
+
+This API is not implemented yet. You can still use the raw client like so:
 
-res = client.get(query: params)
+```ruby
+client = MWS::Sellers::Client.new('GB')
+```
+
+Pull requests are welcome!
+
+### Subscriptions
+
+This API is not implemented yet. You can still use the raw client like so:
+
+```ruby
+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

data/lib/mws/feeds.rb

@@ -0,0 +1 @@
+require 'mws/feeds/client'

data/lib/mws/feeds/client.rb

@@ -0,0 +1,97 @@
+require 'mws/feeds/requests/feed'
+require 'mws/feeds/requests/feed_submission_list'
+require 'mws/feeds/requests/feed_submission_count'
+require 'mws/feeds/requests/feed_submission_result'
+require 'peddler/client'
+
+module MWS
+  module Feeds
+    class Client < ::Peddler::Client
+      # Public: Upload a feed for processing by Amazon MWS.
+      #
+      # content - The String content of the feed, in XML or flat file format.
+      # type    - A String value indicating how the data should be processed.
+      # options - Other optional Hash query parameters used to define the
+      #           submission.
+      #           :marketplace_id_list - A list of one or more marketplace Ids
+      #                                  that you want the feed to be applied
+      #                                  to (defaults to the client's default
+      #                                  country).
+      #           :purge_and_replace   - A Boolean value that enables the purge
+      #                                  and replace functionality (default:
+      #                                  false).
+      #
+      # Examples
+      #
+      #   client.submit_feed(body, '_POST_PRODUCT_DATA_')
+      #
+      # Returns a Feed Submission.
+      def_delegator :feed, :submit, :submit_feed
+
+      # Public: Get a list of feed submissions submitted during a specified time
+      # frame.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Feeds API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_feed_submission_list(submitted_from_date: 1.week.ago)
+      #
+      # Returns an enumerable Feed Submission List.
+      def_delegator :feed_submission_list, :get, :get_feed_submission_list
+
+      # Public: List the next page of the list of feed submissions.
+      #
+      # Examples
+      #
+      #   client.get_feed_submission_list_by_next_token
+      #
+      # Returns an enumerable Feed Submission List.
+      def_delegator :feed_submission_list, :get_by_next_token, :get_feed_submission_list_by_next_token
+
+      # Public: Returns a count of the feeds submitted during a specified time
+      # frame.
+      #
+      # options - The Hash query parameters used to narrow the list. Refer to
+      #           the MWS Feeds API for available parameters.
+      #
+      # Examples
+      #
+      #   client.get_feed_submission_count(submitted_from_date: 1.week.ago)
+      #
+      # Returns the Feed Submission Count.
+      def_delegator :feed_submission_count, :get, :get_feed_submission_count
+
+      # Public: Gets the feed processing report and the Content-MD5 header for
+      # the returned HTTP body.
+      #
+      # feed_submission_id - The String Feed Submission Id.
+      #
+      # Examples
+      #
+      #   client.get_feed_submission_result('123456')
+      #
+      # Returns the Feed Submission Result.
+      def_delegator :feed_submission_result, :get, :get_feed_submission_result
+
+      private
+
+      def feed
+        @feed ||= Requests::Feed.new(self)
+      end
+
+      def feed_submission_list
+        @feed_submission_list ||= Requests::FeedSubmissionList.new(self)
+      end
+
+      def feed_submission_count
+        @feed_submission_count ||= Requests::FeedSubmissionCount.new(self)
+      end
+
+      def feed_submission_result
+        @feed_submission_result ||= Requests::FeedSubmissionResult.new(self)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+require 'peddler/parsers/model'
+
+module MWS
+  module Feeds
+    module Parsers
+      class FeedSubmission < ::Peddler::Parsers::Model
+        value :id do
+          text_at_xpath('FeedSubmissionId')
+        end
+
+        value :type do
+          text_at_xpath('FeedType')
+        end
+
+        value :submitted_at do
+          time_at_xpath('SubmittedDate')
+        end
+
+        value :processing_status do
+          text_at_xpath('FeedProcessingStatus')
+        end
+      end
+    end
+  end
+end

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

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

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

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