oai 0.0.3 → 0.0.4

data/test/provider/tc_exceptions.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class ProviderExceptions < Test::Unit::TestCase
+
+  def setup
+    @provider = ComplexProvider.new
+  end
+
+  def test_resumption_token_exception
+    assert_raise(OAI::ResumptionTokenException) do
+      @provider.list_records(:resumption_token => 'aaadddd:1000')
+    end
+    assert_raise(OAI::ResumptionTokenException) do
+      @provider.list_records(:resumption_token => 'oai_dc:1000')
+    end
+    assert_raise(OAI::ResumptionTokenException) do
+      @provider.list_identifiers(:resumption_token => '..::!:.:!:')
+    end
+    assert_raise(OAI::ResumptionTokenException) do
+      @provider.list_identifiers(:resumption_token => '\:\\:\/$%^&*!@#!:1')
+    end
+  end
+  
+  def test_bad_verb_raises_exception
+    assert @provider.process_request(:verb => 'BadVerb') =~ /badVerb/
+    assert @provider.process_request(:verb => '\a$#^%!@') =~ /badVerb/
+    assert @provider.process_request(:verb => 'identity') =~ /badVerb/
+    assert @provider.process_request(:verb => '!!\\$\$\.+') =~ /badVerb/
+  end
+  
+  def test_bad_format_raises_exception
+    assert_raise(OAI::FormatException) do
+      @provider.get_record(:identifier => 'oai:test/1', :metadata_prefix => 'html')
+    end
+  end
+  
+  def test_bad_id_raises_exception
+    assert_raise(OAI::IdException) do
+      @provider.get_record(:identifier => 'oai:test/5000')
+    end
+    assert_raise(OAI::IdException) do
+      @provider.get_record(:identifier => 'oai:test/-1')
+    end
+    assert_raise(OAI::IdException) do
+      @provider.get_record(:identifier => 'oai:test/one')
+    end
+    assert_raise(OAI::IdException) do
+      @provider.get_record(:identifier => 'oai:test/\\$1\1!')
+    end
+  end
+  
+  def test_no_records_match_dates_that_are_out_of_range
+    assert_raise(OAI::NoMatchException) do
+      @provider.list_records(:from => Chronic.parse("November 2 2000"), 
+                             :until => Chronic.parse("November 1 2000"))
+    end
+  end
+  
+  def test_no_records_match_bad_set
+    assert_raise(OAI::NoMatchException) { @provider.list_records(:set => 'unknown') }
+  end
+  
+end

data/test/provider/tc_functional_tokens.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class ResumptionTokenFunctionalTest < Test::Unit::TestCase
+  include REXML
+  
+  def setup
+    @provider = ComplexProvider.new
+  end
+
+  def test_resumption_tokens
+    assert_nothing_raised { Document.new(@provider.list_records) }
+    doc = Document.new(@provider.list_records)
+    assert_not_nil doc.elements["/OAI-PMH/resumptionToken"]
+    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    token = doc.elements["/OAI-PMH/resumptionToken"].text
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_not_nil doc.elements["/OAI-PMH/resumptionToken"]
+    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+  end
+
+  def test_from_and_until_with_resumption_tokens
+    # Should return 300 records broken into 3 groups of 100.
+    assert_nothing_raised { Document.new(@provider.list_records) }
+    doc = Document.new(
+      @provider.list_records(
+        :from => Chronic.parse("September 1 2004"),
+        :until => Chronic.parse("November 30 2004"))
+      )
+    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    token = doc.elements["/OAI-PMH/resumptionToken"].text
+  
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_not_nil doc.elements["/OAI-PMH/resumptionToken"]
+    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    token = doc.elements["/OAI-PMH/resumptionToken"].text
+
+    doc = Document.new(@provider.list_records(:resumption_token => token))
+    assert_nil doc.elements["/OAI-PMH/resumptionToken"]
+    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+  end
+    
+end

