mws-orders 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5024482ae6bb34ce7a6066333ab17e2bad0c8cd98330ef2d17710c843114c1bb
-  data.tar.gz: 2d2235a1ccd194a58cfb162d4cd89990e3878a232c62b0c7325f30d595dd0cf4
+  metadata.gz: b05f9a8f9c6d1b3eda7df105bd088572fbe93324682f9902f81a16aa7060b55f
+  data.tar.gz: 812d86fb8d5e6e4bdf8f5ad1b928394290f26a282b5f2eed67c8054da1d1cef7
 SHA512:
-  metadata.gz: a0e92ba47bfc2feb5513324f22a60abd078528c327e1be3e22a0d27940f7f45d5917e3708cbda335967d3cb2cbffe9364a4677f359af01d698c897d6c4b52883
-  data.tar.gz: 75677d6f12e108daf1331ba3d18b5d2c54717abd79a85999e68545a13f18773a8804577d5d063710e2fdba7a6b8a151d4b3035f795774f9c3d55bf86d43b9747
+  metadata.gz: 0bcd1463e7bcdf91b937926079202a9ebc93ec783da4a459fcef869c65381b8ad935d654462a3397c7ed5145f55c306f6dff4cc7345096e77f96b6c438bc19d5
+  data.tar.gz: a8df5632bc2d3132680cdc9e9c45cb91d355400fae60a6479f8b248332ce9afc80623eb51f0262fec54075ffcc77694e43415770fc58b568654beeaa6607e2ea

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2013-2014 Hakan Ensari
+Copyright (c) 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,6 +1,6 @@
 # MWS Orders
 
