oai 0.2.1 → 0.3.0

data/lib/oai/provider/response/get_record.rb

@@ -1,8 +1,8 @@
 module OAI::Provider::Response
-  
+
   class GetRecord < RecordResponse
-    required_parameters :identifier
-    
+    required_parameters :identifier, :metadata_prefix
+
     def to_xml
       id = extract_identifier(options.delete(:identifier))
       unless record = provider.model.find(id, options)
@@ -11,7 +11,7 @@ module OAI::Provider::Response
 
       response do |r|
         r.GetRecord do
-          r.record do 
+          r.record do
             header_for record
             data_for record unless deleted?(record)
             about_for record unless deleted?(record)
@@ -19,9 +19,9 @@ module OAI::Provider::Response
         end
       end
     end
-        
+
   end
 
 end
-    
-    
+
+

data/lib/oai/provider/response/list_records.rb

@@ -1,7 +1,8 @@
 module OAI::Provider::Response
 
   class ListRecords < RecordResponse
-    
+    required_parameters :metadata_prefix
+
     def to_xml
       result = provider.model.find(:all, options)
       # result may be an array of records, or a partial result
@@ -27,8 +28,8 @@ module OAI::Provider::Response
         end
       end
     end
-    
+
   end
-  
+
 end
-  
+

data/lib/oai/provider/response/record_response.rb

@@ -2,16 +2,16 @@ module OAI::Provider::Response
   class RecordResponse < Base
     def self.inherited(klass)
       klass.valid_parameters    :metadata_prefix, :from, :until, :set
-      klass.default_parameters  :metadata_prefix => "oai_dc", 
+      klass.default_parameters  :metadata_prefix => "oai_dc",
            :from => Proc.new {|x| Time.parse(x.provider.model.earliest.to_s) }, #-- OAI 2.0 hack - UTC
            :until => Proc.new {|x| Time.parse(x.provider.model.latest.to_s) }   #-- OAI 2.0 hack - UTC
     end
-    
+
     # emit record header
     def header_for(record)
       param = Hash.new
       param[:status] = 'deleted' if deleted?(record)
-      @builder.header param do 
+      @builder.header param do
         @builder.identifier identifier_for(record)
         @builder.datestamp timestamp_for(record)
         sets_for(record).each do |set|
@@ -33,7 +33,7 @@ module OAI::Provider::Response
       return unless provider.model.respond_to? :about
 
       about = provider.model.about(record)
-      return if about.nil? 
+      return if about.nil?
 
       unless about.is_a? Array
         about = [about]
@@ -42,43 +42,43 @@ module OAI::Provider::Response
       about.each do |a|
         @builder.about do
           @builder.target! << a
-        end 
+        end
       end
     end
-    
+
     private
-    
+
     def identifier_for(record)
       "#{provider.prefix}/#{record.id}"
     end
-    
+
     def timestamp_for(record)
       record.send(provider.model.timestamp_field).utc.xmlschema
     end
-    
+
     def sets_for(record)
       return [] unless record.respond_to?(:sets) and record.sets
       record.sets.respond_to?(:each) ? record.sets : [record.sets]
     end
-    
+
     def requested_format
-      format = 
+      format =
       if options[:metadata_prefix]
         options[:metadata_prefix]
       elsif options[:resumption_token]
         OAI::Provider::ResumptionToken.extract_format(options[:resumption_token])
       end
       raise OAI::FormatException.new unless provider.format_supported?(format)
-      
+
       format
     end
-    
+
     def deleted?(record)
       return record.deleted? if record.respond_to?(:deleted?)
       return record.deleted if record.respond_to?(:deleted)
       return record.deleted_at if record.respond_to?(:deleted_at)
       false
     end
-    
+
   end
 end

data/test/activerecord_provider/config/connection.rb

@@ -1,5 +1,9 @@
+require 'active_record'
+require 'logger'
+
 # Configure AR connection
-conn_info = YAML.load_file(
-  File.join(File.dirname(__FILE__), "database.yml")
-)
-ActiveRecord::Base.establish_connection(conn_info)
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection :adapter => "sqlite3",
+                                        :database => ":memory:"
+ActiveRecord::Migrator.up File.join(File.dirname(__FILE__), '..', 'database')

