peddler 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b895fd9d95067954cbd73695cb806cf00ef7d67
-  data.tar.gz: 4b5b4859c729b127b8c753cce4904f624a0ae912
+  metadata.gz: c7ac83135cc31198b41fceb4be3028d9944e702a
+  data.tar.gz: 5a48846777e07c4eb00cd068a81ca08586074a25
 SHA512:
-  metadata.gz: c04561373d334ad22ff43f3dc8a9fe6ebb69fcd37a5d359d6d46dce1650582094fc698a2af482d29db0447d891da9300f1557b92943da5507d66ce0c72f16583
-  data.tar.gz: 8a3bd3bfefb7c156858c025375d86c87a7b999e09798083ac6e047b7b1dedc297b3f86b3d73d1da524bf24dd3f4eaedf8796bc7573ff584b7274550028d67de3
+  metadata.gz: ff2c5463b8af1784df36c2040f1f149b8c80d9c0dc4f57ec2a1ed3a9550c72d3e9a9725a3c09061458ef33abb0bce0b7be30ad6bbbcddaf7c1c5a11a9a3c58a7
+  data.tar.gz: 9148086d4d91c67a83be7a999da65dd492b6db60d08c704ce58286fff11f7a25e73cbddd477b25957a42f329b15b4459c1e3df11590f39239554268d34ff9b0d

data/README.md

@@ -11,33 +11,40 @@ To use Amazon MWS, you must have an eligible seller account.
 
 ![Peddler](http://f.cl.ly/items/231z2m0r1Q2o2q1n0w1N/peddler.jpg)
 
-## Configuration
+## Scope
 
-Require the library and instantiate a client:
+**Peddler** maps one on one to the MWS APIs and their various operations. It treats required request parameters as ordinary arguments and optional ones as keyword arguments. It parses XML responses with [**MultiXml**](https://github.com/sferik/multi_xml), which helps cast the result nodes into Ruby Hashes. Tab-delimited files are handled with Standard Library's [**CSV**](https://github.com/ruby/ruby/blob/trunk/lib/csv.rb).
+
+Further abstraction is not in the scope of this project. See [**MWS Orders**](https://github.com/hakanensari/mws-orders) for a richer interface to the same-named API, built on **Peddler**.
+
+## Quick Start
 
 ```ruby
 require 'peddler'
+
 client = MWS.orders
+parser = client.list_orders(created_after: 1.month.ago)
+parser.parse
 ```
 
 You can set up credentials when instantiating:
 
 ```ruby
 client = MWS.orders(
-  marketplace_id: 'A1F83G8C2ARO7P',
-  merchant_id: 'A2A9WNXCU02UZW',
-  aws_access_key_id: 'AKIVICHZMZ2JRSSLC27W',
-  aws_secret_access_key: 'rOMa3ydPBTJ3AD0bxERTOX0Fv0fAC6Q0s6/czMZO'
+  marketplace_id:        "YOUR_MARKETPLACE_ID",
+  merchant_id:           "YOUR_MERCHANT_ID",
+  aws_access_key_id:     "YOUR_AWS_ACCESS_KEY_ID",
+  aws_secret_access_key: "YOUR_AWS_SECRET_ACCESS_KEY"
 )
 ```
 
-Alternatively, use environment variables if you only have a single set of credentials:
+Alternatively, you can use environment variables if you only have a single set of credentials:
 
 ```sh
-export MWS_MARKETPLACE_ID="A1F83G8C2ARO7P"
-export MWS_MERCHANT_ID="A2A9WNXCU02UZW"
-export AWS_ACCESS_KEY_ID="AKIVICHZMZ2JRSSLC27W"
-export AWS_SECRET_ACCESS_KEY="rOMa3ydPBTJ3AD0bxERTOX0Fv0fAC6Q0s6/czMZO"
+export MWS_MARKETPLACE_ID=YOUR_MARKETPLACE_ID
+export MWS_MERCHANT_ID=YOUR_MERCHANT_ID
+export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
+export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
 ```
 
 ## Usage

data/lib/mws/fulfillment_outbound_shipment/client.rb

@@ -142,7 +142,7 @@ module MWS
       # Returns delivery tracking information for a package in an outbound
       # shipment for a Multi-Channel Fulfillment order
       def get_package_tracking_details
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       # Requests that Amazon stop attempting to fulfill an existing fulfillment

data/lib/mws/reports/client.rb

@@ -186,7 +186,7 @@ module MWS
       # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleListByNextToken.html
       # @raise [NotImplementedError]
       def get_report_schedule_list_by_next_token(*)
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       # Count scheduled reports

data/lib/peddler/client.rb

@@ -23,13 +23,21 @@ module Peddler
     }
 
     attr_accessor :path
-    attr_writer :merchant_id, :marketplace_id, :parser
+    attr_writer :merchant_id, :marketplace_id
     attr_reader :body
 
     alias_method :configure, :tap
 
     params('SellerId' => -> { merchant_id })
 
+    def self.parser
+      @parser ||= Parser
+    end
+
+    def self.parser=(parser)
+      @parser = parser
+    end
+
     def self.path(path = nil)
       path ? @path = path : @path ||= '/'
     end
@@ -54,8 +62,8 @@ module Peddler
       @merchant_id ||= ENV['MWS_MERCHANT_ID']
     end
 
-    def parser
-      @parser ||= Parser
+    def defaults
+      @defaults ||= { expects: 200 }
     end
 
     def headers
@@ -72,7 +80,7 @@ module Peddler
     end
 
     def run(&blk)
-      opts = { query: operation, headers: headers, expects: 200 }
+      opts = defaults.merge(query: operation, headers: headers)
       opts.store(:body, body) if body
       opts.store(:response_block, blk) if block_given?
       res = post(opts)
@@ -103,11 +111,15 @@ module Peddler
     end
 
     def host
-      HOSTS.fetch(marketplace_id) { fail BadMarketplaceId }
+      HOSTS.fetch(marketplace_id) { raise BadMarketplaceId }
     end
 
     def extract_options(args)
       args.last.is_a?(Hash) ? args.pop : {}
     end
+
+    def parser
+      self.class.parser
+    end
   end
 end

data/lib/peddler/version.rb

@@ -1,3 +1,3 @@
 module Peddler
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/test/unit/peddler/test_client.rb

@@ -13,14 +13,12 @@ class TestPeddlerClient < MiniTest::Test
     Excon.stub({}, body: @body, status: 200)
 
     @klass = Class.new(Peddler::Client)
+    @klass.parser = Parser
     @client = @klass.new
-
     @client.aws_access_key_id = 'key'
     @client.aws_secret_access_key = 'secret'
     @client.merchant_id = 'seller'
     @client.marketplace_id = 'ATVPDKIKX0DER' # US
-    @client.parser = Parser
-
     @client.operation('Foo')
   end
 
@@ -116,4 +114,23 @@ class TestPeddlerClient < MiniTest::Test
 
     assert_equal @body, chunks
   end
+
+  def test_request_preserves_user_agent
+    instrumentor = Class.new
+    class << instrumentor
+      attr_accessor :events
+
+      def instrument(name, params = {})
+        events.update(name => params)
+        yield if block_given?
+      end
+    end
+    instrumentor.events = {}
+
+    @client.defaults.update(instrumentor: instrumentor)
+    @client.run
+    headers = instrumentor.events['excon.request'][:headers]
+
+    assert headers.has_key?('User-Agent')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeff