peddler 0.3.1 → 0.4.1

data/lib/peddler.rb

@@ -1,18 +1,6 @@
-# Peddler is a Ruby wrapper to the Amazon Inventory management API.
-module Peddler
+%w(
+  feeds fulfillment_inbound_shipment fulfillment_inventory
+  fulfillment_outbound_shipment orders products reports sellers
+).each do |service|
+  require "peddler/#{service}"
 end
-
-require 'active_support/core_ext/hash'
-require 'net/https'
-require 'ostruct'
-require 'peddler/version'
-require 'peddler/client'
-require 'peddler/handlers'
-require 'peddler/feeds'
-require 'peddler/inventory'
-require 'peddler/legacy_reports'
-require 'peddler/refunds'
-require 'peddler/reports'
-require 'peddler/transport'
-require 'tempfile'
-require 'time'

metadata

@@ -1,206 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: peddler
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Hakan Ensari
+- Ezekiel Templin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-25 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 3
-        - 2
-        version: 2.3.2
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+date: 2012-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 6
-        - 5
-        version: 1.6.5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sdoc-helpers
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 1
-        - 4
-        version: 0.1.4
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: vcr
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeff
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
-  type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: webmock
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        - 0
-        version: 1.4.0
-  type: :development
-  version_requirements: *id006
-description: Peddler is a Ruby wrapper to the Amazon Inventory Management API.
-email: 
-- hakan.ensari@papercavalier.com
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: A wrapper to the Amazon Marketplace Web Service (MWS) API
+email:
+- code@papercavalier.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .rvmrc
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.md
-- Rakefile
-- lib/peddler.rb
-- lib/peddler/client.rb
+files:
 - lib/peddler/feeds.rb
-- lib/peddler/handlers.rb
-- lib/peddler/inventory.rb
-- lib/peddler/legacy_reports.rb
-- lib/peddler/refunds.rb
+- lib/peddler/fulfillment_inbound_shipment.rb
+- lib/peddler/fulfillment_inventory.rb
+- lib/peddler/fulfillment_outbound_shipment.rb
+- lib/peddler/orders.rb
+- lib/peddler/products.rb
 - lib/peddler/reports.rb
-- lib/peddler/transport.rb
+- lib/peddler/sellers.rb
+- lib/peddler/service.rb
 - lib/peddler/version.rb
-- mussels.jpg
-- peddler.gemspec
-- spec/peddler/client_spec.rb
-- spec/peddler/feeds_spec.rb
-- spec/peddler/handlers_spec.rb
-- spec/peddler/inventory_spec.rb
-- spec/peddler/legacy_reports_spec.rb
-- spec/peddler/refunds_spec.rb
-- spec/peddler/reports_spec.rb
-- spec/peddler/transport_spec.rb
-- spec/spec_helper.rb
-- spec/support/amazon.yml.example
-- spec/support/amazon_credentials.rb
-- spec/support/vcr.rb
-- spec_rubies
-has_rdoc: true
+- lib/peddler.rb
+- LICENSE
+- README.md
 homepage: http://github.com/papercavalier/peddler
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: peddler
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Ruby wrapper to the Amazon Inventory Management API
-test_files: 
-- spec/peddler/client_spec.rb
-- spec/peddler/feeds_spec.rb
-- spec/peddler/handlers_spec.rb
-- spec/peddler/inventory_spec.rb
-- spec/peddler/legacy_reports_spec.rb
-- spec/peddler/refunds_spec.rb
-- spec/peddler/reports_spec.rb
-- spec/peddler/transport_spec.rb
-- spec/spec_helper.rb
-- spec/support/amazon.yml.example
-- spec/support/amazon_credentials.rb
-- spec/support/vcr.rb
+summary: Wraps the Amazon Marketplace Web Service API
+test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,5 +0,0 @@
-pkg/*
-*.gem
-*.rbc
-.bundle
-amazon.yml

data/.rspec

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

data/.rvmrc

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,47 +0,0 @@
-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/Rakefile

@@ -1,12 +0,0 @@
-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

@@ -1,229 +0,0 @@
-# = Peddler
-# Peddler is a Ruby wrapper to the {Amazon Inventory management API}[https://images-na.ssl-images-amazon.com/images/G/01/Amazon_AIM/Amazon_AIM.pdf].
-# 
-# Peddler::Client contains some detailed explanation and examples of usage.
-module Peddler
-  # This is the public interface of the Peddler library.
-  class Client
-    # Creates a client.
-    #
-    #    client = Peddler::Client.new(
-    #      :username => 'foo@bar.com',
-    #      :password => 'secret',
-    #      :region   => :us
-    #    )
-    #
-    # Alternatively, set attributes after creating the client:
-    #
-    #    client = Peddler::Client.new
-    #    client.username = 'foo@bar.co.uk'
-    #    client.password = 'tad_more_secret'
-    #    client.region   = 'uk'
-    #
-    def initialize(params={})
-      [:username=, :password=, :region=].each do |method|
-        self.class.send(:define_method, method, lambda { |value| transport.send(method, value) })
-      end
-      params.each_pair { |k, v| self.send("#{k}=", v) }
-    end
-
-    # Creates an inventory batch.
-    #
-    #    batch = client.new_inventory_batch
-    #    book = new_inventory_item(
-    #      :product_id => '1234567890',
-    #      :sku        => 'SKU-001',
-    #      :price      => 10.00,
-    #      :quantity   => 1)
-    #    batch << book
-    #    batch.upload
-    #
-    # Once the batch is processed, you may view the report:
-    #
-    #    report = client.new_report :upload, :id => batch.id
-    #    p report.body
-    #    => "Feed Processing Summary:\n\tNumber of records processed\t\t1\n\tNumber of records successful\t\t1\n\n"
-    #
-    def new_inventory_batch
-      Peddler::Inventory::Batch.new(transport.dup)
-    end
-
-    # A short-hand method to purge inventory.
-    #
-    #    client.purge_inventory
-    #
-    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
-    #    fulfilled_order = client.new_fulfilled_order(
-    #      :order_id    => "123-1234567-1234567",
-    #      :order_date  => "2009-08-01")
-    #    feed << fulfilled_order
-    #    feed.upload
-    #    feed.status
-    #    => "_SUBMITTED_"
-    #    sleep(60)
-    #    feed.status!
-    #    => "_DONE_"
-    #    p feed.download.to_s
-    #
-    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
-    #    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
-    #    feed.status
-    #    => "_SUBMITTED_"
-    #    sleep(60)
-    #    feed.status!
-    #    => "_DONE_"
-    #    p feed.download.to_s
-    #
-    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
-    #    refund = client.new_refund(
-    #      :order_id                 => "123-1234567-1234567",
-    #      :payments_transaction_id  => "12341234567890",
-    #      :refund_amount            => 10.00,
-    #      :reason                   => "CouldNotShip",
-    #      :message                  => "With our apologies.")
-    #    batch << refund
-    #    batch.upload
-    #    sleep(60)
-    #    status = client.latest_reports :batch_refund, :count => 1
-    #    report = client.new_report(
-    #      :batch_refund,
-    #      :id => status[0].id)
-    #    p report.body
-    #    => "123-1234567-1234567order-item-id: 12341234567890\tSUCCESS 10.00 is Refunded.\r\n"
-    #
-    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.
-    #
-    # Possible report names: [:upload, :order, :preorder, :batch_refund,
-    # :open_listings, :open_listings_lite, :open_listings_liter]
-    #
-    # You can download a specific report by using its ID. Otherwise, the 
-    # instance will fetch the latest available report. One oddball exception: 
-    # Upload reports do require an ID and will return nil if you don't provide
-    # one.
-    # 
-    #    orders_report = client.new_report :order
-    #    orders = client.detab(orders_report.body)
-    #    orders[0].buyer_name
-    #    => "John Doe"
-    #
-    #    preorders_report = client.new_report(
-    #      :preorder,
-    #      :product_line  => "Books",
-    #      :frequency     => 2)
-    #    preorders = client.detab(preorders_report.body)
-    #    preorders[0].average_asking_price
-    #    => "100"
-    # 
-    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]
-    #
-    #    client.generate_report :order, :number_of_days => 15
-    #
-    # A word of caution. Open listings may crap up with larger inventories.
-    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.
-    #
-    #    report = client.new_unshipped_orders_report
-    #    report.status
-    #    => "_SUBMITTED_"
-    #    sleep(60)
-    #    report.status!
-    #    => "_DONE_"
-    #    p report.unshipped_orders
-    #   
-    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
-    #    reports[0]
-    #    => #<Peddler::LegacyReports::ReportStatus starts_at="07-29-2009:10-00-06" ... 
-    #
-    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
-  end
-end

data/lib/peddler/handlers.rb

@@ -1,38 +0,0 @@
-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']].flatten.collect  { |input| Peddler::LegacyReports::UploadStatus.new(input) }
-        elsif hash['Reports']
-          [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.
-      def self.decode_response(res, &block)
-        if block_given?
-          res.scan(/[^\n]+/, &block)
-        else
-          lines = res.split("\n")
-          if lines.size > 1
-            params = lines[0].split("\t").collect{ |value| value.gsub(/-/, '_') }
-            params_size = params.size
-            (1..(lines.size - 1)).collect do |line_key|
-              values = lines[line_key].split("\t")
-              data = (0..(params_size - 1)).inject({}) { |memo, key| memo.merge( { params[key] => values[key] } ) }
-              OpenStruct.new(data)
-            end
-          else
-            res
-          end
-        end
-      end
-    end
-  end
-end