titlepage 1.3.0 → 1.4.0

data/Rakefile

@@ -6,11 +6,9 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "1.3.0"
+PKG_VERSION = "1.4.0"
 PKG_NAME = "titlepage"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBYFORGE_PROJECT = 'rbook'
-RUBYFORGE_USER = 'yob'
 
 CLEAN.include "**/.*.sw*"
 
@@ -69,13 +67,13 @@ spec = Gem::Specification.new do |spec|
   spec.has_rdoc = true
   spec.extra_rdoc_files = %w{README COPYING LICENSE}
   spec.rdoc_options << '--title' << 'titlepage Documentation' << '--main'  << 'README' << '-q'
-  spec.add_dependency('rbook-isbn', '>= 1.0')
-  spec.add_dependency('andand', '1.3.1')
-  spec.add_dependency('handsoap', '>= 1.0')
+  spec.add_dependency('isbn10', '~>1.1')
+  spec.add_dependency('andand', '~>1.3')
+  spec.add_dependency('handsoap', '~>1.0')
+  spec.add_dependency('ean13', '~>1.4')
   spec.author = "James Healy"
   spec.email = "jimmy@deefa.com"
-  spec.rubyforge_project = "rbook"
-  spec.homepage = "http://rbook.rubyforge.org/"
+  spec.homepage = "http://github.com/yob/titlepage"
   spec.description = "This library is designed to assist with using the titlepage.com SOAP API."
 end
 

data/lib/titlepage.rb

@@ -3,7 +3,8 @@
 require "bigdecimal"
 require "handsoap"
 require "andand"
-require "rbook/isbn"
+require "isbn10"
+require "ean13"
 
 # a convenience module for accessing the SOAP API for http://www.titlepage.com.
 # Uses boilerplate code generated by soap4r.
@@ -40,4 +41,4 @@ end
 require File.dirname(__FILE__) + '/titlepage/driver'
 require File.dirname(__FILE__) + '/titlepage/utils'
 require File.dirname(__FILE__) + '/titlepage/client'
-require File.dirname(__FILE__) + '/titlepage/wwwclient'
+require File.dirname(__FILE__) + '/titlepage/rest'

data/lib/titlepage/client.rb

@@ -54,8 +54,7 @@ module TitlePage
 
     def all(isbn)
       return NotLoggedInError, 'You must login to titlepage API before performing a search' unless @token
-      isbn = RBook::ISBN::convert_to_isbn13(isbn)
-      return nil if isbn.nil?
+      isbn = ISBN10.new(isbn).to_ean || isbn
       @driver.search_by_isbn13(@token, isbn)
     end
 

data/lib/titlepage/rest.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+###################################################################
+# A proxy REST web service for the titlepage SOAP API.
+#
+# Requires no state and exists to serialise requests to the authoritive
+# API so that an organisation can avoid exceeding the API usage limits.
+#
+# To use this REST wrapper, run the following:
+#
+#     thin -R config.ru -p 4567 start
+#
+# This make the following request:
+#
+#     curl http://127.0.0.1:4567/username/password/ean
+#
+# Returns 400 if the requested EAN is invalid
+# Returns 401 if the titlepage API returned an error, often an authentication issue
+# Returns 404 if the requested EAN wasn't found on titlepage
+# Returns 408 if the titlepage API didn't respond in time
+# Returns 200 and a YAML serialised hash of results if the query was successful
+#
+###################################################################
+
+require 'rubygems'
+require 'sinatra/base'
+require 'ean13'
+require 'yaml'
+require 'timeout'
+
+module TitlePage
+  class Rest < Sinatra::Base
+
+    TIMESTAMP_FILE = "/tmp/titlepage.dat"
+
+    # We only respond to 1 URI
+    get '/:username/:password/:ean' do |username, password, ean|
+      status(400) and return unless EAN13.valid?(ean)
+
+      while (!update_file)
+        sleep 0.5
+      end
+
+      result = nil
+
+      begin
+        TitlePage::Client.open(username, password) do |tp|
+          Timeout::timeout(6) do
+            result = tp.first(ean)
+          end
+        end
+      rescue Timeout::Error
+        status(408) and return
+      rescue Handsoap::Fault
+        status(401) and return
+      end
+
+      if result
+        YAML.dump(result.to_hash)
+      else
+        status(404)
+      end
+    end
+
+    private
+
+    # update a lock file that we use to track when the last query was proxied
+    # through to the authoritive Titlepage API. 
+    #
+    # Updates the file and returns true if no query was made in the previous 3
+    # seconds, otherwise doesn't update the file and returns false.
+    #
+    # Used to ensure we don't exceed the query limit.
+    #
+    def update_file
+      if File.file?(TIMESTAMP_FILE)
+        if Time.now.to_i - File.mtime(TIMESTAMP_FILE).to_i > 3
+          File.open(TIMESTAMP_FILE, "w") { |of| of.write "titlepage timestamp"}
+          true
+        else
+          false
+        end
+      else
+        File.open(TIMESTAMP_FILE, "w") { |of| of.write "titlepage timestamp"}
+        true
+      end
+    end
+  end
+end

data/lib/titlepage/utils.rb

@@ -131,6 +131,7 @@ module TitlePage
       price = self.new
       price.price_type_code = node.xpath("//Price/PriceTypeCode/text()").first.andand.to_s
       val = node.xpath("//Price/PriceAmount/text()").first.andand.to_s
