mws-orders 0.0.1

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

@@ -0,0 +1,32 @@
+module MWS
+  module Orders
+    module Parser
+      class ServiceStatus < Model
+        value :status do
+          text_at_xpath('Status')
+        end
+
+        value :timestamp do
+          time_at_xpath('Timestamp')
+        end
+
+        value :message_id do
+          text_at_xpath('MessageId')
+        end
+
+        value :messages do
+          xpath('Messages/Message').map { |node| ServiceStatusMessage.new(node) }
+        end
+
+        def ok?
+          status == 'GREEN'
+        end
+
+        def inspect
+          status
+        end
+        alias :to_s :inspect
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module MWS
+  module Orders
+    module Parser
+      class ServiceStatusMessage < Model
+        value :locale do
+          text_at_xpath('Locale')
+        end
+
+        value :text do
+          text_at_xpath('Text')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module MWS
+  module Orders
+    module Parser
+      class ShippingAddress < Model
+        value :name do
+          text_at_xpath('Name')
+        end
+
+        value :address_lines do
+          1.upto(3).map { |i| text_at_xpath("AddressLine#{i}") }.compact
+        end
+
+        value :city do
+          text_at_xpath('City')
+        end
+
+        value :state_or_region do
+          text_at_xpath('StateOrRegion')
+        end
+
+        value :postal_code do
+          text_at_xpath('PostalCode')
+        end
+
+        value :country_code do
+          text_at_xpath('CountryCode')
+        end
+
+        value :phone do
+          text_at_xpath('Phone')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module MWS
+  module Orders
+    module Request
+      class Base
+        attr :client
+        attr_accessor :last_response
+
+        def initialize(client)
+          @client = client
+        end
+
+        def next_token
+          node = document.at_xpath('//xmlns:NextToken')
+          node.text if node
+        end
+
+        private
+
+        def execute
+          fetch
+          parse
+        end
+
+        def fetch
+          @last_response = client.post(query: parameters)
+        end
+
+        def parameters(action = nil)
+          @parameters = Helper::Parameters.new(action) if action
+          @parameters
+        end
+
+        def parse
+          parser.new(node)
+        end
+
+        def parser
+          Parser.const_get(name)
+        end
+
+        def node
+          document.xpath("//xmlns:#{name}")
+        end
+
+        def document
+          Nokogiri::XML(last_response.body)
+        end
+
+        def name
+          self.class.name.split('::').last
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module MWS
+  module Orders
+    module Request
+      class OrderItems < Base
+        def list(amazon_order_id)
+          parameters(:list_order_items)
+            .update(amazon_order_id: amazon_order_id)
+            .camelize_keys!
+
+          execute
+        end
+
+        def list_by_next_token
+          parameters(:list_order_items_by_next_token)
+            .update(next_token: next_token)
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/orders/requests/orders.rb

@@ -0,0 +1,36 @@
+module MWS
+  module Orders
+    module Request
+      class Orders < Base
+        def get(*amazon_order_ids)
+          parameters(:get_order)
+            .update(amazon_order_id: amazon_order_ids)
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+
+        def list(options)
+          options[:marketplace_id] ||= client.home_marketplace_id
+
+          parameters(:list_orders)
+            .update(options)
+            .timestamp!
+            .format_structured_lists!
+            .camelize_keys!
+
+          execute
+        end
+
+        def list_by_next_token
+          parameters(:list_orders_by_next_token)
+            .update(next_token: next_token)
+            .camelize_keys!
+
+          execute
+        end
+      end
+    end
+  end
+end

data/lib/mws/orders/requests/service_status.rb

@@ -0,0 +1,18 @@
+module MWS
+  module Orders
+    module Request
+      class ServiceStatus < Base
+        def get
+          parameters(:get_service_status)
+          execute
+        end
+
+        private
+
+        def node
+          document.xpath("//xmlns:GetServiceStatusResult")
+        end
+      end
+    end
+  end
+end

data/lib/mws/orders/version.rb

@@ -0,0 +1,5 @@
+module MWS
+  module Orders
+    VERSION = '0.0.1'
+  end
+end

