rbook 0.1

data/lib/rbook/onix/sales_restriction.rb

@@ -0,0 +1,51 @@
+require 'rexml/document'
+require 'rubygems'
+
+module RBook
+module Onix
+
+  class SalesRestriction
+    attr_accessor :type, :detail
+
+    # Attempts to create a contributor object using the supplied xml element
+    def SalesRestriction.load_from_element(element)
+      raise ArgumentError, 'load_from_element expects a REXML element object' unless element.class == REXML::Element
+      
+      if REXML::XPath.first(element, '//SalesRestriction').nil? 
+        raise LoadError, 'supplied REXML document object does not appear contain a valid SalesRestriction fragment'
+      end
+      
+      restriction = SalesRestriction.new
+
+      tmp = REXML::XPath.first(element, '//SalesRestriction/SalesRestrictionType')
+      restriction.type = tmp.text if tmp != nil
+
+      tmp = REXML::XPath.first(element, '//SalesRestriction/SalesRestrictionDetail')
+      restriction.detail = tmp.text if tmp != nil
+
+      return restriction
+
+    end
+ 
+    # Return an xml element representing this contributor
+    def to_element
+      raise 'SalesRestriction must have a type to create an element' if self.type.nil?
+      raise 'Contributor must have a detail to create an element' if self.detail.nil?
+      
+      restriction =  REXML::Element.new('SalesRestriction') 
+      restriction.add_element('SalesRestrictionType').text = self.type.to_xs
+      restriction.add_element('SalesRestrictionDetail').text = self.detail.to_xs
+      
+      return restriction
+    end
+ 
+    # Return an XML string representing this contributor
+    def to_s
+      tmp = to_element
+      output = ''
+      tmp.write(output, 0)
+      return output
+    end
+  end
+end
+end

data/lib/rbook/onix/supply_detail.rb

@@ -0,0 +1,68 @@
+require 'rexml/document'
+require 'bigdecimal'
+require 'rubygems'
+
+module RBook
+module Onix
+
+  class SupplyDetail
+    attr_accessor :supplier_name, :availability_code, :intermediary_availability_code, :price
+
+    # Attempts to create a contributor object using the supplied xml element
+    def self.load_from_element(element)
+      raise ArgumentError, 'load_from_element expects a REXML element object' unless element.class == REXML::Element
+      
+      if REXML::XPath.first(element, '//SupplyDetail').nil? 
+        raise LoadError, 'supplied REXML document object does not appear contain a valid SupplyDetail fragment'
+      end
+      
+      supply_detail = SupplyDetail.new
+
+      tmp = REXML::XPath.first(element, '//SupplyDetail/SupplierName')
+      supply_detail.supplier_name = tmp.text if tmp != nil
+
+      tmp = REXML::XPath.first(element, '//SupplyDetail/AvailabilityCode')
+      supply_detail.availability_code = tmp.text if tmp != nil
+
+      tmp = REXML::XPath.first(element, '//SupplyDetail/IntermediaryAvailabilityCode')
+      supply_detail.intermediary_availability_code = tmp.text if tmp != nil
+      
+      tmp = REXML::XPath.first(element, '//SupplyDetail/Price/PriceAmount')
+      supply_detail.price = BigDecimal(tmp.text) if tmp != nil
+
+      return supply_detail
+
+    end
+ 
+    # Return an xml element representing this contributor
+    def to_element
+      raise 'SupplyDetail must have a supplier name to create an element' if self.supplier_name.nil?
+      raise 'SupplyDetail must have a availability code to create an element' if self.availability_code.nil?
+      
+      supply_detail =  REXML::Element.new('SupplyDetail') 
+      supply_detail.add_element('SupplierName').text = self.supplier_name.to_xs
+      supply_detail.add_element('AvailabilityCode').text = self.availability_code.to_xs unless self.availability_code.nil?
+      supply_detail.add_element('IntermediaryAvailabilityCode').text = self.intermediary_availability_code_to_xs unless self.intermediary_availability_code.nil?
+      unless self.price.nil?
+        tmp = REXML::Element.new('Price')
+        if self.price.kind_of?(BigDecimal)
+          tmp.add_element('PriceAmount').text = self.price.to_s("F")
+        else
+          tmp.add_element('PriceAmount').text = self.price.to_s
+        end
+        supply_detail.add_element(tmp)
+      end
+      
+      return supply_detail
+    end
+ 
+    # Return an XML string representing this contributor
+    def to_s
+      tmp = to_element
+      output = ''
+      tmp.write(output, 0)
+      return output
+    end
+  end
+  end
+end

