mws-orders 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1573eac66d2fcb6f0d19426a9f49b9e943d6662c
-  data.tar.gz: 32b0a15281d875074c93b2ec382e033c9761d821
+  metadata.gz: a19c5ef1c9834c6008a1618a7e2b9740dbc264d6
+  data.tar.gz: d7a3b54bdeb81dd00380076535e869747e46b71f
 SHA512:
-  metadata.gz: 9cbf5db8dcb0f758ecea5b83210738f704544f06734140aae757c154ac41c82869bfed16ba294f5d10313771e0dfee49435e6675d50970f49ec23ff7268c6cd6
-  data.tar.gz: b5d8b528756fb96208831eaf3a939d27ba913c0b83a359af97afbda93eafdb07f1e82983ebf739397a49b8dde18c440c771f3eff07754f8c96d79ae3dcad23bb
+  metadata.gz: 36ea87627bac392e57c5e6abd92ecc2e6beee64d3b38458a9a8e6ddb4b5f278de30d160569099c6fc3ee50a51d81d20d61d6e2ea44c89a9d77e001984384cf04
+  data.tar.gz: ab91b32c50a02f8f964c1f4bb94753a26801b1d6ed8a0b648a63fae4b4bb731efefbdcf347cb4deddfc7a957670917e034604a810033ae4f0c777db0774b0abb

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2013 Paper Cavalier
+Copyright (c) 2013-2014 Hakan Ensari
 
 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,50 +1,50 @@
 # MWS Orders
 
-**MWS Orders** is a fully-featured Ruby interface to the [Amazon Marketplace
-Web Service (MWS) Orders API][1].
+**MWS Orders** is a full-featured Ruby interface to the [Amazon Marketplace Web Service (MWS) Orders API](http://docs.developer.amazonservices.com/en_UK/orders/index.html). With the MWS Orders API, you can list orders created or updated during a time frame you specify or retrieve information about specific orders.
+
+To use Amazon MWS, you must have an eligible seller account.
 
 ## Usage
 
-Instantiate a client:
+Create a client:
 
 ```ruby
-client = MWS::Orders::Client.new('GB', 'aws_key', 'aws_secret', 'seller_id')
+require "mws-orders"
+client = MWS.orders
 ```
 
-[API methods are available on the client][2].
+Set up credentials [when instantiating or with environment variables](https://github.com/hakanensari/peddler#quick-start).
 
 ### 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)
+orders = client.list_orders(created_after: 1.month.ago)
+puts orders.count # => 100
+puts orders.first # => #<MWS::Orders::Order amazon_order_id="123...
 )
 ```
 
 List the next page of orders:
 
 ```ruby
-client.list_orders_by_next_token
+client.list_orders_by_next_token(orders.next_token)
 ```
 
 Get one or more orders based on their order numbers:
 
 ```ruby
-client.get_order('123-1234567-1234567')
+order = client.get_order("123-1234567-1234567")
+puts order # => #<MWS::Orders::Order amazon_order_id="123...
 ```
 
-All above queries will return an enumerable list of orders.
-
 ### Order Items
 
-List order items based on an order number you specify:
+List order items:
 
 ```ruby
-client.list_order_items('123-1234567-1234567')
+order_items = client.list_order_items("123-1234567-1234567")
 ```
 
 List the next page of order items:
@@ -53,7 +53,7 @@ List the next page of order items:
 client.list_order_items_by_next_token
 ```
 
-All above queries will return an enumerable list of order items.
+Orders and order items are represented by POROs that map one on one to the attributes returned by the API.
 
 ### Service Status
 
@@ -62,12 +62,3 @@ 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&mdash;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.rb

@@ -1,29 +1,2 @@
-require 'cgi'
-require 'delegate'
-require 'forwardable'
-require 'time'
-
-require 'money'
-require 'nokogiri'
-require 'peddler'
-require 'structure'
-
-require 'mws/orders/client'
-require 'mws/orders/helpers/structured_list'
-require 'mws/orders/helpers/parameters'
-require 'mws/orders/requests/base'
-require 'mws/orders/requests/orders'
-require 'mws/orders/requests/order_items'
-require 'mws/orders/requests/service_status'
-require 'mws/orders/parsers/base'
-require 'mws/orders/parsers/model'
-require 'mws/orders/parsers/collection'
-require 'mws/orders/parsers/orders'
-require 'mws/orders/parsers/order'
-require 'mws/orders/parsers/shipping_address'
-require 'mws/orders/parsers/payment_execution_detail'
-require 'mws/orders/parsers/payment_execution_detail_item'
-require 'mws/orders/parsers/order_items'
-require 'mws/orders/parsers/order_item'
-require 'mws/orders/parsers/service_status'
-require 'mws/orders/parsers/service_status_message'
+require "peddler"
+require "mws/orders/parser"

data/lib/mws/orders/collection.rb

@@ -0,0 +1,29 @@
+require "mws/orders/document"
+
+module MWS
+  module Orders
+    class Collection < Document
+      include Enumerable
+
+      def each
+        raise NotImplementedError
+      end
+
+      def empty?
+        count == 0
+      end
+
+      def inspect
+        "#<#{self.class} #{
+          if count > 3
+            "[#{take(3).map(&:inspect).join(', ')}...]"
+          else
+            "[#{map(&:inspect).join(', ')}]"
+          end
+        }>"
+      end
+
+      alias_method :to_s, :inspect
+    end
+  end
+end

data/lib/mws/orders/document.rb

@@ -0,0 +1,28 @@
+require "structure"
+
+module MWS
+  module Orders
+    class Document
+      include Structure
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def xpath(path)
+        node.xpath(add_namespace(path))
+      end
+
+      private
+
+      def add_namespace(path)
+        path
+          .split("/")
+          .map { |attr| "xmlns:#{attr}" }
+          .join("/")
+      end
+    end
+  end
+end

data/lib/mws/orders/entity.rb

@@ -0,0 +1,39 @@
+require "cgi"
+require "time"
+require "money"
+require "mws/orders/document"
+
+module MWS
+  module Orders
+    class Entity < Document
+      def float_at_xpath(path)
+        text = text_at_xpath(path)
+        text.to_f if text
+      end
+
+      def integer_at_xpath(path)
+        text = text_at_xpath(path)
+        text.to_i if text
+      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 time_at_xpath(path)
+        text = text_at_xpath(path)
+        Time.parse(CGI.unescape(text)) if text
+      end
+
+      def text_at_xpath(path)
+        node = xpath(path).first
+        node.text.strip if node
+      end
+    end
+  end
+end

data/lib/mws/orders/invoice_data.rb

@@ -0,0 +1,23 @@
+require "mws/orders/entity"
+
+module MWS
+  module Orders
+    class InvoiceData < Entity
+      attribute(:invoice_requirement) do
+        text_at_xpath("InvoiceRequirement")
+      end
+
+      attribute(:buyer_selected_invoice_category) do
+        text_at_xpath("BuyerSelectedInvoiceCategory")
+      end
+
+      attribute(:invoice_title) do
+        text_at_xpath("InvoiceTitle")
+      end
+
+      attribute(:invoice_information) do
+        text_at_xpath("InvoiceInformation")
+      end
+    end
+  end
+end

data/lib/mws/orders/order.rb

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

data/lib/mws/orders/order_item.rb

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