ruby-mws 0.0.4 → 0.1

data/Gemfile

@@ -11,4 +11,5 @@ gem 'rash'
 
 gem 'rspec'
 gem 'ephemeral_response'
-gem 'awesome_print'
+gem 'awesome_print'
+gem 'pry'

data/README.markdown

@@ -66,10 +66,12 @@ Here, there are more orders to be returned. You can call `has_next?` on the same
 
 Repeat as necessary. You can keep calling `next` on the API instance as long as `has_next?` returns true.
 
-Or if you need to, you can save the next_token and go about the manual way as per Amazon's docs:
+Or if you need to, you can save `next_token` and go about the manual way as per Amazon's docs:
 
     next_response = mws.orders.list_orders_by_next_token :next_token => response.next_token
 
+***
+
 API
 ---
 
@@ -79,23 +81,37 @@ This object can be used to access all API services. Below are examples on how to
 
 ### Orders API
 
-* ListOrders - gets orders by time range and other parameters
+* ListOrders - Gets orders by time range and other parameters
 
     `@mws.orders.list_orders :last_updated_after => Time.now-4.hours, :order_status => 'Shipped'`
 
-* GetOrder - gets orders by Amazon order ID
+* GetOrder - Gets orders by Amazon order ID
 
     `@mws.orders.get_order :amazon_order_id => "002-EXAMPLE-0031387"`
 
     `:amazon_order_id` can be an array to retrieve multiple orders.
 
-* ListOrderItems - gets order items for one order ID (only one order at a time here)
+* 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"`
 
 ### Fulfillment Inventory API
 
-* ListInventorySupply - returns availability of inventory, only returns items based on list of SKUs or last change date
+* ListInventorySupply - Returns availability of inventory, only returns items based on list of SKUs or last change date
 
     `@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`