data/test/activerecord_provider/database/{ar_migration.rb → 0001_oaipmh_tables.rb}

@@ -1,18 +1,16 @@
-ActiveRecord::Migration.verbose = false
-
-class OAIPMHTables < ActiveRecord::Migration
+class OaipmhTables < ActiveRecord::Migration
   def self.up
-    create_table :oai_tokens, :force => true do |t|
+    create_table :oai_tokens do |t|
       t.column :token,      :string,  :null => false
       t.column :created_at, :timestamp
     end
-    
-    create_table :oai_entries, :force => true do |t|
+
+    create_table :oai_entries do |t|
       t.column :record_id, :integer, :null => false
       t.column :oai_token_id, :integer, :null => false
     end
-    
-    create_table :dc_fields, :force => true do |t|
+
+    dc_fields = proc do |t|
       t.column  :title,         :string
       t.column  :creator,       :string
       t.column  :subject,       :string
@@ -31,13 +29,20 @@ class OAIPMHTables < ActiveRecord::Migration
       t.column  :created_at,    :datetime
       t.column  :deleted,       :boolean,   :default => false
     end
-    
-    create_table :dc_fields_dc_sets, :force => true, :id => false do |t|
+
+    create_table :exclusive_set_dc_fields do |t|
+      dc_fields.call(t)
+      t.column  :set,           :string
+    end
+
+    create_table :dc_fields, &dc_fields
+
+    create_table :dc_fields_dc_sets, :id => false do |t|
       t.column :dc_field_id,    :integer
       t.column :dc_set_id,      :integer
     end
-    
-    create_table :dc_sets, :force => true do |t|
+
+    create_table :dc_sets do |t|
       t.column :name,           :string
       t.column :spec,           :string
       t.column :description,    :string

data/test/activerecord_provider/helpers/providers.rb

@@ -1,6 +1,5 @@
 require 'active_record'
 require 'oai'
-require "config/connection.rb"
 
 Dir.glob(File.dirname(__FILE__) + "/../models/*.rb").each do |lib|
   require lib
@@ -26,7 +25,7 @@ class CachingResumptionProvider < OAI::Provider::Base
   record_prefix 'oai:test'
   source_model ActiveRecordCachingWrapper.new(DCField, :limit => 25)
 end
-  
+
 
 class ARLoader
   def self.load
@@ -37,7 +36,7 @@ class ARLoader
       DCField.create(fixtures[key])
     end
   end
-  
+
   def self.unload
     DCField.delete_all
   end

data/test/activerecord_provider/helpers/set_provider.rb

@@ -1,31 +1,11 @@
 # Extend ActiveRecordModel to support sets
 class SetModel < OAI::Provider::ActiveRecordWrapper
-  
+
   # Return all available sets
   def sets
-    DCSet.find(:all)
+    DCSet.scoped
   end
 
-  # Scope the find to a set relation if we get a set in the options    
-  def find(selector, opts={})
-    if opts[:set]
-      set = DCSet.find_by_spec(opts.delete(:set))
-      conditions = sql_conditions(opts)
-
-      if :all == selector
-        set.dc_fields.find(selector, :conditions => conditions)
-      else
-        set.dc_fields.find(selector, :conditions => conditions)
-      end
-    else
-      if :all == selector
-        model.find(selector, :conditions => sql_conditions(opts))
-      else
-        model.find(selector, :conditions => sql_conditions(opts))
-      end
-    end
-  end
-        
 end
 
 class ARSetProvider < OAI::Provider::Base
@@ -33,4 +13,12 @@ class ARSetProvider < OAI::Provider::Base
   repository_url 'http://localhost'
   record_prefix = 'oai:test'
   source_model SetModel.new(DCField, :timestamp_field => 'date')
+end
+
+class ARExclusiveSetProvider < OAI::Provider::Base
+  repository_name 'ActiveRecord Set Based Provider'
+  repository_url 'http://localhost'
+  record_prefix = 'oai:test'
+  source_model OAI::Provider::ActiveRecordWrapper.new(
+    ExclusiveSetDCField, :timestamp_field => 'date')
 end