data/lib/mws-orders.rb

@@ -0,0 +1,29 @@
+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'

data/test/fixtures/mws.yml

@@ -0,0 +1,12 @@
+- country: US
+  aws_access_key_id: AKIAJOD3NLXHOMANRNQQ
+  aws_secret_access_key: 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
+  seller_id: A2JYSO6W6KEP83
+- country: GB
+  aws_access_key_id: AKIAJJDQ2MJTMPXKJE4A
+  aws_secret_access_key: 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
+  seller_id: A2D9DZ30GEWP6N
+- country: JP
+  aws_access_key_id: AKIAJ5RDDSRROM6GXQ5Q
+  aws_secret_access_key: WGPMtwkUvlRXg22byoI+ceXyhnDQOMozUoFmsHzW
+  seller_id: A7BU5WGNVGQ1I

data/test/fixtures/mws.yml.example

@@ -0,0 +1,4 @@
+- country: GB
+  aws_access_key_id: foo
+  aws_secret_access_key: bar
+  seller_id: baz

data/test/fixtures/order_items.xml

@@ -0,0 +1,83 @@
+<?xml version="1.0"?>
+<ListOrderItemsResponse xmlns="https://mws.amazonservices.com
+/Orders/2011-01-01">
+  <ListOrderItemsResult>
+    <NextToken>MRgZW55IGNhcm5hbCBwbGVhc3VyZS6=</NextToken>
+    <AmazonOrderId>058-1233752-8214740</AmazonOrderId>
+    <OrderItems>
+      <OrderItem>
+        <ASIN>BT0093TELA</ASIN>
+        <OrderItemId>68828574383266</OrderItemId>
+        <SellerSKU>CBA_OTF_1</SellerSKU>
+        <Title>Example item name</Title>
+        <QuantityOrdered>1</QuantityOrdered>
+        <QuantityShipped>1</QuantityShipped>
+        <PromotionIds>
+          <PromotionId>SSOF SSS-25</PromotionId>
+        </PromotionIds>
+        <ItemPrice>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>25.99</Amount>
+        </ItemPrice>
+        <ItemTax>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>0.00</Amount>
+        </ItemTax>
+        <ShippingPrice>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>1.26</Amount>
+        </ShippingPrice>
+        <ShippingTax>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>0.00</Amount>
+        </ShippingTax>
+        <PromotionDiscount>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>0.00</Amount>
+        </PromotionDiscount>
+        <ShippingDiscount>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>0.00</Amount>
+        </ShippingDiscount>
+        <ScheduledDeliveryEndDate>2013-01-01T01:30:00.000-06:00
+        </ScheduledDeliveryEndDate>
+        <ScheduledDeliveryStartDate>2012-12-31T02:00:00.000-06:00
+        </ScheduledDeliveryStartDate>
+        <CODFee>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>10.00</Amount>
+        </CODFee>
+        <CODFeeDiscount>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>1.00</Amount>
+        </CODFeeDiscount>
+        <GiftMessageText>For you!</GiftMessageText>
+        <GiftWrapPrice>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>1.99</Amount>
+        </GiftWrapPrice>
+        <GiftWrapLevel>Classic</GiftWrapLevel>
+      </OrderItem>
+      <OrderItem>
+        <ASIN>BCTU1104UEFB</ASIN>
+        <OrderItemId>79039765272157</OrderItemId>
+        <SellerSKU>CBA_OTF_5</SellerSKU>
+        <Title>Example item name</Title>
+        <QuantityOrdered>2</QuantityOrdered>
+        <ItemPrice>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>17.95</Amount>
+        </ItemPrice>
+        <PromotionIds>
+          <PromotionId>FREESHIP</PromotionId>
+        </PromotionIds>
+        <ConditionId>Used</ConditionID>
+        <ConditionSubtypeId>Mint</ConditionSubtypeId>
+        <ConditionNote>Example ConditionNote</ConditionNote>
+      </OrderItem>
+    </OrderItems>
+  </ListOrderItemsResult>
+  <ResponseMetadata>
+    <RequestId>88faca76-b600-46d2-b53c-0c8c4533e43a</RequestId>
+  </ResponseMetadata>
+</ListOrderItemsResponse>