data/test/provider/tc_provider.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class OaiTest < Test::Unit::TestCase
+
+  def setup
+    @mapped_provider = MappedProvider.new
+    @big_provider = BigProvider.new
+  end
+  
+  def test_list_identifiers_for_correct_xml
+    doc = REXML::Document.new(@mapped_provider.list_identifiers)
+    assert_not_nil doc.elements['OAI-PMH/ListIdentifiers']
+    assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header']
+    assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/identifier']
+    assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/datestamp']
+    assert_not_nil doc.elements['OAI-PMH/ListIdentifiers/header/setSpec']
+  end
+  
+  def test_list_records_for_correct_xml
+    doc = REXML::Document.new(@mapped_provider.list_records)
+    assert_not_nil doc.elements['OAI-PMH/ListRecords/record/header']
+    assert_not_nil doc.elements['OAI-PMH/ListRecords/record/metadata']
+  end
+  
+  def test_mapped_source
+    assert_nothing_raised { REXML::Document.new(@mapped_provider.list_records) }
+    doc = REXML::Document.new(@mapped_provider.list_records)
+    assert_equal "title_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:creator'].text
+    assert_equal "creator_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:title'].text
+    assert_equal "tag_0", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:subject'].text
+  end
+  
+  def test_from
+    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    doc = REXML::Document.new(
+      @big_provider.list_records(:from => Chronic.parse("February 1 2001"))
+      )
+    assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
+
+    doc = REXML::Document.new(
+      @big_provider.list_records(:from => Chronic.parse("January 1 2001"))
+      )
+    assert_equal 200, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_until
+    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    doc = REXML::Document.new(
+      @big_provider.list_records(:until => Chronic.parse("November 1 2000"))
+      )
+    assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+  
+  def test_from_and_until
+    assert_nothing_raised { REXML::Document.new(@big_provider.list_records) }
+    doc = REXML::Document.new(
+      @big_provider.list_records(:from => Chronic.parse("November 1 2000"),
+        :until => Chronic.parse("November 30 2000"))
+      )
+    assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
+
+    doc = REXML::Document.new(
+      @big_provider.list_records(:from => Chronic.parse("December 1 2000"),
+      :until => Chronic.parse("December 31 2000"))
+      )
+    assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
+  end
+        
+end

data/test/provider/tc_resumption_tokens.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class ResumptionTokenTest < Test::Unit::TestCase
+  include REXML
+  include OAI::Provider
+  
+  def setup
+    @token = ResumptionToken.new(
+      :from => Chronic.parse("January 1 2005"),
+      :until => Chronic.parse("January 31 2005"), 
+      :set => "A",
+      :metadata_prefix => "oai_dc", 
+      :last => 1
+    )
+  end
+
+  def test_resumption_token_options_encoding
+    assert_equal "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z)",
+      @token.to_s
+  end
+  
+  def test_resumption_token_next_method
+    assert_equal 100, @token.next(100).last
+  end
+  
+  def test_resumption_token_to_condition_hash
+    hash = @token.to_conditions_hash
+    assert_equal @token.from, hash[:from]
+    assert_equal @token.until, hash[:until]
+    assert_equal @token.set, hash[:set]
+    assert_equal @token.prefix, hash[:metadata_prefix]
+  end
+
+  def test_resumption_token_parsing
+    new_token = ResumptionToken.parse(
+      "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z):1"
+    )
+    assert_equal @token, new_token
+  end
+  
+  def test_resumption_token_to_xml
+    doc = REXML::Document.new(@token.to_xml)
+    assert_equal "#{@token.to_s}:#{@token.last}", doc.elements['/resumptionToken'].text
+  end
+    
+end

