gbip 0.7

data/CHANGELOG

@@ -0,0 +1,11 @@
+v0.7 (2nd October 2008)
+- Moved out of the RBook namespace
+- Added GBIP::Title#to_yaml
+- Update to using the version 3 protocol
+  - extra return data (including subjects and publication country)
+
+v0.6 (6th June 2008)
+- Added support for a timeout option in case the server takes too long to respond
+
+v0.5 (3rd July 2007)
+- Initial Release

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/LICENSE

@@ -0,0 +1,13 @@
+= License Terms
+
+Distributed by James Healy under the user's choice* of the 
+{GPL version 2}[http://www.gnu.org/copyleft/gpl.html] (see COPYING for details)
+or the {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
+
+Please email James[mailto:jimmy_AT_deefa.com] with any questions.
+
+*Note:  This license refers specifically to GPLv2.
+Distributing under other versions of the GPL require explicit permission from
+James Healy.  Though we will most likely adopt the GPLv3 when the final draft
+is published, we want to be able to make that decision for ourselves.
+

data/README

@@ -0,0 +1,27 @@
+globalbooksinprint.com is a leading source of bibliographic data.
+Most clients access the database via the web interface, however there
+is a TCP socket based API available apon request.
+
+This library is a small convenience layer for querying the API and viewing
+the results in an object tree.
+
+= Installation
+
+gem install gbip
+
+= Usage
+
+require 'gbip'
+
+gbip = GBIP::POS.new("username", "password")
+puts gbip.find(:first, "0732282721").inspect
+puts gbip.find(:first, "0732282721").to_yaml
+
+= Disclaimer
+
+I am in no way affiliated with Bowker, ther operators of globalbooksinprint.com.
+Please contact them with questions about the service and how to obtain an account.
+
+= Contact
+
+Questions, comments and patches welcome. jimmy _at_ deefa _dot_ com

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require "rake/gempackagetask"
+require 'spec/rake/spectask'
+
+PKG_VERSION = "0.7"
+PKG_NAME = "gbip"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBYFORGE_PROJECT = 'rbook'
+RUBYFORGE_USER = 'yob'
+
+CLEAN.include "**/.*.sw*"
+
+desc "Default Task"
+task :default => [ :spec ]
+
+desc "Cruise Control Tasks"
+task :cruise => [ :spec, :spec_report, :doc ]
+
+# run all rspecs
+desc "Run all rspec files"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.rcov = true
+  t.rcov_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + "/rcov"
+  t.rcov_opts = ["--exclude","spec.*\.rb"]
+end
+
+# generate specdocs
+desc "Generate Specdocs"
+Spec::Rake::SpecTask.new("specdocs") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "rdoc"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/specdoc.rd'
+end
+
+# generate failing spec report
+desc "Generate failing spec report"
+Spec::Rake::SpecTask.new("spec_report") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "html", "--diff"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/spec_report.html'
+  t.fail_on_error = false
+end
+
+# Genereate the RDoc documentation
+desc "Create documentation"
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.title = "RBook"
+  rdoc.rdoc_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/rdoc'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('COPYING')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << "--inline-source"
+end
+
+spec = Gem::Specification.new do |spec|
+  spec.name = PKG_NAME
+  spec.version = PKG_VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "A library for access the globalbooksinprint.com API"
+  spec.files =  Dir.glob("{examples,lib,specs}/**/**/*") +
+    ["Rakefile", "CHANGELOG"]
+
+  spec.require_path = "lib"
+  spec.test_files = Dir[ "specs/**/*.rb" ]
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{README COPYING LICENSE CHANGELOG}
+  spec.rdoc_options << '--title' << 'gbip Documentation' <<
+  '--main'  << 'README' << '-q'
+  spec.add_dependency('rbook-isbn', '>= 1.0')
+  spec.author = "James Healy"
+  spec.email = "jimmy@deefa.com"
+  spec.rubyforge_project = "rbook"
+  spec.homepage = "http://rbook.rubyforge.org/"
+  spec.description = <<END_DESC
+  gbip is a small library to interact with the
+  globalbooksinprint.com API. The API is based
+  on raw TCP sockets.
+END_DESC
+end
+
+desc "Generate a gem for rbook"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+

data/examples/gbip.rb

@@ -0,0 +1,15 @@
+# assuming you have rbook installed via rubygems,
+# in a regular script, replace the following require
+# line with these 2 lines:
+#   require 'rubygems'
+#   require 'rbook/gbip'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'gbip'
+
+gbip = GBIP::POS.new("username", "password")
+
+puts gbip.find(:first, "0732282721").to_yaml
+#puts gbip.find(:first, "0091835135").to_yaml
+#puts gbip.find(:first, "1741146712").to_yaml
+

data/lib/gbip.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
+
+# load the files that form this library
+require 'gbip/pos'
+require 'gbip/title'
+require 'gbip/warehouse'
+
+# load rubygems
+require 'rubygems'
+require 'rbook/isbn'
+
+# Ruby classes for searching the globalbooksinprint.com API. This is a 
+# commercial service and requires a registered account to access. More
+# information on the service can be found at the website.
+#
+# = Basic Usage
+#  gbip = RBook::GBIP::POS.new("username", "password")
+#  puts gbip.find("0091835135").inspect
+#
+module GBIP
+  class InvalidLoginError  < RuntimeError; end
+end

data/lib/gbip/pos.rb

@@ -0,0 +1,127 @@
+require 'socket'
+require 'enumerator'
+require 'timeout'
+
+module GBIP
+
+  # Provides easy access to the globalbooksinprint.com search API.
+  # RBook::GBIP has basic usage examples.
+  class POS
+
+    # don't think we really need these
+    #attr_accessor :username, :password
+
+    POS_SERVER = "pos.bowker.com"
+    POS_PORT = 7052
+
+    # creates a new POS object ready to perform a search
+    def initialize(username, password, socket_class = nil)
+      @username = username
+      @password = password
+      @socket_class = socket_class || TCPSocket
+    end
+
+    # search for the specified ISBN on globalbooksinprint.com.
+    # Accepts both ISBN10 and ISBN13's.
+    # 
+    # Supported options:
+    # :markets => only search the specified markets. comma sperated list
+    # :timeout => amount of time in seconds to wait for a reponse from the server before timing out. Defaults to 10.
+    def find(type, isbn, options = {})
+      case type
+      when :first then default_return = nil
+      when :all then default_return = []
+      else raise ArgumentError, 'type must by :first or :all'
+      end
+
+      options = {:timeout => 10}.merge(options)
+
+      # global only accepts ISBNs as 10 digits at this stage
+      isbn = RBook::ISBN.convert_to_isbn10(isbn.to_s)
+      return default_return if isbn.nil?
+
+      request_format = "POS"
+      account_type = "3"
+      product = "2"
+      username = "#{@username}"
+      password = "#{@password}"
+      version = "3"
+      supplier = ""
+      request = "bn=#{isbn}"
+      filters = "1|1|1|1|1|1|1|1|1|1"
+      if type.eql?(:first)
+        records = "1,0"
+      else
+        records = "10,0"
+      end
+      sort_order = "1"
+      markets = options[:markets] || ""
+
+      request_string = "#{request_format}\t#{account_type}\t#{product}\t#{username}\t#{password}\t"
+      request_string << "#{version}\t#{supplier}\t#{request}\t#{filters}\t#{records}\t#{sort_order}\t"
+      request_string << "#{markets}\t"
+
+      gbip = @socket_class.new(POS_SERVER, POS_PORT)
+      gbip.print request_string
+      response = Timeout::timeout(options[:timeout]) { gbip.gets(nil) }
+      response = response.split("#")
+      gbip.close
+
+      header = nil
+      titles_arr = []
+      response.each do |arr|
+        if header.nil?
+          header = arr.split("\t")
+        else
+          titles_arr << arr.split("\t")
+          titles_arr[-1] = titles_arr.last[1,titles_arr.last.size-1]
+        end
+      end
+
+      # raise an exception if incorrect login details were provided
+      if header.first.eql?("66") 
+        raise GBIP::InvalidLoginError, "Invalid username or password"
+      end
+
+      if titles_arr.size == 0
+        # return nil if no matching records found
+        return nil
+      else
+
+        titles = []
+        titles_arr.each do |arr|
+          title = build_object_tree(arr)
+          titles << title unless title.nil?
+        end
+
+        if type.eql?(:first)
+          return titles.first
+        else
+          return titles
+        end
+      end
+
+    end
+
+    private
+
+    def build_object_tree(arr)
+      raise ArgumentError, 'arr must be an array' unless arr.class == Array
+      return nil if arr.size < 22
+
+      title_arr = arr[0, 22]
+      title = GBIP::Title.new(title_arr)
+
+      if title_arr.last.to_i > 0
+        warehouse_arr = arr[22,arr.size - 22]
+        warehouse_arr.each_slice(5) do |slice|
+          warehouse_obj = GBIP::Warehouse.new(slice)
+          title.warehouses << warehouse_obj unless warehouse_obj.nil?
+        end
+      end
+
+      return title
+    end
+  end
+
+end

data/lib/gbip/title.rb

@@ -0,0 +1,67 @@
+require 'bigdecimal'
+require 'yaml'
+
+module GBIP
+
+  # models a warehouse supply detail from the Global Books in Print API 
+  class Title
+
+
+    attr_accessor :market, :title, :isbn, :binding, :status, :edition
+    attr_accessor :contributor, :publisher, :publication_date
+    attr_accessor :rrp, :supplier, :suppliers_with_stock
+    attr_accessor :country, :pubcode, :currency, :bowker_subject
+    attr_accessor :bisac_subject, :child_subject, :bic_subject
+    attr_accessor :warehouses
+
+    def initialize(arr)
+      raise ArgumentError, "arr must be an array" unless arr.class == Array
+      #raise ArgumentError, "Invalid number of array elements" unless arr.size == 14
+
+      self.market = arr[2].strip
+      self.title = arr[3].strip
+      self.isbn = RBook::ISBN.convert_to_isbn13(arr[4].strip) || arr[4].strip
+      self.binding = arr[5].strip
+      self.status = arr[6].strip
+      self.edition = arr[7].strip
+      self.contributor = arr[8].strip
+      self.publisher = arr[9].strip
+      self.publication_date = arr[10].strip
+      self.rrp = BigDecimal.new(arr[11].strip)
+      self.country = arr[12].strip
+      self.pubcode = arr[13].strip
+      self.currency = arr[14].strip
+      self.bowker_subject = arr[15].strip
+      self.bisac_subject = arr[16].strip
+      self.child_subject = arr[17].strip
+      self.bic_subject = arr[18].strip
+      self.supplier = arr[19].strip
+      self.suppliers_with_stock = arr[20].strip
+
+      @warehouses = []
+    end
+
+    def to_yaml
+      YAML.dump(:status    => self.status,
+                :pubdate   => self.publication_date,
+                :binding   => self.binding,
+                :publisher => self.publisher,
+                :contributor => self.contributor,
+                :isbn      => self.isbn,
+                :edition   => self.edition,
+                :market    => self.market,
+                :rrp       => self.rrp.to_s("F"),
+                :title     => self.title,
+                :country   => self.country,
+                :pubcode   => self.pubcode,
+                :currency  => self.currency,
+                :bowker_subject => self.bowker_subject,
+                :bisac_subject  => self.bisac_subject,
+                :child_subject  => self.child_subject,
+                :bic_subject    => self.bic_subject,
+                :supplier  => self.supplier,
+                :suppliers_with_stock => self.suppliers_with_stock
+               )
+    end
+  end
+end

data/lib/gbip/warehouse.rb

@@ -0,0 +1,22 @@
+require 'date'
+
+module GBIP
+
+  # models a warehouse supply detail from the Global Books in Print API 
+  class Warehouse
+
+    attr_accessor :name, :status, :onhand, :onorder, :updated_at 
+
+    def initialize(arr)
+      raise ArgumentError, "arr must be an array" unless arr.class == Array
+      raise ArgumentError, "Invalid number of array elements" unless arr.size == 5
+
+      self.name = arr[0].strip
+      self.status = arr[1].strip
+      self.onhand = arr[2].to_i
+      self.onorder = arr[3].to_i
+      tmpdate = arr[4]
+      self.updated_at = Date.civil(tmpdate[6,4].to_i, tmpdate[0,2].to_i, tmpdate[3,2].to_i)
+    end
+  end
+end

data/specs/mock_tcpsocket.rb

@@ -0,0 +1,42 @@
+class MockTCPSocket
+
+  def initialize(host,port)
+    # do nothing
+  end
+
+  def print(query)
+    query = query.to_s.split("\t")
+    @username = query[3]
+    @password = query[4]
+    m, @isbn = *query[7].match(/bn=(\d\d\d\d\d\d\d\d\d[\dXx])/)
+  end
+
+  def gets(placeholder)
+   
+    # if incorrect login details are supplied
+    unless @username.eql?("user") && @password.eql?("pass")
+     return File.read(File.dirname(__FILE__) + "/responses/invalid_login.txt").strip
+    end
+
+    # if the requested isbn isn't an isbn10
+    unless RBook::ISBN.valid_isbn10?(@isbn)
+      return File.read(File.dirname(__FILE__) + "/responses/no_result.txt").strip
+    end
+
+    # if the isbn10 is one we have available
+    if @isbn.eql?("1741146712")
+      return File.read(File.dirname(__FILE__) + "/responses/single_result.txt").strip
+    elsif @isbn.eql?("0732282721")
+      return File.read(File.dirname(__FILE__) + "/responses/no_warehouses.txt").strip
+    else
+      return File.read(File.dirname(__FILE__) + "/responses/no_result.txt").strip
+    end
+    @username = nil
+    @password = nil
+    @isbn = nil
+  end
+
+  def close
+
+  end
+end

data/specs/pos_class_spec.rb

@@ -0,0 +1,145 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'gbip'
+require File.dirname(__FILE__) + "/mock_tcpsocket"
+require File.dirname(__FILE__) + "/timeout_tcpsocket"
+
+context "A new POS object" do
+
+  setup do
+    @valid_username = "user"
+    @valid_password = "pass"
+    @invalid_password = "word"
+    @valid_isbn10 = "1741146712"
+    @valid_isbn13 = "9781741146714"
+    @notfound_isbn10 = "0571228526"
+    @notfound_isbn13 = "9780571228522"
+    @valid_isbn10_with_no_warehouses = "0732282721"
+  end
+
+  #####################
+  #  :first searches
+  #####################
+  specify "should raise an exception when an invalid username or password is supplied" do
+    pos = GBIP::POS.new(@valid_username, @invalid_password, MockTCPSocket)
+    lambda { pos.find(:first, @valid_isbn10) }.should raise_error(GBIP::InvalidLoginError)
+  end
+
+  specify "should return a GBIP::Title object when queried for a single valid ISBN10" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @valid_isbn10)
+    result.should be_a_kind_of(GBIP::Title)
+  end
+
+  specify "should return a GBIP::Title object when queried for a single valid ISBN13" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @valid_isbn13)
+    result.should be_a_kind_of(GBIP::Title)
+  end
+
+  specify "should return a GBIP::Title object when querying for a single valid ISBN10 that has no warehouse data" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @valid_isbn10_with_no_warehouses)
+    result.should be_a_kind_of(GBIP::Title)
+    result.warehouses.should be_empty
+  end
+
+  specify "should return nil when a single ISBN10 not recognised by GBIP is requested" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @notfound_isbn10)
+    result.should eql(nil)
+  end
+
+  specify "should return nil when a single ISBN13 not recognised by GBIP is requested" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @notfound_isbn13)
+    result.should eql(nil)
+  end
+
+  specify "should return nil when any object is supplied as an ISBN when searching for :first" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, nil)
+    result.should eql(nil)
+
+    result = pos.find(:first, 3)
+    result.should eql(nil)
+
+    result = pos.find(:first, "23234sdfzsdf3w")
+    result.should eql(nil)
+  end
+
+  specify "should perform a successful query if the ISBN is provided as a number" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:first, @valid_isbn13)
+    result.should be_a_kind_of(GBIP::Title)
+  end
+
+  specify "should raise an exception if no reponse is received in a certain amount of time" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, TimeoutTCPSocket)
+    lambda { pos.find(:first, @valid_isbn13, :timeout => 2) }.should raise_error(Timeout::Error)
+  end
+
+  #####################
+  #  :all searches
+  #####################
+  specify "should return a non-empty Array when queried for a single valid ISBN10" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, @valid_isbn10)
+    result.should be_a_kind_of(Array)
+    result.should_not be_empty
+  end
+
+  specify "should return a non-empty Array when queried for a single valid ISBN13" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, @valid_isbn13)
+    result.should be_a_kind_of(Array)
+    result.should_not be_empty
+  end
+
+  specify "should return an empty Array when a single ISBN10 not recognised by GBIP is requested" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, @notfound_isbn10)
+    result.should be_a_kind_of(Array)
+    result.should be_empty
+  end
+
+  specify "should return an empty Array when a single ISBN13 not recognised by GBIP is requested" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, @notfound_isbn13)
+    result.should be_a_kind_of(Array)
+    result.should be_empty
+  end
+
+  specify "should return an empty array when any object is supplied as an ISBN when searching for :all" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, nil)
+    result.should be_a_kind_of(Array)
+    result.should be_empty
+
+    result = pos.find(:all, 3)
+    result.should be_a_kind_of(Array)
+    result.should be_empty
+
+    result = pos.find(:all, "23234sdfzsdf3w")
+    result.should be_a_kind_of(Array)
+    result.should be_empty
+  end
+
+  specify "should perform a successful query if the ISBN is provided as a number to an :all search" do
+    pos = GBIP::POS.new(@valid_username, @valid_password, MockTCPSocket)
+    result = pos.find(:all, 1741146712)
+    result.should be_a_kind_of(Array)
+    result.should_not be_empty
+  end
+
+  #####################
+  #  invalid searches
+  #####################
+  specify "should raise an exception when an invalid search type is supplied" do
+    pos = GBIP::POS.new(@valid_username, @invalid_password, MockTCPSocket)
+    lambda { pos.find(nil, @valid_isbn10) }.should raise_error(ArgumentError)
+    lambda { pos.find(:last, @valid_isbn10) }.should raise_error(ArgumentError)
+    lambda { pos.find(123456, @valid_isbn10) }.should raise_error(ArgumentError)
+  end
+
+end

