amazon_seller_central 0.1.1 → 0.2.0

data/README.md

@@ -1,7 +1,8 @@
-# amazon_seller_central
+# amazon\_seller\_central
 
 This gem is intended to wrap Amazon's SellerCentral pages with a Ruby
-API. Currently this gem supports accessing buyer feedback only.
+API. Currently this gem supports accessing buyer feedback, accessing
+current inventory listings, and simple updates to those listings.
 
 ## Setup
 
@@ -36,14 +37,50 @@ the block form:
       feedback.rating            # an integer, 1 - 5
     end
 
-## ToDo
+## Inventory Access
+
+You can access current inventory in much the same way as feedback:
+
+    AmazonSellerCentral::Inventory.each_page do |page|
+      listings = page.listings
+      listing = listings.first
+
+      listing.sku          # <Your sku for this listing>
+      listing.asin         # An ASIN, e.g. B003962DXE
+      listing.product_name # The name of the product
+      listing.created_at   # a Time object representing when you created this listing
+      listing.quantity     # an integer
+      listing.condition    # "New" or "Used - Very Good" or whichever
+      listing.price_cents  # an integer of cents. listing.price is also available to get dollars
+      listing.status       # "Open", "Closed (Out of Stock)", or "Incomplete"
+    end
+
+## Updating Inventory
+
+Currently this gem supports updating a listing you've already created
+via the web interface or some other API. Future versions may include
+creating listing entries from scratch.
+
+To update a listing, you use `ListingPage#apply_listings`, like so:
+
+    # alternately get a page inside the 'each_page' method above
+    page = AmazonSellerCentral::Inventory.load_first_page
+    # Updating a listing for my sku, "PR6902-2":
+    listing = page.listings.find("PR6902-2")
+    listing.quantity = 10
+    listing.price_cents = 1599
+    # Note the array syntax here allows you to update multiple listings
+    # on this page at the same time.
+    page.apply_listings([listing])
+
+## TODO
 
 * Access to more sections of Amazon SellerCentral.
 * Rework Mechanize access to allow parallel / thread-safe usage
 * **Note**: This library is likely not thread-safe. (It's untested)
 
-## Contributing to amazon_seller_central
- 
+## Contributing to amazon\_seller\_central
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/amazon_seller_central.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amazon_seller_central}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["optoro"]
-  s.date = %q{2011-07-09}
+  s.date = %q{2011-09-01}
   s.description = %q{This gem is intended to wrap Amazon's SellerCentral pages with a Ruby API. Currently this gem supports accessing buyer feedback only.}
   s.email = %q{dev@optoro.com}
   s.extra_rdoc_files = [
@@ -31,12 +31,23 @@ Gem::Specification.new do |s|
     "lib/amazon_seller_central/configuration.rb",
     "lib/amazon_seller_central/feedback.rb",
     "lib/amazon_seller_central/feedback_page.rb",
+    "lib/amazon_seller_central/inventory.rb",
+    "lib/amazon_seller_central/inventory_page.rb",
+    "lib/amazon_seller_central/listing.rb",
+    "lib/amazon_seller_central/listing_set.rb",
     "lib/amazon_seller_central/mechanizer.rb",
+    "lib/amazon_seller_central/page.rb",
     "spec/amazon_seller_central_spec.rb",
     "spec/lib/feedback_page_spec.rb",
     "spec/lib/feedback_spec.rb",
+    "spec/lib/inventory_page_spec.rb",
+    "spec/lib/inventory_spec.rb",
+    "spec/lib/listing_set_spec.rb",
+    "spec/lib/listing_spec.rb",
     "spec/lib/mechanizer_spec.rb",
     "spec/spec_helper.rb",
+    "spec/support/page_body_regexen.rb",
+    "spec/support/page_examples.rb",
     "spec/support/sample_pages.rb",
     "spec/support/sample_pages/Feedback Manager.html",
     "spec/support/sample_pages/Feedback Page 1.html",
@@ -44,12 +55,19 @@ Gem::Specification.new do |s|
     "spec/support/sample_pages/Feedback Page Last.html",
     "spec/support/sample_pages/Seller Central Homepage.html",
     "spec/support/sample_pages/Seller Central Redirect.html",
-    "spec/support/sample_pages/Seller Central.html"
+    "spec/support/sample_pages/Seller Central.html",
+    "spec/support/sample_pages/another_listings_page.html",
+    "spec/support/sample_pages/listings_last_page.html",
+    "spec/support/sample_pages/listings_page_1.html",
+    "spec/support/sample_pages/listings_page_2.html",
+    "spec/support/sample_pages/update_inventory_result_from_last_page.html",
+    "spec/support/sample_pages/update_inventory_result_from_page_1.html",
+    "spec/support/sample_pages/update_inventory_result_from_page_2.html"
   ]
   s.homepage = %q{http://github.com/optoro/amazon_seller_central}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
+  s.rubygems_version = %q{1.5.0}
   s.summary = %q{Ruby API to access Amazon's SellerCentral}
 
   if s.respond_to? :specification_version then

data/lib/amazon_seller_central/feedback_page.rb

@@ -1,20 +1,11 @@
 module AmazonSellerCentral
-  class FeedbackPage
+  class FeedbackPage < Page
     attr_accessor :body
 
-    def initialize(options={})
-      @page = options.delete(:page)
-      @body = @page ? @page.body : ""
-    end
-
     def has_next?
       @has_next ||= @page.search('a').map(&:text).grep(/Next/).count > 0
     end
 
-    def last_page?
-      !has_next?
-    end
-
     def next_page
       @next_page ||= begin
                        raise NoNextPageAvailableError unless has_next?
@@ -54,9 +45,6 @@ module AmazonSellerCentral
 
     extend ClassMethods
 
-    class NoNextPageAvailableError < StandardError
-    end
-
     private
         def feedback_row_to_object(row)
           data = row.search('.//td').map(&:text)

data/lib/amazon_seller_central/inventory.rb

@@ -0,0 +1,23 @@
+module AmazonSellerCentral
+  class Inventory
+    module ClassMethods
+      def load_first_page
+        AmazonSellerCentral.mechanizer.login_to_seller_central
+        manage_inventory = AmazonSellerCentral.mechanizer.follow_link_with(:text => "Manage Inventory")
+        InventoryPage.new( :page => manage_inventory, :page_no => 1, :uri_base => manage_inventory.uri.to_s )
+      end
+
+      def load_all_pages
+        pages = [load_first_page]
+        while pages.last.has_next?
+          pages << pages.last.next_page
+          yield pages.last if block_given?
+        end
+        pages
+      end
+      alias each_page load_all_pages
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/amazon_seller_central/inventory_page.rb

@@ -0,0 +1,126 @@
+module AmazonSellerCentral
+  class InventoryPage < Page
+    def initialize(options={})
+      @listings_applied = false
+      @page_no  = options.delete(:page_no)
+      @uri_base = options.delete(:uri_base)
+      super
+    end
+
+    def has_next?
+      @has_next ||= @page.search(".//div[@id='nextPage']").any?
+    end
+
+    def next_page
+      @next_page ||= begin
+                       raise NoNextPageAvailableError unless has_next?
+
+                       next_page = AmazonSellerCentral.mechanizer.agent.get("#{@uri_base}&searchPageOffset=#{@page_no + 1}")
+                       InventoryPage.new(
+                         :page => next_page,
+                         :page_no => (@page_no + 1),
+                         :uri_base => @uri_base
+                       )
+                     end
+    end
+
+    def listings(rescan=false)
+      @listings = nil if rescan
+      @listings ||= begin
+                      set = ListingSet.new
+                      # being more specific here breaks on some pages
+                      @page.parser.css('tr').select{|r| r['id'] =~ /^sku-/ && r.css('td').size == 12 }.each do |row|
+                        set << listing_row_to_object(row)
+                      end
+                      set
+                    end
+    end
+    alias :parse :listings
+
+    def apply_listings(new_listings)
+      if @listings_applied
+        raise UnsupportedModification.new("Can't apply listing data twice from the same page object. Refetch this page before attempting to update listings")
+      end
+
+      form = @page.form_with(:name => 'itemSummaryForm')
+      new_listings.each do |l|
+        if listings(true).find(l.sku).price.nil? && l.price != nil
+          raise UnsupportedModification.new("Can't set price for #{l.asin} to $#{l.price}, the listing is not yet complete and this library doesn't yet support completing listings")
+        end
+
+        form["inv|#{l.sku}|#{l.asin}"]   = l.quantity
+        form["price|#{l.sku}|#{l.asin}"] = l.price 
+      end
+      form['formOperation'] = 'saveChanges'
+      r = form.submit
+      @listings_applied = true
+      true
+    end
+
+    class UnsupportedModification < StandardError; end
+
+    private
+
+      # 0 - hidden input of sku
+      # 1 - checkbox itemOffer
+      # 2 - actions
+      # 3 - sku
+      # 4 - asin
+      # 5 - product name
+      # 6 - date created
+      # 7 - qty
+      # 8 - condition
+      # 9 - your price
+      # 10 - low price
+      # 11 - status
+      def listing_row_to_object(row)
+        l = Listing.new
+        row.css('td').each_with_index do |td, i|
+
+          txt = td.text.strip # yes, slightly slower to do this here, but I type less.
+
+          case i
+          when 3
+            l.sku = txt
+          when 4
+            l.asin = txt
+          when 5
+            l.product_name = txt
+          when 6
+            l.created_at = Time.parse(txt)
+          when 7
+            l.quantity = td.css('input').first['value'].to_i
+          when 8
+            l.condition = txt
+          when 9
+            l.price = get_price(td)
+          when 10
+            l.low_price = get_low_price(td)
+          when 11
+            l.status = txt
+          end
+        end
+        l
+      end
+
+      def get_price(td)
+        if td.css('input').size == 0 # incomplete listing
+          nil
+        else
+          td.css('input').first['value'].to_f
+        end
+      end
+
+      # Turns out you can't get this without a subrequest
+      def get_low_price(td)
+        nil
+        # if td.css('a').size == 0 # no listing complete
+        #   nil
+        # elsif td.css('a div').size == 1
+        #   true
+        # else
+        #   td.text.gsub(/[^\d.]/,'').to_f
+        # end
+      end
+  end
+end

data/lib/amazon_seller_central/listing.rb

@@ -0,0 +1,42 @@
+module AmazonSellerCentral
+  # It turns out you can't get low_price without executing a sub-request, so
+  # I'm leaving it alone for now.
+  class Listing
+    module ClassMethods
+      def is_asin?(value)
+        value.to_s =~ /^B.{9}$/
+      end
+    end
+    extend ClassMethods
+
+    attr_accessor :sku, :asin, :product_name, :created_at, :quantity, :condition, :price_cents, :low_price_cents, :status
+
+    alias :qty :quantity
+    alias :qty= :quantity=
+
+    alias :product :product_name
+    alias :product= :product_name=
+
+    def price
+      @price_cents.kind_of?(Numeric) ? @price_cents / 100.0 : @price_cents
+    end
+    def price=(price)
+      @price_cents = price.kind_of?(Numeric) ? (price * 100).round : price
+    end
+
+    alias :your_price :price
+    alias :your_price= :price=
+
+    def low_price
+      @low_price_cents.kind_of?(Numeric) ? @low_price_cents / 100.0 : @low_price_cents
+    end
+    def low_price=(low_price)
+      @low_price_cents = low_price.kind_of?(Numeric) ? (low_price * 100).round : low_price
+    end
+
+    def save
+      puts "Sorry, you want to send this listing as part of an array to the InventoryPage it came from, with InventoryPage#apply_listings"
+      false
+    end
+  end
+end

data/lib/amazon_seller_central/listing_set.rb

@@ -0,0 +1,13 @@
+module AmazonSellerCentral
+  class ListingSet < Array
+
+    def find(selector)
+      if Listing.is_asin?(selector)
+        select{|e| e.asin == selector }
+      else
+        detect{|e| e.sku == selector }
+      end
+    end
+
+  end
+end

data/lib/amazon_seller_central/mechanizer.rb

@@ -5,7 +5,7 @@ module AmazonSellerCentral
     include Singleton
     MASQUERADE_AGENTS = ['Mac Safari', 'Mac FireFox', 'Linux Firefox']
 
-    attr_reader :agent, :last_page
+    attr_reader :agent
 
     def login_email
       AmazonSellerCentral.configuration.login_email
@@ -19,25 +19,30 @@ module AmazonSellerCentral
       @agent ||= Mechanize.new {|ag| ag.user_agent_alias = MASQUERADE_AGENTS[rand(MASQUERADE_AGENTS.size)] }
     end
 
+    def last_page
+      agent.current_page
+    end
+
     def login_to_seller_central
       page = agent.get('https://sellercentral.amazon.com/')
       form = page.form_with(:name => 'signin')
 
-      form.email = login_email
+      form.email    = login_email
       form.password = login_password
-      @last_page = form.submit
+      form.submit
+      last_page.body =~ /Welcome! You are signed in as/
     end
 
     def follow_link_with(options)
       raise AgentResetError unless last_page
       link = last_page.link_with(options)
       raise LinkNotFoundError unless link
-      @last_page = agent.click(link)
+      agent.click(link)
     end
 
     def reset!
       @agent     = nil
-      @last_page = nil
+      #@last_page = nil
     end
 
     class LinkNotFoundError < StandardError; end

data/lib/amazon_seller_central/page.rb

@@ -0,0 +1,26 @@
+module AmazonSellerCentral
+  class Page
+    attr_accessor :body
+
+    def initialize(options={})
+      @page = options.delete(:page)
+      @body = @page ? @page.body : ""
+    end
+
+    def has_next?
+      false
+    end
+
+    def last_page?
+      !has_next?
+    end
+
+    def next_page
+      raise NoNextPageAvailableError.new("Unimplemented, override Page#next_page")
+    end
+
+    class NoNextPageAvailableError < StandardError
+    end
+
+  end
+end

data/lib/amazon_seller_central.rb

@@ -1,7 +1,12 @@
 require 'amazon_seller_central/configuration'
 require 'amazon_seller_central/mechanizer'
+require 'amazon_seller_central/listing_set'
+require 'amazon_seller_central/page'
 require 'amazon_seller_central/feedback'
 require 'amazon_seller_central/feedback_page'
+require 'amazon_seller_central/listing'
+require 'amazon_seller_central/inventory'
+require 'amazon_seller_central/inventory_page'
 
 module AmazonSellerCentral
   def self.configuration

data/spec/lib/feedback_page_spec.rb

@@ -3,36 +3,16 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "FeedbackPage" do
   before :all do
     #AmazonSellerCentral.mechanizer.reset!
-    @first_page_test_regex  = /Wow!  Amazing price, super fast shipping./
-    @second_page_test_regex = /This printer was not in good shape as the seller described./
-    @last_page_test_regex   = /easy to put together - ignore the first review/
+    @first_page_test_regex  = FEEDBACK_FIRST_PAGE_TEST_REGEX
+    @second_page_test_regex = FEEDBACK_SECOND_PAGE_TEST_REGEX
+    @last_page_test_regex   = FEEDBACK_LAST_PAGE_TEST_REGEX
 
     @first_page  = AmazonSellerCentral::FeedbackPage.load_first_page
     @second_page = @first_page.next_page
     @last_page   = @second_page.next_page
   end
 
-  it "knows if there is a next page of feedback" do
-    @first_page.has_next?.should be_true
-    @second_page.has_next?.should be_true
-    @last_page.has_next?.should be_false
-  end
-
-  it "returns the next page when there is one" do
-    @first_page.next_page.body.should =~ @second_page_test_regex
-  end
-
-  it "raises an exception when asked for a next page and there is none" do
-    lambda {
-      @last_page.next_page
-    }.should raise_exception(AmazonSellerCentral::FeedbackPage::NoNextPageAvailableError)
-  end
-
-  it "knows if it is the last page" do
-    @first_page.last_page?.should be_false
-    @second_page.last_page?.should be_false
-    @last_page.last_page?.should be_true
-  end
+  it_should_behave_like "all pages"
 
   it "transforms itself into a collection of Feedback objects" do
     feedback = @first_page.feedbacks
@@ -40,7 +20,7 @@ describe "FeedbackPage" do
     feedback.last.comments.should == "quick delivery.  product arrived in perfect condition.  good experience."
   end
 
-  describe "class methods" do
+  describe "ClassMethods" do
     it "loads the first page of feedback data" do
       AmazonSellerCentral.mechanizer.reset!
       page = AmazonSellerCentral::FeedbackPage.load_first_page

data/spec/lib/inventory_page_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "InventoryPage" do
+  before :all do
+    @first_page_test_regex  = INVENTORY_FIRST_PAGE_TEST_REGEX
+    @second_page_test_regex = INVENTORY_SECOND_PAGE_TEST_REGEX
+    @last_page_test_regex   = INVENTORY_LAST_PAGE_TEST_REGEX
+  end
+
+  before :each do
+    mock_seller_central_page_results!
+    @first_page  = AmazonSellerCentral::Inventory.load_first_page
+    @second_page = @first_page.next_page
+    @last_page   = @second_page.next_page
+  end
+
+  it_should_behave_like "all pages"
+
+  it "returns a ListingSet for listings" do
+    listings = @first_page.listings
+    listings.should be_kind_of(AmazonSellerCentral::ListingSet)
+  end
+
+  it "transforms itself into a set of Listing objects" do
+    listings = @first_page.listings
+    listings.size.should == 250
+
+    listings[27].sku.should             == "PR30122-11"
+    listings[27].asin.should            == "B0019MU9C2"
+    listings[27].product_name.should    == "Battery Brain Platinum"
+    listings[27].created_at.should      == Time.parse("2011-08-31 00:36:22")
+    listings[27].quantity.should        == 0
+    listings[27].condition.should       == "New"
+    listings[27].price_cents.should     == nil
+    listings[27].low_price.should       == nil
+    listings[27].low_price_cents.should == nil
+    listings[27].status.should          == "Incomplete"
+
+    listings[1].sku.should             == "PR48458-3"
+    listings[1].asin.should            == "B004O0TRDI"
+    listings[1].product_name.should    == "Onkyo HT-S3400 5.1 Channel Home Theater Receiver/Speaker Package"
+    listings[1].created_at.should      == Time.parse("2011-08-31 18:14:49")
+    listings[1].quantity.should        == 1
+    listings[1].condition.should       == "Used - Good"
+    listings[1].price_cents.should     == 22559
+    # listings[1].low_price.should       == true
+    # listings[1].low_price_cents.should == true
+    listings[1].status.should          == "Open"
+
+    listings[10].sku.should             == "PR27880-11"
+    listings[10].asin.should            == "B003962DXE"
+    listings[10].product_name.should    == "Panasonic Lumix DMC-FH20K 14.1 MP Digital Camera with 8x Optical Image Stabilized Zoom and 2.7-Inch LCD (Black)"
+    listings[10].created_at.should      == Time.parse("2011-08-31 10:40:13")
+    listings[10].quantity.should        == 1
+    listings[10].condition.should       == "New"
+    listings[10].price_cents.should     == 10899
+    #listings[10].low_price_cents.should == 10250
+    listings[10].status.should          == "Open"
+  end
+
+  it "loads listings appropriately for another sample page" do
+    # This sample page was only parsing 25 results before
+    FakeWeb.register_uri(:get, 'https://sellercentral.amazon.com/gp/ezdpc-gui/inventory-status/status.html/ref=ag_invmgr_mmap_home', :response => mock_pages[:another_listings_page])
+    listings = AmazonSellerCentral::Inventory.load_first_page.listings
+    listings.size.should == 250
+
+    listings[1].sku.should             == "PR6902-2"
+    listings[1].asin.should            == "B000Q82PIQ"
+    listings[1].product_name.should    == "Western Digital 500 GB Caviar Blue SATA 3 Gb/s 7200 RPM 16 MB Cache Bulk/OEM Desktop Hard Drive - WD5000AAKS"
+    listings[1].created_at.should      == Time.parse("2011-08-31 22:42:13")
+    listings[1].quantity.should        == 1
+    listings[1].condition.should       == "Used - Very Good"
+    listings[1].price_cents.should     == 3819
+    # listings[1].low_price.should       == true
+    listings[1].status.should          == "Open"
+  end
+
+  it "accepts a set of Listing objects to apply updates to the page" do
+    listings = @first_page.listings
+    l = listings[0]
+    # l.quantity = 0
+    # l.price = 225.59
+    l.quantity = 2
+    l.price = 220.99
+
+    listings = [l]
+
+    @first_page.apply_listings(listings).should be_true
+
+    (AmazonSellerCentral.mechanizer.last_page.parser.css('div#msg_saveSuccess')[0]['style'] !~ /display: none/).should be_true
+
+    FakeWeb.register_uri(:get, 'https://sellercentral.amazon.com/gp/ezdpc-gui/inventory-status/status.html/ref=ag_invmgr_mmap_home', :response => mock_pages[:update_inventory_result_from_page_1])
+    listing = AmazonSellerCentral::Inventory.load_first_page.listings[0]
+    listing.sku.should      == l.sku
+    listing.quantity.should == l.quantity
+    listing.price.should    == l.price
+  end
+
+  it "raises an unsupported modification error when trying to set the price on an incomplete listing" do
+    listings = @first_page.listings
+    l = listings[27]
+    l.price = 24.26
+    lambda {
+      @first_page.apply_listings([l])
+    }.should raise_exception(AmazonSellerCentral::InventoryPage::UnsupportedModification)
+  end
+
+  it "raises an unsupported modification error when trying to apply listings twice" do
+    listings = @first_page.listings
+    l = listings[0]
+    l.price = 24.26
+    @first_page.apply_listings([l])
+
+    l.price = 26.26
+    lambda {
+      @first_page.apply_listings([l])
+    }.should raise_exception(AmazonSellerCentral::InventoryPage::UnsupportedModification)
+  end
+
+end

data/spec/lib/inventory_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Inventory" do
+  it "loads the first page of inventory data" do
+    AmazonSellerCentral.mechanizer.reset!
+    page = AmazonSellerCentral::Inventory.load_first_page
+    page.should be_kind_of(AmazonSellerCentral::InventoryPage)
+    page.body.should =~ INVENTORY_FIRST_PAGE_TEST_REGEX
+  end
+
+  it "loads all inventory pages" do
+    AmazonSellerCentral.mechanizer.reset!
+    pages = AmazonSellerCentral::Inventory.load_all_pages
+    pages.size.should == 3
+    pages.first.body.should =~ INVENTORY_FIRST_PAGE_TEST_REGEX
+    pages.last.body.should =~ INVENTORY_LAST_PAGE_TEST_REGEX
+  end
+
+  it "passes a page to a block when given" do
+    last_seen = nil
+    AmazonSellerCentral::Inventory.each_page do |page|
+      last_seen = page
+    end
+    last_seen.body.should =~ INVENTORY_LAST_PAGE_TEST_REGEX
+  end
+end