data/test/provider/tc_simple_provider.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class TestSimpleProvider < Test::Unit::TestCase
+
+  def setup
+    @simple_provider = SimpleProvider.new
+    @model = @simple_provider.class.model
+  end
+  
+  def test_identify
+    doc = REXML::Document.new(@simple_provider.identify)
+    assert_equal @simple_provider.class.name,
+      doc.elements["/OAI-PMH/Identify/repositoryName"].text
+    assert_equal SimpleModel.new.earliest.to_s,
+      doc.elements["/OAI-PMH/Identify/earliestDatestamp"].text
+  end
+
+  def test_list_sets
+    doc = REXML::Document.new(@simple_provider.list_sets)
+    sets = doc.elements["/OAI-PMH/ListSets"]
+    assert_equal @model.sets.size, sets.size
+    assert_equal @model.sets[0].name, sets[0].elements["//setName"].text
+  end
+  
+  def test_metadata_formats
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_metadata_formats) }
+    doc =  REXML::Document.new(@simple_provider.list_metadata_formats)
+    assert_equal "oai_dc",
+      doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text
+  end
+  
+  def test_list_records_without_constraints
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_records) }
+
+    total = @model.find(:all).size
+    doc = REXML::Document.new(@simple_provider.list_records)
+    assert_equal total, doc.elements['OAI-PMH/ListRecords'].size
+  end
+  
+  def test_list_records_with_set_equal_a
+    total = @model.find(:all, :set => 'A').size
+    doc = REXML::Document.new(@simple_provider.list_records(:set => 'A'))
+    assert_equal total, doc.elements['OAI-PMH/ListRecords'].size
+  end
+  
+  def test_list_record_with_set_equal_ab
+    total = @model.find(:all, :set => 'A:B').size
+    doc = REXML::Document.new(@simple_provider.list_records(:set => 'A:B'))
+    assert_equal total, doc.elements['OAI-PMH/ListRecords'].size
+  end
+
+  def test_list_identifiers_without_constraints
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_identifiers) }
+
+    total = @model.find(:all).size
+    doc = REXML::Document.new(@simple_provider.list_identifiers)
+    assert_equal total, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+  end
+  
+  def test_list_identifiers_with_set_equal_a
+    total = @model.find(:all, :set => 'A').size
+    doc = REXML::Document.new(@simple_provider.list_identifiers(:set => 'A'))
+    assert_equal total, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+  end
+  
+  def test_list_indentifiers_with_set_equal_ab
+    total = @model.find(:all, :set => 'A:B').size
+    doc = REXML::Document.new(@simple_provider.list_identifiers(:set => 'A:B'))
+    assert_equal total, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+  end
+
+  def test_get_record
+    assert_nothing_raised { REXML::Document.new(@simple_provider.get_record(:identifier => 'oai:test/1')) }
+    doc = REXML::Document.new(@simple_provider.get_record(:identifier => 'oai:test/1'))
+    assert_equal 'oai:test/1', doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+  end
+  
+  def test_deleted_record
+    assert_nothing_raised { REXML::Document.new(@simple_provider.get_record(:identifier => 'oai:test/6')) }
+    doc = REXML::Document.new(@simple_provider.get_record(:identifier => 'oai:test/5'))
+    assert_equal 'oai:test/5', doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+    assert_equal 'deleted', doc.elements['OAI-PMH/GetRecord/record/header'].attributes["status"]
+  end
+          
+end

data/test/provider/test_helper.rb

@@ -0,0 +1,36 @@
+require 'oai'
+require 'test/unit'
+
+require File.dirname(__FILE__) + '/models'
+include OAI
+
+class SimpleProvider < Provider::Base
+  repository_name 'Test Provider'
+  record_prefix 'oai:test'
+  source_model SimpleModel.new
+end
+
+class BigProvider < Provider::Base
+  repository_name 'Another Provider'
+  record_prefix 'oai:test'
+  source_model BigModel.new
+end
+
+class TokenProvider < Provider::Base
+  repository_name 'Token Provider'
+  record_prefix 'oai:test'
+  source_model BigModel.new(25)
+end
+
+class MappedProvider < Provider::Base
+  repository_name 'Mapped Provider'
+  record_prefix 'oai:test'
+  source_model MappedModel.new
+end
+
+class ComplexProvider < Provider::Base
+  repository_name 'Complex Provider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model ComplexModel.new(100)
+end

metadata

@@ -3,13 +3,13 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: oai
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2006-09-19 00:00:00 -04:00
+  version: 0.0.4
+date: 2007-02-05 00:00:00 -05: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-marc
+homepage: http://www.textualize.com/ruby_oai_0
 rubyforge_project: 
 description: 
 autorequire: oai
@@ -29,44 +29,140 @@ post_install_message:
 authors: 
 - Ed Summers
 files: 
