rbook 0.1 → 0.2

data/README

@@ -6,6 +6,7 @@ There are currently 5 key components in the library. Please refer to their
 respective documentation for information on usage.
 
 - RBook::Bisac - Support for reading and writing BISAC files.
+- RBook::GBIP - Very rudimentary support for using the globalbooksinprint.com TCP API.
 - RBook::ISBN - Convenience methods for validating and converting ISBNs.
 - RBook::Onix - Support for reading and writing ONIX files.
 - RBook::TitlePage - A wrapper for the titlepage.com SOAP API.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require "rubygems"
 
-PKG_VERSION = "0.1"
+PKG_VERSION = "0.2"
 PKG_NAME = "rbook"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBYFORGE_PROJECT = 'rbook'
@@ -77,7 +77,8 @@ end
 desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
   require 'vendor/code_statistics'
-  dirs = [["Library", "lib"],["Functional tests", "test/functional"],["Unit tests", "test/unit"]]
+  #dirs = [["Library", "lib"],["Functional tests", "test/functional"],["Unit tests", "test/unit"]]
+  dirs = [["Library", "lib"],["Unit tests", "test/unit"]]
   CodeStatistics.new(*dirs).to_s
 end
 

data/examples/gbip.rb

@@ -0,0 +1,12 @@
+# 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'
+require File.dirname(__FILE__) + '/../lib/rbook/gbip'
+
+gbip = RBook::GBIP::POS.new("username", "password")
+
+puts gbip.find("0091835135").inspect
+#puts tp.find("1741146712").inspect
+

data/examples/onix/stream_reader.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'rbook/onix'
+
+reader = RBook::Onix::StreamReader.new(File.dirname(__FILE__)+"/../../test/data/chalice.xml")
+counter = 0
+
+reader.each do |product|
+  puts product.product_identifier
+  counter += 1
+end
+
+puts "total of ##{counter.to_s} products"

data/examples/titlepage.rb

@@ -5,7 +5,7 @@
 #   require 'rbook/titlepage'
 require File.dirname(__FILE__) + '/../lib/rbook/titlepage'
 
-RBook::TitlePage.open("username", "password") do |tp|
+RBook::TitlePage::Client.open("username", "password") do |tp|
 
   puts tp.find("0091835135").inspect
   sleep 3

data/lib/rbook/bisac.rb

@@ -1,175 +1,29 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
+
+require 'rbook/bisac/message'
+require 'rbook/bisac/product'
+require 'rbook/isbn'
+
 module RBook
 
-  # Ruby class for reading and writing BISAC files.
+  # Ruby module for reading and writing BISAC files.
   # BISAC is a really bad format for electronic exchange of data - ONIX should be
   # used where possible. Here be dragons.
   #
