zoom 0.3.0 → 0.4.0

data/ChangeLog

@@ -1,3 +1,30 @@
+2007-08-12 Walter McGinnis <walter at katipo dot co dot nz>
+	* v0.4.0 - checking in support of ZOOM::Connection#package
+
+	* creating a .4 version of gem
+	
+	* AUTHORS
+	- added Walter McGinnis
+
+	* ChangeLog
+	- this entry
+	
+2007-08-11  Nicolai Moles-Benfell <n.molesbenfell@gmail.com>
+        * AUTHORS
+        - added Nicolai Moles-Benfell
+	- added Walter McGinnis
+	
+        * src/rbzoomoptions.c:
+				Added support for rubyfying option names that contain hyphens or full stops.
+				
+				* src/rbzoomconnection.c:
+			  Added ZOOM::Connection#package, a factory method that returns an instance of a ZOOM::Package object.
+			
+				Added.
+			  * src/rbzoompackage.c:
+			
+			  
+
 v0.3.0	Tue Jul 10 11:57:40 EDT 2007
   - new format for this file 
   - added Rakefile

data/Rakefile

@@ -1,4 +1,4 @@
-RUBY_ZOOM_VERSION = '0.3.0'
+RUBY_ZOOM_VERSION = '0.4.0'
 
 require 'rubygems'
 require 'rake'
@@ -36,7 +36,7 @@ spec = Gem::Specification.new do |s|
   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.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.  This version introduces ZOOM Extended Services.'
   s.autorequire = 'zoom'
   s.files = 
     Dir.glob('src/*.c') +

data/src/rbzoom.c

@@ -29,4 +29,5 @@ Init_zoom (void)
     Init_zoom_query (mZoom);
     Init_zoom_resultset (mZoom);
     Init_zoom_record (mZoom);
+    Init_zoom_package (mZoom);
 }

data/src/rbzoom.h

@@ -29,6 +29,7 @@ void Init_zoom_connection (VALUE mZoom);
 void Init_zoom_query (VALUE mZoom);
 void Init_zoom_resultset (VALUE mZoom);
 void Init_zoom_record (VALUE mZoom);
+void Init_zoom_package (VALUE mZoom);
 
 /* rbzoomoptions.c */
 ZOOM_options ruby_hash_to_zoom_options (VALUE hash);
@@ -43,6 +44,12 @@ VALUE rbz_resultset_make (ZOOM_resultset resultset);
 
 /* rbzoomrecord.c */
 VALUE rbz_record_make (ZOOM_record record);
+
+/* rbzoompackage.c */
+VALUE rbz_package_make (ZOOM_connection connection, ZOOM_options options);
+
+/* rbconnection.c */
+void rbz_connection_check(VALUE obj); 
         
 /* useful macros */
 #if !defined (RVAL2CSTR)

data/src/rbzoomconnection.c

@@ -23,6 +23,7 @@
  */
 static VALUE cZoomConnection;
 
+
 static VALUE
 rbz_connection_make (ZOOM_connection connection)
 {
@@ -60,6 +61,15 @@ rbz_connection_get (VALUE obj)
     }                                                   \
     while (0)
 
+void rbz_connection_check(VALUE obj)
+{
+	ZOOM_connection connection;
+	
+	connection = rbz_connection_get(obj);
+  	RAISE_IF_FAILED (connection);
+}
+
+
 /*
  * Class method: open(host, port=nil) { |conn| ... }
  * host: hostname of the target to connect to.
@@ -242,6 +252,31 @@ rbz_connection_search (VALUE self, VALUE criterion)
     return rbz_resultset_make (resultset);
 }
 
+
+/*
+ * Method: package()
+ *  
+ * Constructs a new extended services ZOOM::Package using this connections host information.
+ *
+ * Note: The Perl script passes this connections options if already set, otherwise constructs a new ZOOM::Option object. 
+ * Currently this method always constructs a new ZOOM::Option object for each package.
+ * 
+ * Returns: a new ZOOM::Package object,
+ */
+static VALUE
+rbz_connection_package(VALUE self)
+{
+  ZOOM_connection connection;
+  ZOOM_options options;
+  ZOOM_package package;
+
+  connection = rbz_connection_get (self);
+  options = ZOOM_options_create ();
+  package = rbz_package_make(connection, options);
+  return package;
+}
+
+
 void
 Init_zoom_connection (VALUE mZoom)
 {
@@ -253,6 +288,7 @@ Init_zoom_connection (VALUE mZoom)
     rb_define_method (c, "connect", rbz_connection_connect, -1);
     rb_define_method (c, "set_option", rbz_connection_set_option, 2);
     rb_define_method (c, "get_option", rbz_connection_get_option, 1);
+    rb_define_method (c, "package", rbz_connection_package, 0);
 
     define_zoom_option (c, "implementationName");
     define_zoom_option (c, "user");

data/src/rbzoomoptions.c

@@ -96,6 +96,15 @@ define_zoom_option (VALUE klass, const char *option)
             rubyname [j++] = '_';
             c = tolower (c);
         }