data/test/activerecord_provider/helpers/transactional_test_case.rb

@@ -0,0 +1,34 @@
+class TransactionalTestCase < Test::Unit::TestCase
+
+  def run(result, &block)
+    # Handle the default "you have no tests" test if it turns up
+    return if @method_name.to_s == "default_test"
+    ActiveRecord::Base.transaction do
+      load_fixtures
+      result = super(result, &block)
+      raise ActiveRecord::Rollback
+    end
+    result
+  end
+
+  protected
+
+  def load_fixtures
+    fixtures = YAML.load_file(
+      File.join(File.dirname(__FILE__), '..', 'fixtures', 'dc.yml')
+    )
+    disable_logging do
+      fixtures.keys.sort.each do |key|
+        DCField.create(fixtures[key])
+      end
+    end
+  end
+
+  def disable_logging
+    logger = ActiveRecord::Base.logger
+    ActiveRecord::Base.logger = nil
+    yield
+    ActiveRecord::Base.logger = logger
+  end
+
+end

data/test/activerecord_provider/models/dc_field.rb

@@ -1,7 +1,7 @@
 class DCField < ActiveRecord::Base
-  set_inheritance_column 'DONOTINHERIT'
-  has_and_belongs_to_many :sets, 
-    :join_table => "dc_fields_dc_sets", 
-    :foreign_key => "dc_field_id", 
+  inheritance_column = 'DONOTINHERIT'
+  has_and_belongs_to_many :sets,
+    :join_table => "dc_fields_dc_sets",
+    :foreign_key => "dc_field_id",
     :class_name => "DCSet"
 end

data/test/activerecord_provider/models/dc_set.rb

@@ -1,6 +1,7 @@
 class DCSet < ActiveRecord::Base
-  has_and_belongs_to_many :dc_fields, 
-    :join_table => "dc_fields_dc_sets", 
+  has_and_belongs_to_many :dc_fields,
+    :join_table => "dc_fields_dc_sets",
     :foreign_key => "dc_set_id",
     :class_name => "DCField"
+
 end

data/test/activerecord_provider/models/exclusive_set_dc_field.rb

@@ -0,0 +1,11 @@
+class ExclusiveSetDCField < ActiveRecord::Base
+  inheritance_column = 'DONOTINHERIT'
+
+  def self.sets
+    klass = Struct.new(:name, :spec)
+    self.uniq.pluck('`set`').compact.map do |spec|
+      klass.new("Set #{spec}", spec)
+    end
+  end
+
+end

data/test/activerecord_provider/tc_ar_provider.rb

@@ -1,27 +1,30 @@
 require 'test_helper'
 
-class ActiveRecordProviderTest < Test::Unit::TestCase
+class ActiveRecordProviderTest < TransactionalTestCase
 
   def test_identify
     assert @provider.identify =~ /ActiveRecord Based Provider/
   end
-  
+
   def test_metadata_formats
     assert_nothing_raised { REXML::Document.new(@provider.list_metadata_formats) }
     doc =  REXML::Document.new(@provider.list_metadata_formats)
     assert doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text == 'oai_dc'
   end
-  
+
   def test_metadata_formats_for_record
     record_id = DCField.find(:first).id
     assert_nothing_raised { REXML::Document.new(@provider.list_metadata_formats(:identifier => "oai:test/#{record_id}")) }
     doc =  REXML::Document.new(@provider.list_metadata_formats)
     assert doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text == 'oai_dc'
   end
-  
+
   def test_list_records
-    assert_nothing_raised { REXML::Document.new(@provider.list_records) }
-    doc = REXML::Document.new(@provider.list_records)
+    assert_nothing_raised do
+      REXML::Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
+    doc = REXML::Document.new(@provider.list_records(
+      :metadata_prefix => 'oai_dc'))
     assert_equal 100, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
 
@@ -33,52 +36,60 @@ class ActiveRecordProviderTest < Test::Unit::TestCase
 
   def test_get_record
     record_id = DCField.find(:first).id