-[![Build Status](https://travis-ci.org/hakanensari/mws-orders.svg)](https://travis-ci.org/hakanensari/mws-orders)
+[![CircleCI](https://circleci.com/gh/hakanensari/mws-orders.svg?style=svg)](https://circleci.com/gh/hakanensari/mws-orders)
 
 **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.
 
@@ -26,7 +26,7 @@ List orders created or updated during a time frame you specify:
 response = client.list_orders(created_after: 1.month.ago)
 orders = response.parse
 puts orders.count # => 100
-puts orders.first # => #<MWS::Orders::Order amazon_order_id="123...
+orders.first.inspect # => #<MWS::Orders::Order 902-3159896-1390916>
 )
 ```
 
@@ -41,7 +41,7 @@ Get one or more orders based on their order numbers:
 ```ruby
 response = client.get_order('123-1234567-1234567')
 order = response.parse
-puts order # => #<MWS::Orders::Order amazon_order_id="123...
+order.inspect # => #<MWS::Orders::Order 902-3159896-1390916>
 ```
 
 ### Order Items

data/lib/mws/orders/address.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'mws/orders/entity'
+
+module MWS
+  module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Datatypes.html#Address
+    class Address < Entity
+      attribute(:name) do
+        string('Name')
+      end
+
+      attribute(:lines) do
+        1.upto(3).map { |i| string("AddressLine#{i}") }.compact
+      end
+
+      attribute(:city) do
+        string('City')
+      end
+
+      attribute(:state_or_region) do
+        string('StateOrRegion')
+      end
+
+      attribute(:postal_code) do
+        string('PostalCode')
+      end
+
+      attribute(:country_code) do
+        string('CountryCode')
+      end
+
+      attribute(:phone) do
+        string('Phone')
+      end
+    end
+  end
+end

data/lib/mws/orders/buyer_customized_info.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'mws/orders/entity'
+
+module MWS
+  module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Datatypes.html#BuyerCustomizedInfo
+    class BuyerCustomizedInfo < Entity
+      attribute :customized_url do
+        string('CustomizedURL')
+      end
+    end
+  end
+end

data/lib/mws/orders/buyer_tax_info.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'mws/orders/entity'
+require 'mws/orders/tax_classification'
+
+module MWS
+  module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Datatypes.html#BuyerTaxInfo
+    class BuyerTaxInfo < Entity
+      attribute :company_legal_name do
+        string('CompanyLegalName')
+      end
+
+      attribute(:taxing_region) do
+        string('TaxingRegion')
+      end
+
+      attribute(:tax_classifications) do
+        entities('TaxClassifications/TaxClassification', TaxClassification)
+      end
+    end
+  end
+end

data/lib/mws/orders/collection.rb

@@ -4,6 +4,7 @@ require 'mws/orders/document'
 
 module MWS
   module Orders
+    # Returns a list of parsed objects
     class Collection < Document
       include Enumerable
 

data/lib/mws/orders/document.rb

@@ -2,6 +2,7 @@
 
 module MWS
   module Orders
+    # Wraps a Nokogiri node
     class Document
       attr_reader :node
 
@@ -13,13 +14,14 @@ module MWS
         node.xpath(add_namespace(path))
       end
 
+      def at_xpath(path)
+        node.at_xpath(add_namespace(path))
+      end
+
       private
 
       def add_namespace(path)
-        path
-          .split('/')
-          .map { |attr| "xmlns:#{attr}" }
-          .join('/')
+        path.split('/').map { |attr| "xmlns:#{attr}" }.join('/')
       end
     end
   end

data/lib/mws/orders/entity.rb

@@ -8,37 +8,48 @@ require 'mws/orders/document'
 
 module MWS
   module Orders
+    # A parsed object
     class Entity < Document
       include Structure
 
-      def float_at_xpath(path)
-        text = text_at_xpath(path)
-        text&.to_f
+      def boolean(path)
+        string(path) == 'true'
       end
 
-      def integer_at_xpath(path)
-        text = text_at_xpath(path)
-        text&.to_i
+      def entities(path, klass)
+        xpath(path).map { |node| klass.new(node) }
       end
 
-      def money_at_xpath(path)
-        amount = float_at_xpath("#{path}/Amount")
+      def entity(path, klass)
+        node = at_xpath(path)
+        klass.new(node) if node
+      end
+
+      def float(path)
+        string(path)&.to_f
+      end
+
+      def integer(path)
+        string(path)&.to_i
+      end
+
+      def money(path)
+        amount = float("#{path}/Amount")
         return unless amount
 
-        currency_code = text_at_xpath("#{path}/CurrencyCode")
+        currency_code = string("#{path}/CurrencyCode")
         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
+      def string(path)
+        at_xpath(path)&.text&.strip
       end
 
-      def text_at_xpath(path)
-        node = xpath(path).first
-        node&.text&.strip
+      def time(path)
+        text = string(path)
+        Time.parse(CGI.unescape(text)) if text
       end
     end
   end

data/lib/mws/orders/invoice_data.rb

@@ -4,21 +4,22 @@ require 'mws/orders/entity'
 
 module MWS
   module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Datatypes.html#InvoiceData
     class InvoiceData < Entity
       attribute(:invoice_requirement) do
-        text_at_xpath('InvoiceRequirement')
+        string('InvoiceRequirement')
       end
 
       attribute(:buyer_selected_invoice_category) do
-        text_at_xpath('BuyerSelectedInvoiceCategory')
+        string('BuyerSelectedInvoiceCategory')
       end
 
       attribute(:invoice_title) do
-        text_at_xpath('InvoiceTitle')
+        string('InvoiceTitle')
       end
 
       attribute(:invoice_information) do
-        text_at_xpath('InvoiceInformation')
+        string('InvoiceInformation')
       end
     end
   end

data/lib/mws/orders/message.rb

@@ -4,13 +4,14 @@ require 'mws/orders/entity'
 
 module MWS
   module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/MWS_GetServiceStatus.html
     class Message < Entity
       attribute(:locale) do
-        text_at_xpath('Locale')
+        string('Locale')
       end
 
       attribute(:text) do
-        text_at_xpath('Text')
+        string('Text')
       end
     end
   end

data/lib/mws/orders/order.rb

@@ -1,116 +1,165 @@
 # frozen_string_literal: true
 
 require 'mws/orders/entity'
-require 'mws/orders/shipping_address'
-require 'mws/orders/payment_execution_detail'
+require 'mws/orders/address'
+require 'mws/orders/buyer_tax_info'
+require 'mws/orders/payment_execution_detail_item'
 
 module MWS
   module Orders
+    # https://docs.developer.amazonservices.com/en_US/orders-2013-09-01/Orders_Datatypes.html#Order
     class Order < Entity
       attribute(:amazon_order_id) do
-        text_at_xpath('AmazonOrderId')
+        string('AmazonOrderId')
       end
 
       attribute(:seller_order_id) do
-        text_at_xpath('SellerOrderId')
+        string('SellerOrderId')
       end
 
       attribute(:purchased_at) do
-        time_at_xpath('PurchaseDate')
+        time('PurchaseDate')
       end
 
       attribute(:last_updated_at) do
-        time_at_xpath('LastUpdateDate')
+        time('LastUpdateDate')
       end
 
       attribute(:status) do
-        text_at_xpath('OrderStatus')
+        string('OrderStatus')
       end
 
       attribute(:fulfillment_channel) do
-        text_at_xpath('FulfillmentChannel')
+        string('FulfillmentChannel')
       end
 
       attribute(:sales_channel) do
-        text_at_xpath('SalesChannel')
+        string('SalesChannel')
       end
 
       attribute(:order_channel) do
-        text_at_xpath('OrderChannel')
+        string('OrderChannel')
       end
 
       attribute(:ship_service_level) do
-        text_at_xpath('ShipServiceLevel')
+        string('ShipServiceLevel')
       end
 
       attribute(:shipping_address) do
-        node = xpath('ShippingAddress').first
-        ShippingAddress.new(node) if node
+        entity('ShippingAddress', Address)
       end
 
       attribute(:total) do
-        money_at_xpath('OrderTotal')
+        money('OrderTotal')
       end
 
       attribute(:number_of_items_shipped) do
-        integer_at_xpath('NumberOfItemsShipped')
+        integer('NumberOfItemsShipped')
       end
 
       attribute(:number_of_items_unshipped) do
-        integer_at_xpath('NumberOfItemsUnshipped')
+        integer('NumberOfItemsUnshipped')
       end
 
       attribute(:payment_execution_detail) do
-        node = xpath('PaymentExecutionDetail').first
-        PaymentExecutionDetail.new(node) if node
+        xpath('PaymentExecutionDetail/PaymentExecutionDetailItem')
+          .map { |node| PaymentExecutionDetailItem.new(node) }
       end
 
       attribute(:payment_method) do
-        text_at_xpath('PaymentMethod')
+        string('PaymentMethod')
+      end
+
+      attribute(:payment_method_details) do
+        xpath('PaymentMethodDetails/PaymentMethodDetail').map(&:text)
+      end
+
+      attribute(:replacement_order?) do
+        boolean('IsReplacementOrder')
+      end
+
+      attribute(:replaced_order_id) do
+        string('ReplacedOrderId')
       end
 
       attribute(:marketplace_id) do
-        text_at_xpath('MarketplaceId')
+        string('MarketplaceId')
+      end
+
+      attribute(:buyer_email) do
+        string('BuyerEmail')
       end
 
       attribute(:buyer_name) do
-        text_at_xpath('BuyerName')
+        string('BuyerName')
       end
 
-      attribute(:buyer_email) do
-        text_at_xpath('BuyerEmail')
+      attribute(:buyer_county) do
+        string('BuyerCounty')
       end
 
-      attribute(:shipment_service_level_category) do
-        text_at_xpath('ShipmentServiceLevelCategory')
+      attribute(:buyer_tax_info) do
+        entity('BuyerTaxInfo', BuyerTaxInfo)
       end
 
-      attribute(:cba_displayable_shipping_label) do
-        text_at_xpath('CbaDisplayableShippingLabel')
+      attribute(:shipment_service_level_category) do
+        string('ShipmentServiceLevelCategory')
       end
 
       attribute(:shipped_by_amazon_tfm) do
-        text_at_xpath('ShippedByAmazonTFM')
+        string('ShippedByAmazonTFM')
       end
 
       attribute(:tfm_shipment_status) do
-        text_at_xpath('TFMShipmentStatus')
+        string('TFMShipmentStatus')
+      end
+
+      attribute(:easy_ship_shipment_status) do
+        string('EasyShipShipmentStatus')
       end
 
       attribute(:type) do
-        text_at_xpath('OrderType')
+        string('OrderType')
       end
 
       attribute(:earliest_shipped_at) do
-        time_at_xpath('EarliestShipDate')
+        time('EarliestShipDate')
       end
 
       attribute(:latest_shipped_at) do
-        time_at_xpath('LatestShipDate')
+        time('LatestShipDate')
+      end
+
+      attribute(:earliest_delivered_at) do
+        time('LatestDeliveryDate')
       end
 
       attribute(:latest_delivered_at) do
-        time_at_xpath('LatestDeliveryDate')
+        time('LatestDeliveryDate')
+      end
+
+      attribute(:business_order?) do
+        boolean('IsBusinessOrder')
+      end
+
+      attribute(:purchase_order_number) do
+        string('PurchaseOrderNumber')
+      end
+
+      attribute(:prime?) do
+        boolean('IsPrime')
+      end
+
+      attribute(:premium?) do
+        boolean('IsPremiumOrder')
+      end
+
+      attribute(:promise_response_due_at) do
+        time('PromiseResponseDueDate')
+      end
+
+      attribute(:estimated_ship_date_set?) do
+        boolean('IsEstimatedShipDateSet')
       end
 
       def to_s