+		else if (c == '-')
+		{
+			c = '_';
+		}
+		else if (c == '.')
+		{
+			c = '_';
+		}
+		
         rubyname [j] = c;
     }
     rubyname [j] = '\0';

data/src/rbzoompackage.c

@@ -0,0 +1,186 @@
+/*
+ * Copyright (C) 2007 Katipo Communications, Ltd.
+ *
+ * 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"
+#include <stdio.h>
+
+/* Class: ZOOM::Package
+ * This class represents an Extended Services Package: an instruction to the server 
+ * to do something not covered by the core parts of the Z39.50 standard 
+ */
+static VALUE cZoomPackage;
+
+
+static ZOOM_package
+rbz_package_get (VALUE obj)
+{
+    ZOOM_package package;
+
+	if (cZoomPackage == Qnil)
+		rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");
+        
+    Data_Get_Struct (obj, struct ZOOM_package_p, package);
+    assert (package != NULL);
+
+    return package;
+}
+
+
+/* Method: make(connection, options)
+*
+*  Creates a ZOOM::Package from the connection and options specified.
+*
+*  Returns: the created ZOOM::Package or Qnil.
+*/
+VALUE
+rbz_package_make (ZOOM_connection connection, ZOOM_options options)
+{
+
+  ZOOM_package package;
+
+  package =  ZOOM_connection_package(connection, options);
+
+  if (cZoomPackage == Qnil)
+	rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");
+
+  return package != NULL
+      ? Data_Wrap_Struct (cZoomPackage,
+                          NULL,
+                          ZOOM_package_destroy,
+                          package)
+      : Qnil;
+}
+
+
+/*
+ * Method: 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 package.
+ * 
+ * Returns: self.
+ */
+static VALUE
+rbz_package_set_option (VALUE self, VALUE key, VALUE val)
+{   
+
+	ZOOM_package package;
+    
+    package = rbz_package_get (self);
+    ZOOM_package_option_set (package,
+                                RVAL2CSTR (key),
+                                RVAL2CSTR (rb_obj_as_string (val)));
+   
+    return self;
+}
+
+
+/*
+ * Method: get_option(key)
+ * key: the name of the option, as a string.
+ *
+ * Gets the value of a package's option.
+ * 
+ * Returns: the value of the given option, as a string, integer or boolean.
+ */
+static VALUE
+rbz_package_get_option (VALUE self, VALUE key)
+{
+	ZOOM_package package;
+    const char *value;
+ 
+    package = rbz_package_get (self);
+ 
+    value = ZOOM_package_option_get (package,
+                                        RVAL2CSTR (key));
+
+    return zoom_option_value_to_ruby_value (value);
+}
+
+/*
+ * Method: send(type)
+ * type:  the actual extended service package type to be sent, as a string.
+ *
+ * Sends the package.
+ * 
+ * Returns: self.
+ */
+static VALUE
+rbz_package_send(VALUE self, VALUE type)
+{
+    ZOOM_package package;
+	const char *typeChar;
+
+    package = rbz_package_get (self);
+
+    typeChar = StringValuePtr(type);
+    ZOOM_package_send(package, typeChar);
+  
+    return self;
+}
+
+
+
+/* Interface to a subset of the Z39.50 extended services.
+*/
+void
+Init_zoom_package (VALUE mZoom)
+{
+    VALUE c;
+    
+    c = rb_define_class_under (mZoom, "Package", rb_cObject); 
+
+	/* Remove the default constructor to force initialization through Connection#package. */
+    rb_undef_method (CLASS_OF (c), "new");
+
+	/* Instance methods */
+    rb_define_method (c, "set_option", rbz_package_set_option, 2);
+    rb_define_method (c, "get_option", rbz_package_get_option, 1);
+    rb_define_method (c, "send", rbz_package_send, 1);
+
+	// Common Options
+    define_zoom_option (c, "package-name");
+	define_zoom_option (c, "user-id");
+	define_zoom_option (c, "function");
+	define_zoom_option (c, "waitAction");
+	define_zoom_option (c, "targetReference");
+	
+	// Item Order, type must be set to itemorder in ZOOM_package_send.
+	define_zoom_option (c, "contact-name");
+	define_zoom_option (c, "contact-phone");
+	define_zoom_option (c, "contact-email");
+	define_zoom_option (c, "itemorder-item");
+	
+	// Record Update, type must be set to update in ZOOM_package_send.
+	define_zoom_option (c, "action");
+	define_zoom_option (c, "recordIdOpaque");
+	define_zoom_option (c, "recordIdNumber");
+	define_zoom_option (c, "record");
+	define_zoom_option (c, "syntax");
+	define_zoom_option (c, "databaseName");
+	define_zoom_option (c, "correlationInfo.note");
+	define_zoom_option (c, "correlationInfo.id");
+	define_zoom_option (c, "elementSetName");
+	
+	// Database Create, type must be set to create in ZOOM_package_send.
+	// Database Drop, type must be set to drop in ZOOM_package_send.
+	define_zoom_option (c, "databaseName");
+	    
+    cZoomPackage = c;
+}