-  # Basic Usage:
-  #   require 'rubygems'
-  #   require 'rbook/bisac'
-  #   bisac = RBook::Bisac.new("Rainbow", "0000000000", "jan06", "1")
-  #   item = {:isbn       => "020161622X", 
-  #           :title      => "Pragmatic Programmer", 
-  #           :author     => "Hunt Thomas",
-  #           :price      => "2995",
-  #           :binding    => "PB",
-  #           :pubdate    => "061223",
-  #           :publihser  => "Pearson Education",
-  #           :imprint    => "Addison-Wesley",
-  #           :edition    => "1",
-  #           :volume     => "1",
-  #           :volumes    => "1",
-  #           :status     => "O/O"
-  #          }
-  #   bisac.add_item(item)
-  #   bisac.write("/tmp/jan06.txt")
-  class Bisac
-
-    # creates a new bisac file in memory
-    # company = company name (10 chars)
-    # san = company SAN number (12 chars)
-    # batch = batch name for this file (6 chars)
-    # code = 1 for new titles, 2 for updated titles (1 char)
-    def initialize(company, san, batch, code)
-      @company = company
-      @san = san
-      @batch = batch
-      @code = code
-      @data = []
-    end
-
-    # TODO: Not Yet Implemented.
-    # loads the requested BISAC file into memory. Returns an array of hashes
-    def self.load(filename)
-
-    end
-
-    # adds a new title to the bisic file. Expects a hash with the required data.
-    #
-    # Required hash indexes:
-    # - :isbn
-    # - :title
-    # - :author
-    # - :price
-    # - :pubdate
-    # - :publisher
-    # - :imprint
-    # - :edition
-    # - :binding
-    # - :volume
-    # - :volumes
-    # - :status
-    def add_item(item)
-      raise ArgumentError, 'item must be a hash' unless item.kind_of?(Hash)
-      raise ArgumentError, 'Hash needs an :isbn index' if item[:isbn].nil?
-      raise ArgumentError, 'Hash needs an :title index' if item[:title].nil?
-      raise ArgumentError, 'Hash needs an :author index' if item[:author].nil?
-      raise ArgumentError, 'Hash needs an :price index' if item[:price].nil?
-      raise ArgumentError, 'Hash needs an :pubdate index' if item[:pubdate].nil?
-      raise ArgumentError, 'Hash needs an :publisher index' if item[:publisher].nil?
-      raise ArgumentError, 'Hash needs an :imprint index' if item[:imprint].nil?
-      raise ArgumentError, 'Hash needs an :volumes index' if item[:volumes].nil?
-      raise ArgumentError, 'Hash needs an :edition index' if item[:edition].nil?
-      raise ArgumentError, 'Hash needs an :binding index' if item[:binding].nil?
-      raise ArgumentError, 'Hash needs an :volume index' if item[:volume].nil?
-      raise ArgumentError, 'Hash needs an :status index' if item[:status].nil?
-      @data << item
-    end
-
-    # converts this bisac file into a string
-    def to_s
-      # File Header
-      content = "**HEADER**"
-      content << Time.now.strftime("%y%m%d")
-      content << @company[0,10].ljust(10)
-      content << @san[0,12].ljust(12)
-      content << @batch[0,6].ljust(6)
-      content << @code[0,1].ljust(1)
-      content << "**PUBSTAT*"
-      content << "040"
-      content << "".ljust(201)
-      content << "\n"
-    
-      # File Content
-      counter = 0
-      @data.each do |item|
-        content << item[:isbn][0,10].ljust(10) # 10 digit isbn
-        content << "1"
-        content << "N"
-        content << "N"
-        content << "B"
-        content << "N"
-        content << item[:title][0,30].ljust(30)
-        content << "N"
-        content << item[:author][0,30].ljust(30)
-        content << "N"
-        content << "A" # author role
-        content << "N"
-        content << item[:price][0,7].rjust(7,"0") # current price
-        content << "N"
-        content << item[:pubdate][0,6].ljust(6) # published date
-        content << "N"
-        content << item[:publisher][0,10].ljust(10) # publisher
-        content << "N"
-        content << item[:imprint][0,14].ljust(14) #imprint
-        content << "N"
-        content << item[:volumes][0,3].rjust(3,"0") # volumes included in this isbn
-        content << "N"
-        content << item[:edition][0,2].rjust(2,"0") # edition
-        content << "N"
-        content << item[:binding][0,2].rjust(2) # binding
-        content << "N"
-        content << item[:volume][0,3].rjust(3,"0") # volume number
-        content << "N"
-        content << "0000000" # new price
-        content << "N"
-        content << "000000" # new price effective date
-        content << "N"
-        content << "   " # audience type
-        content << "N"
-        content << item[:status][0,3].rjust(3) # status
-        content << "N"
-        content << "      " # available date. only use for status' like NYP
-        content << "N"
-        content << "          " # alternate isbn
-        content << "N"
-        content << "999999" # out of print date. only use for status == OP
-        content << "N"
-        content << "   " # geographic restrictions
-        content << "N"
-        content << "        " # library of congress catalogue number
-        content << "N"
-        content << "".ljust(40) # series title
-        content << "N"
-        content << "0" # price code for current price
-        content << "N"
-        content << "0" # price code for new price
-        content << "N"
-        content << "0000000" # freight pass through price
-        content << "N"
-        content << "000000" # new freight pass through price
-        content << "00000" # last changed date
-        content << "\n"
-        
-        
-        counter = counter + 1
-      end
-
-      # File Footer
-      content << "**TRAILER*"
-      content << Time.now.strftime("%y%m%d")
-      content << @batch[0,6].ljust(6)
-      content << counter.to_s[0,6].ljust(6)
-      content << "**PUBSTAT*"
-      content << "".ljust(221)
-      
-      
-      return content
-    end
+  # = Basic Usage
+  #  require 'rubygems'
+  #  require 'rbook/bisac'
+  #  include Rbook
+  #  msg = Bisac::Message.new('Company', '1234567', '111111', '1'))
+  #  item = Bisac::Product.new('0123456789')
+  #  item.title = "A Book"
+  #  item.author = "Healy, James"
+  #  item.price = "1995"
+  #  item.binding = "PB"
+  #  item.status = "AVL"
+  #  msg << item
+  #  puts msg.to_s
+  module Bisac
 
