campusbooks 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marshall Roch
+
+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
+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.

data/README.rdoc

@@ -0,0 +1,7 @@
+= campusbooks
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Marshall Roch. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 2

data/lib/campusbooks.rb

@@ -0,0 +1,15 @@
+module CampusBooks
+  class Error < StandardError ; end
+
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_key=(key)
+    @api_key = key
+  end
+end
+
+require 'campusbooks/base'
+require 'campusbooks/book'
+require 'campusbooks/offer'

data/lib/campusbooks/base.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+
+module CampusBooks
+  class Base
+    include HTTParty
+    base_uri 'http://api.campusbooks.com/3/rest'
+    format :xml
+
+    protected
+      def self.get_response(path, options={})
+        res = self.get(path, options)
+        case res['response']['status']
+          when 'ok'
+            return res['response']
+
+          when 'error'
+            err_count = res['response']['errors']['error'].length
+            raise Error, err_count == 1 ? 'An error' : "#{err_count} errors" +
+              " occured while getting path '#{path}' with options #{options.inspect}:\n  " +
+              res['response']['errors']['error'].join("\n  ")
+        end
+      end
+
+  end
+end

data/lib/campusbooks/book.rb

@@ -0,0 +1,83 @@
+require 'isbn/tools'
+
+module CampusBooks
+  class Book < Base
+    SUPPORTED_PARAMS = [
+      :isbn10,          # Ten-Digit ISBN for this book
+      :isbn13,          # Thirteen-Digit ISBN for this book
+      :title,           # Book Title
+      :author,          # Book Author
+      :binding,         # Book Binding
+      :msrp,            # List price for the book
+      :pages,           # Number of pages in the book
+      :publisher,       # Book Publisher
+      :published_date,  # Published Date
+      :edition,         # Edition
+      :description      # A text description for the book
+    ]
+    attr_reader *SUPPORTED_PARAMS
+    alias_method :isbn, :isbn13
+
+    def self.find(isbn, opts = {})
+      isbn = isbn.to_s
+      canonical_isbn = (ISBN_Tools.is_valid_isbn13?(isbn) ? isbn : ISBN_Tools.isbn10_to_isbn13(isbn)) or raise ArgumentError.new('isbn is invalid')
+      
+      include_prices = opts[:include] && [*opts[:include]].include?(:prices)
+
+      raw_result = get_response(include_prices ? '/bookprices' : '/bookinfo', :query => { 
+        :isbn => canonical_isbn, :key => CampusBooks.api_key 
+      })
+      
+      book_params = include_prices ? raw_result['page']['book'] : raw_result['page']
+      
+      if raw_result['page']['offers']
+        book_params['offers'] = flatten_offers(raw_result['page']['offers'])
+      end
+      
+      new(book_params)
+    end
+
+    def initialize(params = {})
+      create_offers(params.delete('offers')) if params.key?('offers')
+
+      SUPPORTED_PARAMS.each do |param|
+        instance_variable_set("@#{param}", params[param.to_s]) if params.key?(param.to_s)
+      end
+    end
+
+    def published_date
+      @parsed_published_date ||= Date.parse(@published_date)
+    end
+
+    def offers
+      if !@offers_loaded
+        raw_offers = get_response('/prices', :query => { :isbn => @isbn, :key => CampusBooks.api_key })['page']
+        create_offers(self.class.flatten_offers(raw_offers))
+      end
+      @offers
+    end
+
+    private
+      def self.flatten_offers(data)
+        result = []
+        data['condition'].each do |condition|
+          if condition['offer']
+            if condition['offer'].is_a?(Array)
+              condition['offer'].each do |offer|
+                result.push(offer)
+              end
+            else
+              result.push(condition['offer'])
+            end
+          end
+        end
+        result
+      end
+      
+      def create_offers(offer_hashes)
+        @offers = offer_hashes.inject([]) { |ary, offer_hash| ary.push(Offer.new(offer_hash)) }
+        @offers_loaded = true
+        return @offers
+      end
+  end
+end

data/lib/campusbooks/offer.rb