+      val = val.gsub(/[^\d\.]/,"") # strip any extra chars (like commas)
       price.price_amount = BigDecimal.new(val) if val.size > 0
       price
     end
@@ -218,9 +219,8 @@ module TitlePage
         :availability => self.supply_detail.product_availability,
         :on_hand  => self.supply_detail.stock.on_hand,
         :on_order  => self.supply_detail.stock.on_order,
-        :expected_shop_date => self.supply_detail.expected_ship_date,
-        :pack_quantity => self.supply_detail.pack_quantity,
-
+        :expected_ship_date => self.supply_detail.expected_ship_date,
+        :pack_quantity => self.supply_detail.pack_quantity
       }
     end
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: titlepage
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  hash: 7
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - James Healy
@@ -9,39 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 +11:00
+date: 2010-09-03 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rbook-isbn
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: isbn10
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.0"
-    version: 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: andand
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.3.1
-    version: 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: handsoap
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ean13
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id004
 description: This library is designed to assist with using the titlepage.com SOAP API.
 email: jimmy@deefa.com
 executables: []
@@ -53,19 +89,18 @@ extra_rdoc_files:
 - COPYING
 - LICENSE
 files: 
-- examples/titlepage_www.rb
 - examples/titlepage.rb
 - lib/titlepage.rb
 - lib/titlepage/utils.rb
+- lib/titlepage/rest.rb
 - lib/titlepage/client.rb
-- lib/titlepage/wwwclient.rb
 - lib/titlepage/driver.rb
 - Rakefile
 - README
 - COPYING
 - LICENSE
 has_rdoc: true
-homepage: http://rbook.rubyforge.org/
+homepage: http://github.com/yob/titlepage
 licenses: []
 
 post_install_message: 
@@ -78,21 +113,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: rbook
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A library for using the titlepage.com API

data/examples/titlepage_www.rb

@@ -1,10 +0,0 @@
-# assuming you have titlepage installed via rubygems,
-# in a regular script, replace the following require
-# line with these 2 lines:
-#   require 'rubygems'
-#   require 'titlepage'
-require File.dirname(__FILE__) + '/../lib/titlepage'
-
-TitlePage::WWWClient.open("username","password") do |client|
-  puts client.get_onix_file("9780060000707")
-end

data/lib/titlepage/wwwclient.rb

@@ -1,100 +0,0 @@
-# encoding: utf-8
-
-module TitlePage
-
-  # A helper class for grabbing ONIX files from titlepage.com
-  #
-  # A valid login is required, see the site for information on applying
-  # for access.
-  #
-  # You should be aware of any limits of query volume imposed by the provider - currently a
-  # maximum of 30 queries per minute is permitted.
-  #
-  # = Usage
-  #
-  #   TitlePage::WWWClient.open("username","password") do |tp|
-  #     puts tp.get_onix_file("9780091835132")
-  #   end
-  #
-  class WWWClient
-
-    TITLEPAGE_DOMAIN = "www.titlepage.com"
-
-    def get_onix_file(isbn)
-      isbn = RBook::ISBN.convert_to_isbn13(isbn)
-      raise ArgumentError, 'Invalid ISBN supplied' if isbn.nil?
-
-      headers = { 'Cookie' => @cookie }
-
-      login_response = Net::HTTP.start(TITLEPAGE_DOMAIN, 80) do |http|
-        data = [
-          "posted=yes",
-          "quicksearch=#{isbn}",
-          "qsrchby=isbn13",
-            "detailed=Search"
-        ].join("&")
-        http.post('/results.php', data, headers)
-      end
-      regex = /onclick=\"bookPopUp\(\'(.+)\'\);\"/
-        code = login_response.body.match(regex)
-      if code.nil?
-        return nil
-      else
-        code = code[1]
-      end
-      onix_file = Net::HTTP.start(TITLEPAGE_DOMAIN, 80) do |http|
-        data = [
-          "download=Download",
-          "rr=#{code}"
-        ].join("&")
-        http.post('/detail.php', data, headers)
-      end
-      return onix_file.body
-    end
-
-    # login to the titlepage website.
-    def login(username, password)
-      login_response = Net::HTTP.start(TITLEPAGE_DOMAIN, 80) do |http|
-        data = [
-          "usr=#{username}",
-          "pwd=#{password}",
-          "login=Login"
-        ].join("&")
-        headers = { 'Referer' => 'http://www.titlepage.com/index.php' }
-        http.post('/index.php', data, headers)
-      end
-      @cookie = login_response['set-cookie']
-    end
-
-    # logout from the titlepage API
-    def logout
-      if @cookie
-        login_response = Net::HTTP.start(TITLEPAGE_DOMAIN, 80) do |http|
-          http.get("/logout.php")
-        end
-        @cookie = nil
-      end
-    end
-
-    # a convenience method to make queries to title page a little cleaner. This function
-    # essentially calls the login and logout functions for you automatically.
-    #
-    #  TitlePage::WWWClient.open("username","password") do |tp|
-    #    result = tp.get_onix_file("9780091835132")
-    #  end
-    def self.open(username, password)
-
-      tp = self.new
-
-      begin
-        tp.login(username, password)
-
-        yield(tp)
-
-      ensure
-        tp.logout
-      end
-    end
-
-  end
-end