oai 0.0.12 → 0.0.13

data/{README → README.md}

@@ -1,37 +1,43 @@
-= ruby-oai
-
-== DESCRIPTION
-
-ruby-oai is a Open Archives Protocol for Metadata Harvesting (OAI-PMH[http://openarchives.org]) 
-library for Ruby. If you're not familiar with OAI-PMH[http://openarchives.org] it is the most used 
-protocol for sharing metadata between digital library repositories.
-
-The OAI-PMH[http://openarchives.org] spec defines six verbs (Identify, ListIdentifiers, ListRecords, 
+ruby-oai
+========
+
+ruby-oai is a Open Archives Protocol for Metadata Harvesting (OAI-PMH)
+library for Ruby. OAI-PMH[http://openarchives.org] it is a somewhat 
+archaic protocol for sharing metadata between digital library repositories. 
+If you are looking to share metadata on the web you are probably better off
+using a feed format like RSS or Atom. If have to work with a backwards 
+digital repository that only offers OAI-PMH access then ruby-oai is your 
+friend.
+
+The [OAI-PMH](http://openarchives.org) spec defines six verbs (Identify, ListIdentifiers, ListRecords, 
 GetRecords, ListSets, ListMetadataFormat) used for discovery and sharing of
 metadata.
 
 The ruby-oai gem includes a client library, a server/provider library and
 a interactive harvesting shell.
 
-=== client
+Client
+------
 
 The OAI client library is used for harvesting metadata from repositories. 
 For example to initiate a ListRecords request to pubmed you can:
 
+```ruby
   require 'oai'
   client = OAI::Client.new 'http://www.pubmedcentral.gov/oai/oai.cgi'
   for record in client.list_records
     puts record.metadata
   end
+```
 
 See OAI::Client for more details
 
-=== provider
-
-The OAI provider library handles serving local content to other clients.
+Server
+------
 
-Setting up a simple provider:
+The OAI provider library handles serving local content to other clients. Here's how to set up a simple provider:
 
+```ruby
   class MyProvider < Oai::Provider
     repository_name 'My little OAI provider'
     repository_url  'http://localhost/provider'
@@ -39,43 +45,38 @@ Setting up a simple provider:
     admin_email 'root@localhost'   # String or Array
     source_model MyModel.new       # Subclass of OAI::Provider::Model
   end
+```
 
 See OAI::Provider for more details
 
-=== interactive harvester
+Interactive Harvester
+---------------------
 
-The OAI-PMH[http://openarchives.org] client shell allows OAI Harvesting to be configured in
-an interactive manner.  Typing 'oai' on the command line starts the
-shell.
-
-After initial configuration, the shell can be used to manage harvesting
-operations.
+The OAI-PMH client shell allows OAI Harvesting to be configured in an interactive manner.  Typing 'oai' on the command line starts the shell. After initial configuration, the shell can be used to manage harvesting operations.
 
 See OAI::Harvester::Shell for more details
 
-== INSTALLATION
+Installation
+------------
 
 Normally the best way to install oai is from rubyforge using the gem
 command line tool:
 
+```
   % gem install oai
+```
 
 If you're reading this you've presumably got the tarball or zip distribution.
 So you'll need to:
 
+```
   % rake package
   % gem install pkg/oai-x.y.z.gem 
+```
 
 Where x.y.z is the version of the gem that was generated.
 
-== TODO
-
-* consolidate response classes used by provider and client
-* automatic validation of metadata schemas
-* email the authors with your suggestions
-
-== AUTHORS
+License
+-------
 
-- Ed Summers <ehs@pobox.com>
-- William Groppe <will.groppe@gmail.com>
-- Terry Reese <terry.reese@oregonstate.edu>
+[Public Domain](http://creativecommons.org/publicdomain/zero/1.0/)

data/Rakefile

@@ -1,4 +1,4 @@
-RUBY_OAI_VERSION = '0.0.12'
+RUBY_OAI_VERSION = '0.0.13'
 
 require 'rubygems'
 require 'rake'
@@ -21,13 +21,12 @@ spec = Gem::Specification.new do |s|
     s.summary = 'A ruby library for working with the Open Archive Initiative Protocol for Metadata Harvesting (OAI-PMH)'
     s.require_path = 'lib'
     s.autorequire = 'oai'
-    s.has_rdoc = true
     s.bindir = 'bin'
     s.executables = 'oai'
 
     s.add_dependency('builder', '>=2.0.0')
     
-    s.files = %w(README Rakefile) +
+    s.files = %w(README.md Rakefile) +
       Dir.glob("{bin,test,lib}/**/*") + 
       Dir.glob("examples/**/*.rb")
 end

data/lib/oai/provider/metadata_format.rb

@@ -58,9 +58,8 @@ module OAI::Provider::Metadata
      
       if record.respond_to?(pluralize(method))
         record.send pluralize(method)
-      elsif record.respond_to?(method)
-        # at this point, this function will throw a dep. error because of the call to type -- a reserved work
-        # in ruby
+      elsif method != 'type' and record.respond_to?(method)
+        # TODO: this calls type, which is deprecated, should be 
         record.send method
       else
         []

data/lib/oai/provider/response.rb

@@ -61,6 +61,10 @@ module OAI
       
       return true if self.class.valid_options.nil? and options.empty?
       
+      # check if the request includes an argument and there are no valid 
+      # arguments for that verb (Identify, for example).
+      raise OAI::ArgumentException.new if self.class.valid_options.nil? && !options.empty?
+      
       if self.class.required_options
         return false unless (self.class.required_options - @options.keys).empty?
       end

data/lib/oai/provider/resumption_token.rb

@@ -32,7 +32,7 @@ module OAI::Provider
         end
         self.new(options)
       rescue => err
-        raise ResumptionTokenException.new
+        raise OAI::ResumptionTokenException.new
       end
     end
     

data/test/client/tc_exception.rb

@@ -4,7 +4,7 @@ class ExceptionTest < Test::Unit::TestCase
 
   def test_not_found
     client = OAI::Client.new 'http://www.google.com'
-    assert_raises(ArgumentError) { client.identify }
+    assert_raises(OAI::Exception) { client.identify }
   end
 
   def test_xml_error

data/test/client/tc_low_resolution_dates.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class LowResolutionDatesTest < Test::Unit::TestCase
 
   def test_low_res_date_parsing
-    client = OAI::Client.new 'http://caltechcstr.library.caltech.edu/perl/oai2' 
+    client = OAI::Client.new 'http://authors.library.caltech.edu/cgi/oai2' 
 
     date = Date.new 2003, 1, 1
     

data/test/provider/models.rb

@@ -113,6 +113,7 @@ class TestModel < OAI::Provider::Model
       
   def generate_records(number, timestamp = Time.now.utc.xmlschema, sets = [], deleted = false)
     @earliest = timestamp.dup if @earliest.nil? || timestamp.to_s < @earliest
+    @earliest = timestamp.dup if @earliest.nil?
     
     # Add any sets we don't already have
     sets = [sets] unless sets.respond_to?(:each)

data/test/provider/tc_exceptions.rb

@@ -7,6 +7,12 @@ class ProviderExceptions < Test::Unit::TestCase
     @provider = ComplexProvider.new
   end
 
+  def test_argument_exception
+    assert_raise(OAI::ArgumentException) do
+      @provider.identify(:identifier => 'invalid_arg')
+    end 
+  end
+
   def test_resumption_token_exception
     assert_raise(OAI::ResumptionTokenException) do
       @provider.list_records(:resumption_token => 'aaadddd:1000')

data/test/provider/tc_simple_provider.rb

@@ -13,6 +13,11 @@ class TestSimpleProvider < Test::Unit::TestCase
       doc.elements["/OAI-PMH/Identify/repositoryName"].text
     assert_equal SimpleModel.new.earliest.to_s,
       doc.elements["/OAI-PMH/Identify/earliestDatestamp"].text
+      
+      # PC
+  #  lambda { REXML::Document.new(@simple_provider.identify(:set => 'A')) }
+    
+  
   end
 
   def test_list_sets

metadata

@@ -1,152 +1,161 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: oai
 version: !ruby/object:Gem::Version 
-  version: 0.0.12
-date: 2008-12-22 00:00:00 -08:00
-summary: A ruby library for working with the Open Archive Initiative Protocol for Metadata Harvesting (OAI-PMH)
-require_paths: 
-- lib
-email: ehs@pobox.com
-homepage: http://www.textualize.com/ruby_oai_0
-rubyforge_project: 
-description: 
-autorequire: oai
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  hash: 5
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 13
+  version: 0.0.13
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Ed Summers
+autorequire: oai
+bindir: bin
+cert_chain: []
+
+date: 2012-04-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: ehs@pobox.com
+executables: 
+- oai
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
-- README
+- README.md
 - Rakefile
 - bin/oai
-- test/client
-- test/client/helpers
-- test/client/helpers/test_wrapper.rb
+- test/client/tc_get_record.rb
+- test/client/tc_identify.rb
 - test/client/helpers/provider.rb
-- test/client/tc_list_sets.rb
-- test/client/tc_list_metadata_formats.rb
+- test/client/helpers/test_wrapper.rb
+- test/client/tc_list_identifiers.rb
 - test/client/tc_utf8_escaping.rb
-- test/client/tc_identify.rb
+- test/client/tc_list_sets.rb
+- test/client/test_helper.rb
+- test/client/tc_list_records.rb
 - test/client/tc_libxml.rb
-- test/client/tc_list_identifiers.rb
-- test/client/tc_get_record.rb
 - test/client/tc_low_resolution_dates.rb
-- test/client/tc_list_records.rb
-- test/client/tc_xpath.rb
-- test/client/test_helper.rb
 - test/client/tc_exception.rb
-- test/activerecord_provider
-- test/activerecord_provider/tc_ar_provider.rb
-- test/activerecord_provider/helpers
+- test/client/tc_list_metadata_formats.rb
+- test/client/tc_xpath.rb
+- test/provider/tc_simple_provider.rb
+- test/provider/models.rb
+- test/provider/tc_functional_tokens.rb
+- test/provider/tc_provider.rb
+- test/provider/tc_resumption_tokens.rb
+- test/provider/test_helper.rb
+- test/provider/tc_exceptions.rb
+- test/test.xml
+- test/activerecord_provider/fixtures/dc.yml
 - test/activerecord_provider/helpers/providers.rb
 - test/activerecord_provider/helpers/set_provider.rb
-- test/activerecord_provider/models
-- test/activerecord_provider/models/dc_set.rb
+- test/activerecord_provider/tc_caching_paging_provider.rb
+- test/activerecord_provider/tc_ar_sets_provider.rb
 - test/activerecord_provider/models/oai_token.rb
+- test/activerecord_provider/models/dc_set.rb
 - test/activerecord_provider/models/dc_field.rb
+- test/activerecord_provider/test_helper.rb
 - test/activerecord_provider/tc_simple_paging_provider.rb
-- test/activerecord_provider/tc_caching_paging_provider.rb
-- test/activerecord_provider/database
-- test/activerecord_provider/database/ar_migration.rb
 - test/activerecord_provider/database/oaipmhtest
-- test/activerecord_provider/test_helper.rb
-- test/activerecord_provider/fixtures
-- test/activerecord_provider/fixtures/dc.yml
-- test/activerecord_provider/tc_ar_sets_provider.rb
-- test/activerecord_provider/config
-- test/activerecord_provider/config/database.yml
+- test/activerecord_provider/database/ar_migration.rb
+- test/activerecord_provider/tc_ar_provider.rb
 - test/activerecord_provider/config/connection.rb
-- test/test.xml
-- test/provider
-- test/provider/tc_provider.rb
-- test/provider/tc_functional_tokens.rb
-- test/provider/tc_simple_provider.rb
-- test/provider/tc_exceptions.rb
-- test/provider/tc_resumption_tokens.rb
-- test/provider/test_helper.rb
-- test/provider/models.rb
-- lib/oai
+- test/activerecord_provider/config/database.yml
+- lib/oai/set.rb
 - lib/oai/xpath.rb
-- lib/oai/client
+- lib/oai/harvester/logging.rb
+- lib/oai/harvester/mailer.rb
+- lib/oai/harvester/harvest.rb
+- lib/oai/harvester/shell.rb
+- lib/oai/harvester/config.rb
+- lib/oai/client/list_identifiers.rb
+- lib/oai/client/list_records.rb
+- lib/oai/client/header.rb
 - lib/oai/client/identify.rb
 - lib/oai/client/record.rb
-- lib/oai/client/list_sets.rb
-- lib/oai/client/header.rb
-- lib/oai/client/metadata_format.rb
-- lib/oai/client/response.rb
-- lib/oai/client/list_records.rb
 - lib/oai/client/get_record.rb
-- lib/oai/client/list_identifiers.rb
+- lib/oai/client/response.rb
+- lib/oai/client/metadata_format.rb
 - lib/oai/client/list_metadata_formats.rb
-- lib/oai/exception.rb
-- lib/oai/constants.rb
-- lib/oai/set.rb
-- lib/oai/harvester
-- lib/oai/harvester/harvest.rb
-- lib/oai/harvester/config.rb
-- lib/oai/harvester/logging.rb
-- lib/oai/harvester/mailer.rb
-- lib/oai/harvester/shell.rb
-- lib/oai/client.rb
-- lib/oai/harvester.rb
-- lib/oai/provider.rb
-- lib/oai/provider
-- lib/oai/provider/resumption_token.rb
-- lib/oai/provider/partial_result.rb
+- lib/oai/client/list_sets.rb
 - lib/oai/provider/model.rb
-- lib/oai/provider/metadata_format.rb
-- lib/oai/provider/response.rb
-- lib/oai/provider/response
-- lib/oai/provider/response/identify.rb
-- lib/oai/provider/response/list_sets.rb
+- lib/oai/provider/model/activerecord_caching_wrapper.rb
+- lib/oai/provider/model/activerecord_wrapper.rb
+- lib/oai/provider/response/list_identifiers.rb
+- lib/oai/provider/response/list_records.rb
 - lib/oai/provider/response/record_response.rb
+- lib/oai/provider/response/identify.rb
 - lib/oai/provider/response/error.rb
-- lib/oai/provider/response/list_records.rb
 - lib/oai/provider/response/get_record.rb
-- lib/oai/provider/response/list_identifiers.rb
 - lib/oai/provider/response/list_metadata_formats.rb
-- lib/oai/provider/model
-- lib/oai/provider/model/activerecord_caching_wrapper.rb
-- lib/oai/provider/model/activerecord_wrapper.rb
-- lib/oai/provider/extensions
-- lib/oai/provider/metadata_format
+- lib/oai/provider/response/list_sets.rb
 - lib/oai/provider/metadata_format/oai_dc.rb
-- lib/oai.rb
+- lib/oai/provider/resumption_token.rb
+- lib/oai/provider/response.rb
+- lib/oai/provider/partial_result.rb
+- lib/oai/provider/metadata_format.rb
+- lib/oai/constants.rb
+- lib/oai/client.rb
+- lib/oai/provider.rb
+- lib/oai/harvester.rb
+- lib/oai/exception.rb
 - lib/test.rb
+- lib/oai.rb
 - examples/providers/dublin_core.rb
 - examples/models/file_model.rb
-test_files: []
+homepage: http://www.textualize.com/ruby_oai_0
+licenses: []
 
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: 
-- oai
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: builder
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.0
-    version: 
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A ruby library for working with the Open Archive Initiative Protocol for Metadata Harvesting (OAI-PMH)
+test_files: []
+