zoom 0.3.0

data/ChangeLog

@@ -0,0 +1,149 @@
+v0.3.0	Tue Jul 10 11:57:40 EDT 2007
+  - new format for this file 
+  - added Rakefile
+  - applied patch from Jason Ronallo to enable raw method on records
+  - added test suite
+  - created gem for rubyforge
+
+2007-05-05  Ed Summers <ehs@pobox.com>
+        * AUTHORS
+        - added Ed Summers
+
+        * src/lib/*
+        - removed marc.rb since it isn't used and conflicts with the marc gem
+
+2006-09-21  Laurent Sansonetti  <lrz@chopine.be>
+
+	* ChangeLog,
+	  README,
+	  src/**/*.{c,h,rb}:
+
+	s/gnome.org/chopine.be/g.
+
+2006-09-21  Devin Bayer  <devin@freeshell.org>
+
+	* .cvsignore:
+
+	Ignores zoom.bundle.
+
+   * sample/needle.rb:
+
+	Updated the needle demo application.
+
+   * src/rbzoomconnection.c:
+
+	Do not fail when reading options.
+
+2006-08-22  Laurent Sansonetti  <lrz@chopine.be>
+
+	* AUTHORS:
+
+	- Updated my e-mail address ;
+	- Added Devin.
+ 
+2006-08-22  Devin Bayer  <devin@freeshell.org>
+
+	* src/rbzoomrecord.c:
+
+	Added ZOOM::Record#raw, to grab a marc record in marc format.
+
+2006-08-20  Devin Bayer  <devin@freeshell.org>
+
+	* sample/needle.rb:
+
+	Added new sample, contributed by Devin Bayer.
+
+=== Ruby/ZOOM 0.2.2 ===
+
+2005-11-08  Laurent Sansonetti  <lrz@chopine.be>
+
+	* README:
+
+	Added a note about YAZ's --enable-shared problem.
+
+	* AUTHORS:
+
+	Added Pascal and Matt.
+
+2005-11-08  Matt Vanderpol  <matt@vanderpol.net>
+
+	* src/rbzoomquery.c (.new_prefix, .new_cql):
+
+	Fixed constructors.
+
+=== Ruby/ZOOM 0.2.1 ===
+
+2005-09-23  Pascal Terjan  <pterjan@linuxfr.org>
+
+	* src/rbzoomoptions.c:
+
+	Fixes segfault when rubyfying the option name.
+
+=== Ruby/ZOOM 0.2.0 ===
+
+2005-08-02  Laurent Sansonetti  <lrz@chopine.be>
+
+	* src/rbzoomresultset.rb (#[]):
+
+	Retrieves the record one by one using ZOOM_resultset_record instead
+	of getting them all in once with ZOOM_resultset_records (for a strange
+	reason sometimes the resultset was not empty but ZOOM_resultset_records
+	used to return empty records).
+
+2005-07-19  Laurent Sansonetti  <lrz@chopine.be>
+
+	* src/lib/marc.rb:
+
+	Added an experimental MARC decoder.
+
+=== Ruby/ZOOM 0.1.0 ===
+
+2005-03-18  Laurent Sansonetti  <lrz@chopine.be>
+
+	* COPYING.LIB,
+	  AUTHORS,
+	  README:
+
+	Added.
+
+	* src/rbzoomconnection.c,
+	  src/rbzoomquery.c:
+
+	Fixed documentation.
+
+	* src/rbzoomresultset.c (#[]):
+
+	- Range objects are supported ;
+	- Do not clone nil objects.
+
+2005-03-17  Laurent Sansonetti  <lrz@chopine.be>
+
+	* doc/.cvsignore,
+	  doc/gendoc.sh:
+
+	Added.
+
+	* src/rbzoom.c,
+	  src/rbzoom.h,
+	  src/rbzoomconnection.c,
+	  src/rbzoomoptions.c,
+	  src/rbzoomquery.c,
+	  src/rbzoomrecord.c,
+	  src/rbzoomresultset.c:
+
+	Added extdoc documentation + LGPL headers.
+
+2005-03-16  Laurent Sansonetti  <lrz@chopine.be>
+
+	* src/rbzoomrecord.c (#database, #syntax, #render, #xml):
+
+	Added.
+
+	* src/rbzoom.c,
+	  sample/hello.rb:
+
+	Renamed the module name as 'ZOOM'.
+
+2005-03-14  Laurent Sansonetti  <lrz@chopine.be>
+
+	Initial RubyForge revision.

data/README

@@ -0,0 +1,58 @@
+Ruby/ZOOM
+=========
+
+Ruby/ZOOM provides a Ruby binding to the Z39.50 Object-Orientation Model 
+(ZOOM), an abstract object-oriented programming interface to a subset of the 
+services specified by the Z39.50 standard, also known as the international 
+standard ISO 23950.
+
+This software is based (and therefore depends) on YAZ, a free-software 
+implementation of the Z39.50/SRW/SRU standards, but could be easily ported to 
+any ZOOM compliant implementation.
+
+Ruby/ZOOM is free-software, covered by the GNU Lesser General Public License 
+and provided without any warranties of any kind.
+
+Requirements
+------------
+
+    Ruby:       http://www.ruby-lang.org/
+    YAZ (*):    http://www.indexdata.dk/yaz/ 
+
+    * : Make sure you did pass the --enabled-shared option to the configure
+        script before building YAZ.  Ruby/ZOOM requires a YAZ shared library 
+        and YAZ does not build it by default. 
+
+Install
+-------
+
+    0. install Ruby
+    1. install YAZ
+    2. gem install ruby-zoom
+
+Build from Source
+-----------------
+
+    0. checkout out code from cvs at rubyforge
+    1. install Rake
+    2. rake 
+    5. gem install pkg/zoom-*.gem
+
+Samples
+-------
+
+    Some programming examples are available in the `sample' directory. 
+
+Copying
+-------
+
+    Copyright (c) 2005 Laurent Sansonetti <lrz@chopine.be>
+      
+    This library is free software.
+    You can distribute/modify this program under the terms of
+    the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1.
+
+Project Website
+---------------
+
+    http://ruby-zoom.rubyforge.org

data/Rakefile

@@ -0,0 +1,54 @@
+RUBY_ZOOM_VERSION = '0.3.0'
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'mkmf'
+
+CLEAN.include '**/*.o'
+CLEAN.include '**/*.so'
+CLEAN.include '**/Makefile'
+CLEAN.include '**/*.log'
+CLEAN.include 'pkg'
+
+task :default => [:build, :test, :package] do |t|
+end
+
+task :build => [:clean] do |t|
+  Dir.chdir('src') do 
+    system('ruby', 'extconf.rb')
+    system('make')
+  end
+end
+
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.ruby_opts = ['-r test/unit', '-I src', '-r zoom']
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = 'zoom'
+  s.version = RUBY_ZOOM_VERSION
+  s.homepage = 'http://ruby-zoom.rubyforge.org'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby/ZOOM provides a Ruby binding to the Z40.50 Object-Orientation Model (ZOOM), an abstract object-oriented programming interface to a subset of the services specified by the Z39.50 standard, also known as the international standard ISO 23950.'
+  s.autorequire = 'zoom'
+  s.files = 
+    Dir.glob('src/*.c') +
+    Dir.glob('src/*.h') +
+    Dir.glob('src/*.rb') +
+    Dir.glob('test/**/*') + 
+    Dir.glob('sample/**/*') +
+    ['README', 'ChangeLog', 'Rakefile']
+  s.extensions = 'src/extconf.rb'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/sample/CVS/Entries

@@ -0,0 +1,3 @@
+/hello.rb/1.2/Wed Mar 16 20:33:13 2005//
+/needle.rb/1.2/Thu Sep 21 09:52:14 2006//
+D

data/sample/CVS/Repository

@@ -0,0 +1 @@
+ruby-zoom/sample

data/sample/CVS/Root

@@ -0,0 +1 @@
+:ext:esummers@rubyforge.org:/var/cvs/ruby-zoom

data/sample/hello.rb

@@ -0,0 +1,8 @@
+require 'zoom'
+
+ZOOM::Connection.open('z3950.loc.gov', 7090) do |conn|
+    conn.database_name = 'Voyager'
+    conn.preferred_record_syntax = 'USMARC'
+    rset = conn.search('@attr 1=7 0253333490')
+    p rset[0]
+end

data/sample/needle.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby -w
+#
+# Given a list of ISBNs and Z39.50 servers, try to get a MARC record
+# for each book.  The servers listed here seem to be the best
+# worldwide.  If an ISBN cannot be found then we use the xisbn service
+# to try different editions.
+#
+# TODO: If more then one record is found, pick the longest one.
+#
+# By Devin Bayer - Summer 2006 - Public Domain
+#
+#
+require 'zoom'
+require 'net/http'
+Net::HTTP.version_1_2
+require 'rexml/document'
+
+servers_source = [
+    # Server, Username, Password
+    [ 'z3950.loc.gov:7090/Voyager' ], # Library of Congress
+    [ 'amicus.nlc-bnc.ca/ANY', 'akvadrako', 'aw4gliu' ], # Canada
+    [ 'catnyp.nypl.org:210/INNOPAC' ], # New York Public
+    [ 'z3950.copac.ac.uk:2100/COPAC' ], # United Kingdom
+    [ 'z3950.btj.se:210/BURK' ], # Sweden
+    [ '195.249.206.204:210/Default' ], # DenMark
+    [ 'library.ox.ac.uk:210/ADVANCE' ], # Oxford
+    [ '216.16.224.199:210/INNOPAC' ], # Cambridge
+    [ 'prodorbis.library.yale.edu:7090/Voyager' ], # Yale
+    [ 'zsrv.library.northwestern.edu:11090/Voyager' ]] # NorthWestern University
+    
+#########################################
+# Connect to each server
+#########################################
+@servers = Array.new
+
+servers_source.each do |array|
+    tries = 0
+    $stderr.puts 'INFO: connecting to ' + array[0]
+    begin
+	con = ZOOM::Connection.new()
+	con.preferred_record_syntax = 'MARC21'
+	con.element_set_name = 'F'
+	if array[1] then
+	    con.user = array[1]
+	    con.password = array[2]
+	end
+	con.connect(array[0])
+	@servers << con
+    rescue RuntimeError
+	$stderr.puts 'ERROR: connecting to ' + array[0] + ': ' + $!
+	tries += 1
+	retry if tries < 3
+	$stderr.puts 'WARNING: giving up on ' + array[0]
+    end
+end
+
+#################################
+# search for ISBN on each server
+#  return true if found
+#################################
+def search(isbn)
+    @servers.each do |con|
+	begin
+	    rset = con.search("@attr 1=7 #{isbn}")
+	    if rset.size > 0 and rset[0].to_s.chomp.length > 1 then
+		$stderr.puts con.host + ': ' + isbn + ': ' + 
+		    rset.size.to_s + ' records'
+		puts rset[0].raw('marc8')
+		return true
+	    end
+	rescue RuntimeError
+	    $stderr.puts 'WARNING: ' + con.host + ': ' +
+		isbn + ': ' + $!
+	end
+    end
+    return false
+end
+
+#########################################
+# Lookup each ISBN
+#########################################
+failed_isbns = Array.new
+
+xisbn = Net::HTTP.new('labs.oclc.org')
+
+File.open('isbns').each_line do |isbn|
+    isbn = isbn.chomp.upcase
+    next if isbn.length < 1
+    if not search(isbn) then
+	tries = 0
+	# Try alternate editions
+	begin
+	    xisbn.start if not xisbn.started?
+	    xml = xisbn.get("/xisbn/#{isbn}").body
+	rescue SocketError, Errno::ECONNRESET, Errno::EPIPE, EOFError, Timeout::Error
+	    xisbn.finish if xisbn.started?
+	    if tries < 3 then
+		tries += 1
+		retry
+	    else
+		$stderr.puts "ERROR: xisbn failure: " + $!
+	    end
+	end
+	found = false
+	REXML::Document.new(xml).root.each_element do |elem|
+	    alt = elem.texts.to_s.chomp.upcase
+	    next if alt == isbn
+	    if search(alt) then
+		$stderr.puts "INFO: alternate for #{isbn}: #{alt}" 
+		found = true
+		break
+	    end
+	end
+	if not found then
+	    $stderr.puts "INFO: isbn #{isbn} not found"
+	    failed_isbns << isbn
+	end
+    end
+end
+
+if failed_isbns.size > 0 then
+    $stderr.puts "ISBN's not found:"
+    failed_isbns.each { |isbn| $stderr.puts isbn }
+end

data/src/extconf.rb

@@ -0,0 +1,17 @@
+require 'mkmf'
+
+unless system('yaz-config')
+  $stderr.puts 'yaz does not appear to be installed'
+  break
+end
+
+unless have_header('yaz/zoom.h')
+  $stderr.puts 'yaz zoom header not available'
+  break
+end
+
+$CFLAGS << " #{`yaz-config --cflags`} "
+$LDFLAGS << " #{`yaz-config --libs`} "
+
+create_makefile("zoom")
+

data/src/rbzoom.c

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2005 Laurent Sansonetti <lrz@chopine.be>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "rbzoom.h"
+
+void
+Init_zoom (void)
+{
+    VALUE mZoom;
+
+    mZoom = rb_define_module ("ZOOM");
+
+    Init_zoom_connection (mZoom);
+    Init_zoom_query (mZoom);
+    Init_zoom_resultset (mZoom);
+    Init_zoom_record (mZoom);
+}