data/test/package_test.rb

@@ -0,0 +1,136 @@
+require "test/unit"
+require "zoom"
+
+class TestPackage < Test::Unit::TestCase
+
+  def setup
+    @connection = ZOOM::Connection.new
+  end
+
+  def test_connection_package
+      assert(@connection.respond_to?('package'))
+      p = @connection.package
+      assert_equal(p.class.to_s, 'ZOOM::Package')
+  end
+
+
+  def test_option_returns_same_value
+      p = @connection.package
+      p.action = 'update'
+      assert_equal('update', p.action)
+  end
+
+  def test_options_containing_hyphen
+    # option contact-name
+      p = @connection.package
+      assert(p.respond_to?('contact_name'))
+      assert(p.respond_to?('contact_name='))
+      assert(p.respond_to?('set_contact_name'))
+
+      p.contact_name = 'contact_name value'
+      assert_equal('contact_name value', p.contact_name)
+  end
+
+
+  def test_option_containing_fullstop
+    #option correlationInfo.note
+      p = @connection.package
+      assert(p.respond_to?('correlation_info_note'))
+      assert(true, p.respond_to?('correlation_info_note='))
+      assert_equal(true, p.respond_to?('set_correlation_info_note'))
+
+      p.correlation_info_note = 'correlation_info_note value'
+      assert_equal('correlation_info_note value', p.correlation_info_note)
+  end
+
+  # test z39.50 instance that supports extended services by connecting to zebra instance
+  # TODO: get a more permanent test zebra server hosted
+  # THESE ARE CURRENTLY BROKEN
+  # record syntax might be not quite right
+  # and thus updates are creating new records (not matching old record)
+  # and destroys are failing, too (also not matching old record)
+#   def test_crud_record
+#     @id = 'oai:casanova.katipo.co.nz:site:WebLink:2'
+#     @record = File.read('test/record.xml')
+#     @record_update = File.read('test/record-update.xml')
+#     @options = { 'user' => 'test', 'password' => 'test' }
+
+#     # create
+#     c = ZOOM::Connection.new(@options).connect('casanova.katipo.co.nz', 9998)
+#     c.database_name = 'test'
+#     p = c.package
+#     p.function = 'create'
+#     p.wait_action = 'waitIfPossible'
+#     p.syntax = 'no syntax'
+
+#     p.action = 'specialUpdate'
+#     p.record = @record
+#     p.record_id_opaque = @id
+
+#     p.send('update')
+#     p.send('commit')
+
+#     # make sure it's there
+#     ZOOM::Connection.open('casanova.katipo.co.nz', 9998) do |conn|
+#       conn.database_name = 'test'
+#       conn.preferred_record_syntax = 'XML'
+#       result_set = conn.search("@attr 1=12 @attr 4=3 \"#{@id}\"")
+#       assert_equal 1, result_set.length
+#     end
+    
+#     # update
+#     c = ZOOM::Connection.new(@options).connect('casanova.katipo.co.nz', 9998)
+#     c.database_name = 'test'
+#     p = c.package
+    
+#     p.function = 'create'
+#     p.wait_action = 'waitIfPossible'
+#     p.syntax = 'no syntax'
+    
+#     p.action = 'specialUpdate'
+#     p.record = @record_update
+#     p.record_id_opaque = @id
+#     p.send('update')
+#     p.send('commit')
+
+#     # confirm update record is there
+#     ZOOM::Connection.open('casanova.katipo.co.nz', 9998) do |conn|
+#       conn.database_name = 'test'
+#       conn.preferred_record_syntax = 'XML'
+#       result_set = conn.search("@attr 1=1016 woohoo")
+#       assert_equal 1, result_set.length
+#     end
+
+#     # confirm original record has been written over
+#     ZOOM::Connection.open('casanova.katipo.co.nz', 9998) do |conn|
+#       conn.database_name = 'test'
+#       conn.preferred_record_syntax = 'XML'
+#       result_set = conn.search("@attr 1=4 kete")
+#       assert_equal 1, result_set.length
+#     end
+
+#     # cleanup
+#     c2 = ZOOM::Connection.new(@options).connect('casanova.katipo.co.nz', 9998)
+#     c2.database_name = 'test'
+#     p2 = c2.package
+    
+#     p2.function = 'create'
+#     p2.wait_action = 'waitIfPossible'
+#     p2.syntax = 'no syntax'
+    
+#     p2.action = 'recordDelete'
+#     p2.record = @record_update
+#     p2.record_id_opaque = @id
+#     p2.send("update")
+#     p2.send("commit")
+    
+#     # make sure the file has been destroyed
+#     ZOOM::Connection.open('casanova.katipo.co.nz', 9998) do |conn|
+#       conn.database_name = 'test'
+#       conn.preferred_record_syntax = 'XML'
+#       result_set = conn.search("@attr 1=12 @attr 4=3 \"#{@id}\"")
+#       assert_equal 0, result_set.length
+#     end
+#   end
+
+end

