mws-orders 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e5fc7496851e79217521eef0d282505343a3704
-  data.tar.gz: 8342dc83d8146fc0a64af2f002fc4754280c6610
+SHA256:
+  metadata.gz: 5024482ae6bb34ce7a6066333ab17e2bad0c8cd98330ef2d17710c843114c1bb
+  data.tar.gz: 2d2235a1ccd194a58cfb162d4cd89990e3878a232c62b0c7325f30d595dd0cf4
 SHA512:
-  metadata.gz: 5a7dc5870c74393acd3d40d24c32aa0cd5f495e2e83f7a823f5014d9acf9646bd903563f432f3b19af4e909ae81beb006c5426789215f02c20c684fd1a47c058
-  data.tar.gz: c74b2533d707cc1ca6e63e308db703c4f827ab037d3f831108db99faf122172e99c757d2e20238f57f3f98e5941e5ff573715151fe85d630517b7d77302d2c4b
+  metadata.gz: a0e92ba47bfc2feb5513324f22a60abd078528c327e1be3e22a0d27940f7f45d5917e3708cbda335967d3cb2cbffe9364a4677f359af01d698c897d6c4b52883
+  data.tar.gz: 75677d6f12e108daf1331ba3d18b5d2c54717abd79a85999e68545a13f18773a8804577d5d063710e2fdba7a6b8a151d4b3035f795774f9c3d55bf86d43b9747

data/README.md

@@ -11,18 +11,20 @@ To use Amazon MWS, you must have an eligible seller account.
 Create a client:
 
 ```ruby
-require "mws-orders"
-client = MWS.orders
+require 'mws/orders/parser'
+client = MWS.orders(marketplace: 'ATVPDKIKX0DER',
+                    merchant_id: '123')
 ```
 
