peddler 0.2.4 → 0.3.0

data/.gitignore

@@ -1,3 +1,5 @@
-.DS_Store
-peddler.gemspec
-pkg
+pkg/*
+*.gem
+*.rbc
+.bundle
+amazon.yml

data/.rspec

@@ -0,0 +1 @@
+-cfd

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm --create use ree@peddler
+rvm wrapper ree@peddler

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in peddler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    peddler (0.3.0)
+      activesupport (>= 2.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    addressable (2.2.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    rdiscount (1.6.5)
+    rdoc (2.4.3)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    sdoc (0.2.20)
+      json (>= 1.1.3)
+      rdoc (= 2.4.3)
+    sdoc-helpers (0.1.4)
+      sdoc (~> 0.2)
+    vcr (1.2.0)
+    webmock (1.4.0)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 2.3.2)
+  peddler!
+  rdiscount (~> 1.6.5)
+  rspec (~> 2.0.0)
+  sdoc-helpers (~> 0.1.4)
+  vcr (~> 1.2.0)
+  webmock (~> 1.4.0)

data/LICENSE

@@ -1,7 +1,7 @@
 (The MIT License)
- 
-Copyright (c) 2009 Paper Cavalier
- 
+
+Copyright (c) 2009-2010 Paper Cavalier
+
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 'Software'), to deal in the Software without restriction, including
@@ -9,14 +9,14 @@ without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
- 
+
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
- 
+
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+Peddler
+=======
+
+Peddler is a Ruby wrapper to the Amazon Inventory management API.
+
+![Peddler](http://github.com/papercavalier/peddler/raw/master/mussels.jpg)
+
+Example usage
+-------------
+
+Set up a client:
+
+    client = Peddler::Client.new(
+      :username => 'foo@bar.com',
+      :password => 'secret',
+      :region   => :us)
+
+Create an inventory file:
+
+    batch = client.new_inventory_batch
+    item = client.new_inventory_item(
+      :product_id => '1234567890',
+      :price      => 100.00,
+      :sku        => 'SKU-123',
+      :quantity   => 10)
+    batch << item
+
+Repeat ad infinitum and upload:
+
+    batch.upload
+
+The batch now should have an upload ID. Now, check the error log:
+
+    upload_log = client.new_report(
+      :upload,
+      :id => batch.id)
+    upload_log.body
+    => "Feed Processing Summary:\n\tNumber of records processed\t\t1\n\tNumber of records successful\t\t1\n\n"
+
+You are wondering if you have any new orders:
+
+    orders_report = client.new_report :order
+    orders = client.detab(orders_report.body)
+    p orders.size
+    => 1500
+    p orders[0].item_name
+    => "A Thousand Plateaus: Capitalism and Schizophrenia (Paperback) by Gilles Deleuze"
+
+After processing the orders, post back the results to Amazon:
+
+    feed = client.new_order_fulfillment_feed
+    fulfilled_order = client.new_fulfilled_order(
+      :order_id         => '123-1234567-1234567',
+      :order_date       => '2009-08-01',
+      :carrier_code     => 'USPS',
+      :tracking_number  => '0308 0330 0000 0000 0000')
+    feed << fulfilled_order
+
+Once done, upload:
+
+    feed.upload
+
+Want to see the processing report?
+
+    p feed.status
+    => "_SUBMITTED_"
+
+Refresh until you get:
+
+    p feed.status!
+    => "_DONE_"
+
+Then, check the report:
+
+    p feed.download.to_s
+
+You have an order you can't fill and haven't shipped yet. No problem:
+
+    feed = client.new_order_cancellation_feed
+    cancelled_order = client.new_cancelled_order(
+      :order_id                 => '123-1234567-1234567',
+      :cancellation_reason_code => 'NoInventory',
+      :amazon_order_item_code   => '12341234567890')
+    feed << cancelled_order
+    feed.upload
+    sleep(60)
+    feed.status!
+    => "_DONE_"  
+    p feed.download.to_s
+    => ...
+
+To post a refund for an already-shipped item, you use the batch refund method:
+
+    refunds = client.new_refund_batch
+    refund = client.new_refund(
+      :order_id                 => '123-1234567-1234567',
+      :payments_transaction_id  => '12341234567890',
+      :refund_amount            => 1.00,
+      :reason                   => 'GeneralAdjustment',
+      :message                  => 'With our apologies.')
+    refunds << refund
+    refunds.upload
+
+For a change, let's download something different from Amazon, like a preorder report:
+
+    preorder_report = client.new_report(
+      :preorder,
+      :product_line => 'Books',
+      :frequency    => 2)
+    preorders = client.detab(preorder_report.body)
+    p preorders.size
+    => 2000
+    p preorders[0].asin
+    => "1234567890"
+    p preorders[0].average_asking_price
+    => "100"
+
+[Read source](http://gloss.papercavalier.com/peddler) for more info.
+
+Todo
+----
+
+Switch to using the [Amazon Marketplace Web Service (Amazon MWS)](https://mws.amazon.com/index.html).
+
+Compatibility
+-------------
+
+Specs pass against Ruby 1.8.7, Ruby 1.9.2, and Rubinius 1.1.

data/Rakefile

@@ -1,18 +1,12 @@
-require 'rubygems'
-require 'rake'
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = 'peddler'
-    s.summary = 'A Ruby wrapper to the Amazon Inventory Management API'
-    s.email = 'hakan.ensari@papercavalier.com'
-    s.homepage = 'http://papercavalier.github.com/peddler'
-    s.description = 'Peddler is a Ruby wrapper to the Amazon Inventory Management API.'
-    s.authors = ['Hakan Şenol Ensari']
-    s.add_dependency 'activesupport', '>= 2.3.5'
-    s.add_development_dependency 'rspec', '>= 1.3.0'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
-end
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'sdoc_helpers'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/lib/peddler/client.rb

@@ -26,7 +26,7 @@ module Peddler
       end
       params.each_pair { |k, v| self.send("#{k}=", v) }
     end
-    
+
     # Creates an inventory batch.
     #
     #    batch = client.new_inventory_batch
@@ -47,7 +47,7 @@ module Peddler
     def new_inventory_batch
       Peddler::Inventory::Batch.new(transport.dup)
     end
-    
+
     # A short-hand method to purge inventory.
     #
     #    client.purge_inventory
@@ -55,20 +55,20 @@ module Peddler
     def purge_inventory
       empty_batch = Peddler::Inventory::Batch.new(transport.dup)
       empty_batch.upload(:method => 'purge')
-      
+
     end
-    
+
     # Creates an inventory item. Parameter keys are lowercased and underscored but otherwise the same as
     # the colum titles in the tab-delimited upload templates provided by Amazon.
     def new_inventory_item(params={})
       Peddler::Inventory::Item.new(params)
     end
-    
+
     # Returns count of pending inventory uploads queued at Amazon.
     def inventory_queue
       Peddler::Inventory::Queue.count(transport)
     end
-    
+
     # Creates an order fulfillment batch.
     #
     #    feed = client.new_order_fulfillment_feed
@@ -87,13 +87,13 @@ module Peddler
     def new_order_fulfillment_feed
       Peddler::Feeds::OrderFulfillment::Batch.new(transport.dup)
     end
-    
+
     # Creates an item that can then be added to an order fulfillment feed. Keys are lowercased and underscored but
     # otherwise the same as Amazon's headers. See section 7.1 in the API docs.
     def new_fulfilled_order(params={})
       Peddler::Feeds::OrderFulfillment::Item.new(params)
     end
-    
+
     # Creates an order cancellation batch.
     #
     #    feed = client.new_order_cancellation_feed
@@ -113,13 +113,13 @@ module Peddler
     def new_order_cancellation_feed
       Peddler::Feeds::OrderCancellation::Batch.new(transport.dup)
     end
-    
+
     # Creates an item that can then be added to an order cancellation feed. Keys are lowercased and underscored but
     # otherwise the same as Amazon's headers. See section 7.4 in the API docs.
     def new_cancelled_order(params={})
       Peddler::Feeds::OrderCancellation::Item.new(params)
     end
-    
+
     # Creates a refund batch.
     #
     #    batch = client.new_refund_batch
@@ -142,14 +142,14 @@ module Peddler
     def new_refund_batch
       Peddler::Refunds::Batch.new(transport.dup)
     end
-    
+
     # Creates a refund item that can then be added to a refund batch.
     #
     # Possible reasons: ["GeneralAdjustment", "CouldNotShip", "DifferentItem", "MerchandiseNotReceived", "MerchandiseNotAsDescribed"]
     def new_refund(params={})
       Peddler::Refunds::Item.new(params)
     end
-    
+
     # Creates an instance for an already-generated report. Works only with 
     # legacy reports, meaning anything that comes before section 7 in the API
     # docs.
@@ -178,7 +178,7 @@ module Peddler
     def new_report(name,params={})
       Peddler::LegacyReports::Report.new(transport.dup, name, params)
     end
-    
+
     # Requests a report. Returns true when successful.
     #
     # Possible report names: [:order, :open_listings, :open_listings_lite, :open_listings_liter]
@@ -189,7 +189,7 @@ module Peddler
     def generate_report(name,params={})
       Peddler::LegacyReports.generate(transport, name, params)
     end
-    
+
     # Creates an unshipped order report. Takes on some optional parameters, such as :id, :starts_at, :ends_at. By default,
     # it will request a new unshipped order report for the past seven days.
     #
@@ -204,7 +204,7 @@ module Peddler
     def new_unshipped_orders_report(params={})
       Peddler::Reports::UnshippedOrdersReport.new(transport.dup, params)
     end
-    
+
     # Returns status of most recent reports. Optional "count" defaults to 10. Name can be [ :upload, :order, :batch_refund, :open_listings, :open_listings_lite, :open_listings_liter ].
     #
     #    reports = client.latest_reports :order, :count => 1
@@ -214,14 +214,14 @@ module Peddler
     def latest_reports(name,params={})
       Peddler::LegacyReports.latest(transport, name, params)
     end
-    
+
     # Decodes tab-delimited content into an array of OpenStruct objects.
     def detab(msg)
       Peddler::Handlers::TabDelimitedHandler.decode_response(msg)
     end
-    
+
     private
-    
+
     def transport #:nodoc:all
       @transport ||= Peddler::Transport.new
     end

data/lib/peddler/feeds.rb

@@ -1,32 +1,32 @@
 module Peddler
-  
+
   # This module includes functionality to handle the charge-when-ship-related 
   # feeds Amazon added to the API in 2009.
   module Feeds
-    
+
     # This is a downloadable file. Outputs Amazon's response verbatim for now.
     class Download
       attr_accessor :id, :type, :related_reference_id, :available_at, :acknowledged
-      
+
       MAPPED_PARAMS = {
         'DownloadId'          => 'id',
         'DownloadType'        => 'type',
         'RelatedReferenceId'  => 'related_reference_id',
         'AvailableDate'       => 'available_at',
         'Acknowledged'        => 'acknowledged'}
-      
+
       def initialize(transport, params={})
         @transport = transport
         params.each_pair{ |k, v| self.send "#{MAPPED_PARAMS[k]}=", v }
       end
-      
+
       # Retrieves and returns report.
       def to_s
         @body ||= download_report
       end
-      
+
       private
-      
+
       def download_report
         return nil if @id.nil?
         @transport.modernize_request
@@ -36,12 +36,12 @@ module Peddler
         @transport.execute_request
       end
     end
-    
+
     # This is the base class.
     class Feed
       attr_writer   :file_content
       attr_accessor :batch, :download, :status, :type, :id, :submitted_at, :started_processing_at, :completed_processing_at, :messages_processed, :messages_successful, :messages_with_errors, :messages_with_warnings
-      
+
       MAPPED_PARAMS = {
         'UploadStatus'              => 'status',
         'UploadType'                => 'type',
@@ -54,12 +54,12 @@ module Peddler
         'MessagesSuccessful'        => 'messages_successful',
         'MessagesWithErrors'        => 'messages_with_errors',
         'MessagesWithWarnings'      => 'messages_with_warnings'}
-        
+
       def initialize(transport)
         @transport = transport
         @batch = []
       end
-      
+
       # Returns content of the upload file.
       def file_content
         return @file_content if @file_content 
@@ -67,14 +67,14 @@ module Peddler
         @batch.each{ |item| out << item.to_s }
         @file_content = out
       end
-      
+
       # Returns status and will also refresh if not already "done."
       def status!
         return @status if @status.nil? || @status =~ /_DONE_/
         refresh_status
         @status
       end
-      
+
       # Uploads batch.
       def upload
         raise PeddlerError.new('Batch already uploaded') unless @id.nil?
@@ -87,14 +87,14 @@ module Peddler
         process_response(res)
         @status
       end
-      
+
       # Adds an item to the batch.
       def <<(item)
         @batch << item
       end
-      
+
       private
-      
+
       def refresh_status
         @transport.modernize_request
         @transport.query_params.merge!({
@@ -103,7 +103,7 @@ module Peddler
         res = @transport.execute_request
         process_response(res)
       end
-      
+
       def process_response(res)
         upload = Hash.from_xml(res)['Response']['Upload'] || Hash.from_xml(res)['Response']['UploadsStatusList']['Upload']
         upload.each_pair do |key, value|
@@ -115,7 +115,7 @@ module Peddler
         end
       end
     end
-    
+
     module OrderFulfillment
       # This class contains methods to upload order fulfillment info to Amazon.
       # See sections 7.1 through 7.3 in the API documentation for more detail.
@@ -126,7 +126,7 @@ module Peddler
           super(transport)
         end
       end
-      
+
       # This is an order fulfillment item.
       class Item
         attr_accessor :order_id, :order_item_id, :quantity, :ship_date, :carrier_name, :tracking_number, :ship_method
@@ -135,19 +135,19 @@ module Peddler
         def initialize(params={})
           params.each_pair{ |key, value| send("#{key}=", value) }
         end
-        
+
         # Validates when setting carrier code.
         def carrier_code=(carrier_code)
           @carrier_code = carrier_code if %w{USPS UPS FedEx other}.include?(carrier_code)
         end
-        
+
         # Outputs a formatted line for the tab-delimited upload file.
         def to_s
           "#{@order_id}\t#{@order_item_id}\t#{@quantity}\t#{@ship_date}\t#{@carrier_code}\t#{@carrier_name}\t#{@tracking_number}\t#{@ship_method}\r\n"
         end
       end
     end
-    
+
     # This module contains methods to upload cancelled orders to Amazon.
     # See section 7.4 in the API documentation for more detail.
     module OrderCancellation
@@ -164,16 +164,16 @@ module Peddler
       class Item
         attr_accessor :order_id, :amazon_order_item_code
         attr_reader   :cancellation_reason_code
-        
+
         def initialize(params={})
           params.each_pair{ |key, value| send("#{key}=", value) }
         end
-        
+
         # Validates when setting cancellation reason code.
         def cancellation_reason_code=(cancellation_reason_code)
           @cancellation_reason_code = cancellation_reason_code if %w{ BuyerCanceled CustomerExchange CustomerReturn GeneralAdjustment MerchandiseNotReceived NoInventory ShippingAddressUndeliverable }.include?(cancellation_reason_code)
         end
-        
+
         # Outputs a formatted line for the tab-delimited upload file.
         def to_s
           if @cancellation_reason_code.nil? != @amazon_order_item_code.nil?
@@ -184,4 +184,4 @@ module Peddler
       end
     end
   end
-end
+end

data/lib/peddler/handlers.rb

@@ -1,17 +1,17 @@
 module Peddler
   module Handlers
     class XMLHandler
-      
+
       # Parses legacy responses to queries on statuses of generated reports and inventory uploads.
       def self.parse_legacy(hash)
         if hash['Batches']
-          hash['Batches']['Batch'].collect  { |input| Peddler::LegacyReports::UploadStatus.new(input) }
+          [hash['Batches']['Batch']].flatten.collect  { |input| Peddler::LegacyReports::UploadStatus.new(input) }
         elsif hash['Reports']
-          hash['Reports']['Report'].collect { |input| Peddler::LegacyReports::ReportStatus.new(input) }
+          [hash['Reports']['Report']].flatten.collect { |input| Peddler::LegacyReports::ReportStatus.new(input) }
         end
       end
     end
-    
+
     class TabDelimitedHandler
       # Decodes tab-delimited content into an array of OpenStruct objects. It
       # assumes first line contains parameter names.
@@ -35,4 +35,4 @@ module Peddler
       end
     end
   end
-end
+end