@@ -0,0 +1,35 @@
+module CampusBooks
+  class Offer < Base
+    SUPPORTED_PARAMS = [
+      :isbn,                # The ISBN for this offer
+      :isbn13,              # The thirteen digit ISBN for this offer
+      :isbn10,              # The ten digit ISBN for this offer
+      :merchant_id,         # A numeric merchant ID (Note, this value may be signed)
+      :merchant_name,       # The Name of the merchant (looked up from the defined constants)
+      :price,               # The price that this merchant is listing this item for
+      :shipping_ground,     # The cost to ship to an address in the US via ground services
+      :total_price,         # Seller price plus the ground shipping price
+      :link,                # Link to purchase the book
+      :condition_id,        # Numeric representation of the condition (see constants)
+      :condition_text,      # Text representation of the condition
+      :availability_id,     # Numeric representation of the availability (how long it takes for the seller to ship it)
+      :availability_text,   # Text representation of the availability
+      :location,            # Geographic location where this item ships from (not always present)
+      :their_id,            # The merchant's id for this offer (not always present)
+      :comments,            # Comments about this offering
+      :condition_text       # Text representation of the condition
+    ]
+    attr_reader *SUPPORTED_PARAMS
+    
+    def initialize(params = {})
+      SUPPORTED_PARAMS.each do |param|
+        instance_variable_set("@#{param}", params[param.to_s]) if params.key?(param.to_s)
+      end
+    end
+    
+    # Fall back on ISBN13 or ISBN10 if @isbn isn't set
+    def isbn
+      @isbn || @isbn13 || @isbn10
+    end
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class BaseTest < Test::Unit::TestCase
+
+  def setup
+    CampusBooks.api_key = 'SmT8KuLkGvy7SexotRTB'
+  end
+
+  should "parse OK response and return just the response" do
+    expected_response = {
+      "status"=>"ok", 
+      "version"=>"1", 
+      "page" => {
+        "name"=>"bookinfo",
+        "rating"=>"5.0",
+        "category"=>nil,
+        "title"=>"The Ruby Programming Language",
+        "isbn10"=>"0596516177",
+        "tried_amazon"=>"1",
+        "author"=>"David Flanagan - Yukihiro Matsumoto",
+        "msrp"=>"39.99",
+        "rank"=>"19257",
+        "isbn13"=>"9780596516178",
+        "publisher"=>"O'Reilly Media, Inc.",
+        "pages"=>"446",
+        "edition"=>"Paperback",
+        "binding"=>"Paperback",
+        "published_date"=>"2008-01-25",
+        "image"=>"http://ecx.images-amazon.com/images/I/41n-JSlBHkL._SL75_.jpg"
+      }, 
+      "label"=>{
+        "name"=>"Scheduleman Tartan",
+        "plid"=>"1709"
+      }
+    }
+    CampusBooks::Base.expects(:get).once.returns({
+      "response" => expected_response
+    })
+    actual_response = CampusBooks::Base.get_response('/bookinfo', :query => { :isbn => '9780596516178' })
+    assert_equal expected_response, actual_response
+  end
+  
+  should "raise an exception when an API error occurs" do
+    CampusBooks::Base.expects(:get).once.returns({
+      "response" => {
+        "status" => "error",
+        "errors" => {
+          "error" => [
+            "Permission Denied - Invalid or missing API Key",
+            "'isbn' parameter is required",
+            "'' is not a valid ISBN",
+            "Unable to create a book with isbn "
+          ]
+        },
+        "version" => "3"
+      }
+    })
+    exception = assert_raise CampusBooks::Error do
+      CampusBooks::Base.get_response('/bookinfo', :query => { :isbn => '' })
+    end
+    assert_equal %Q{4 errors occured while getting path '/bookinfo' with options {:query=>{:isbn=>""}}:
+  Permission Denied - Invalid or missing API Key
+  'isbn' parameter is required
+  '' is not a valid ISBN
+  Unable to create a book with isbn }, exception.message
+  end
+end