data/test/record-update.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OAI-PMH xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd" xmlns="http://www.openarchives.org/OAI/2.0/">
+  <responseDate>2007-01-14 18:30:51</responseDate>
+  <request metadataPrefix="oai_dc" identifier="oai:casanova.katipo.co.nz:site:WebLink:1" verb="GetRecord">http://localhost/site/web_links/show/1.xml</request>
+  <GetRecord>
+    <record>
+      <header>
+        <identifier>oai:casanova.katipo.co.nz:site:WebLink:2</identifier>
+        <datestamp>2007-01-14</datestamp>
+      </header>
+      <metadata>
+        <oai_dc:dc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/">
+          <dc:identifier>http://localhost/site/web_links/show/1</dc:identifier>
+          <dc:title>Kete.net</dc:title>
+          <dc:description>This is the site that describes the Kete project, woohoo!</dc:description>
+          <dc:description>http://kete.net.nz/</dc:description>
+          <dc:subject>kete</dc:subject>
+          <dc:date>Sun Jan 14 18:29:54 +1300 2007</dc:date>
+          <dc:creator>admin</dc:creator>
+          <dc:contributor>admin</dc:contributor>
+          <dc:type>InteractiveResource</dc:type>
+          <dc:format>text/html</dc:format>
+        </oai_dc:dc>
+      </metadata>
+    </record>
+  </GetRecord>
+</OAI-PMH>

