peddler 0.7.9 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fa0b5d3d2a19f2c2466f3b81f8b3af63c30efe9
-  data.tar.gz: f934d8b778d1c56c5c7533f9c5d59ebf0cf06550
+  metadata.gz: ea0fdd1ff90c94773f752bd53dbf254e10bd6f1f
+  data.tar.gz: 9246c675af95a2f4def757766ac4ef58704c6988
 SHA512:
-  metadata.gz: a6ca2e943bc525e08b7e8195bdd12e5b65075dbb30bad789328e8a92fc18d59f0df035538459a091b7069a9da5e9ecb27ccdc8d910208c7ab4b26405dcdad427
-  data.tar.gz: e3f5068c70c530a2f198cdfbe571ccb7c6b119125aed38b9b132f78da568891cb2ee1bfa5867254640a0747d831b9c50438cda2132d67f51d8a221d26d73388a
+  metadata.gz: 280944799765cc755270f75c55b25637b2ca33ac88feb42aa87d18382349b3cb08423ff60bb835c133588158becc8030a3a0fdcffb62a2d1ae3c396b3023f1b7
+  data.tar.gz: eae4ebbcf5207c81ad78d343cf66741f088869a5d2153177885dd930042c1f536b72d9620c67afc721152d06f9070359f04aecccf5a17d0c89b77b88f3e9eea0

data/README.md