+- README
+- Rakefile
+- bin/oai
+- test/activerecord_provider
+- test/client
+- test/provider
+- test/test.xml
+- test/activerecord_provider/config
+- test/activerecord_provider/database
+- test/activerecord_provider/fixtures
+- test/activerecord_provider/helpers
+- test/activerecord_provider/models
+- test/activerecord_provider/tc_ar_provider.rb
+- test/activerecord_provider/tc_ar_sets_provider.rb
+- test/activerecord_provider/tc_caching_paging_provider.rb
+- test/activerecord_provider/tc_simple_paging_provider.rb
+- test/activerecord_provider/test_helper.rb
+- test/activerecord_provider/config/connection.rb
+- test/activerecord_provider/config/database.yml
+- test/activerecord_provider/database/ar_migration.rb
+- test/activerecord_provider/database/oaipmhtest
+- test/activerecord_provider/fixtures/dc.yml
+- test/activerecord_provider/helpers/providers.rb
+- test/activerecord_provider/helpers/set_provider.rb
+- test/activerecord_provider/models/dc_field.rb
+- test/activerecord_provider/models/dc_set.rb
+- test/activerecord_provider/models/oai_token.rb
+- test/client/helpers
+- test/client/tc_exception.rb
+- test/client/tc_get_record.rb
+- test/client/tc_identify.rb
+- test/client/tc_libxml.rb
+- test/client/tc_list_identifiers.rb
+- test/client/tc_list_metadata_formats.rb
+- test/client/tc_list_records.rb
+- test/client/tc_list_sets.rb
+- test/client/tc_xpath.rb
+- test/client/test_helper.rb
+- test/client/helpers/provider.rb
+- test/client/helpers/test_wrapper.rb
+- test/provider/models.rb
+- test/provider/tc_exceptions.rb
+- test/provider/tc_functional_tokens.rb
+- test/provider/tc_provider.rb
+- test/provider/tc_resumption_tokens.rb
+- test/provider/tc_simple_provider.rb
+- test/provider/test_helper.rb
 - lib/oai
 - lib/oai.rb
 - lib/test.rb
+- lib/oai/client
 - lib/oai/client.rb
+- lib/oai/constants.rb
 - lib/oai/exception.rb
-- lib/oai/get_record.rb
-- lib/oai/header.rb
-- lib/oai/identify.rb
-- lib/oai/list_identifiers.rb
-- lib/oai/list_metadata_formats.rb
-- lib/oai/list_records.rb
-- lib/oai/list_sets.rb
-- lib/oai/metadata_format.rb
-- lib/oai/record.rb
-- lib/oai/response.rb
+- lib/oai/harvester
+- lib/oai/harvester.rb
+- lib/oai/provider
+- lib/oai/provider.rb
 - lib/oai/set.rb
 - lib/oai/xpath.rb
-- test/tc_exception.rb
-- test/tc_get_record.rb
-- test/tc_identify.rb
-- test/tc_libxml.rb
-- test/tc_list_identifiers.rb
-- test/tc_list_metadata_formats.rb
-- test/tc_list_records.rb
-- test/tc_list_sets.rb
-- test/tc_xpath.rb
-- test/test.xml
+- lib/oai/client/get_record.rb
+- lib/oai/client/header.rb
+- lib/oai/client/identify.rb
+- lib/oai/client/list_identifiers.rb
+- lib/oai/client/list_metadata_formats.rb
+- lib/oai/client/list_records.rb
+- lib/oai/client/list_sets.rb
+- lib/oai/client/metadata_format.rb
+- lib/oai/client/record.rb
+- lib/oai/client/response.rb
+- lib/oai/harvester/config.rb
+- lib/oai/harvester/harvest.rb
+- lib/oai/harvester/logging.rb
+- lib/oai/harvester/mailer.rb
+- lib/oai/harvester/shell.rb
+- lib/oai/provider/extensions
+- lib/oai/provider/metadata_format
+- lib/oai/provider/metadata_format.rb
+- lib/oai/provider/model
+- lib/oai/provider/model.rb
+- lib/oai/provider/partial_result.rb
+- lib/oai/provider/response
+- lib/oai/provider/response.rb
+- lib/oai/provider/resumption_token.rb
+- lib/oai/provider/metadata_format/oai_dc.rb
+- lib/oai/provider/model/activerecord_caching_wrapper.rb
+- lib/oai/provider/model/activerecord_wrapper.rb
+- lib/oai/provider/response/error.rb
+- lib/oai/provider/response/get_record.rb
+- lib/oai/provider/response/identify.rb
+- lib/oai/provider/response/list_identifiers.rb
+- lib/oai/provider/response/list_metadata_formats.rb
+- lib/oai/provider/response/list_records.rb
+- lib/oai/provider/response/list_sets.rb
+- lib/oai/provider/response/record_response.rb
+- examples/models/file_model.rb
+- examples/providers/dublin_core.rb
 test_files: []
 
 rdoc_options: []
 
 extra_rdoc_files: []
 
-executables: []
-
+executables: 
+- oai
 extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: chronic
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+- !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: