peddler 0.2.4 → 0.3.0

data/lib/peddler/inventory.rb

@@ -13,23 +13,23 @@ module Peddler
         end
       end
     end
-    
+
     # This is an inventory batch.
     class Batch
       attr_reader :id
       attr_accessor :batch
-      
+
       def initialize(transport)
         @transport = transport
         @batch = []
       end
-      
+
       # Uploads batch to Amazon.
       def upload(params={})
         raise PeddlerError.new('Batch already uploaded') unless @id.nil?
         @transport.legacize_request
         @transport.path << 'catalog-upload/'
-        
+
         case params[:method].to_s
         when 'modify'
           @transport.path << 'modify-only'
@@ -42,11 +42,11 @@ module Peddler
           @transport.body = file_content
         end
         params.delete(:method)
-        
+
         params = defaultize(params)
         @transport.headers.merge!(params)
         res = @transport.execute_request
-        
+
         if res =~ /^<BatchID>(.*)<\/BatchID>$/
           @id = $1
         else
@@ -54,7 +54,7 @@ module Peddler
         end
         true
       end
-      
+
       # Returns upload file string.
       def file_content(type=:long)
         case type
@@ -67,14 +67,14 @@ module Peddler
         end
         out
       end
-      
+
       # Adds an item to inventory.
       def <<(item)
         @batch << item
       end
-      
+
       private
-      
+
       def defaultize(params)
         params = {
           :upload_for         => 'Marketplace',
@@ -84,7 +84,7 @@ module Peddler
           :batch_id           => 'Y',
           :email              => 'Y'
         }.merge(params)
-        
+
         # Some Amazon dimwit figured he'd rather not camelize this one
         if params[:enable_expedited_shipping]
           params['enable-expedited-shipping'] = params[:enable_expedited_shipping]
@@ -92,11 +92,11 @@ module Peddler
         else
           params['enable-expedited-shipping'] = 'Y'
         end
-        
+
         params
       end
     end
-    
+
     # This is an inventory item.
     class Item
       attr_accessor :product_id,
@@ -122,11 +122,11 @@ module Peddler
                     :asin1,
                     :asin2,
                     :asin3
-      
+
       def initialize(params={})
         params.each_pair{ |key, value| send("#{key.to_s}=", value) }
       end
-      
+
       def to_s(type=:long)
         case type
         when :long
@@ -137,4 +137,4 @@ module Peddler
       end
     end
   end
-end
+end

data/lib/peddler/legacy_reports.rb

@@ -1,8 +1,8 @@
 module Peddler
-  
+
   # This module contains methods to manage legacy reports -- anything that comes before section 7 in the API docs.
   module LegacyReports
-    
+
     # Returns statuses of most recent reports in an array of OpenStructs.
     def self.latest(transport,name,params={})
       transport.legacize_request
@@ -17,7 +17,7 @@ module Peddler
       res = transport.execute_request
       Peddler::Handlers::XMLHandler.parse_legacy(Hash.from_xml(res)) || []
     end
-    
+
     # Requests a report to be generated and returns the report instance if request is successful.
     def self.generate(transport,name,params={})
       transport.legacize_request
@@ -27,23 +27,23 @@ module Peddler
       res = transport.execute_request
       res =~ /SUCCESS/ ? Peddler::LegacyReports::Report.new(transport, name) : false
     end
-    
+
     # A legacy report
     class Report
       attr_accessor :name, :id, :product_line, :frequency
-      
+
       def initialize(transport, name=nil, params={})
         @transport, @name = transport, name
         params.each_pair{ |key, value| self.send "#{key}=", value }
       end
-      
+
       def body
         return nil if @name == :upload && @id.nil?
         @body ||= download
       end
-    
+
       private
-      
+
       def download
         return false if @name.nil? && @id.nil?
         case @name.to_s
@@ -68,7 +68,7 @@ module Peddler
         end
       end
     end
-    
+
     class Status < OpenStruct
       def initialize(input)
         if input.kind_of? String
@@ -76,12 +76,12 @@ module Peddler
         end
         super(hash)
       end
-    
+
       def id
         @table[:id] || self.object_id
       end
     end
-  
+
     class ReportStatus < Status
       def initialize(input)
         @keymap = {
@@ -91,7 +91,7 @@ module Peddler
         super(input)
       end
     end
-  
+
     class UploadStatus < Status
       def initialize(input)
         @keymap = {

data/lib/peddler/refunds.rb

@@ -3,21 +3,21 @@ module Peddler
     # This is a refund batch.
     class Batch
       attr_accessor :batch
-      
+
       def initialize(transport)
         @transport = transport
         @batch = []
       end
-      
+
       def file_content
         out = "order-id\tpayments-transaction-id\trefund-amount\treason\tmessage\r\n"
         @file_content = @batch.inject(out){ |memo, item| memo << item.to_s }
       end
-      
+
       def <<(item)
         @batch << item
       end
-      
+
       def upload
         raise PeddlerError.new("Batch already uploaded") if @completed
         @transport.legacize_request
@@ -26,29 +26,27 @@ module Peddler
         res = @transport.execute_request
         @completed = true if res == "<Success>SUCCESS</Success>"
       end
-      
+
     end
-    
+
     # This is a refund.
     class Item
       REFUND_REASONS = %w{ GeneralAdjustment CouldNotShip DifferentItem MerchandiseNotReceived MerchandiseNotAsDescribed }
-      
+
       attr_accessor :order_id, :payments_transaction_id, :refund_amount, :message
       attr_reader   :reason
-      
+
       def initialize(options={})
         options.each_pair{ |key, value| send("#{key.to_s}=", value) }
       end
-      
+
       def reason=(reason)
         @reason = reason if REFUND_REASONS.include?(reason)
       end
-      
+
       def to_s
         "#{self.order_id}\t#{self.payments_transaction_id}\t#{self.refund_amount}\t#{self.reason}\t#{self.message}\r\n"
       end
     end
-    
   end
-  
-end
+end

data/lib/peddler/reports.rb

@@ -1,16 +1,16 @@
 module Peddler
-  
+
   # This module generates and downloads unshipped order reports.
   # I decided to keep this out of Peddler::LegacyReports because the API is
   # quite different.
   module Reports
-    
+
     # This is an unshipped orders report. It is very similar to the feed 
     # objects, so I'm just porting over the class.
     class UnshippedOrdersReport < Peddler::Feeds::Feed
       alias         :unshipped_orders :batch
       attr_accessor :starts_at, :ends_at, :scheduled
-      
+
       MAPPED_PARAMS = {
         'ReportID'                  => 'id',
         'StartDate'                 => 'starts_at',
@@ -22,7 +22,7 @@ module Peddler
         'StartedProcessingDate'     => 'started_processing_at',
         'CompletedProcessingDate'   => 'completed_processing_at',
         'CompletedProcesssingDate'  => 'completed_processing_at'}
-      
+
       # Creates new unshipped order report. It will send a request to 
       # Amazon to generate the report if the report ID is not already set.
       def initialize(transport, params={})
@@ -37,9 +37,9 @@ module Peddler
         end
         self
       end
-      
+
       private
-      
+
       def refresh_status
         @transport.modernize_request
         @transport.query_params.merge!({
@@ -48,7 +48,7 @@ module Peddler
         res = @transport.execute_request
         process_response(res)
       end
-      
+
       def generate_report
         @transport.modernize_request
         @transport.query_params.merge!({
@@ -59,7 +59,7 @@ module Peddler
         res = @transport.execute_request
         process_response(res)
       end
-      
+
       def process_response(res)
         hash = Hash.from_xml(res)
         report = Hash.from_xml(res)['Response']['Report'] || Hash.from_xml(res)['Response']['ReportsList']['Report']
@@ -73,7 +73,7 @@ module Peddler
         end
       end
     end
-    
+
     # This is an unshipped order.
     class Item
       attr_accessor :order_id, :order_item_id, :quantity, :ship_date, :carrier_name, :tracking_number, :ship_method
@@ -82,16 +82,16 @@ 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
-end
+end

data/lib/peddler/transport.rb

@@ -4,7 +4,7 @@ module Peddler
       super(msg)
     end
   end
-  
+
   # Our work horse. Runs on top of Net::HTTP.
   class Transport
     API_HOSTS = {
@@ -15,20 +15,20 @@ module Peddler
       :fr => 'secure.amazon.fr',
       :jp => 'vendornet.amazon.co.jp'
     }
-                       
+
     BASE_HEADERS  = {
       'User-Agent'    => "Peddler/#{Peddler::VERSION}",
       'Content-Type'  => 'text/xml;charset=utf-8',
       'Cookie'        => 'x-main=YvjPkwfntqDKun0QEmVRPcTTZDMe?Tn?; ubid-main=002-8989859-9917520; ubid-tacbus=019-5423258-4241018;x-tacbus=vtm4d53DvX@Sc9LxTnAnxsFL3DorwxJa; ubid-tcmacb=087-8055947-0795529; ubid-ty2kacbus=161-5477122-2773524; session-id=087-178254-5924832;session-id-time=950660664'
     }
-    
+
     BASE_PARAMS = {
       'Service' => 'MerchantQueryService'
     }
-    
+
     attr_writer   :username, :password
     attr_accessor :path, :query_params, :headers, :body
-    
+
     #Returns request instance
     def request
       req = request_method.new("#{path.gsub(/\/$/, "")}/#{query_string}")
@@ -43,7 +43,7 @@ module Peddler
       req.body = body if body
       req
     end
-    
+
     def execute_request
       begin
         conn.start do |http|
@@ -57,24 +57,24 @@ module Peddler
         end
       end
     end
-    
+
     def clear_request
       self.headers = BASE_HEADERS.dup
       self.body = nil
     end
-    
+
     def legacize_request
       clear_request
       self.path = '/exec/panama/seller-admin/'
       self.query_params = {}
     end
-    
+
     def modernize_request
       clear_request
       self.path = '/query/'
       self.query_params = BASE_PARAMS.dup
     end
-    
+
     def region=(region)
       @conn = nil
       region = region.to_sym
@@ -84,19 +84,19 @@ module Peddler
         raise PeddlerError.new('Region not recognized')
       end
     end
-    
+
     def url
       URI.parse("https://#{host}#{path}#{query_string}")
     end
-    
+
     def dump_headers(msg)
       msg.each_header do |k, v|
         p "#{k}=#{v}"
       end
     end
-    
+
     private
-    
+
     #Returns the Net::HTTP instance.
     def conn
       if @conn
@@ -108,7 +108,7 @@ module Peddler
         @conn = conn
       end
     end
-    
+
     def request_method
       if !body.nil? || (query_params && !query_params.empty?)
         Net::HTTP::Post
@@ -116,11 +116,11 @@ module Peddler
         Net::HTTP::Get
       end
     end
-    
+
     def host
       API_HOSTS[@region]
     end
-    
+
     def query_string
       if query_params && !query_params.empty?
         params = query_params.collect do |k, v|
@@ -132,4 +132,4 @@ module Peddler
       end
     end
   end
-end
+end

data/lib/peddler/version.rb

@@ -0,0 +1,3 @@
+module Peddler
+  VERSION = '0.3.0'
+end

data/lib/peddler.rb

@@ -1,18 +1,17 @@
 # Peddler is a Ruby wrapper to the Amazon Inventory management API.
 module Peddler
-  VERSION = '0.2.3'
 end
 
-require 'active_support'
+require 'active_support/core_ext/hash'
 require 'net/https'
 require 'ostruct'
-require File.dirname(__FILE__) + '/peddler/client'
-require File.dirname(__FILE__) + '/peddler/handlers'
-require File.dirname(__FILE__) + '/peddler/feeds'
-require File.dirname(__FILE__) + '/peddler/inventory'
-require File.dirname(__FILE__) + '/peddler/legacy_reports'
-require File.dirname(__FILE__) + '/peddler/refunds'
-require File.dirname(__FILE__) + '/peddler/reports'
-require File.dirname(__FILE__) + '/peddler/transport'
+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'
+require 'time'

data/peddler.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'peddler/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'peddler'
+  s.version     = Peddler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Hakan Ensari']
+  s.email       = ['hakan.ensari@papercavalier.com']
+  s.homepage    = 'http://github.com/papercavalier/peddler'
+  s.summary     = %q{A Ruby wrapper to the Amazon Inventory Management API}
+  s.description = %q{Peddler is a Ruby wrapper to the Amazon Inventory Management API.}
+
+  s.rubyforge_project = 'peddler'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '>= 2.3.2'
+  s.add_development_dependency 'rdiscount', '~> 1.6.5'
+  s.add_development_dependency 'sdoc-helpers', '~> 0.1.4'
+  s.add_development_dependency 'rspec', '~> 2.0.0'
+  s.add_development_dependency 'vcr', '~> 1.2.0'
+  s.add_development_dependency 'webmock', '~> 1.4.0'
+end

data/spec/peddler/client_spec.rb

@@ -1,47 +1,45 @@
-require File.join(File.dirname(__FILE__), "/../spec_helper") 
+require 'spec_helper'
 
 module Peddler
-  
   describe Client do 
-    
-    before(:each) do
-      @client = Peddler::Client.new :username => "seller@example.com",
-                                    :password => "secret",
-                                    :region   => "us"
+    let(:client) do
+      Peddler::Client.new(
+        :username => 'seller@example.com',
+        :password => 'secret',
+        :region   => 'us'
+      )
     end
-      
-    it "should return a new inventory batch" do
-      @client.new_inventory_batch.should be_an_instance_of(Peddler::Inventory::Batch)
+
+    it "returns a new inventory batch" do
+      client.new_inventory_batch.should be_an_instance_of Peddler::Inventory::Batch
     end
-    
-    it "should return a new inventory item" do
-      @client.new_inventory_item.should be_an_instance_of(Peddler::Inventory::Item)
+
+    it "returns a new inventory item" do
+      client.new_inventory_item.should be_an_instance_of Peddler::Inventory::Item
     end
-    
-    it "should return a new order fulfillment feed" do
-      @client.new_order_fulfillment_feed.should be_an_instance_of(Peddler::Feeds::OrderFulfillment::Batch)
+
+    it "returns a new order fulfillment feed" do
+      client.new_order_fulfillment_feed.should be_an_instance_of Peddler::Feeds::OrderFulfillment::Batch
     end
-    
-    it "should return a new fulfilled order" do
-      @client.new_fulfilled_order.should be_an_instance_of(Peddler::Feeds::OrderFulfillment::Item)
+
+    it "returns a new fulfilled order" do
+      client.new_fulfilled_order.should be_an_instance_of Peddler::Feeds::OrderFulfillment::Item
     end
-    
-    it "should return a new order cancellation feed" do
-      @client.new_order_cancellation_feed.should be_an_instance_of(Peddler::Feeds::OrderCancellation::Batch)
+
+    it "returns a new order cancellation feed" do
+      client.new_order_cancellation_feed.should be_an_instance_of Peddler::Feeds::OrderCancellation::Batch
     end
-    
-    it "should return a new cancelled order" do
-      @client.new_cancelled_order.should be_an_instance_of(Peddler::Feeds::OrderCancellation::Item)
+
+    it "returns a new cancelled order" do
+      client.new_cancelled_order.should be_an_instance_of Peddler::Feeds::OrderCancellation::Item
     end
-    
-    it "should return a new refund batch" do
-      @client.new_refund_batch.should be_an_instance_of(Peddler::Refunds::Batch)
+
+    it "returns a new refund batch" do
+      client.new_refund_batch.should be_an_instance_of Peddler::Refunds::Batch
     end
-    
-    it "should return a new report" do
-      @client.new_report(:foo).should be_an_instance_of(Peddler::LegacyReports::Report)
+
+    it "returns a new report" do
+      client.new_report(:foo).should be_an_instance_of Peddler::LegacyReports::Report
     end
-    
   end
-  
 end