data/test/fixtures/orders.xml

@@ -0,0 +1,109 @@
+<?xml version="1.0"?>
+<ListOrdersResponse xmlns="https://mws.amazonservices.com/Orders/2011-01-01">
+  <ListOrdersResult>
+    <NextToken>2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=</NextToken>
+    <LastUpdatedBefore>2010-10-05T18%3A12%3A20.687Z</LastUpdatedBefore>
+    <Orders>
+      <Order>
+        <AmazonOrderId>058-1233752-8214740</AmazonOrderId>
+        <PurchaseDate>2010-10-05T00%3A06%3A07.000Z</PurchaseDate>
+        <LastUpdateDate>2010-10-05T12%3A43%3A16.000Z</LastUpdateDate>
+        <OrderStatus>Unshipped</OrderStatus>
+        <OrderType>StandardOrder</OrderType>
+        <SalesChannel>Checkout by Amazon</SalesChannel>
+        <ShipServiceLevel>Std DE Dom</ShipServiceLevel>
+        <FulfillmentChannel>MFN</FulfillmentChannel>
+        <OrderTotal>
+          <CurrencyCode>USD</CurrencyCode>
+          <Amount>111.01</Amount>
+        </OrderTotal>
+        <ShippingAddress>
+          <Name>John Smith</Name>
+          <AddressLine1>2700 First Avenue</AddressLine1>
+          <City>Seattle</City>
+          <StateOrRegion>WA</StateOrRegion>
+          <PostalCode>98102</PostalCode>
+          <CountryCode>US</CountryCode>
+        </ShippingAddress>
+        <NumberOfItemsShipped>0</NumberOfItemsShipped>
+        <NumberOfItemsUnshipped>1</NumberOfItemsUnshipped>
+        <PaymentExecutionDetail>
+          <PaymentExecutionDetailItem>
+            <Payment>
+              <CurrencyCode>USD</CurrencyCode>
+              <Amount>101.01</Amount>
+            </Payment>
+            <PaymentMethod>COD</PaymentMethod>
+          </PaymentExecutionDetailItem>
+          <PaymentExecutionDetailItem>
+            <Payment>
+              <CurrencyCode>USD</CurrencyCode>
+              <Amount>10.00</Amount>
+            </Payment>
+            <PaymentMethod>GC</PaymentMethod>
+          </PaymentExecutionDetailItem>  
+        </PaymentExecutionDetail>
+        <PaymentMethod>COD</PaymentMethod>
+        <MarketplaceId>ATVPDKIKX0DER</MarketplaceId>
+        <BuyerName>Amazon User</BuyerName>
+        <BuyerEmail>5vlh04mgfmjh9h5@marketplace.amazon.com</BuyerEmail>
+        <ShipmentServiceLevelCategory>Standard
+        </ShipmentServiceLevelCategory>
+      </Order>
+      <Order>
+        <ShipmentServiceLevelCategory>Standard
+        </ShipmentServiceLevelCategory>
+        <OrderTotal>
+          <Amount>10.87</Amount>
+          <CurrencyCode>USD</CurrencyCode>
+        </OrderTotal>
+        <FulfillmentChannel>MFN</FulfillmentChannel>
+        <BuyerEmail>1x3v628skdi34u2@marketplace.amazon.com</BuyerEmail>
+        <OrderStatus>Pending</OrderStatus>
+        <BuyerName>Example Name</BuyerName>
+        <ShipServiceLevel>Std US Dom</ShipServiceLevel>
+        <CbaDisplayableShippingLabel>Example shipment service level
+        </CbaDisplayableShippingLabel>
+        <LastUpdateDate>2012-10-11T15:53:37Z</LastUpdateDate>
+        <PurchaseDate>2012-10-11T14:15:55Z</PurchaseDate>
+        <EarliestShipDate>2012-10-13T05:00:00Z</EarliestShipDate>
+        <LatestShipDate>2012-10-15T07:59:59Z</LatestShipDate>
+        <OrderType>Preorder</OrderType>
+        <NumberOfItemsUnshipped>0</NumberOfItemsUnshipped>
+        <MarketplaceId>ATVPDKIKX0DER</MarketplaceId>
+        <SalesChannel>Amazon.com</SalesChannel>
+        <ShippingAddress>
+          <Phone>111 222 1234</Phone>
+          <PostalCode>48823</PostalCode>
+          <Name>Example Name</Name>
+          <CountryCode>US</CountryCode>
+          <StateOrRegion>WA</StateOrRegion>
+          <AddressLine1>1234 Ridge Rd</AddressLine1>
+          <City>Seattle</City>
+        </ShippingAddress>
+        <NumberOfItemsShipped>1</NumberOfItemsShipped>
+        <AmazonOrderId>123-1234567-4567890</AmazonOrderId>
+        <PaymentMethod>Other</PaymentMethod>
+      </Order>
+      <Order>
+        <ShipmentServiceLevelCategory>Standard
+        </ShipmentServiceLevelCategory>
+        <FulfillmentChannel>MFN</FulfillmentChannel>
+        <OrderStatus>Pending</OrderStatus>
+        <OrderType>StandardOrder</OrderType>
+        <ShipServiceLevel>Std US Dom</ShipServiceLevel>
+        <LastUpdateDate>2012-10-12T20:34:00Z</LastUpdateDate>
+        <PurchaseDate>2012-10-12T20:33:16Z</PurchaseDate>
+        <NumberOfItemsUnshipped>0</NumberOfItemsUnshipped>
+        <MarketplaceId>ATVPDKIKX0DER</MarketplaceId>
+        <SalesChannel>Amazon.com</SalesChannel>
+        <NumberOfItemsShipped>0</NumberOfItemsShipped>
+        <AmazonOrderId>123-9876543-6543212</AmazonOrderId>
+        <PaymentMethod>Other</PaymentMethod>
+      </Order>
+    </Orders>
+  </ListOrdersResult>
+  <ResponseMetadata>
+    <RequestId>88faca76-b600-46d2-b53c-0c8c4533e43a</RequestId>
+  </ResponseMetadata>
+</ListOrdersResponse>

