alexandria-zoom 0.6.0

data/ext/zoom/rbzoomresultset.c

@@ -0,0 +1,268 @@
+/*
+ * 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"
+
+#ifdef MAKING_RDOC_HAPPY
+mZoom = rb_define_module("ZOOM");
+#endif
+
+/* Class: ZOOM::ResultSet
+ * The result set object is a container for records returned from a target.
+ */
+static VALUE cZoomResultSet;
+
+VALUE
+rbz_resultset_make (ZOOM_resultset resultset)
+{
+    return resultset != NULL
+        ? Data_Wrap_Struct (cZoomResultSet,
+                            NULL,
+                            ZOOM_resultset_destroy,
+                            resultset)
+        : Qnil;
+}
+
+static ZOOM_resultset
+rbz_resultset_get (VALUE obj)
+{
+    ZOOM_resultset resultset;
+        
+    Data_Get_Struct (obj, struct ZOOM_resultset_p, resultset);
+    assert (resultset != NULL);
+
+    return resultset;
+}
+
+/*
+ * call-seq: 
+ * 	set_option(key, value)
+ *
+ * key: the name of the option, as a string.
+ *
+ * value: the value of this option (as a string, integer or boolean).
+ *
+ * Sets an option on the result set.
+ * 
+ * Returns: self.
+ */
+static VALUE
+rbz_resultset_set_option (VALUE self, VALUE key, VALUE val)
+{
+    ZOOM_resultset_option_set (rbz_resultset_get (self),
+                               RVAL2CSTR (key),
+                               RVAL2CSTR (rb_obj_as_string (val)));
+    
+    return self;
+}
+
+/*
+ * call-seq: 
+ * 	get_option(key)
+ *
+ * key: the name of the option, as a string.
+ *
+ * Gets the value of a result set's option.
+ * 
+ * Returns: the value of the given option, as a string, integer or boolean.
+ */
+static VALUE
+rbz_resultset_get_option (VALUE self, VALUE key)
+{
+    const char *value;
+ 
+    value = ZOOM_resultset_option_get (rbz_resultset_get (self),
+                                       RVAL2CSTR (key));
+
+    return zoom_option_value_to_ruby_value (value);
+}
+
+/* 
+ * Returns: the number of hits.
+ */
+static VALUE
+rbz_resultset_size (VALUE self)
+{
+    return INT2NUM (ZOOM_resultset_size (rbz_resultset_get (self)));
+}
+
+/*
+ * call-seq:
+ * 	[](key)
+ *
+ * key: either an integer, a range or an interval of 2 integers.
+ *
+ * Retrieves one or many records from the result set, according to the given
+ * key.
+ *
+ * 	# Gets the first record.
+ * 	rset[0]
+ * 	# Gets the first, second and third records.
+ * 	rset[1..3]
+ * 	# Gets three records starting from the second one.
+ * 	rset[2, 3]
+ *
+ * Returns: one or many references to ZOOM::Record objects.
+ */
+static VALUE
+rbz_resultset_index (int argc, VALUE *argv, VALUE self)
+{
+    ZOOM_record *records;
+    ZOOM_record record;
+    VALUE ary;
+    size_t begin;
+    size_t count;
+    size_t i;
+    
+    if (argc == 1) {
+        VALUE arg = argv [0];
+
+        if (TYPE (arg) == T_FIXNUM || TYPE (arg) == T_BIGNUM) {
+            record = ZOOM_resultset_record (rbz_resultset_get (self),
+                                            NUM2LONG (arg));
+            return record != NULL
+                ? rbz_record_make (ZOOM_record_clone (record))
+                : Qnil;
+        }
+       
+        if (CLASS_OF (arg) == rb_cRange) {
+            begin = NUM2LONG (rb_funcall (arg, rb_intern ("begin"), 0));
+            count = NUM2LONG (rb_funcall (arg, rb_intern ("end"), 0));
+            count -= begin;
+        }
+        else
+            rb_raise (rb_eArgError, 
+                      "Invalid argument of type %s (not Numeric or Range)",
+                      rb_class2name (CLASS_OF (arg)));
+    }
+    else {
+        VALUE rb_begin;
+        VALUE rb_count;
+        
+        rb_scan_args (argc, argv, "2", &rb_begin, &rb_count);
+        
+        begin = NUM2LONG (rb_begin);
+        count = NUM2LONG (rb_count);
+    }
+        
+    ary = rb_ary_new ();
+    if (count == 0)
+        return ary;
+
+    /* Allocate array */
+    records = ALLOC_N (ZOOM_record, count);
+
+    /* Download records in batches */
+    ZOOM_resultset_records (rbz_resultset_get (self), records, begin, count);
+
+    /* Test the first record in the set.  If null, then fall back.  If valid, 
+     * generate the ruby array.
+     */
+
+    if (records[0]!=NULL) {
+       for (i = 0; i < count; i++)
+
+         /* We don't want any null records -- if there is on in the resultset, 
+          * ignore it.
+          */
+
+         if (records[i]!=NULL)
+            rb_ary_push (ary, rbz_record_make (ZOOM_record_clone (records [i])));
+    } else {
+      /* This is our fallback function
+       * It exists for those anomalies where the server 
+       * will not respect the batch request and will return just 
+       * a null array (per change request 36 where Laurent Sansonetti notes
+       *    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).
+       */
+
+      for (i = 0; i < count; i++) {
+        record = ZOOM_resultset_record (rbz_resultset_get (self),
+                                        begin + i);
+        /* Ignore null records */
+        if (record != NULL)
+            rb_ary_push (ary, rbz_record_make (ZOOM_record_clone (record)));
+      }
+    }
+
+    return ary;
+}
+
+/*
+ * Lists the records inside the result set.
+ *
+ * Returns: an array of ZOOM::Record objects.
+ */
+static VALUE
+rbz_resultset_records (VALUE self)
+{
+    VALUE argv [2];
+
+    argv [0] = INT2FIX (0);
+    argv [1] = rbz_resultset_size (self);
+    
+    return rbz_resultset_index (2, argv, self);
+}
+
+/*
+ * call-seq: 
+ * 	each_record { |record| ... }
+ *
+ * Parses the records inside the result set and call the given block for each
+ * record, passing a reference to a ZOOM::Record object as parameter.
+ *
+ * Returns: self.
+ */
+static VALUE
+rbz_resultset_each_record (VALUE self)
+{
+    rb_ary_each (rbz_resultset_records (self));
+    return self;
+}
+
+void
+Init_zoom_resultset (VALUE mZoom)
+{
+    VALUE c;
+    
+    c = rb_define_class_under (mZoom, "ResultSet", rb_cObject); 
+    rb_undef_alloc_func(c);
+
+    rb_undef_method (CLASS_OF (c), "new");
+    rb_define_method (c, "set_option", rbz_resultset_set_option, 2);
+    rb_define_method (c, "get_option", rbz_resultset_get_option, 1);
+    
+    define_zoom_option (c, "start");
+    define_zoom_option (c, "count");
+    define_zoom_option (c, "presentChunk");
+    define_zoom_option (c, "elementSetName");
+    define_zoom_option (c, "preferredRecordSyntax");
+    define_zoom_option (c, "schema");
+    define_zoom_option (c, "setname");
+    
+    rb_define_method (c, "size", rbz_resultset_size, 0);
+    rb_define_alias (c, "length", "size");
+    rb_define_method (c, "records", rbz_resultset_records, 0);
+    rb_define_method (c, "each_record", rbz_resultset_each_record, 0);
+    rb_define_method (c, "[]", rbz_resultset_index, -1);
+    
+    cZoomResultSet = c;
+}

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,125 @@
+#!/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 'rubygems'
+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', 'USERNAME', 'PASSWORD' ], # 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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: alexandria-zoom
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Matijs van Zuijlen
+- Laurent Sansonetti
+- Ed Summers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pkg-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake-manifest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.41'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description:
+email:
+executables: []
+extensions:
+- ext/zoom/extconf.rb
+extra_rdoc_files: []
+files:
+- ChangeLog
+- LICENSE
+- README.md
+- ext/zoom/extconf.rb
+- ext/zoom/rbzoom.c
+- ext/zoom/rbzoom.h
+- ext/zoom/rbzoomconnection.c
+- ext/zoom/rbzoomoptions.c
+- ext/zoom/rbzoompackage.c
+- ext/zoom/rbzoomquery.c
+- ext/zoom/rbzoomrecord.c
+- ext/zoom/rbzoomresultset.c
+- sample/hello.rb
+- sample/needle.rb
+homepage: https://github.com/mvz/alexandria-zoom
+licenses:
+- LGPL-2.1
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: 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.
+test_files: []