data/lib/rbook/onix/xchar.rb

@@ -0,0 +1,98 @@
+# sourced from http://www.intertwingly.net/blog/2005/09/28/XML-Cleansing
+
+module XChar
+  # http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
+  CP1252 = {
+    128 => 8364, # euro sign
+    130 => 8218, # single low-9 quotation mark
+    131 =>  402, # latin small letter f with hook
+    132 => 8222, # double low-9 quotation mark
+    133 => 8230, # horizontal ellipsis
+    134 => 8224, # dagger
+    135 => 8225, # double dagger
+    136 =>  710, # modifier letter circumflex accent
+    137 => 8240, # per mille sign
+    138 =>  352, # latin capital letter s with caron
+    139 => 8249, # single left-pointing angle quotation mark
+    140 =>  338, # latin capital ligature oe
+    142 =>  381, # latin capital letter z with caron
+    145 => 8216, # left single quotation mark
+    146 => 8217, # right single quotation mark
+    147 => 8220, # left double quotation mark
+    148 => 8221, # right double quotation mark
+    149 => 8226, # bullet
+    150 => 8211, # en dash
+    151 => 8212, # em dash
+    152 =>  732, # small tilde
+    153 => 8482, # trade mark sign
+    154 =>  353, # latin small letter s with caron
+    155 => 8250, # single right-pointing angle quotation mark
+    156 =>  339, # latin small ligature oe
+    158 =>  382, # latin small letter z with caron
+    159 =>  376} # latin capital letter y with diaeresis
+
+  # http://www.w3.org/TR/REC-xml/#dt-chardata
+  PREDEFINED = {
+    38 => '&', # ampersand
+    60 => '<',  # left angle bracket
+    62 => '>'}  # right angle bracket
+
+  # http://www.w3.org/TR/REC-xml/#charsets
+  VALID = [[0x9, 0xA, 0xD], (0x20..0xD7FF), 
+    (0xE000..0xFFFD), (0x10000..0x10FFFF)]
+end
+
+class Fixnum
+  # xml escaped version of chr
+  def xchr
+    n = XChar::CP1252[self] || self
+    n = 42 unless XChar::VALID.find {|range| range.include? n}
+    XChar::PREDEFINED[n] or (n<128 ? n.chr : "&##{n};")
+  end
+end
+
+class String
+  # xml escaped version of to_s
+  def to_xs
+    unpack('U*').map {|n| n.xchr}.join # ASCII, UTF-8
+  rescue
+    unpack('C*').map {|n| n.xchr}.join # ISO-8859-1, WIN-1252
+  end
+end
+
+=begin
+require 'test/unit'
+
+class TestXmlEscaping < Test::Unit::TestCase
+  def test_ascii
+    assert_equal 'abc', 'abc'.to_xs
+  end
+
+  def test_predefined
+    assert_equal '&amp;', '&'.to_xs              # ampersand
+    assert_equal '&lt;',  '<'.to_xs              # left angle bracket
+    assert_equal '&gt;',  '>'.to_xs              # right angle bracket
+  end
+
+  def test_invalid
+    assert_equal '*', "\x00".to_xs               # null
+    assert_equal '*', "\x0C".to_xs               # form feed
+    assert_equal '*', "\xEF\xBF\xBF".to_xs       # U+FFFF
+  end
+
+  def test_iso_8859_1
+    assert_equal '&#231;', "\xE7".to_xs          # small c cedilla
+    assert_equal '&#169;', "\xA9".to_xs          # copyright symbol
+  end
+
+  def test_win_1252
+    assert_equal '&#8217;', "\x92".to_xs         # smart quote
+    assert_equal '&#8364;', "\x80".to_xs         # euro
+  end
+
+  def test_utf8
+    assert_equal '&#8217;', "\xE2\x80\x99".to_xs # right single quote
+    assert_equal '&#169;',  "\xC2\xA9".to_xs     # copy
+  end
+end
+=end

data/lib/rbook/titlepage.rb