data/test/record.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<OAI-PMH xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd" xmlns="http://www.openarchives.org/OAI/2.0/">
+  <responseDate>2007-01-14 18:30:51</responseDate>
+  <request metadataPrefix="oai_dc" identifier="oai:casanova.katipo.co.nz:site:WebLink:1" verb="GetRecord">http://localhost/site/web_links/show/1.xml</request>
+  <GetRecord>
+    <record>
+      <header>
+        <identifier>oai:casanova.katipo.co.nz:site:WebLink:2</identifier>
+        <datestamp>2007-01-14</datestamp>
+      </header>
+      <metadata>
+        <oai_dc:dc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/">
+          <dc:identifier>http://localhost/site/web_links/show/1</dc:identifier>
+          <dc:title>Kete.net</dc:title>
+          <dc:description>This is the site that describes the Kete project.</dc:description>
+          <dc:description>http://kete.net.nz/</dc:description>
+          <dc:subject>kete</dc:subject>
+          <dc:date>Sun Jan 14 18:29:54 +1300 2007</dc:date>
+          <dc:creator>admin</dc:creator>
+          <dc:contributor>admin</dc:contributor>
+          <dc:type>InteractiveResource</dc:type>
+          <dc:format>text/html</dc:format>
+        </oai_dc:dc>
+      </metadata>
+    </record>
+  </GetRecord>
+</OAI-PMH>

data/test/search_test.rb

@@ -1,14 +1,18 @@
 class SearchTest < Test::Unit::TestCase
-
+  # Walter McGinnis, 2007-08-06
+  # for some reason the result as string has an extra \n at the end
+  # that now needs to be trimmed off the end
+  # by doing this with a gsub for replacing \n\n pattern with a single \n
+  # if this changes back to a single \n in the future
+  # this shouldn't break
   def test_search_results
     ZOOM::Connection.open('z3950.loc.gov', 7090) do |conn|
       conn.database_name = 'Voyager'
       conn.preferred_record_syntax = 'USMARC'
       result_set = conn.search('@attr 1=7 0253333490')
       assert_equal 1, result_set.length
-      assert_equal File.read('test/record.txt'), result_set[0].to_s
+      assert_equal File.read('test/record.txt'), result_set[0].to_s.gsub("\n\n", "\n")
       assert_equal File.read('test/record.dat'), result_set[0].raw
     end
   end
-
 end

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: zoom
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-07-10 00:00:00 -04:00
-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.
+  version: 0.4.0
+date: 2007-08-12 00:00:00 +12:00
+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.  This version introduces ZOOM Extended Services.
 require_paths: 
 - lib
 email: 
@@ -30,26 +30,22 @@ authors: []
 
 files: 
 - src/rbzoom.c
+- src/rbzoomconnection.c
 - src/rbzoomoptions.c
+- src/rbzoompackage.c
 - src/rbzoomquery.c
-- src/rbzoomresultset.c
 - src/rbzoomrecord.c
-- src/rbzoomconnection.c
+- src/rbzoomresultset.c
 - src/rbzoom.h
 - src/extconf.rb
-- test/search_test.rb
+- test/package_test.rb
+- test/record-update.xml
 - test/record.dat
-- test/CVS
 - test/record.txt
-- test/CVS/Entries
-- test/CVS/Root
-- test/CVS/Repository
-- sample/needle.rb
-- sample/CVS
+- test/record.xml
+- test/search_test.rb
 - sample/hello.rb
-- sample/CVS/Entries
-- sample/CVS/Root
-- sample/CVS/Repository
+- sample/needle.rb
 - README
 - ChangeLog
 - Rakefile

data/sample/CVS/Entries

@@ -1,3 +0,0 @@
-/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

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

data/sample/CVS/Root

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

data/test/CVS/Entries

@@ -1,4 +0,0 @@
-/record.dat/1.1/Fri Jul  6 16:17:58 2007//
-/record.txt/1.1/Fri Jul  6 15:51:46 2007//
-/search_test.rb/1.2/Tue Jul 10 13:13:31 2007//
-D

data/test/CVS/Repository

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

data/test/CVS/Root

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