mws-orders 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 161b00e5e2956a4798a37cd121baea48c58031f7
+  data.tar.gz: 02981d3f4fb416ebe23f89fd4975d7daae325810
+SHA512:
+  metadata.gz: c4caab1a5269758e84ffd649d8c54b119b0de5b609eedf97d4ac2dd91a7cf00dd38bf0f458777e7a8c72c5667e62b4254955a5a618adc8aa687265d14d2936a0
+  data.tar.gz: 28365116614a1e9d35826cbf767c24328688af70b64ccdd49ace25be268e63ade05f3e02c9f9055af785335fd8082a1737baad3d275a4e999ffe703efee16d54

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# MWS Orders
+
+**MWS Orders** is a fully-featured Ruby interface to the [Amazon Marketplace
+Web Service (MWS) Orders API][1].
+
+## Usage
+
+Instantiate a client:
+
+```ruby
+client = MWS::Orders::Client.new('GB', 'aws_key', 'aws_secret', 'seller_id')
+```
+
+[API methods are available on the client][2].
+
+### Orders
+
+List orders created or updated during a time frame you specify:
+
+```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
+```
+
+### Naming Conventions
+
+Request and response attribute names follow Amazon's naming conventions with a
+few exceptions, where some Railsism has insidiuously crept in—e.g.
+`shipped_at` instead of `ShipDate`.
+
+[1]: http://docs.developer.amazonservices.com/en_UK/orders/index.html
+[2]: https://github.com/papercavalier/mws-orders/blob/master/lib/mws/orders/client.rb

data/lib/mws/orders/client.rb

@@ -0,0 +1,88 @@
+module MWS
+  module Orders
+    class Client < ::Peddler::Orders
+      extend Forwardable
+
+      # Public: Get one or more orders.
+      #
+      # amazon_order_ids - One or more String Amazon order ids.
+      #
+      # Examples
+      #
+      #   client.get_order('123-1234567-1234567')
+      #
+      # Returns an enumerable list of Orders.
+      def_delegator :orders, :get, :get_order
+
+      # Public: List orders created or updated during a specified time frame.
+      #
+      # params - The Hash request parameters used to narrow the orders list.
+      #          Refer to the MWS Orders API for available parameters.
+      #
+      # Examples
+      #
+      #   client.list_orders(created_after: 1.week.ago)
+      #
+      # Returns an enumerable list of Orders.
+      def_delegator :orders, :list, :list_orders
+
+      # Public: List the next page of orders using the NextToken parameter.
+      #
+      # Examples
+      #
+      #   client.list_orders_by_next_token
+      #
+      # Returns an enumerable list of Orders.
+      def_delegator :orders, :list_by_next_token, :list_orders_by_next_token
+
+      # Public: List order items for an amazon order.
+      #
+      # amazon_order_id - The String Amazon order id.
+      #
+      # Examples
+      #
+      #   client.list_order_items('123-1234567-1234567')
+      #
+      # Returns an enaumerable list of Order Items.
+      def_delegator :order_items, :list, :list_order_items
+
+      # Public: List the next page of order items using the NextToken
+      # parameter.
+      #
+      # Examples
+      #
+      #   client.list_order_items_by_next_token
+      #
+      # Returns an enaumerable list of Order Items.
+      def_delegator :order_items, :list_by_next_token, :list_order_items_by_next_token
+
+      # Public: Get the service status of the API.
+      #
+      # Examples
+      #
+      #   client.get_service_status
+      #
+      # Returns the Service Status.
+      def_delegator :service_status, :get, :get_service_status
+
+      # Internal: Returns the String home marketplace id of the client.
+      def home_marketplace_id
+        marketplace_id(country)
+      end
+
+      private
+
+      def orders
+        @orders ||= Request::Orders.new(self)
+      end
+
+      def order_items
+        @order_items ||= Request::OrderItems.new(self)
+      end
+
+      def service_status
+        @service_status ||= Request::ServiceStatus.new(self)
+      end
+    end
+  end
+end

data/lib/mws/orders/helpers/parameters.rb

@@ -0,0 +1,53 @@
+module MWS
+  module Orders
+    module Helper
+      class Parameters < SimpleDelegator
+        def initialize(action)
+          super({ 'Action' => camelize(action) })
+        end
+
+        def timestamp!
+          each do |key, value|
+            store(key, value.iso8601) if value.respond_to?(:iso8601)
+          end
+
+          self
+        end
+
+        def format_structured_lists!
+          lists = {}
+
+          each do |key, value|
+            if StructuredList.handle?(key)
+              lists.update(StructuredList.new(key).build(delete(key)))
+            end
+          end
+
+          update(lists)
+        end
+
+        def camelize_keys!
+          keys.each do |key|
+            if key.is_a?(Symbol)
+              new_key = camelize(key)
+              store(new_key, delete(key))
+            end
+          end
+
+          self
+        end
+
+        def update(hsh)
+          __getobj__.update(hsh)
+          self
+        end
+
+        private
+
+        def camelize(sym)
+          sym.to_s.split('_').map(&:capitalize).join
+        end
+      end
+    end
+  end
+end