@@ -0,0 +1,96 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
+
+require 'rbook/isbn'
+require 'rbook/errors'
+require 'rbook/titlepage/titlepage_driver'
+
+module RBook
+
+  # a convenience class for accessing the SOAP API for http://www.titlepage.com.
+  # Uses boilerplate code generated by soap4r.
+  #
+  # You should be aware of any limits of query volume imposed by the provider - currently a
+  # maximum of 30 queries per minute is permitted.
+  #
+  # All examples require the following two lines at the top of your file:
+  #   require 'rubygems'
+  #   require 'rbook/titlepage'
+  #
+  # Basic usage:
+  #  tp = Book::TitlePage.new
+  #  tp.login('someuser','topsecret')
+  #  puts tp.find("0091835135").inspect
+  #  sleep 3
+  #  puts tp.find("9780672327568").inspect
+  #  tp.logout
+  #
+  # Alternative Usage:
+  #  RBook::TitlePage.open("username","password") do |tp|
+  #    puts tp.find("0091835135").inspect
+  #    sleep 3
+  #    puts tp.find("9780672327568").inspect
+  #  end
+  class TitlePage
+
+    # Optional driver parameter allows an alternative SOAP driver to the default to be specified.
+    # This is primarily for testing purposes and probably isn't useful to anyone in the real world.
+    def initialize(driver = nil)
+      @driver = driver || TitleQueryPortType.new
+      @token = nil
+    end
+
+    # login to the titlepage API.
+    def login(username, password)
+      raise InvalidRubyVersionError, 'Ruby 1.8.3 or higher is required to use this class' unless RUBY_VERSION >= "1.8.3"
+      logout if @token
+      @token = @driver.login(username, password)
+      return true if @token
+    end
+
+    # logout from the titlepage API
+    def logout
+      if @token
+        @driver.logout(@token)
+      end
+    end
+
+    # retrieve information on a specified ISBN
+    def find(isbn)
+      return NotLoggedInError, 'You must login to titlepage API before performing a search' unless @token
+      isbn = ISBN::convert_to_isbn13(isbn)
+      return nil if isbn.nil?
+      begin
+        result = @driver.SearchByEAN(@token, isbn)
+        if result.Product.nil?
+          return nil
+        else
+          return result
+        end
+      rescue 
+        return 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.
+    #
+    #  RBook::TitlePage.open("username","password") do |tp|
+    #    result = tp.find("9780091835132")
+    #  end
+    def TitlePage.open(username, password, driver = nil)
+      
+      tp = TitlePage.new(driver || TitleQueryPortType.new)
+
+      begin
+        tp.login(username, password)
+     
+        yield(tp)
+      
+      ensure
+        tp.logout
+      end
+    end
+
+  end
+end

data/lib/rbook/titlepage/TitleQueryClient.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+require 'defaultDriver.rb'
+
+endpoint_url = ARGV.shift
+obj = TitleQueryPortType.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   Login(userName, password)
+#
+# ARGS
+#   userName        String - {http://www.w3.org/2001/XMLSchema}string
+#   password        String - {http://www.w3.org/2001/XMLSchema}string
+#
+# RETURNS
+#   token           String - {http://www.w3.org/2001/XMLSchema}string
+#
+userName = "rba303"
+password = "ra1nb0Wb"
+puts obj.login(userName, password)
+
+# SYNOPSIS
+#   SearchByISBN(token, iSBN)
+#
+# ARGS
+#   token           String - {http://www.w3.org/2001/XMLSchema}string
+#   iSBN            String - {http://www.w3.org/2001/XMLSchema}string
+#
+# RETURNS
+#   searchResults   SearchResults - {urn:TitleQuery}SearchResults
+#
+token = iSBN = nil
+puts obj.searchByISBN(token, iSBN)
+
+# SYNOPSIS
+#   SearchByEAN(token, eAN)
+#
+# ARGS
+#   token           String - {http://www.w3.org/2001/XMLSchema}string
+#   eAN             String - {http://www.w3.org/2001/XMLSchema}string
+#
+# RETURNS
+#   searchResults   SearchResults - {urn:TitleQuery}SearchResults
+#
+token = eAN = nil
+puts obj.searchByEAN(token, eAN)
+
+# SYNOPSIS
+#   Logout(token)
+#
+# ARGS
+#   token           String - {http://www.w3.org/2001/XMLSchema}string
+#
+# RETURNS
+#   N/A
+#
+token = nil
+puts obj.logout(token)
+
+

data/lib/rbook/titlepage/titlepage_driver.rb