-    # writes the content of this bisac file out to the specified file
-    def write(filename)
-      File.open(filename, "w") { |f| f.puts to_s }
-    end
   end
 end

data/lib/rbook/bisac/message.rb

@@ -0,0 +1,99 @@
+
+
+module RBook
+  module Bisac
+
+    # Represents a single Bisac File. See RBook::Bisac for a basic
+    # usage example.
+    class Message
+
+      attr_accessor :company, :san, :batch, :code, :products
+
+      # creates a new bisac file in memory
+      # params:
+      # - company = company name (10 chars)
+      # - san = company SAN number (12 chars)
+      # - batch = batch name for this file (6 chars)
+      # - code = 1 for new titles, 2 for updated titles (1 char)
+      def initialize(company, san, batch, code)
+        @company = company
+        @san = san
+        @batch = batch
+        @code = code
+        @products = []
+      end
+
+      # loads the requested BISAC file into memory.
+      # returns a Message object or nil if the file is not 
+      # a BISAC file
+      def self.load(filename)
+        msg = self.new(nil,nil,nil,nil)
+        
+        File.open(filename, "r") do |f|
+          f.each_line do |l|
+            if l[0,10].eql?("**HEADER**") 
+              msg.company = l[16,10].strip
+              msg.san = l[26,12].strip
+              msg.batch = l[38,6].strip
+              msg.code = l[44,1].strip
+            elsif !l[0,11].eql?("**TRAILER**") 
+              product = RBook::Bisac::Product.from_string(l)
+              msg << product unless product.nil?
+            end
+          end
+        end
+        
+        if msg.company.nil? || msg.san.nil? || msg.batch.nil? || msg.code.nil?
+          return nil
+        else
+          return msg
+        end
+      end
+
+      # adds a new title to the bisic file. Expects a Rbook::Bisac::Product object.
+      def << (item)
+        unless item.class == RBook::Bisac::Product
+          raise ArgumentError, 'item must be a RBook::Bisac::Product object'
+        end
+        @products << item
+      end
+
+      # converts this bisac file into a string
+      def to_s
+        # File Header
+        content = "**HEADER**"
+        content << Time.now.strftime("%y%m%d")
+        content << @company[0,10].ljust(10)
+        content << @san[0,12].ljust(12)
+        content << @batch[0,6].ljust(6)
+        content << @code[0,1].ljust(1)
+        content << "**PUBSTAT*"
+        content << "040"
+        content << "".ljust(201)
+        content << "\n"
+
+        # File Content
+        counter = 0
+        @products.each do |item|
+          content << item.to_s + "\n"
+          counter = counter + 1
+        end
+
+        # File Footer
+        content << "**TRAILER*"
+        content << Time.now.strftime("%y%m%d")
+        content << @batch[0,6].ljust(6)
+        content << counter.to_s[0,6].ljust(6)
+        content << "**PUBSTAT*"
+        content << "".ljust(221)
+
+        return content
+      end
+
+      # writes the content of this bisac file out to the specified file
+      def write(filename)
+        File.open(filename, "w") { |f| f.puts to_s }
+      end
+    end
+  end
+end

data/lib/rbook/bisac/product.rb