+    `@mws.inventory.list_inventory_supply :query_start_date_time => Time.now-1.day`
+
+### Reports API
+
+* RequestReport - Used to submit a request for a report by [report type](http://docs.developer.amazonservices.com/en_US/reports/Reports_ReportType.html). Returns report request info.
+
+    `@mws.reports.request_report :report_type => "_GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA_", :start_date => 1.day.ago, :end_date => Time.now`
+
+* GetReportRequestList - Returns a list of the most recently requested reports. Use `report_request_id` to find the status of your report. Once `report_processing_status` for your request is "_DONE_", use `generated_report_id` to get your results.
+
+    `@mws.reports.get_report_request_list`
+
+* GetReport - Used to request a report by report ID. All reports are currently returned as a flat file string.
+
+    `@mws.reports.get_report :report_id => '11223344'`

data/lib/ruby-mws.rb

@@ -51,8 +51,12 @@ require 'ruby-mws/connection'
 require 'ruby-mws/exceptions'
 require 'ruby-mws/version'
 
+require 'ruby-mws/api/binary_parser'
+
 require 'ruby-mws/api/base'
 require 'ruby-mws/api/inventory'
 require 'ruby-mws/api/order'
+require 'ruby-mws/api/report'
 require 'ruby-mws/api/query'
-require 'ruby-mws/api/response'
+require 'ruby-mws/api/response'
+require 'ruby-mws/api/binary_response'

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

@@ -6,8 +6,9 @@ module MWS
 
     class Base
       include HTTParty
-      # debug_output $stderr  # only in development
-      format :xml
+      parser MWS::API::BinaryParser
+      debug_output $stderr  # only in development
+      #format :xml
       headers "User-Agent"   => "ruby-mws/#{MWS::VERSION} (Language=Ruby/1.9.3-p0)"
       headers "Content-Type" => "text/xml"
 
@@ -31,28 +32,34 @@ module MWS
         end
       end
 
-      def send_request(name, params, options)
+      def send_request(name, params, options={})
         # prepare all required params...
-        params = [params, options, @connection.to_hash].inject :merge
-        
-        # default/common params
-        params[:action]            ||= name.to_s.camelize
-        params[:signature_method]  ||= 'HmacSHA256'
-        params[:signature_version] ||= '2'
-        params[:timestamp]         ||= Time.now.iso8601
-        params[:version]           ||= '2009-01-01'
+        params = [default_params(name), params, options, @connection.to_hash].inject :merge
 
         params[:lists] ||= {}
         params[:lists][:marketplace_id] = "MarketplaceId.Id"
 
         query = Query.new params
-        @response = Response.parse self.class.send(params[:verb], query.request_uri), name, params
+        resp = self.class.send(params[:verb], query.request_uri)
+
+        @response = Response.parse resp, 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 default_params(name)
+        {
+          :action            => name.to_s.camelize,
+          :signature_method  => 'HmacSHA256',
+          :signature_version => '2',
+          :timestamp         => Time.now.iso8601,
+          :version           => '2009-01-01'
+        }
+      end
+
       def has_next?
         not @next[:token].nil?
       end

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

@@ -0,0 +1,16 @@
+module MWS
+  module API
+
+    class BinaryParser < HTTParty::Parser
+      SupportedFormats.merge!({ "application/octet-stream" => :binary })
+
+      protected
+
+      def binary
+        body
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,13 @@
+module MWS
+  module API
+
+    class BinaryResponse < Struct.new(:body)
+
+      def self.parse(response, name, params)
+        new(response.parsed_response)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,22 @@
+module MWS
+  module API
+
+    class Report < Base
+      def_request [:request_report],
+                  :verb => :post,
+                  :uri => '/',
+                  :version => '2009-01-01'
+
+      def_request [:get_report],
+                  :verb => :get,
+                  :uri => '/',
+                  :version => '2009-01-01'
+
+      def_request [:get_report_request_list, :get_report_request_list_by_next_token],
+                  :verb => :get,
+                  :uri => '/',
+                  :version => '2009-01-01'
+    end
+
+  end
+end

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

@@ -3,8 +3,10 @@ module MWS
 
     class Response < Hashie::Rash
       
-      def self.parse(hash, name, params)
-        rash = self.new(hash)
+      def self.parse(body, name, params)
+        return body unless body.is_a?(Hash)
+
+        rash = self.new(body)
         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"]

data/lib/ruby-mws/base.rb

@@ -16,6 +16,10 @@ module MWS
       @inventory ||= MWS::API::Inventory.new(@connection)
     end
 
+    def reports
+      @reports ||= MWS::API::Report.new(@connection)
+    end
+
 
     # serves as a server ping
     def self.server_time

data/lib/ruby-mws/version.rb

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

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

@@ -5,21 +5,20 @@ describe MWS::API::Inventory do
   before :all do
     EphemeralResponse.activate
     @mws = MWS.new(auth_params)
-    @timestamp = "2012-04-25T21:42:11-04:00"
   end
 
   context "requests" do
 
     describe "list_inventory_supply" do
       it "should return items based on seller SKUs" do
-        items = @mws.inventory.list_inventory_supply :timestamp => @timestamp,
+        items = @mws.inventory.list_inventory_supply :timestamp => timestamp,
           :seller_skus => %w[PF-5VZN-04XR V4-03EY-LAL1 OC-TUKC-031P]
         items.should have_key :inventory_supply_list
         items.inventory_supply_list.should be_an_instance_of Array
       end
 
       it "should return items with inventory changes since a certain time" do
-        items = @mws.inventory.list_inventory_supply :timestamp => @timestamp,
+        items = @mws.inventory.list_inventory_supply :timestamp => timestamp,
           :query_start_date_time => "2012-01-15T10:04:01-05:00"
         items.should have_key :inventory_supply_list
         items.inventory_supply_list.should be_an_instance_of Array

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

@@ -5,14 +5,13 @@ describe MWS::API::Order do
   before :all do
     EphemeralResponse.activate
     @mws = MWS.new(auth_params)
-    @timestamp = "2012-04-25T21:42:55-04:00"
   end
 
   context "requests" do
     describe "list_orders" 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
+          :timestamp => timestamp
         orders.orders.should be_an_instance_of Array
         orders.orders.first.should have_key :amazon_order_id
       end
@@ -20,7 +19,7 @@ describe MWS::API::Order do
 
     describe "list_orders_by_next_token" do
       it "should receive a list_orders_by_next_token_result" do
-        orders = @mws.orders.list_orders_by_next_token :timestamp => @timestamp,
+        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
@@ -30,7 +29,7 @@ describe MWS::API::Order do
     describe "get_order" do
       it "should return one order for one order id" do
         order = @mws.orders.get_order :amazon_order_id => "102-4850183-7065809",
-          :timestamp => @timestamp
+          :timestamp => timestamp
         order.should have_key :orders
         order.orders.should be_an_instance_of Array
         order.orders.first.should have_key :amazon_order_id
@@ -38,7 +37,7 @@ describe MWS::API::Order do
 
       it "should return multiple orders for multiple order ids" do
         orders = @mws.orders.get_order :amazon_order_id => ["102-4850183-7065809", "002-3400187-5292203"],
-          :timestamp => @timestamp
+          :timestamp => timestamp
         orders.orders.should be_an_instance_of Array
         orders.orders.size.should == 2
         orders.orders.first.should have_key :amazon_order_id
@@ -48,7 +47,7 @@ describe MWS::API::Order do
     describe "list_order_items" do
       it "should return a list of items for an order" do
         order = @mws.orders.list_order_items :amazon_order_id => "102-4850183-7065809",
-          :timestamp => @timestamp
+          :timestamp => timestamp
         order.should have_key :amazon_order_id
         order.should have_key :order_items
         order.order_items.should be_an_instance_of Array

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

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe MWS::API::Report do
+
+  before :all do
+    EphemeralResponse.activate
+    @mws = MWS.new(auth_params)
+  end
+
+  context "requests" do
+    describe "get_report" do
+      # TODO: Mock Response?
+    end
+
+    describe "request_report" do
+      it "should request a report" do
+        response = @mws.reports.request_report report_type: '_GET_FLAT_FILE_OPEN_LISTINGS_DATA_', timestamp: timestamp
+        response.should have_key(:request_report_info)
+      end
+    end
+
+    describe "get_report_request_list" do
+      it "should get a list of report requests" do
+        response = @mws.reports.get_report_request_list timestamp: timestamp
+        response.request_report_info.should be_an_instance_of Array
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -14,7 +14,7 @@ RSpec.configure do |config|
     @mws_object ||= MWS.new(auth_params)
   end
 
-  # To test, create spec/credentials.yml or fill in below
+  # To test, create spec/credentials.yml
   def auth_params
     @auth_params ||=
       begin
@@ -28,6 +28,11 @@ RSpec.configure do |config|
         }
       end
   end