@@ -30,17 +30,6 @@ client = MWS.orders(
 )
 ```
 
-Or you can set them via `Client#configure`:
-
-```ruby
-client.configure do |c|
-  c.marketplace_id = 'A1F83G8C2ARO7P'
-  c.merchant_id = 'A2A9WNXCU02UZW'
-  c.aws_access_key_id = 'AKIVICHZMZ2JRSSLC27W'
-  c.aws_secret_access_key = 'rOMa3ydPBTJ3AD0bxERTOX0Fv0fAC6Q0s6/czMZO'
-end
-```
-
 Alternatively, use environment variables if you only have a single set of credentials:
 
 ```sh
@@ -86,8 +75,6 @@ The MWS Fulfillment Inventory API can help you stay up-to-date on the availabili
 
 ### Fulfillment Outbound Shipment
 
-**Partially implemented**
-
 The MWS Fulfillment Outbound Shipment API enables you to fulfill orders placed through channels other than Amazon's retail web site, using your inventory in the Amazon Fulfillment Network. You can request previews of potential fulfillment orders that return estimated shipping fees and shipping dates based on shipping speed. You can get detailed item-level, shipment-level, and order-level information for any existing fulfillment order that you specify. You can also request lists of existing fulfillment orders based on when they were fulfilled and by the fulfillment method associated with them.
 
 Support for creating and cancelling fulfillment orders has been implemented, but the rest of the API is not supported yet.
@@ -98,6 +85,12 @@ Support for creating and cancelling fulfillment orders has been implemented, but
 
 The MWS Off-Amazon Payments API helps you to process payments for purchases made by buyers on your website using the Login and Pay with Amazon service. This API enables you to programmatically retrieve shipping and payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund payments, enabling a variety of payments scenarios.
 
+You can switch the client to the sandbox environment:
+
+```ruby
+client = MWS.off_amazon_payments.sandbox
+```
+
 [Read more](http://rubydoc.info/github/hakanensari/peddler/MWS/OffAmazonPayments)
 
 ### Orders

data/lib/mws/fulfillment_outbound_shipment.rb

@@ -10,14 +10,29 @@ module MWS
   # and order-level information for any existing fulfillment order that you
   # specify. You can also request lists of existing fulfillment orders based on
   # when they were fulfilled and by the fulfillment method associated with them.
-  #
-  # @todo Not implemented
   class FulfillmentOutboundShipment < ::Peddler::Client
     path '/FulfillmentOutboundShipment/2010-10-01'
 
     # Lists fulfillment order previews
-    def get_fulfillment_preview
-      raise NotImplementedError
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_GetFulfillmentPreview.html
+    # @param address [Struct, Hash]
+    # @param items [Array<Struct, Hash>]
+    # @param opts [Hash]
+    # @option opts Array[String] :shipping_speed_categories
+    # @option opts Boolean :include_cod_fulfillment_preview
+    # @return [Peddler::XMLParser]
+    def get_fulfillment_preview(address, items, opts = {})
+      if opts.has_key?(:include_cod_fulfillment_preview)
+        opts['IncludeCODFulfillmentPreview'] = opts.delete(:include_cod_fulfillment_preview)
+      end
+
+      operation('GetFulfillmentPreview')
+        .add(opts.merge('Address' => address, 'Items' => items))
+        .structure!('Items', 'member')
+        .structure!('ShippingSpeedCategories')
+
+      run
     end
 
     # Requests that Amazon ship items from the seller's Amazon Fulfillment
@@ -30,15 +45,12 @@ module MWS
     # @param displayable_order_comment [String]
     # @param shipping_speed_category [String]
     # @param destination_address [Struct, Hash]
-    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Datatypes.html#Address
     # @params items [Array<Struct, Hash>]
-    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Datatypes.html#CreateFulfillmentOrderItem
     # @param opts [Hash]
     # @option opts [String] :fulfillment_action
     # @option opts [String] :fulfillment_policy
     # @option opts [Array<String>] :notification_email_list
     # @option opts [Struct, Hash] :cod_settings
-    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_Datatypes.html#CODSettings
     # @return [Peddler::XMLParser]
     def create_fulfillment_order(seller_fulfillment_order_id, displayable_order_id, displayable_order_date_time, displayable_order_comment, shipping_speed_category, destination_address, items, opts = {})
       if opts.has_key?(:cod_settings)
@@ -65,23 +77,64 @@ module MWS
 
     # Updates and/or requests shipment for a fulfillment order with an order
     # hold on it
-    def update_fulfillment_order
-      raise NotImplementedError
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_UpdateFulfillmentOrder.html
+    # @param seller_fulfillment_order_id [String]
+    # @param opts [Hash]
+    # @option opts [String] :fulfillment_action
+    # @option opts [String] :displayable_order_id
+    # @option opts [String, #iso8601] :displayable_order_date_time
+    # @option opts [String] :displayable_order_comment
+    # @option opts [String] :shipping_speed_category
+    # @option opts [Struct, Hash] :destination_address
+    # @option opts [String] :fulfillment_policy
+    # @option opts [Array<String>] :notification_email_list
+    # @option opts [Array<Struct, Hash>] :items
+    # @return [Peddler::XMLParser]
+    def update_fulfillment_order(seller_fulfillment_order_id, opts = {})
+      operation('UpdateFulfillmentOrder')
+        .add(opts.merge('SellerFulfillmentOrderId' => seller_fulfillment_order_id))
+        .structure!('NotificationEmailList', 'member')
+        .structure!('Items', 'member')
+
+      run
     end
 
     # Gets a fulfillment order
-    def get_fulfillment_order
-      raise NotImplementedError
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_GetFulfillmentOrder.html
+    # @param seller_fulfillment_order_id [String]
+    # @return [Peddler::XMLParser]
+    def get_fulfillment_order(seller_fulfillment_order_id)
+      operation('GetFulfillmentOrder')
+        .add('SellerFulfillmentOrderId' => seller_fulfillment_order_id)
+
+      run
     end
 
     # Returns a list of fulfillment orders fulfilled on or after a date
-    def list_all_fulfillment_orders
-      raise NotImplementedError
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_ListAllFulfillmentOrders.html
+    # @param opts [Hash]
+    # @option opts [String, #iso8601] :query_start_date_time
+    # @return [Peddler::XMLParser]
+    def list_all_fulfillment_orders(query_start_date_time = nil)
+      opts = query_start_date_time ? { 'QueryStartDateTime' => query_start_date_time } : {}
+      operation('ListAllFulfillmentOrders').add(opts)
+
+      run
     end
 
     # Returns the next page of fulfillment orders
-    def list_all_fulfillment_orders_by_next_token
-      raise NotImplementedError
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/fba_outbound/FBAOutbound_ListAllFulfillmentOrdersByNextToken.html
+    # @param next_token [String]
+    # @return [Peddler::XMLParser]
+    def list_all_fulfillment_orders_by_next_token(next_token)
+      operation('ListAllFulfillmentOrdersByNextToken')
+        .add('NextToken' => next_token)
+
+      run
     end
 
     # Returns delivery tracking information for a package in an outbound

data/lib/mws/off_amazon_payments.rb

@@ -15,6 +15,143 @@ module MWS
   class OffAmazonPayments < ::Peddler::Client
     path '/OffAmazonPayments/2013-01-01/'
 
+    # Switches the client to the sandbox environment
+    #
+    # @see https://payments.amazon.com/help/Checkout-by-Amazon/Using-the-Checkout-by-Amazon-Sandbox/Overview-of-the-Sandbox
+    # @return [self]
+    def sandbox
+      self.path = '/OffAmazonPayments_Sandbox/2013-01-01/'
+      self
+    end
+
+    # Creates an order reference for the given object
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CreateOrderReferenceForId.html
+    # @param id [String]
+    # @param id_type [String]
+    # @param opts [Hash]
+    # @option opts [Boolean] :inherit_shipping_address
+    # @option opts [Boolean] :confirm_now
+    # @return [Peddler::XMLParser]
+    def create_order_reference_for_id(id, id_type, opts = {})
+      operation('CreateOrderReferenceForId')
+        .add(opts.merge(
+          'Id' => id,
+          'IdType' => id_type
+        ))
+
+      run
+    end
+
+    # Returns details about the Billing Agreement object and its current state
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetBillingAgreementDetails.html
+    # @param amazon_billing_agreement_id [String]
+    # @param opts [Hash]
+    # @option opts [String] :address_consent_token
+    # @return [Peddler::XMLParser]
+    def get_billing_agreement_details(amazon_billing_agreement_id, opts = {})
+      operation('GetBillingAgreementDetails')
+        .add(opts.merge(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id
+        ))
+
+      run
+    end
+
+    # Sets billing agreement details such as a description of the agreement and
+    # other information about the seller
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetBillingAgreementDetails.html
+    # @param amazon_billing_agreement_id [String]
+    # @param billing_agreement_attributes [Struct, Hash]
+    # @return [Peddler::XMLParser]
+    def set_billing_agreement_details(amazon_billing_agreement_id, billing_agreement_attributes)
+      operation('SetBillingAgreementDetails')
+        .add(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id,
+          'BillingAgreementAttributes' => billing_agreement_attributes
+        )
+
+      run
+    end
+
+    # Confirms that the billing agreement is free of constraints and all
+    # required information has been set on the billing agreement
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmBillingAgreement.html
+    # @param amazon_billing_agreement_id [String]
+    # @return [Peddler::XMLParser]
+    def confirm_billing_agreement(amazon_billing_agreement_id)
+      operation('ConfirmBillingAgreement')
+        .add(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id
+        )
+
+      run
+    end
+
+    # Validates the status of the BillingAgreement object and the payment method
+    # associated with it
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ValidateBillingAgreement.html
+    # @param amazon_billing_agreement_id [String]
+    # @return [Peddler::XMLParser]
+    def validate_billing_agreement(amazon_billing_agreement_id)
+      operation('ValidateBillingAgreement')
+        .add(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id
+        )
+
+      run
+    end
+
+    # Reserves a specified amount against the payment method(s) stored in the
+    # billing agreement
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_AuthorizeOnBillingAgreement.html
+    # @param amazon_billing_agreement_id [String]
+    # @param authorization_reference_id [String]
+    # @param authorization_amount [Hash, Struct]
+    # @param opts [Hash]
+    # @option opts [String] :seller_authorization_note
+    # @option opts [Integer] :transaction_timeout
+    # @option opts [Boolean] :capture_now
+    # @option opts [String] :soft_descriptor
+    # @option opts [String] :seller_note
+    # @option opts [String] :platform_id
+    # @option opts [Hash, Struct] :seller_order_attributes
+    # @option opts [Boolean] :inherit_shipping_address
+    # @return [Peddler::XMLParser]
+    def authorize_on_billing_agreement(amazon_billing_agreement_id, authorization_reference_id, authorization_amount, opts = {})
+      operation('AuthorizeOnBillingAgreement')
+        .add(opts.merge(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id,
+          'AuthorizationReferenceId' => authorization_reference_id,
+          'AuthorizationAmount' => authorization_amount
+        ))
+
+      run
+    end
+
+    # Confirms that you want to terminate the billing agreement with the buyer
+    # and that you do not expect to create any new order references or
+    # authorizations on this billing agreement
+    #
+    # @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_CloseBillingAgreement.html
+    # @param amazon_billing_agreement_id [String]
+    # @param opts [Hash]
+    # @option opts [String] :closure_reason
+    # @return [Peddler::XMLParser]
+    def close_billing_agreement(amazon_billing_agreement_id, opts = {})
+      operation('CloseBillingAgreement')
+        .add(opts.merge(
+          'AmazonBillingAgreementId' => amazon_billing_agreement_id
+        ))
+
+      run
+    end
+
     # Sets order reference details such as the order total and a description for
     # the order
     #

data/lib/peddler/client.rb

@@ -22,6 +22,7 @@ module Peddler
       'ATVPDKIKX0DER'  => 'mws.amazonservices.com'
     }
 
+    attr_accessor :path
     attr_writer :merchant_id, :marketplace_id
     attr_reader :body
 
@@ -42,7 +43,7 @@ module Peddler
     end
 
     def aws_endpoint
-      "https://#{host}#{self.class.path}"
+      "https://#{host}#{self.path || self.class.path}"
     end
 
     def marketplace_id

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.7.9'
+  VERSION = '0.7.10'
 end

data/test/unit/mws/test_off_amazon_payments.rb

@@ -0,0 +1,9 @@
+require 'helper'
+require 'mws/products'
+
+class MWSOffAmazonPaymentsTest < MiniTest::Test
+  def test_sandbox
+    client = MWS::OffAmazonPayments.new(marketplace_id: 'A1F83G8C2ARO7P').sandbox
+    assert_includes client.aws_endpoint, 'OffAmazonPayments_Sandbox'
+  end
+end

data/test/unit/peddler/test_client.rb

@@ -33,6 +33,13 @@ class PeddlerClientTest < MiniTest::Test
     assert @client.aws_endpoint.match(%r{/Foo$})
   end
 
+  def test_instance_path_overrides_class_path
+    @klass.path('/Foo')
+
+    @client.path = '/Foo/Bar'
+    assert @client.aws_endpoint.match(%r{/Foo/Bar$})
+  end
+
   def test_default_path
     assert_equal '/', @klass.path
   end

data/test/unit/peddler/test_structured_list.rb

@@ -16,6 +16,13 @@ class PeddlerStructuredListTest < MiniTest::Test
     assert_equal exp, @list.build(%w(foo bar))
   end
 
+  def test_handles_single_key
+    list = Peddler::StructuredList.new('Foo')
+    exp = { 'Foo.1' => 'bar' }
+
+    assert_equal exp, list.build('bar')
+  end
+
   def test_handles_more_than_two_keys
     list = Peddler::StructuredList.new('QueryList', 'Query', '1', 'FilterOptions', 'FilterOption')
     exp = { 'QueryList.Query.1.FilterOptions.FilterOption.1' => 'foo' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff
@@ -170,6 +170,7 @@ files:
 - test/integration_helper.rb
 - test/mws.yml
 - test/mws.yml.example
+- test/unit/mws/test_off_amazon_payments.rb
 - test/unit/mws/test_products.rb
 - test/unit/peddler/test_client.rb
 - test/unit/peddler/test_flat_file_parser.rb
@@ -192,7 +193,8 @@ files:
 - test/vcr_cassettes/Sellers.yml
 - test/vcr_cassettes/Subscriptions.yml
 homepage: http://github.com/hakanensari/peddler
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -232,6 +234,7 @@ test_files:
 - test/integration_helper.rb
 - test/mws.yml
 - test/mws.yml.example
+- test/unit/mws/test_off_amazon_payments.rb
 - test/unit/mws/test_products.rb
 - test/unit/peddler/test_client.rb
 - test/unit/peddler/test_flat_file_parser.rb