ruby-mws 0.0.3 → 0.0.4

data/.gitignore

@@ -4,4 +4,5 @@ Gemfile.lock
 pkg/*
 .DS_Store
 spec/credentials.yml
-spec/fixtures/ephemeral_response/*
+spec/fixtures/ephemeral_response/*
+.rvmrc

data/README.markdown

@@ -1,41 +1,48 @@
 ruby-mws
 ========
 
-Under development
------------------
+by Erik Lyngved
 
-This is a Ruby gem that wraps the Amazon Marketplace Web Service (MWS) API. It is still missing many features, but some basic requests are available.
+### Read me!
 
-Please use at your own risk. This has not been tested thoroughly and is not guaranteed to work in any capacity. See the LICENSE file for more details.
+ruby-mws is a Ruby gem that wraps the Amazon Marketplace Web Service (MWS) API. Right now it only supports Amazon's Order and Inventory APIs.
+
+I made this gem for my own purposes, and it's not fully featured. Pull requests or bug reports are always welcome.
 
 Quick Start
 -----------
 
-### Initialize the connection object
+To quickly test your connection to the service without credentials, you can ping the server, which returns server time in UTC:
+
+    MWS::Base.server_time
+
+### Initialization
 
 Pass in your developer account credentials. All four params below are required.
 
-    mws = MWS.new {:aws_access_key_id => "AKIAIFKEXAMPLE4WZHHA",
+    mws = MWS.new (:aws_access_key_id => "AKIAIFKEXAMPLE4WZHHA",
       :secret_access_key => "abc123def456/SECRET/+ghi789jkl",
       :seller_id => "A27WEXAMPLEBXY",
-      :marketplace_id => "ATVPDKIKX0DER"}
+      :marketplace_id => "ATVPDKIKX0DER")
 
-### Make a request
+### Requests
 
-Let's use the Orders API to retrieve recently updated orders.
+We'll use the Orders API to retrieve recently updated orders.
 
     # Retrieve all orders updated within the last 4 hours
-    response = mws.orders.list_orders :last_updated_after => Time.now-4.hours   # Rails helper used
+    response = mws.orders.list_orders :last_updated_after => 4.hours.ago   # ActiveSupport time helper
 
 (All datetime fields accept Time or DateTime objects, as well as strings in iso8601 format.)
 
-### Parse the response
+### Responses
 
-We can parse our response to view the orders and any other data returned.
+Response objects inherit [Hashie](http://github.com/intridea/hashie) for easy access and [Rash](http://github.com/tcocca/rash) to convert Amazon's CamelCase convention to underscore. So you're just left with plain ol' Ruby goodness.
+
+Let's parse our response to view the orders and any other data returned.
 
     response.orders.first   # => { "amazon_order_id" => "002-EXAMPLE-0031387",
-                                   "purchase_date" => "2012-01-13T19:11:46.000Z",
-                                   ... }
+                            #      "purchase_date" => "2012-01-13T19:11:46.000Z",
+                            #      ... }
 
 Response objects are accessible in Hash or method notation.
 
@@ -50,35 +57,31 @@ Use `keys` and `has_key?` to discover what's in the response.
 
 For responses with long lists of data, results are returned from the service in pages (usually 100 per page). Example:
 
-    response = mws.orders.list_orders :last_updated_after => Time.now-1.week   # returns 100 orders
+    response = mws.orders.list_orders :last_updated_after => 1.week.ago   # returns 100 orders & next_token
 
 Here, there are more orders to be returned. You can call `has_next?` on the same API instance to see if the last response returned has a next page. If so, calling `next` will make the request for the next page.
 
     mws.orders.has_next?   # => true
     next_response = mws.orders.next   # returns next page of orders
 
-You can keep calling `next` on the API instance as long as `has_next?` returns true.
-
-You can always go about the manual way as per Amazon's docs:
-
-    next_response = mws.orders.list_orders_by_next_response :next_token => response.next_token
+Repeat as necessary. You can keep calling `next` on the API instance as long as `has_next?` returns true.
 
-### Underscore notation
+Or if you need to, you can save the next_token and go about the manual way as per Amazon's docs:
 
-ruby-mws wraps Amazon's CamelCase convention with Ruby-friendly underscore notation. This goes for request names and params, as well as response field names.
+    next_response = mws.orders.list_orders_by_next_token :next_token => response.next_token
 
-Available Requests
-------------------
+API
+---
 
-    @mws = MWS.new(authentication_hash)   # initialize the connection object
+    @mws = MWS.new(authentication_hash)   # initialize the connection object (see above)
 
 This object can be used to access all API services. Below are examples on how to make the different requests that are available so far. Refer to the [Amazon MWS Reference Docs](https://developer.amazonservices.com/) for available fields for each request.
 
 ### Orders API
 
-* ListOrders - gets orders by time frame and other parameters
+* ListOrders - gets orders by time range and other parameters
 
-    `@mws.orders.list_orders :last_updated_after => Time.now-4.hours`
+    `@mws.orders.list_orders :last_updated_after => Time.now-4.hours, :order_status => 'Shipped'`
 
 * GetOrder - gets orders by Amazon order ID
 
@@ -86,7 +89,7 @@ This object can be used to access all API services. Below are examples on how to
 
     `:amazon_order_id` can be an array to retrieve multiple orders.
 
-* ListOrderItems - gets order items for one order ID
+* ListOrderItems - gets order items for one order ID (only one order at a time here)
 
     `@mws.orders.list_order_items :amazon_order_id => "002-EXAMPLE-0031387"`
 
@@ -94,5 +97,5 @@ This object can be used to access all API services. Below are examples on how to
 
 * ListInventorySupply - returns availability of inventory, only returns items based on list of SKUs or last change date
 
-    `@mws.inventory.list_inventory_supply :seller_skus => %w[PF-5VZN-04XR V4-03EY-LAL1 OC-TUKC-031P`
+    `@mws.inventory.list_inventory_supply :seller_skus => ['PF-5VZN-04XR', 'V4-03EY-LAL1', 'OC-TUKC-031P']`
     `@mws.inventory.list_inventory_supply :query_start_date_time => Time.now-1.day`

data/bin/ruby-mws

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'ruby-mws'

data/lib/ruby-mws/api/base.rb

@@ -22,9 +22,8 @@ module MWS
 
       def self.def_request(requests, *options)
         [requests].flatten.each do |name|
-          # class variable = a way to store options splat to pass into pseudomethod
-          self.class_variable_set("@@#{name}_options", options.first)
           self.class_eval %Q{
+            @@#{name}_options = options.first
             def #{name}(params={})
               send_request(:#{name}, params, @@#{name}_options)
             end
@@ -47,18 +46,11 @@ module MWS
         params[:lists][:marketplace_id] = "MarketplaceId.Id"
 
         query = Query.new params
-        @response = Response.new self.class.send(params[:verb], query.request_uri)
-
-        begin
-          res = @response.send("#{name}_response").send("#{name}_result")
-          if @next[:token] = res.next_token  # modifying, not comparing
-            @next[:action] = params[:next_action] || (name.match(/_by_next_token/) ? name : "#{name}_by_next_token")
-          end
-          params[:mods].each {|mod| mod.call(res) } if params[:mods]
-          res
-        rescue NoMethodError
-          @response
+        @response = Response.parse self.class.send(params[:verb], query.request_uri), name, params
+        if @response.respond_to?(:next_token) and @next[:token] = @response.next_token  # modifying, not comparing
+          @next[:action] = name.match(/_by_next_token/) ? name : "#{name}_by_next_token"
         end
+        @response
       end
 
       def has_next?

data/lib/ruby-mws/api/order.rb

@@ -2,14 +2,15 @@ module MWS
   module API
 
     class Order < Base
-
-
       def_request [:list_orders, :list_orders_by_next_token],
         :verb => :get,
         :uri => '/Orders/2011-01-01',
         :version => '2011-01-01',
+        :lists => {
+          :order_status => "OrderStatus.Status"
+        },
         :mods => [
-          lambda {|r| r.orders = r.orders.order}
+          lambda {|r| r.orders = r.orders.order if r.orders}
         ]
 
       def_request [:list_order_items, :list_order_items_by_next_token],

data/lib/ruby-mws/api/response.rb

@@ -2,7 +2,26 @@ module MWS
   module API
 
     class Response < Hashie::Rash
-      # Just a wrapper for the Hashie class
+      
+      def self.parse(hash, name, params)
+        rash = self.new(hash)
+        handle_error_response(rash["error_response"]["error"]) unless rash["error_response"].nil?
+        raise BadResponseError, "received non-matching response type #{rash.keys}" if rash["#{name}_response"].nil?
+        rash = rash["#{name}_response"]
+
+        if rash = rash["#{name}_result"]
+          # only runs mods if correct result is present
+          params[:mods].each {|mod| mod.call(rash) } if params[:mods]
+          rash
+        end
+      end
+
+      def self.handle_error_response(error)
+        msg = "#{error.code}: #{error.message}"
+        msg << " -- #{error.detail}" unless error.detail.nil?
+        raise ErrorResponse, msg
+      end
+
     end
 
   end

data/lib/ruby-mws/exceptions.rb

@@ -9,4 +9,9 @@ module MWS
   class NoNextToken < MWSException
   end
 
+  class ErrorResponse < MWSException
+  end
+
+  class BadResponseError < MWSException
+  end
 end

data/lib/ruby-mws/version.rb

@@ -1,3 +1,3 @@
 module MWS
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/ruby-mws/api/inventory_spec.rb

@@ -5,7 +5,7 @@ describe MWS::API::Inventory do
   before :all do
     EphemeralResponse.activate
     @mws = MWS.new(auth_params)
-    @timestamp = "2012-01-15T18:07:48-05:00"
+    @timestamp = "2012-04-25T21:42:11-04:00"
   end
 
   context "requests" do

data/spec/ruby-mws/api/order_spec.rb

@@ -5,16 +5,16 @@ describe MWS::API::Order do
   before :all do
     EphemeralResponse.activate
     @mws = MWS.new(auth_params)
-    @timestamp = "2012-01-15T17:28:17-05:00"
+    @timestamp = "2012-04-25T21:42:55-04:00"
   end
 
   context "requests" do
     describe "list_orders" do
-      it "should receive a list_orders_result" do
+      it "should receive a list of orders" do
         orders = @mws.orders.list_orders :last_updated_after => "2012-01-15T13:07:26-05:00" ,
           :timestamp => @timestamp
         orders.orders.should be_an_instance_of Array
-        orders.should == @mws.orders.response.list_orders_response.list_orders_result
+        orders.orders.first.should have_key :amazon_order_id
       end
     end
 
@@ -23,6 +23,7 @@ describe MWS::API::Order do
         orders = @mws.orders.list_orders_by_next_token :timestamp => @timestamp,
           :next_token => "zwR7fTkqiKp/YYuZQbKv1QafEPREmauvizt1MIhPYZZl3LSdPSOgN1byEfyVqilNBpcRD1uxgRxTg2dsYWmzKd8ytOVgN7d/KyNtf5fepe2OEd7gVZif6X81/KsTyqd1e64rGQd1TyCS68vI7Bqws+weLxD7b1CVZciW6QBe7o2FizcdzSXGSiKsUkM4/6QGllhc4XvGqg5e0zIeaOVNezxWEXvdeDL7eReo//Hc3LMRF18hF5ZYNntoCB8irbDGcVkxA+q0fZYwE7+t4NjazyEZY027dXAVTSGshRBy6ZTthhfBGj6Dwur8WCwcU8Vc25news0zC1w6gK1h3EdXw7a3u+Q12Uw9ZROnI57RGr4CrtRODNGKSRdGvNrxcHpI2aLZKrJa2MgKRa+KsojCckrDiHqb8mBEJ88g6izJN42dQcLTGQRwBej+BBOOHYP4"
         orders.orders.should be_an_instance_of Array
+        orders.orders.first.should have_key :amazon_order_id
       end
     end
 
@@ -40,6 +41,7 @@ describe MWS::API::Order do
           :timestamp => @timestamp
         orders.orders.should be_an_instance_of Array
         orders.orders.size.should == 2
+        orders.orders.first.should have_key :amazon_order_id
       end
     end
 

data/spec/spec_helper.rb

@@ -14,12 +14,12 @@ RSpec.configure do |config|
     @mws_object ||= MWS.new(auth_params)
   end
 
+  # To test, create spec/credentials.yml or fill in below
   def auth_params
     @auth_params ||=
       begin
         hsh = YAML.load(File.open(File.join(File.expand_path(File.dirname(__FILE__)), 'credentials.yml'))).symbolize_keys!
       rescue
-        # some fake auth values
         {
           :aws_access_key_id  => 'access',
           :secret_access_key  => 'super_secret',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mws
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-16 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70242944939120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242944939120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ephemeral_response
-  requirement: &70242944938600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242944938600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70242944938020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242944938020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70242944937380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242944937380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: &70242944936700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242944936700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70242944936280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242944936280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rash
-  requirement: &70242944935840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,21 +117,27 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242944935840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: (Under development) This gem serves as a wrapper for Amazon.com's Marketplace
   Web Service (MWS) API. Visit http://github.com/elyngved/ruby-mws for documentation.
 email:
 - elyngved@gmail.com
-executables: []
+executables:
+- ruby-mws
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - LICENSE
 - README.markdown
 - Rakefile
+- bin/ruby-mws
 - lib/ruby-mws.rb
 - lib/ruby-mws/api/base.rb
 - lib/ruby-mws/api/inventory.rb
@@ -142,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ruby-mws
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: RubyMWS Gem
@@ -156,3 +192,4 @@ test_files:
 - spec/ruby-mws/base_spec.rb
 - spec/ruby-mws/connection_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-1.9.3-p0@ruby-mws