+
+  def timestamp
+    # use a recent timestamp here... how to replace this?
+    "2013-11-17T21:17:59-06:00"
+  end
 end
 
 class TestWorksError < StandardError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mws
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: '0.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -140,9 +140,12 @@ files:
 - bin/ruby-mws
 - lib/ruby-mws.rb
 - lib/ruby-mws/api/base.rb
+- lib/ruby-mws/api/binary_parser.rb
+- lib/ruby-mws/api/binary_response.rb
 - lib/ruby-mws/api/inventory.rb
 - lib/ruby-mws/api/order.rb
 - lib/ruby-mws/api/query.rb
+- lib/ruby-mws/api/report.rb
 - lib/ruby-mws/api/response.rb
 - lib/ruby-mws/base.rb
 - lib/ruby-mws/connection.rb
@@ -155,6 +158,7 @@ files:
 - spec/ruby-mws/api/inventory_spec.rb
 - spec/ruby-mws/api/order_spec.rb
 - spec/ruby-mws/api/query_spec.rb
+- spec/ruby-mws/api/report_spec.rb
 - spec/ruby-mws/base_spec.rb
 - spec/ruby-mws/connection_spec.rb
 - spec/spec_helper.rb
@@ -189,6 +193,7 @@ test_files:
 - spec/ruby-mws/api/inventory_spec.rb
 - spec/ruby-mws/api/order_spec.rb
 - spec/ruby-mws/api/query_spec.rb
+- spec/ruby-mws/api/report_spec.rb
 - spec/ruby-mws/base_spec.rb
 - spec/ruby-mws/connection_spec.rb
 - spec/spec_helper.rb