data/specs/responses/invalid_login.txt

@@ -0,0 +1 @@
+66

data/specs/responses/no_result.txt

@@ -0,0 +1 @@
+3	rainbowbook	0	#		3										

data/specs/responses/no_warehouses.txt

@@ -0,0 +1 @@
+3	rainbowbook	3	#	64970973	1	AUS	Roar of the Lion	978-0-7322-8272-1	UK-Trade Paper	Out of Print		Coates, Frank	HarperCollins Publishers Australia	042007	32.99	AUSTRALIA	402956	$	FICTION	FICTION / General		FICTION & RELATED ITEMS			0		

data/specs/responses/single_result.txt

@@ -0,0 +1 @@
+3	rainbowbook	3	#	63006879	1	USA	Affluenza:When Too Much Is Never Enough	978-1-74114-671-4	Perfect	Active Record		Hamilton, Clive	Allen & Unwin	042006	14.95	AUSTRALIA	33545	$	CONSUMER STUDIES	SOCIAL SCIENCE / General		SOCIETY & SOCIAL SCIENCES		BDT,BNT,GRD,ING	7	Brodart Company, Williamsport, PA	Available for order		0	09/25/2008	Baker & Taylor Books, Bridgewater, NJ			1	10/01/2008	Baker & Taylor Books, Commerce, GA			0	10/01/2008	Baker & Taylor Books, Momence, IL		2	6	10/01/2008	Baker & Taylor Books, Reno, NV			6	10/01/2008	Gardners Books Limited, E. Sussex	Available for order		0	10/01/2008	Ingram Book Company, La Vergne, TN	Available for order		0	10/01/2008	