data/test/fixtures/service_status.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<GetServiceStatusResponse
+xmlns="https://mws.amazonservices.com/Orders/2011-01-01">
+  <GetServiceStatusResult>
+    <Status>GREEN_I</Status>
+    <Timestamp>2010-09-24T21:38:09.676Z</Timestamp>
+    <MessageId>173964729I</MessageId>
+    <Messages>
+      <Message>
+        <Locale>en_US</Locale>
+        <Text>We are experiencing high latency in UK because of heavy
+traffic.</Text>
+      </Message>
+    </Messages>
+  </GetServiceStatusResult>
+  <ResponseMetadata>
+    <RequestId>d80c6c7b-f7c7-4fa7-bdd7-854711cb3bcc</RequestId>
+  </ResponseMetadata>
+</GetServiceStatusResponse>

data/test/helpers/parameters_test.rb

@@ -0,0 +1,34 @@
+require_relative '../test_helper'
+
+class ParametersHelperTest < MiniTest::Test
+  def setup
+    @parameters = Helper::Parameters.new(:do_it)
+  end
+
+  def test_has_an_action_key
+    assert_equal 'DoIt', @parameters.fetch('Action')
+  end
+
+  def test_formats_timestamps
+    ts = Minitest::Mock.new
+    ts.expect(:iso8601, 'formatted')
+    @parameters.store('a timestamp', ts)
+    assert_equal 'formatted', @parameters.timestamp!.fetch('a timestamp')
+  end
+
+  def test_formats_structured_lists
+    @parameters.store(:order_status, 'foo')
+    assert_equal 'foo', @parameters.format_structured_lists!.fetch('OrderStatus.Status.1')
+  end
+
+  def test_camelizes_keys
+    @parameters.store(:underscored_key, 'baz')
+    refute @parameters.camelize_keys!.has_key?(:underscored_key)
+    assert @parameters.has_key?('UnderscoredKey')
+  end
+
+  def test_updates_delegated_hash
+    assert_kind_of Helper::Parameters, @parameters.update(key: 'value')
+    assert_equal 'value', @parameters.fetch(:key)
+  end
+end