@@ -0,0 +1,176 @@
+module RBook
+  module Bisac
+
+    # Class to represent a single product line in a Bisac File. See
+    # RBook::Bisac for basic usage instructions.
+    class Product
+
+      attr_reader :isbn, :title, :author, :price, :pubdate, :publisher
+      attr_reader :imprint, :volumes, :edition, :binding, :volume, :status
+
+      # Creates a new product object with the requested ISBN. Must be a 10 digit ISBN.
+      def initialize(isbn)
+        raise ArgumentError, 'isbn must 10 chars or less' if isbn.to_s.length > 10
+        
+        @isbn = isbn.to_s
+        @title = ""
+        @author = ""
+        @price = ""
+        @pubdate = ""
+        @publisher = ""
+        @imprint = ""
+        @volumes = ""
+        @edition = ""
+        @binding = ""
+        @volume = ""
+        @status = ""
+      end
+
+      # sets the products author. Maximum of 30 chars.
+      def author=(author)
+        @author = author.to_s
+      end
+    
+      # sets the products binding. Maximum of 2 chars.
+      def binding=(binding)
+        @binding = binding.to_s
+      end
+
+      # sets the products edition number. Maximum of 3 chars.
+      def edition=(edition)
+        @edition = edition.to_s
+      end
+
+      # takes a single line from a BISAC file and attempts to convert
+      # it to a Product object
+      def self.from_string(s)
+        s = s.to_s
+        return nil if s.length < 259
+        product = self.new(s[0,10])
+        product.title = s[15,30].strip
+        product.author = s[46,30].strip
+        product.price = s[79,7].strip if s[79,7].strip.match(/\A\d{0,7}\Z/)
+        product.pubdate = s[87,6].strip if s[87,6].strip.match(/\A\d{6}\Z/)
+        product.publisher = s[94,10].strip
+        product.imprint = s[105,14].strip
+        product.volumes = s[120,3].strip
+        product.edition = s[124,2].strip
+        product.binding = s[127,2].strip
+        product.volume = s[130,3].strip
+        product.status = s[153,3].strip
+        return product
+      end
+
+      # Sets the products imprint. Maximum of 14 chars.
+      def imprint=(imprint)
+        @imprint = imprint.to_s
+      end
+
+      # Sets the price imprint. Maximum of 7 chars. Must by a whole 
+      # number (represent price in cents).
+      def price=(price)
+        unless price.to_s.match(/\A\d{0,7}\Z/)
+          raise ArgumentError, 'price should be a whole number with no more than 7 digits. (price in cents)'
+        end
+        @price = price.to_s
+      end
+
+      # Sets the products pubdate. Must be in the form YYMMDD
+      def pubdate=(pubdate)
+        unless pubdate.to_s.match(/\A\d{6}\Z/)
+          raise ArgumentError, 'pubdate should be a date in the form YYMMDD.'
+        end
+        @pubdate = pubdate.to_s
+      end
+      
+      # sets the products publisher. Maximum of 10 chars.
+      def publisher=(publisher)
+        @publisher = publisher.to_s
+      end
+
+      # sets the products status code. Maximum of 3 chars.
+      def status=(status)
+        @status = status.to_s
+      end
+
+      # sets the products title. Maximum of 30 chars.
+      def title=(title)
+        @title = title.to_s
+      end
+
+      # Returns the product as a single line ready for inserting into a BISAC file.
+      # Doesn't have a \n on the end
+      def to_s
+        content = ""
+        content << @isbn[0,10].ljust(10) # 10 digit isbn
+        content << "1"
+        content << "N"
+        content << "N"
+        content << "B"
+        content << "N"
+        content << @title[0,30].ljust(30)
+        content << "N"
+        content << @author[0,30].ljust(30)
+        content << "N"
+        content << "A" # author role
+        content << "N"
+        content << @price[0,7].rjust(7,"0") # current price
+        content << "N"
+        content << @pubdate[0,6].ljust(6) # published date
+        content << "N"
+        content << @publisher[0,10].ljust(10) # publisher
+        content << "N"
+        content << @imprint[0,14].ljust(14) #imprint
+        content << "N"
+        content << @volumes[0,3].rjust(3,"0") # volumes included in this isbn
+        content << "N"
+        content << @edition[0,2].rjust(2,"0") # edition
+        content << "N"
+        content << @binding[0,2].rjust(2,"0") # binding
+        content << "N"
+        content << @volume[0,3].rjust(3,"0") # volume number
+        content << "N"
+        content << "0000000" # new price
+        content << "N"
+        content << "000000" # new price effective date
+        content << "N"
+        content << "   " # audience type
+        content << "N"
+        content << @status[0,3].rjust(3) # status
+        content << "N"
+        content << "      " # available date. only use for status' like NYP
+        content << "N"
+        content << "          " # alternate isbn
+        content << "N"
+        content << "999999" # out of print date. only use for status == OP
+        content << "N"
+        content << "   " # geographic restrictions
+        content << "N"
+        content << "        " # library of congress catalogue number
+        content << "N"
+        content << "".ljust(40) # series title
+        content << "N"
+        content << "0" # price code for current price
+        content << "N"
+        content << "0" # price code for new price
+        content << "N"
+        content << "0000000" # freight pass through price
+        content << "N"
+        content << "000000" # new freight pass through price
+        content << "00000" # last changed date
+
+        return content
+      end
+
+      # sets the products volume number. Maximum of 3 chars.
+      def volume=(volume)
+        @volume = volume.to_s
+      end
+      
+      # sets the number of volumes in the set this product belongs to. Maximum of 3 chars.
+      def volumes=(volumes)
+        @volumes = volumes.to_s
+      end
+    end
+  end
+end