data/specs/timeout_tcpsocket.rb

@@ -0,0 +1,19 @@
+class TimeoutTCPSocket
+
+  def initialize(host,port)
+    # do nothing
+  end
+
+  def print(query)
+    # do nothing
+  end
+
+  def gets(placeholder)
+    sleep 5
+    ""
+  end
+
+  def close
+    # do nothing
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: gbip
+version: !ruby/object:Gem::Version 
+  version: "0.7"
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-02 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 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: gbip is a small library to interact with the globalbooksinprint.com API. The API is based on raw TCP sockets.
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
+- LICENSE
+- CHANGELOG
+files: 
+- examples/gbip.rb
+- lib/gbip.rb
+- lib/gbip
+- lib/gbip/pos.rb
+- lib/gbip/title.rb
+- lib/gbip/warehouse.rb
+- specs/mock_tcpsocket.rb
+- specs/pos_class_spec.rb
+- specs/responses
+- specs/responses/invalid_login.txt
+- specs/responses/no_result.txt
+- specs/responses/no_warehouses.txt
+- specs/responses/single_result.txt
+- specs/timeout_tcpsocket.rb
+- Rakefile
+- CHANGELOG
+- README
+- COPYING
+- LICENSE
+has_rdoc: true
+homepage: http://rbook.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --title
+- gbip Documentation
+- --main
+- README
+- -q
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rbook
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for access the globalbooksinprint.com API
+test_files: 
+- specs/mock_tcpsocket.rb
+- specs/pos_class_spec.rb
+- specs/timeout_tcpsocket.rb