data/test/helpers/structured_list_test.rb

@@ -0,0 +1,17 @@
+require_relative '../test_helper'
+
+class StructuredListHelperTest < MiniTest::Test
+  def setup
+    @structured_list = Helper::StructuredList.new(:order_status)
+  end
+
+  def test_builds_a_structured_list_for_a_single_value
+    exp = { 'OrderStatus.Status.1' => 'foo' }
+    assert_equal(exp, @structured_list.build('foo'))
+  end
+
+  def test_builds_a_structured_list_for_an_array_of_values
+    exp = { 'OrderStatus.Status.1' => 'foo', 'OrderStatus.Status.2' => 'bar' }
+    assert_equal(exp, @structured_list.build(%w(foo bar)))
+  end
+end

data/test/integration/order_items_test.rb

@@ -0,0 +1,16 @@
+require_relative 'test_helper'
+
+class OrderItemsTest < IntegrationTest
+  def sample_amazon_order_id(client)
+    order = client.list_orders(created_after: Date.today - 365).to_a.sample
+    order.amazon_order_id
+  end
+
+  def list_order_items
+    @clients.each do |client|
+      amazon_order_id = sample_amazon_order_id(client)
+      order_items = client.list_order_items(amazon_order_id)
+      refute_empty order_items
+    end
+  end
+end

data/test/integration/orders_test.rb

@@ -0,0 +1,17 @@
+require_relative 'test_helper'
+
+class OrdersTest < IntegrationTest
+  def test_lists_and_gets_orders
+    @clients.each do |client|
+      amazon_order_ids = []
+      orders = client.list_orders(created_after: Date.today - 365)
+      amazon_order_ids << orders.to_a.sample.amazon_order_id
+
+      orders = client.list_orders_by_next_token
+      amazon_order_ids << orders.to_a.sample.amazon_order_id
+
+      orders = client.get_order(*amazon_order_ids)
+      assert orders
+    end
+  end
+end

data/test/integration/service_status_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+class ServiceStatusTest < IntegrationTest
+  def test_gets_service_status
+    @clients.each do |client|
+      assert client.get_service_status
+    end
+  end
+end

data/test/integration/test_helper.rb

@@ -0,0 +1,12 @@
+require_relative '../test_helper'
+require 'yaml'
+
+class IntegrationTest < MiniTest::Test
+  def accounts
+    YAML.load_file(File.expand_path('../../fixtures/mws.yml', __FILE__))
+  end
+
+  def setup
+    @clients = accounts.map { |mws| Client.new(*mws.values) }
+  end
+end

data/test/parsers/collection_test.rb

@@ -0,0 +1,7 @@
+require_relative 'test_helper'
+
+class CollectionParserTest < ParserTest
+  def test_is_enumerable
+    assert_respond_to Parser::Collection.new(nil), :map
+  end
+end

data/test/parsers/model_test.rb

@@ -0,0 +1,27 @@
+require_relative 'test_helper'
+
+class ModelParserTest < ParserTest
+  def test_parses_money
+    xml = <<-EOF
+    <Price xmlns="example">
+      <CurrencyCode>USD</CurrencyCode>
+      <Amount>10.00</Amount>
+    </Price>
+    EOF
+    model = Parser::Model.new(Nokogiri(xml))
+    money = model.money_at_xpath('Price')
+    assert_equal '$10.00', money.format
+  end
+
+  def test_parses_japanese_yen
+    xml = <<-EOF
+    <Price xmlns="example">
+      <CurrencyCode>JPY</CurrencyCode>
+      <Amount>1000.00</Amount>
+    </Price>
+    EOF
+    model = Parser::Model.new(Nokogiri(xml))
+    money = model.money_at_xpath('Price')
+    assert_equal '¥1,000', money.format
+  end
+end