-    assert_nothing_raised { REXML::Document.new(@provider.get_record(:identifier => "oai:test/#{record_id}")) }
-    doc = REXML::Document.new(@provider.get_record(:identifier => "#{record_id}"))
+    assert_nothing_raised do
+      REXML::Document.new(@provider.get_record(
+        :identifier => "oai:test/#{record_id}", :metadata_prefix => 'oai_dc'))
+    end
+    doc = REXML::Document.new(@provider.get_record(
+      :identifier => "#{record_id}", :metadata_prefix => 'oai_dc'))
     assert_equal "oai:test/#{record_id}", doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
   end
-  
+
   def test_deleted
     record = DCField.find(:first)
     record.deleted = true;
     record.save
-    doc = REXML::Document.new(@provider.get_record(:identifier => "oai:test/#{record.id}"))
+    doc = REXML::Document.new(@provider.get_record(
+      :identifier => "oai:test/#{record.id}", :metadata_prefix => 'oai_dc'))
     assert_equal "oai:test/#{record.id}", doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
     assert_equal 'deleted', doc.elements['OAI-PMH/GetRecord/record/header'].attributes["status"]
   end
-  
+
   def test_from
     first_id = DCField.find(:first, :order => "id asc").id
     DCField.update_all(['updated_at = ?', Time.parse("January 1 2005")],
       "id < #{first_id + 90}")
     DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")],
       "id < #{first_id + 10}")
-    
+
     from_param = Time.parse("January 1 2006")
-    
+
     doc = REXML::Document.new(
-      @provider.list_records(:from => from_param)
-      )
-    assert_equal DCField.find(:all, :conditions => ["updated_at >= ?", from_param]).size, 
+      @provider.list_records(
+        :metadata_prefix => 'oai_dc', :from => from_param)
+    )
+    assert_equal DCField.find(:all, :conditions => ["updated_at >= ?", from_param]).size,
       doc.elements['OAI-PMH/ListRecords'].size
 
     doc = REXML::Document.new(
-      @provider.list_records(:from => Time.parse("May 30 2005"))
-      )
+      @provider.list_records(
+        :metadata_prefix => 'oai_dc', :from => Time.parse("May 30 2005"))
+    )
     assert_equal 20, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-  
+
   def test_until
     first_id = DCField.find(:first, :order => "id asc").id
     DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")],
       "id < #{first_id + 10}")
 
     doc = REXML::Document.new(
-      @provider.list_records(:until => Time.parse("June 1 2005"))
-      )
+      @provider.list_records(
+        :metadata_prefix => 'oai_dc', :until => Time.parse("June 1 2005"))
+    )
     assert_equal 10, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-  
+
   def test_from_and_until
     first_id = DCField.find(:first, :order => "id asc").id
     DCField.update_all(['updated_at = ?', Time.parse("June 1 2005")])
@@ -88,19 +99,47 @@ class ActiveRecordProviderTest < Test::Unit::TestCase
       "id < #{first_id + 10}")
 
     doc = REXML::Document.new(
-      @provider.list_records(:from => Time.parse("June 3 2005"),
+      @provider.list_records(
+        :metadata_prefix => 'oai_dc',
+        :from => Time.parse("June 3 2005"),
         :until => Time.parse("June 16 2005"))
       )
     assert_equal 40, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
-  
+
+  def test_handles_empty_collections
+    DCField.delete_all
+    assert DCField.count == 0
+    # Identify and ListMetadataFormats should return normally
+    test_identify
+    test_metadata_formats
+    # ListIdentifiers and ListRecords should return "noRecordsMatch" error code
+    assert_raises(OAI::NoMatchException) do
+      REXML::Document.new(@provider.list_identifiers)
+    end
+    assert_raises(OAI::NoMatchException) do
+      REXML::Document.new(@provider.list_records(:metadata_prefix => 'oai_dc'))
+    end
+  end
+
   def setup
     @provider = ARProvider.new
-    ARLoader.load
   end
-  
+
+end
+
+class ActiveRecordProviderTimezoneTest < ActiveRecordProviderTest
+
+  def setup
+    require 'active_record'
+    ActiveRecord::Base.default_timezone = :utc
+    super
+  end
+
   def teardown
-    ARLoader.unload
+    require 'active_record'
+    ActiveRecord::Base.default_timezone = :local
+    super
   end
-  
+
 end