-Set up credentials [when instantiating or with environment variables](https://github.com/hakanensari/peddler#quick-start).
+Set up credentials [when instantiating or with environment variables](https://github.com/hakanensari/peddler#usage).
 
 ### Orders
 
 List orders created or updated during a time frame you specify:
 
 ```ruby
-orders = client.list_orders(created_after: 1.month.ago)
+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...
 )
@@ -31,13 +33,14 @@ puts orders.first # => #<MWS::Orders::Order amazon_order_id="123...
 List the next page of orders:
 
 ```ruby
-client.list_orders_by_next_token(orders.next_token)
+client.list_orders_by_next_token(orders.next_token).parse
 ```
 
 Get one or more orders based on their order numbers:
 
 ```ruby
-order = client.get_order("123-1234567-1234567")
+response = client.get_order('123-1234567-1234567')
+order = response.parse
 puts order # => #<MWS::Orders::Order amazon_order_id="123...
 ```
 
@@ -46,13 +49,14 @@ puts order # => #<MWS::Orders::Order amazon_order_id="123...
 List order items:
 
 ```ruby
-order_items = client.list_order_items("123-1234567-1234567")
+response = client.list_order_items('123-1234567-1234567')
+order_items = response.parse
 ```
 
 List the next page of order items:
 
 ```ruby
-client.list_order_items_by_next_token
+client.list_order_items_by_next_token.parse
 ```
 
 Orders and order items are represented by POROs that map one on one to the attributes returned by the API.
@@ -62,5 +66,5 @@ Orders and order items are represented by POROs that map one on one to the attri
 Check the operational status of the API:
 
 ```ruby
-client.get_service_status
+client.get_service_status.parse
 ```

data/lib/mws/orders/collection.rb

@@ -1,4 +1,6 @@
-require "mws/orders/document"
+# frozen_string_literal: true
+
+require 'mws/orders/document'
 
 module MWS
   module Orders
@@ -10,20 +12,18 @@ module MWS
       end
 
       def empty?
-        count == 0
+        count.zero?
+      end
+
+      def attributes
+        map(&:attributes)
       end
 
       def inspect
-        "#<#{self.class} #{
-          if count > 3
-            "[#{take(3).map(&:inspect).join(', ')}...]"
-          else
-            "[#{map(&:inspect).join(', ')}]"
-          end
-        }>"
+        "#<#{self.class.name} #{to_a}>"
       end
 
-      alias_method :to_s, :inspect
+      alias to_s inspect
     end
   end
 end

data/lib/mws/orders/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MWS
   module Orders
     class Document
@@ -15,9 +17,9 @@ module MWS
 
       def add_namespace(path)
         path
-          .split("/")
+          .split('/')
           .map { |attr| "xmlns:#{attr}" }
-          .join("/")
+          .join('/')
       end
     end
   end

data/lib/mws/orders/entity.rb

@@ -1,8 +1,10 @@
-require "cgi"
-require "time"
-require "money"
-require "structure"
-require "mws/orders/document"
+# frozen_string_literal: true
+
+require 'cgi'
+require 'time'
+require 'money'
+require 'structure'
+require 'mws/orders/document'
 
 module MWS
   module Orders
@@ -11,19 +13,20 @@ module MWS
 
       def float_at_xpath(path)
         text = text_at_xpath(path)
-        text.to_f if text
+        text&.to_f
       end
 
       def integer_at_xpath(path)
         text = text_at_xpath(path)
-        text.to_i if text
+        text&.to_i
       end
 
       def money_at_xpath(path)
-        return unless amount = float_at_xpath("#{path}/Amount")
+        amount = float_at_xpath("#{path}/Amount")
+        return unless amount
 
         currency_code = text_at_xpath("#{path}/CurrencyCode")
-        amount = amount * 100 unless currency_code == "JPY"
+        amount *= 100 unless currency_code == 'JPY'
 
         Money.new(amount, currency_code)
       end
@@ -35,7 +38,7 @@ module MWS
 
       def text_at_xpath(path)
         node = xpath(path).first
-        node.text.strip if node
+        node&.text&.strip
       end
     end
   end

data/lib/mws/orders/invoice_data.rb

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

data/lib/mws/orders/message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'mws/orders/entity'
+
+module MWS
+  module Orders
+    class Message < Entity
+      attribute(:locale) do
+        text_at_xpath('Locale')
+      end
+
+      attribute(:text) do
+        text_at_xpath('Text')
+      end
+    end
+  end
+end

data/lib/mws/orders/order.rb

@@ -1,112 +1,120 @@
-require "mws/orders/entity"
-require "mws/orders/shipping_address"
-require "mws/orders/payment_execution_detail"
+# frozen_string_literal: true
+
+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")
+        text_at_xpath('AmazonOrderId')
       end
 
       attribute(:seller_order_id) do
-        text_at_xpath("SellerOrderId")
+        text_at_xpath('SellerOrderId')
       end
 
       attribute(:purchased_at) do
-        time_at_xpath("PurchaseDate")
+        time_at_xpath('PurchaseDate')
       end
 
       attribute(:last_updated_at) do
-        time_at_xpath("LastUpdateDate")
+        time_at_xpath('LastUpdateDate')
       end
 
       attribute(:status) do
-        text_at_xpath("OrderStatus")
+        text_at_xpath('OrderStatus')
       end
 
       attribute(:fulfillment_channel) do
-        text_at_xpath("FulfillmentChannel")
+        text_at_xpath('FulfillmentChannel')
       end
 
       attribute(:sales_channel) do
-        text_at_xpath("SalesChannel")
+        text_at_xpath('SalesChannel')
       end
 
       attribute(:order_channel) do
-        text_at_xpath("OrderChannel")
+        text_at_xpath('OrderChannel')
       end
 
       attribute(:ship_service_level) do
-        text_at_xpath("ShipServiceLevel")
+        text_at_xpath('ShipServiceLevel')
       end
 
       attribute(:shipping_address) do
-        if node = xpath("ShippingAddress").first
-          ShippingAddress.new(node)
-        end
+        node = xpath('ShippingAddress').first
+        ShippingAddress.new(node) if node
       end
 
       attribute(:total) do
-        money_at_xpath("OrderTotal")
+        money_at_xpath('OrderTotal')
       end
 
       attribute(:number_of_items_shipped) do
-        integer_at_xpath("NumberOfItemsShipped")
+        integer_at_xpath('NumberOfItemsShipped')
       end
 
       attribute(:number_of_items_unshipped) do
-        integer_at_xpath("NumberOfItemsUnshipped")
+        integer_at_xpath('NumberOfItemsUnshipped')
       end
 
       attribute(:payment_execution_detail) do
-        if node = xpath("PaymentExecutionDetail").first
-          PaymentExecutionDetail.new(node)
-        end
+        node = xpath('PaymentExecutionDetail').first
+        PaymentExecutionDetail.new(node) if node
       end
 
       attribute(:payment_method) do
-        text_at_xpath("PaymentMethod")
+        text_at_xpath('PaymentMethod')
       end
 
       attribute(:marketplace_id) do
-        text_at_xpath("MarketplaceId")
+        text_at_xpath('MarketplaceId')
       end
 
       attribute(:buyer_name) do
-        text_at_xpath("BuyerName")
+        text_at_xpath('BuyerName')
       end
 
       attribute(:buyer_email) do
-        text_at_xpath("BuyerEmail")
+        text_at_xpath('BuyerEmail')
       end
 
       attribute(:shipment_service_level_category) do
-        text_at_xpath("ShipmentServiceLevelCategory")
+        text_at_xpath('ShipmentServiceLevelCategory')
       end
 
       attribute(:cba_displayable_shipping_label) do
-        text_at_xpath("CbaDisplayableShippingLabel")
+        text_at_xpath('CbaDisplayableShippingLabel')
       end
 
       attribute(:shipped_by_amazon_tfm) do
-        text_at_xpath("ShippedByAmazonTFM")
+        text_at_xpath('ShippedByAmazonTFM')
       end
 
       attribute(:tfm_shipment_status) do
-        text_at_xpath("TFMShipmentStatus")
+        text_at_xpath('TFMShipmentStatus')
       end
 
       attribute(:type) do
-        text_at_xpath("OrderType")
+        text_at_xpath('OrderType')
       end
 
       attribute(:earliest_shipped_at) do
-        time_at_xpath("EarliestShipDate")
+        time_at_xpath('EarliestShipDate')
       end
 
       attribute(:latest_shipped_at) do
-        time_at_xpath("LatestShipDate")
+        time_at_xpath('LatestShipDate')
+      end
+
+      attribute(:latest_delivered_at) do
+        time_at_xpath('LatestDeliveryDate')
+      end
+
+      def to_s
+        amazon_order_id
       end
     end
   end

data/lib/mws/orders/order_item.rb

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