@@ -0,0 +1,134 @@
+require File.dirname(__FILE__) + '/titlepage_utils.rb'
+
+require 'soap/rpc/driver'
+
+class TitleQueryPortType < ::SOAP::RPC::Driver
+  DefaultEndpointUrl = "http://www.titlepage.com.au/ws/TitleQuery.php"
+  MappingRegistry = ::SOAP::Mapping::Registry.new
+
+  MappingRegistry.set(
+    SearchResults,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "SearchResults") }
+  )
+  MappingRegistry.set(
+    Product,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Product") }
+  )
+  MappingRegistry.set(
+    ArrayOfProductIdentifier,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::Registry::TypedArrayFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "ProductIdentifier") }
+  )
+  MappingRegistry.set(
+    Title,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Title") }
+  )
+  MappingRegistry.set(
+    ArrayOfContributor,
+    ::SOAP::SOAPArray,
+    ::SOAP::Mapping::Registry::TypedArrayFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Contributor") }
+  )
+  MappingRegistry.set(
+    SupplyDetail,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "SupplyDetail") }
+  )
+  MappingRegistry.set(
+    Stock,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Stock") }
+  )
+  MappingRegistry.set(
+    Price,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Price") }
+  )
+  MappingRegistry.set(
+    ProductIdentifier,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "ProductIdentifier") }
+  )
+  MappingRegistry.set(
+    Contributor,
+    ::SOAP::SOAPStruct,
+    ::SOAP::Mapping::Registry::TypedStructFactory,
+    { :type => XSD::QName.new("urn:TitleQuery", "Contributor") }
+  )
+
+  Methods = [
+    [ XSD::QName.new("http://www.titlepage.com/ws", "Login"),
+      "http://www.titlepage.com.au/ws/TitleQuery.php/Login",
+      "login",
+      [ ["in", "UserName", ["::SOAP::SOAPString"]],
+        ["in", "Password", ["::SOAP::SOAPString"]],
+        ["retval", "Token", ["::SOAP::SOAPString"]] ],
+      { :request_style =>  :rpc, :request_use =>  :encoded,
+        :response_style => :rpc, :response_use => :encoded }
+    ],
+    [ XSD::QName.new("http://www.titlepage.com/ws", "SearchByISBN"),
+      "http://www.titlepage.com.au/ws/TitleQuery.php/SearchByISBN",
+      "searchByISBN",
+      [ ["in", "Token", ["::SOAP::SOAPString"]],
+        ["in", "ISBN", ["::SOAP::SOAPString"]],
+        ["retval", "SearchResults", ["SearchResults", "urn:TitleQuery", "SearchResults"]] ],
+      { :request_style =>  :rpc, :request_use =>  :encoded,
+        :response_style => :rpc, :response_use => :encoded }
+    ],
+    [ XSD::QName.new("http://www.titlepage.com/ws", "SearchByEAN"),
+      "http://www.titlepage.com.au/ws/TitleQuery.php/SearchByEAN",
+      "searchByEAN",
+      [ ["in", "Token", ["::SOAP::SOAPString"]],
+        ["in", "EAN", ["::SOAP::SOAPString"]],
+        ["retval", "SearchResults", ["SearchResults", "urn:TitleQuery", "SearchResults"]] ],
+      { :request_style =>  :rpc, :request_use =>  :encoded,
+        :response_style => :rpc, :response_use => :encoded }
+    ],
+    [ XSD::QName.new("http://www.titlepage.com/ws", "Logout"),
+      "http://www.titlepage.com.au/ws/TitleQuery.php/Logout",
+      "logout",
+      [ ["in", "token", ["::SOAP::SOAPString"]] ],
+      { :request_style =>  :rpc, :request_use =>  :encoded,
+        :response_style => :rpc, :response_use => :encoded }
+    ]
+  ]
+
+  def initialize(endpoint_url = nil)
+    endpoint_url ||= DefaultEndpointUrl
+    super(endpoint_url, nil)
+    self.mapping_registry = MappingRegistry
+    init_methods
+  end
+
+private
+
+  def init_methods
+    Methods.each do |definitions|
+      opt = definitions.last
+      if opt[:request_style] == :document
+        add_document_operation(*definitions)
+      else
+        add_rpc_operation(*definitions)
+        qname = definitions[0]
+        name = definitions[2]
+        if qname.name != name and qname.name.capitalize == name.capitalize
+          ::SOAP::Mapping.define_singleton_method(self, qname.name) do |*arg|
+            __send__(name, *arg)
+          end
+        end
+      end
+    end
+  end
+end
+