sru 0.0.2 → 0.0.3

data/lib/sru/client.rb

@@ -8,6 +8,21 @@ module SRU
   # A client for issuing requests to a particular SRU server.
   # SRU is a RESTlike information retrieval protocol detailed at
   # http://www.loc.gov/standards/sru/
+  #
+  #  require 'sru'
+  #
+  #  client = SRU::Client.new 'http://sru.example.com'
+  #
+  #  # fetch a SRU::ExplainResponse object from the server
+  #  explain = client.explain
+  #
+  #  # issue a search and get back a SRU::SearchRetrieveResponse object 
+  #  # which serves as an iterator 
+  #  records = client.search_retrieve 'rosetta stone', :maximumRecords => 5
+  #  records.each {|record| puts record}
+  #
+  #  # issue a scan request and print out each term
+  #  client.scan('king tut', :maximumTerms => 12).each {|term| puts term}
   
   class Client
 
@@ -41,11 +56,12 @@ module SRU
     # as an optional second argument. 
     # 
     #   client = SRU::Client.new 'http://example.com/sru'
-    #   response = client.search_retrieve('mark twain', maximumRecords => 1)
+    #   response = client.search_retrieve 'mark twain', maximumRecords => 1
     
     def search_retrieve(query, options={})
-      options['query'] = query
-      options['operation'] = 'searchRetrieve'
+      options[:query] = query
+      options[:operation] = 'searchRetrieve'
+      options[:maximumRecords] = 10 unless options.has_key? :maximumRecords
       doc = get_doc(options)
       return SearchResponse.new(doc)
     end
@@ -55,11 +71,12 @@ module SRU
     # object. You must supply the first parameter which is the searchClause.
     # Other SRU options can be sent in a hash as the seond argument.
     #
-    #   scan_response = client.scan 'title
+    #   scan_response = client.scan 'title', :maximumTerms => 5
    
     def scan(clause, options={})
-      options['scanClause'] = clause
-      options['operation'] = 'scan'
+      options[:scanClause] = clause
+      options[:operation] = 'scan'
+      options[:maximumTerms] = 5 unless options.has_key? :maximumTerms
       doc = get_doc(options)
       return ScanResponse.new(doc)
     end
@@ -71,7 +88,7 @@ module SRU
    
     def get_doc(hash)
       # all requests get a version
-      hash['version'] = @version 
+      hash[:version] = @version 
 
       # don't want to monkey with the original
       uri = @server.clone

data/{test.rb → test/client_test.rb}

@@ -1,9 +1,3 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift 'lib'
-require 'test/unit'
-require 'sru'
-
 class ClientTests < Test::Unit::TestCase
 
   def test_explain
@@ -31,16 +25,23 @@ class ClientTests < Test::Unit::TestCase
     assert_equal 0, results.entries.size
   end
 
-  def test_scan
-    # this scan response appears to be canned might need to change
-    client = SRU::Client.new 'http://tweed.lib.ed.ac.uk:8080/elf/search/copac'
-    scan = client.scan('foobar')
-    assert scan.entries.size > 0
-    assert_equal SRU::Term, scan.entries[0].class
-    assert_equal 'low', scan.entries[0].value
-    assert_equal '1', scan.entries[0].number_of_records
+  def test_default_maximum_records
+    client = SRU::Client.new 'http://z3950.loc.gov:7090/voyager'
+    results = client.search_retrieve 'twain'
+    assert_equal 10, results.entries.size
   end
 
+  # need to find a target that supports scan so we can exercise it
+  #def test_scan
+  #  # this scan response appears to be canned might need to change
+  #  client = SRU::Client.new 'http://tweed.lib.ed.ac.uk:8080/elf/search/copac'
+  #  scan = client.scan('foobar')
+  #  assert scan.entries.size > 0
+  #  assert_equal SRU::Term, scan.entries[0].class
+  #  assert_equal 'low', scan.entries[0].value
+  #  assert_equal '1', scan.entries[0].number_of_records
+  #end
+
   def test_xml_exception
     assert_raise(SRU::Exception) {SRU::Client.new 'http://www.google.com'}
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: sru
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2006-04-17 00:00:00 -05:00
-summary: talk to sru servers with ruby
+  version: 0.0.3
+date: 2006-10-25 00:00:00 -04:00
+summary: a Ruby library for Search and Retrieve by URL
 require_paths: 
-  - lib
+- lib
 email: ehs@pobox.com
 homepage: http://www.textualize.com/sruby
 rubyforge_project: 
@@ -18,31 +18,38 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
-  - Ed Summers
+- Ed Summers
 files: 
-  - lib/sru
-  - lib/sru.rb
-  - lib/sru/client.rb
-  - lib/sru/exception.rb
-  - lib/sru/explain.rb
-  - lib/sru/response.rb
-  - lib/sru/scan.rb
-  - lib/sru/search_retrieve.rb
-  - lib/sru/term.rb
-test_files: 
-  - test.rb
+- lib/sru
+- lib/sru.rb
+- lib/sru/client.rb
+- lib/sru/exception.rb
+- lib/sru/explain.rb
+- lib/sru/response.rb
+- lib/sru/scan.rb
+- lib/sru/search_retrieve.rb
+- lib/sru/term.rb
+- test/client_test.rb
+test_files: []
+
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+