rbook 0.1 → 0.2

data/lib/rbook/onix/stream_reader.rb

@@ -0,0 +1,120 @@
+require 'rexml/document'
+require 'thread'
+
+module RBook
+  module Onix
+
+    # a utility class for the ONIX Stream Reader. See RBook::ONIX::StreamReader for 
+    # basic usage instructions.
+    class Listener
+
+      def initialize(queue)
+        @queue = queue
+        @in_product = false
+      end
+
+      def doctype(name, pub_sys, long_name, uri)   
+      end
+
+      def tag_start(name, attrs)
+        case name
+        when "Product"
+          # A new product tag has been read, so start
+          # building a new product to add to the queue
+          @in_product = true
+          @product_fragment = "<Product>"
+        else
+          @product_fragment << "<#{name}>" if @in_product
+        end
+      end
+
+      def text(text)
+        @product_fragment << text if @in_product
+      end
+
+      def tag_end(name)
+        case name
+        when "ONIXMessage"
+          # the ONIXMessage tag indicates the end of the file, so add
+          # nil to the queue to let the iterating thread know reading
+          # is finished
+          @queue.push(nil)
+        when "Product"
+          # A product tag is finished, so add it to the queue
+          @product_fragment << "</Product>"
+          begin
+            doc = REXML::Document.new(@product_fragment)
+            unless doc.root.nil?
+              product = RBook::Onix::Product.load_from_element(doc.root)
+              @queue.push(product) unless product.nil?
+            end
+          rescue
+            # error occurred while building the product from an XML fragment
+          end
+          @in_product = false
+        else
+          @product_fragment << "</#{name}>" if @in_product
+        end
+      end
+
+      def xmldecl(version, encoding, standalone)
+        # do nothing
+      end
+
+      def method_missing
+        # do nothing
+      end
+    end
+
+    # A stream reader for ONIX files. Using a stream reader is preferred for
+    # large XML files as the file is processed in stages, removing the need
+    # to store the entire thing in memory at once.
+    #
+    # This class provides forward only iteration over a single ONIX file, 
+    # returning a RBook::ONIX::Product object for each product encountered.
+    # 
+    # = Basic usage
+    #  require 'rbook/onix'
+    #  reader = RBook::ONIX::StreamReader.new("some_onix_file.xml")
+    #  reader.each do |product|
+    #    puts product.inspect
+    #  end
+    class StreamReader
+
+      # creates a new stream reader to read the specified file.
+      # file can be specified as a String or File object
+      def initialize(input)
+        if input.class == String
+          @input = File.new(input)
+        elsif input.class == File
+          @input = input
+        else
+          throw "Unable to read from path or file"                
+        end
+        # create a sized queue to store each product read from the file
+        @queue = SizedQueue.new(100)
+
+        # launch a reader thread to process the file and store each
+        # product in the queue
+        Thread.new do
+          producer = Listener.new(@queue)
+          REXML::Document.parse_stream(@input, producer)
+        end
+      end
+
+      # iterate over the file and return a product file to a block.
+      #   
+      #  reader = RBook::ONIX::StreamReader.new("some_onix_file.xml")
+      #  reader.each do |product|
+      #    puts product.inspect
+      #  end
+      def each
+        obj = @queue.pop
+        while !obj.nil?
+          yield obj
+          obj = @queue.pop
+        end
+      end
+    end
+  end  
+end

data/lib/rbook/onix/stream_writer.rb

@@ -0,0 +1,40 @@
+require 'rexml/document'
+
+module RBook
+  module Onix
+
+    class StreamWriter
+
+      # Default constructor.
+      def initialize(output, msg)
+        raise ArgumentError, 'msg must be an RBook::Onix::Message object' unless msg.class == RBook::Onix::Message
+        @output = output
+        @msg = msg
+      end
+
+      def start_document(encoding = nil)
+        decl = REXML::XMLDecl.new
+        doctype = REXML::DocType.new('ONIXMessage', "SYSTEM \"#{RBook::Onix::Message::ONIX_DTD_URL}\"")
+        if encoding
+          decl.encoding = encoding
+        else
+          decl.encoding = "UTF-8"
+        end
+        @output.write(decl.to_s+"\n")
+        @output.write(doctype.to_s+"\n")
+        @output.write("<ONIXMessage>\n")
+        @output.write(@msg.header.to_s)
+      end
+
+      def << (product)
+        @output.write(product.to_s)
+      end
+
+      def end_document
+        @output.write("</ONIXMessage>\n")
+      end
+
+    end
+
+  end
+end

data/lib/rbook/onix/supply_detail.rb

@@ -42,7 +42,7 @@ module Onix
       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?
+      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)

data/lib/rbook/titlepage.rb

@@ -3,10 +3,11 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
 require 'rbook/isbn'
 require 'rbook/errors'
 require 'rbook/titlepage/titlepage_driver'
+require 'rbook/titlepage/client'
 
 module RBook
 
-  # a convenience class for accessing the SOAP API for http://www.titlepage.com.
+  # a convenience module 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
@@ -17,7 +18,7 @@ module RBook
   #   require 'rbook/titlepage'
   #
   # Basic usage:
-  #  tp = Book::TitlePage.new
+  #  tp = RBook::TitlePage::Client.new
   #  tp.login('someuser','topsecret')
   #  puts tp.find("0091835135").inspect
   #  sleep 3
@@ -25,72 +26,11 @@ module RBook
   #  tp.logout
   #
   # Alternative Usage:
-  #  RBook::TitlePage.open("username","password") do |tp|
+  #  RBook::TitlePage::Client.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
-
+  module TitlePage
   end
 end

data/lib/rbook/titlepage/client.rb

@@ -0,0 +1,81 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
+
+require 'rbook/isbn'
+require 'rbook/errors'
+require 'rbook/titlepage/titlepage_driver'
+
+module RBook
+  module TitlePage
+
+    # 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.
+    #
+    # For a basic usage overview, check out RBook::TitlePage
+    class Client
+
+      # 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 self.open(username, password, driver = nil)
+
+        tp = self.new(driver || TitleQueryPortType.new)
+
+        begin
+          tp.login(username, password)
+
+          yield(tp)
+
+        ensure
+          tp.logout
+        end
+      end
+
+    end
+  end
+end

data/lib/rbook/titlepage/titlepage_driver.rb

@@ -2,133 +2,136 @@ 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
+module RBook
+  module TitlePage
+    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") }
-  )
+      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 }
-    ]
-  ]
+      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
+      def initialize(endpoint_url = nil)
+        endpoint_url ||= DefaultEndpointUrl
+        super(endpoint_url, nil)
+        self.mapping_registry = MappingRegistry
+        init_methods
+      end
 
-private
+    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)
+      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
   end
 end
-