data/lib/mws/orders/helpers/structured_list.rb

@@ -0,0 +1,40 @@
+module MWS
+  module Orders
+    module Helper
+      class StructuredList
+        KEYS = {
+          order_status:        %w(OrderStatus Status),
+          marketplace_id:      %w(MarketplaceId Id),
+          fulfillment_channel: %w(FulfillmentChannel Channel),
+          payment_method:      %w(PaymentMethod),
+          tfm_shipment_status: %w(TFMShipmentStatus Status),
+          amazon_order_id:     %w(AmazonOrderId Id)
+        }
+
+        attr :keys
+
+        def self.handle?(key)
+          KEYS.has_key?(key)
+        end
+
+        def initialize(key)
+          @keys = KEYS.fetch(key)
+        end
+
+        def build(values)
+          Array(values)
+            .each_with_index
+            .reduce(Hash.new) { |hsh, (v, i)|
+              hsh.merge(composite_key(i + 1) => v)
+            }
+        end
+
+        private
+
+        def composite_key(index)
+          (keys.dup << index).join('.')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module MWS
+  module Orders
+    module Parser
+      class Base
+        attr :document
+
+        def initialize(document)
+          @document = document
+        end
+
+        private
+
+        def at_xpath(path)
+          document.at_xpath(with_namespace(path))
+        end
+
+        def xpath(path)
+          document.xpath(with_namespace(path))
+        end
+
+        def with_namespace(path)
+          path.split('/').map { |attr| "xmlns:#{attr}" }.join('/')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module MWS
+  module Orders
+    module Parser
+      class Collection < Base
+        include Enumerable
+
+        def each
+          raise NotImplementedError
+        end
+
+        def empty?
+          count == 0
+        end
+
+        def inspect
+          "#<#{self.class}>"
+        end
+        alias :to_s :inspect
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module MWS
+  module Orders
+    module Parser
+      class InvoiceData < Model
+        value :invoice_requirement do
+          text_at_xpath('InvoiceRequirement')
+        end
+
+        value :buyer_selected_invoice_category do
+          text_at_xpath('BuyerSelectedInvoiceCategory')
+        end
+
+        value :invoice_title do
+          text_at_xpath('InvoiceTitle')
+        end
+
+        value :invoice_information do
+          text_at_xpath('InvoiceInformation')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module MWS
+  module Orders
+    module Parser
+      class Model < Base
+        include Structure
+
+        def float_at_xpath(path)
+          str = text_at_xpath(path)
+          str.to_f if str
+        end
+
+        def integer_at_xpath(path)
+          str = text_at_xpath(path)
+          str.to_i if str
+        end
+
+        def money_at_xpath(path)
+          return unless amount = float_at_xpath("#{path}/Amount")
+
+          currency_code = text_at_xpath("#{path}/CurrencyCode")
+          amount = amount * 100 unless currency_code == 'JPY'
+
+          Money.new(amount, currency_code)
+        end
+
+        def text_at_xpath(path)
+          node = at_xpath(path)
+          node.text if node
+        end
+
+        def time_at_xpath(path)
+          str = text_at_xpath(path)
+          Time.parse(CGI.unescape(str)) if str
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+module MWS
+  module Orders
+    module Parser
+      class Order < Model
+        value :amazon_order_id do
+          text_at_xpath('AmazonOrderId')
+        end
+
+        value :seller_order_id do
+          text_at_xpath('SellerOrderId')
+        end
+
+        value :purchased_at do
+          time_at_xpath('PurchaseDate')
+        end
+
+        value :last_updated_at do
+          time_at_xpath('LastUpdateDate')
+        end
+
+        value :status do
+          text_at_xpath('OrderStatus')
+        end
+
+        value :fulfillment_channel do
+          text_at_xpath('FulfillmentChannel')
+        end
+
+        value :sales_channel do
+          text_at_xpath('SalesChannel')
+        end
+
+        value :order_channel do
+          text_at_xpath('OrderChannel')
+        end
+
+        value :ship_service_level do
+          text_at_xpath('ShipServiceLevel')
+        end
+
+        value :shipping_address do
+          ShippingAddress.new(at_xpath('ShippingAddress'))
+        end
+
+        value :total do
+          money_at_xpath('OrderTotal')
+        end
+
+        value :number_of_items_shipped do
+          integer_at_xpath('NumberOfItemsShipped')
+        end
+
+        value :number_of_items_unshipped do
+          integer_at_xpath('NumberOfItemsUnshipped')
+        end
+
+        value :payment_execution_detail do
+          node = at_xpath('PaymentExecutionDetail')
+          PaymentExecutionDetail.new(node) if node
+        end
+
+        value :payment_method do
+          text_at_xpath('PaymentMethod')
+        end
+
+        value :marketplace_id do
+          text_at_xpath('MarketplaceId')
+        end
+
+        value :buyer_name do
+          text_at_xpath('BuyerName')
+        end
+
+        value :buyer_email do
+          text_at_xpath('BuyerEmail')
+        end
+
+        value :shipment_service_level_category do
+          text_at_xpath('ShipmentServiceLevelCategory')
+        end
+
+        value :cba_displayable_shipping_label do
+          text_at_xpath('CbaDisplayableShippingLabel')
+        end
+
+        value :shipped_by_amazon_tfm do
+          text_at_xpath('ShippedByAmazonTFM')
+        end
+
+        value :tfm_shipment_status do
+          text_at_xpath('TFMShipmentStatus')
+        end
+
+        value :type do
+          text_at_xpath('OrderType')
+        end
+
+        value :earliest_shipped_at do
+          time_at_xpath('EarliestShipDate')
+        end
+
+        value :latest_shipped_at do
+          time_at_xpath('LatestShipDate')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+module MWS
+  module Orders
+    module Parser
+      class OrderItem < Model
+        value :asin do
+          text_at_xpath('ASIN')
+        end
+
+        value :seller_sku do
+          text_at_xpath('SellerSKU')
+        end
+
+        value :order_item_id do
+          text_at_xpath('OrderItemId')
+        end
+
+        value :title do
+          text_at_xpath('Title')
+        end
+
+        value :quantity_ordered do
+          integer_at_xpath('QuantityOrdered')
+        end
+
+        value :quantity_shipped do
+          integer_at_xpath('QuantityShipped')
+        end
+
+        value :gift_message_text do
+          text_at_xpath('GiftMessageText')
+        end
+
+        value :gift_wrap_level do
+          text_at_xpath('GiftWrapLevel')
+        end
+
+        value :item_price do
+          money_at_xpath('ItemPrice')
+        end
+
+        value :shipping_price do
+          money_at_xpath('ShippingPrice')
+        end
+
+        value :gift_wrap_price do
+          money_at_xpath('GiftWrapPrice')
+        end
+
+        value :item_tax do
+          money_at_xpath('ItemTax')
+        end
+
+        value :shipping_tax do
+          money_at_xpath('ShippingTax')
+        end
+
+        value :gift_wrap_tax do
+          money_at_xpath('GiftWrapPrice')
+        end
+
+        value :shipping_discount do
+          money_at_xpath('ShippingDiscount')
+        end
+
+        value :promotion_discount do
+          money_at_xpath('PromotionDiscount')
+        end
+
+        value :promotion_ids do
+          xpath('PromotionId').map(&:text)
+        end
+
+        value :cod_fee do
+          money_at_xpath('CODFee')
+        end
+
+        value :cod_fee_discount do
+          money_at_xpath('CODFeeDiscount')
+        end
+
+        value :invoice_data do
+          xpath('InvoiceData').map { |node| InvoiceData.new(node) }
+        end
+
+        value :condition_id do
+          text_at_xpath('ConditionId')
+        end
+
+        value :condition_subtype_id do
+          text_at_xpath('ConditionSubtypeId')
+        end
+
+        value :condition_note do
+          text_at_xpath('ConditionNote')
+        end
+
+        value :scheduled_delivery_ends_at do
+          time_at_xpath('ScheduledDeliveryEndDate')
+        end
+
+        value :scheduled_delivery_starts_at do
+          time_at_xpath('ScheduledDeliveryStartDate')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module MWS
+  module Orders
+    module Parser
+      class OrderItems < Collection
+        def each(&blk)
+          order_item_nodes.each { |node| yield OrderItem.new(node) }
+        end
+
+        private
+
+        def order_item_nodes
+          xpath('OrderItem')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module MWS
+  module Orders
+    module Parser
+      class Orders < Collection
+        extend Forwardable
+
+        def_delegator :order_nodes, :each
+
+        private
+
+        def order_nodes
+          xpath('Order').map { |node| Order.new(node) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module MWS
+  module Orders
+    module Parser
+      class PaymentExecutionDetail < Collection
+        def each(&blk)
+          payment_execution_detail_item_nodes.each { |node| yield PaymentExecutionDetailItem.new(node) }
+        end
+
+        private
+
+        def payment_execution_detail_item_nodes
+          xpath('PaymentExecutionDetailItem')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module MWS
+  module Orders
+    module Parser
+      class PaymentExecutionDetailItem < Model
+        value :payment do
+          money_at_xpath('Payment')
+        end
+
+        value :payment_method do
+          text_at_xpath('PaymentMethod')
+        end
+      end
+    end
+  end
+end