data/test/book_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class BookTest < Test::Unit::TestCase
+  VALID_ISBN13 = '9780596516178'
+  VALID_ISBN10 = '0596516177'
+
+  def setup
+    CampusBooks.api_key = 'SmT8KuLkGvy7SexotRTB' # 'AbC123dEFG4H5jkl6MNO'
+  end
+
+  should "store ISBN from constructor" do
+    mock_successful_request
+    book = CampusBooks::Book.find(VALID_ISBN13)
+    assert_equal VALID_ISBN13, book.isbn
+  end
+
+  should "convert ISBN10 to ISBN13" do
+    mock_successful_request
+    book = CampusBooks::Book.find(VALID_ISBN10)
+    assert_equal VALID_ISBN13, book.isbn
+  end
+
+  should "validate ISBN during construction" do
+    assert_nothing_raised do
+      mock_successful_request
+      CampusBooks::Book.find(VALID_ISBN10)
+    end
+    assert_raise ArgumentError, 'isbn is invalid' do
+      CampusBooks::Book.find('0-596-51617-8')
+    end
+  end
+
+  should "get valid values" do
+    mock_successful_request
+    book = CampusBooks::Book.find(VALID_ISBN13)
+    assert_equal VALID_ISBN10, book.isbn10
+    assert_equal VALID_ISBN13, book.isbn13
+    assert_equal VALID_ISBN13, book.isbn
+    assert_equal 'The Ruby Programming Language', book.title
+    assert_equal 'David Flanagan - Yukihiro Matsumoto', book.author
+    assert_equal 'Paperback', book.binding
+    assert_equal '39.99', book.msrp
+    assert_equal '446', book.pages
+    assert_equal "O'Reilly Media, Inc.", book.publisher
+    assert_equal Date.parse('2008-01-25'), book.published_date
+    assert_equal 'Paperback', book.edition
+    assert_equal 'Foo bar', book.description
+  end
+  
+  should "include prices" do
+    book = CampusBooks::Book.find(VALID_ISBN13, :include => :prices)
+  end
+
+  private
+    def mock_successful_request
+      CampusBooks::Book.expects(:get).once.returns({
+        "response" => {
+          "status"=>"ok", 
+          "version"=>"1", 
+          "page" => {
+            "name"=>"bookinfo",
+            "rating"=>"5.0",
+            "category"=>nil,
+            "title"=>"The Ruby Programming Language",
+            "isbn10"=>"0596516177",
+            "tried_amazon"=>"1",
+            "author"=>"David Flanagan - Yukihiro Matsumoto",
+            "msrp"=>"39.99",
+            "rank"=>"19257",
+            "isbn13"=>"9780596516178",
+            "publisher"=>"O'Reilly Media, Inc.",
+            "pages"=>"446",
+            "edition"=>"Paperback",
+            "binding"=>"Paperback",
+            "published_date"=>"2008-01-25",
+            "image"=>"http://ecx.images-amazon.com/images/I/41n-JSlBHkL._SL75_.jpg",
+            "description" => 'Foo bar'
+          }, 
+          "label"=>{
+            "name"=>"Scheduleman Tartan",
+            "plid"=>"1709"
+          }
+        }
+      })
+    end
+    
+    def mock_failed_request(isbn = '0-596-51617-8')
+      CampusBooks::Book.expects(:get).once.returns({
+        "response" => {
+          "status" => "error",
+          "errors" => {
+            "error" => [
+              "'#{isbn}' is not a valid ISBN"
+            ]
+          },
+          "version" => "3"
+        }
+      })
+    end
+end

data/test/offer_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class OfferTest < Test::Unit::TestCase
+  
+  should "set params in constructor" do
+    offer = CampusBooks::Offer.new({
+      "merchant_id" => "24",
+      "price"=>"11.93",
+      "shipping_ground"=>"3.99",
+      "condition_id"=>"2",
+      "availability_id"=>"2",
+      "comments"=>"Good condition. Absolutely no highlighting or markings inside the books. Decent covers subject to prior use.",
+      "isbn10"=>"0596516177",
+      "total_price"=>"15.92",
+      "isbn13"=>"9780596516178",
+      "merchant_name"=>"Amazon Marketplace",
+      "availability_text"=>"Ready to ship",
+      "link"=>"http://partners.campusbooks.com/link.php?params=ABCDEF",
+      "condition_text"=>"Used"
+    })
+    #assert_equal '9780596516178', offer.isbn
+    assert_equal '9780596516178', offer.isbn13
+    assert_equal '0596516177', offer.isbn10
+    assert_equal '24', offer.merchant_id
+    assert_equal 'Amazon Marketplace', offer.merchant_name
+    assert_equal '11.93', offer.price
+    assert_equal '3.99', offer.shipping_ground
+    assert_equal '15.92', offer.total_price
+    assert_equal 'http://partners.campusbooks.com/link.php?params=ABCDEF', offer.link
+    assert_equal '2', offer.condition_id
+    assert_equal 'Used', offer.condition_text
+    assert_equal '2', offer.availability_id
+    assert_equal 'Ready to ship', offer.availability_text
+
+    # FIXME: Need an example of these
+    # assert_equal 'foo', offer.location
+    # assert_equal 'foo', offer.their_id
+    # assert_equal 'foo', offer.comments
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+begin
+  require 'shoulda'
+rescue LoadError
+  puts "Shoulda not available. Install it with: sudo gem install thoughtbot-shoulda -s http://gems.github.com"
+end
+begin
+  require 'mocha'
+rescue LoadError
+  puts "Mocha not available. Install it with: sudo gem install mocha"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'campusbooks'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: campusbooks
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Marshall Roch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: isbn-tools
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A Ruby library for accessing the CampusBooks.com API
+email: marshall@mroch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/campusbooks/base.rb
+- lib/campusbooks/book.rb
+- lib/campusbooks/offer.rb
+- lib/campusbooks.rb
+- test/base_test.rb
+- test/book_test.rb
+- test/offer_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/mroch/campusbooks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: CampusBooks API for Ruby
+test_files: []
+