oaipmh 0.0.1 → 0.0.2

data/README

@@ -1,3 +1,129 @@
-README for oaipmh
-=================
-
+# = README
+#
+# Copyright (C) 2006 William Groppe
+#
+# Will Groppe mailto:wfg@artstor.org
+#
+# Open Archives Initiative - Protocol for Metadata Harvesting see 
+# http://www.openarchives.org/ 
+#
+# === Features
+# * Easily setup a simple repository
+# * Simple integration with ActiveRecord
+# * Dublin Core metadata format included
+# * Easily add addition metadata formats
+# * Adaptable to any data source
+#
+#
+# === Current shortcomings
+# * No resumption tokens
+# * Doesn't validate metadata
+# * No deletion support
+# * Many others I can't think of right now. :-)
+#
+#
+# === ActiveRecord integration
+#
+# To successfully use ActiveRecord as a OAI PMH datasource the database table
+# should include an updated_at column so that updates to the table are 
+# tracked by ActiveRecord.  This provides much of the base functionality for
+# selecting update periods.
+#
+# To understand how the data is extracted from the AR model it's best to just
+# go thru the logic:
+#
+# Does the model respond to 'to_{prefix}'?  Where prefix is the
+# metadata prefix.  If it does then just include the response from
+# the model.  So if you want to provide custom or complex metadata you can 
+# simply define a 'to_{prefix}' method on your model.
+# 
+# Example:
+#
+#  class Record < ActiveRecord::Base
+#
+#    def to_oai_dc
+#      xml = Builder::XmlMarkup.new
+#      xml.tag!('oai_dc:dc',
+#        'xmlns:oai_dc' => "http://www.openarchives.org/OAI/2.0/oai_dc/",
+#        'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
+#        '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}) do
+#
+#          xml.oai_dc :title, title
+#          xml.oai_dc :subject, subject
+#      end
+#      xml.to_s
+#    end
+#
+#  end
+#
+# If the model doesn't define a 'to_{prefix}' then start iterating thru
+# the defined metadata fields.
+#
+# Grab a mapping if one exists by trying to call 'map_{prefix}'.
+#
+# Now do the iteration and try calling methods on the model that match
+# the field names, or the mapped field names.
+#
+# So with Dublin Core we end up with the following:
+#
+# 1. Check for 'title' mapped to a different method.
+# 2. Call model.titles - try plural
+# 3. Call model.title - try singular last
+#
+# Extremely contrived Blog example:
+#
+#  class Post < ActiveRecord::Base
+#    def map_oai_dc
+#      {:subject => :tags, 
+#       :description => :text, 
+#       :creator => :user, 
+#       :contibutor => :comments}
+#    end
+#  end
+#
+# === Supporting custom metadata
+#
+# See OaiPmh::Metadata for details.
+# 
+# == Examples
+#
+# === Sub classing a provider
+#
+#  class MyProvider < OaiPmh::Provider
+#    name 'My little OAI provider'
+#    url 'http://localhost/provider'
+#    prefix 'oai:localhost'
+#    email 'root@localhost'             # String or Array
+#    deletes 'no'                       # future versions will support deletes
+#    granularity 'YYYY-MM-DDThh:mm:ssZ' # update resolution
+#    model MyModel                      # Class to get data from
+#  end
+#
+# # Now use it
+#
+#  provider = MyProvider.new
+#  provider.identify
+#  provider.list_sets
+#  provider.list_metadata_formats
+# # these verbs require a working model
+#  provider.list_identifiers
+#  provider.list_records
+#  provider.get_record('oai:localhost/1')
+#
+#
+# === Configuring the default provider
+#
+#  class OaiPmh::Provider
+#    name 'My little OAI Provider'
+#    url 'http://localhost/provider'
+#    prefix 'oai:localhost'
+#    email 'root@localhost'             # String or Array
+#    deletes 'no'                       # future versions will support deletes
+#    granularity 'YYYY-MM-DDThh:mm:ssZ' # update resolution
+#    model MyModel                      # Class to get data from
+#  end
+#
+#

data/Rakefile

@@ -10,9 +10,9 @@ require 'fileutils'
 include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'oaipmh', 'version')
 
-AUTHOR = "will"
-EMAIL = "your contact email for bug fixes and info"
-DESCRIPTION = "description of gem"
+AUTHOR = "Will Groppe"
+EMAIL = "will.groppe@gmail.com"
+DESCRIPTION = "OAI-PMH Provider"
 RUBYFORGE_PROJECT = "oaipmh"
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 BIN_FILES = %w(  )
@@ -57,8 +57,10 @@ spec =
         s.require_path = "lib"
         s.autorequire = "oaipmh"
 
-        #s.add_dependency('activesupport', '>=1.3.1')
-        #s.required_ruby_version = '>= 1.8.2'
+        s.add_dependency('activesupport', '>=1.3.1')
+        s.add_dependency('chronic', '>=0.1.4')
+        s.add_dependency('builder', '>=2.0.0')
+        s.required_ruby_version = '>= 1.8.2'
 
         s.files = %w(README CHANGELOG Rakefile) +
           Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 

data/lib/oaipmh.rb

@@ -1,9 +1,8 @@
-# Copyright (C) 2006 William Groppe
-#
-# Will Groppe mailto:wfg@artstor.org
-#
-#
+require 'rubygems'
+require 'active_support'
+require 'builder'
+require 'chronic'
 
-Dir[File.join(File.dirname(__FILE__), 'oaipmh/**/*.rb')].sort.each do |lib|
+Dir[File.join(File.dirname(__FILE__), 'oaipmh/*.rb')].sort.each do |lib|
   require lib
 end

data/lib/oaipmh/constants.rb

@@ -1,5 +1,7 @@
 module OaiPmh
 
+  METADATA = {}
+
   module Const
   
     # OAI defines six verbs with various allowable options.

data/lib/oaipmh/extensions/camping.rb

@@ -1,11 +1,11 @@
 require 'oaipmh'
 
 module OaiPmh
-  module Extensions
-    module Camped
+  module Goes
+    module Camping
   
       def self.included(mod)
-        instance_eval(%{module #{mod}::Controllers
+        instance_eval(%{module ::#{mod}::Controllers
           class Oai
             def get
               @headers['Content-Type'] = 'text/xml'

data/lib/oaipmh/metadata.rb

@@ -1,7 +1,5 @@
 require 'oaipmh/metadata/oai_dc'
 module OaiPmh
-
-  METADATA = {}
     
   def OaiPmh.register_metadata_class(metadata_class)
     METADATA[metadata_class.to_s] = metadata_class

data/lib/oaipmh/provider.rb

@@ -132,28 +132,31 @@ module OaiPmh
   class Provider
     include Helpers
     
-    @@options = {}
-    
     AVAILABLE_FORMATS = {}
 
     class << self
-       
-      OaiPmh::Const::DEFAULTS.keys.each do |field|
-         class_eval %{
-           def #{field}(value)
-             @@options[:#{field}] = value
-           end
-         }
-      end
-      
+      attr_accessor :options
+
       def model(value)
-        @@options[:model] = value
+        self.options ||={}
+        self.options[:model] = value
       end
-      
+
     end
     
+    OaiPmh::Const::DEFAULTS.keys.each do |field|
+       class_eval %{
+         def self.#{field}(value)
+           self.options ||={}
+           self.options[:#{field}] = value
+         end
+       }
+    end
+
     def initialize
-      @config = OaiPmh::Const::DEFAULTS.merge(@@options)
+      @config = self.class.options ? 
+        OaiPmh::Const::DEFAULTS.merge(self.class.options) :
+        OaiPmh::Const::DEFAULTS
     end
     
     def identify
@@ -235,12 +238,13 @@ module OaiPmh
     end
     
     def list_sets_response
-      raise SetException.new unless sets
+      raise SetException.new unless @model && @model.oai_sets
       @xml.ListSets do |ls|
-        oai_sets.each do |ms|
+        @model.oai_sets.each do |ms|
           @xml.set do |set|
             @xml.setSpec ms.spec
             @xml.setName ms.name
+            @xml.setDescription(ms.description) if ms.respond_to?(:description)
           end
         end
       end
@@ -250,19 +254,19 @@ module OaiPmh
       @xml.ListMetadataFormats do 
         @config[:formats].each_pair do |key, format|
           @xml.metadataFormat do 
-            @xml.metadataPrefix instance_eval("#{format}.prefix")
-            @xml.schema instance_eval("#{format}.schema")
-            @xml.metadataNamespace instance_eval("#{format}.namespace")
+            @xml.metadataPrefix format.send(:prefix)
+            @xml.schema format.send(:schema)
+            @xml.metadataNamespace format.send(:namespace)
           end
         end
       end
     end
     
     def list_identifiers_response
-      raise FORMAT_ERROR unless @config[:formats].include? @format
+      raise FormatException.new unless @config[:formats].include? @format
         records = find :all
 
-      raise RECORDS_ERROR if records.nil? || records.empty?
+      raise NoMatchException.new if records.nil? || records.empty?
 
       @xml.ListIdentifiers do
         records.each do |record|
@@ -350,10 +354,12 @@ module OaiPmh
       
     # emit record header
     def metadata_header(record)
-      @xml.header do |h|
-        h.identifier "#{@config[:prefix]}/#{record.id}"
-        h.datestamp record.updated_at.utc.xmlschema
-        h.set @opts[:set] if @opts[:set]
+      @xml.header do 
+        @xml.identifier "#{@config[:prefix]}/#{record.id}"
+        @xml.datestamp record.updated_at.utc.xmlschema
+        record.sets.each do |set|
+          @xml.setSpec set.spec
+        end if record.respond_to?(:sets)
       end
     end
 
@@ -369,8 +375,8 @@ module OaiPmh
           @xml << str
         end
       else
-        map = record.respond_to?("map_#{@format}") ? 
-          instance_eval("record.map_#{@format}") : {}
+        map = @model.respond_to?("map_#{@format}") ? 
+          @model.send("map_#{@format}") : {}
 
         mdformat = @config[:formats][@format]
         @xml.metadata do
@@ -378,7 +384,7 @@ module OaiPmh
             mdformat.fields.each do |field|
               set = value_for(field, record, map)
               set.each do |mdv|
-                instance_eval("@xml.#{mdformat.element_ns} :#{field}, %{#{mdv}}")
+                @xml.tag! "#{mdformat.element_ns}:#{field}", mdv
               end
             end
           end
@@ -397,17 +403,20 @@ module OaiPmh
     # 4) Try calling the singular name method on the model, if it's not a 
     #    reserved word. 
     def value_for(field, record, map)
-      if map.keys.include?(field)
-          return map[field].nil? ? [] : 
-          record.send("#{map[field]}").to_a
+      if map.keys.include?(field.intern)
+          value = record.send(map[field.intern])
+          if value.kind_of?(String)
+            return [value]
+          end
+          return value.to_a 
       end
     
       begin
-        return record.send("#{field.pluralize}").to_a
-      rescue
+        return record.send(field.pluralize).to_a
+      rescue 
         unless OaiPmh::Const::RESERVED_WORDS.include?(field)
           begin
-            return record.send("#{field}").to_a
+            return [record.send(field)]
           rescue
             return []
           end

data/lib/oaipmh/set.rb

@@ -0,0 +1,30 @@
+# = set.rb
+#
+# Copyright (C) 2006 William Groppe
+#
+# Will Groppe mailto: wfg@artstor.org
+#
+#
+# Implementing a set from scratch requires overridding two methods from
+# OaiPmh::Set
+#
+# * name - descriptive name of this set
+# * spec - short name of set
+#
+# and optionally
+#
+# * description - long description of the set
+#
+module OaiPmh
+  class Set
+    
+    def name
+      "unknown"
+    end
+    
+    def spec
+      "set"
+    end
+        
+  end
+end

data/lib/oaipmh/version.rb

@@ -2,7 +2,7 @@ module Oaipmh #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/oaipmh_test.rb

@@ -1,11 +1,81 @@
+require 'rexml/document'
 require File.dirname(__FILE__) + '/test_helper.rb'
 
+class MappedProvider < OaiPmh::Provider
+  name 'Mapped Provider'
+  prefix 'oai:test'
+  model MappedModel
+end
+
+class SimpleProvider < OaiPmh::Provider
+  name 'Test Provider'
+  prefix 'oai:test'
+  model SimpleModel
+end
+
 class OaipmhTest < Test::Unit::TestCase
 
   def setup
+    @simple_provider = SimpleProvider.new
+    @mapped_provider = MappedProvider.new
+  end
+  
+  def test_indentify
+    doc = REXML::Document.new(@simple_provider.identify)
+    assert doc.elements["/OAI-PMH/Identify/repositoryName"].text == 'Test Provider'
+    assert doc.elements["/OAI-PMH/Identify/earliestDatestamp"].text == SimpleModel.oai_earliest.to_s
+  end
+
+  def test_list_sets
+    doc = REXML::Document.new(@simple_provider.list_sets)
+    sets = doc.elements["/OAI-PMH/ListSets"]
+    assert sets.size == 2
+    assert sets[0].elements["//setName"].text == "Test Set"
+  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 doc.elements['/OAI-PMH/ListMetadataFormats/metadataFormat/metadataPrefix'].text == 'oai_dc'
   end
   
-  def test_truth
-    assert true
+  def test_list_records
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_records) }
+    doc = REXML::Document.new(@simple_provider.list_records)
+    assert_equal 5, doc.elements['OAI-PMH/ListRecords'].to_a.size
+    doc = REXML::Document.new(@simple_provider.list_records(:set => 'A'))
+    assert_equal 5, doc.elements['OAI-PMH/ListRecords'].to_a.size
+    doc = REXML::Document.new(@simple_provider.list_records(:set => 'A:B'))
+    assert_equal 2, doc.elements['OAI-PMH/ListRecords'].to_a.size
   end
+
+  def test_list_identifiers
+    assert_nothing_raised { REXML::Document.new(@simple_provider.list_identifiers) }
+    doc = REXML::Document.new(@simple_provider.list_identifiers)
+    assert_equal 5, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+    doc = REXML::Document.new(@simple_provider.list_identifiers(:set => 'A'))
+    assert_equal 5, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+    doc = REXML::Document.new(@simple_provider.list_identifiers(:set => 'A:B'))
+    assert_equal 2, doc.elements['OAI-PMH/ListIdentifiers'].to_a.size
+  end
+
+  def test_get_record
+    assert_nothing_raised { REXML::Document.new(@simple_provider.get_record('oai:test/1')) }
+    doc = REXML::Document.new(@simple_provider.get_record('oai:test/1'))
+    assert_equal 'oai:test/1', doc.elements['OAI-PMH/GetRecord/record/header/identifier'].text
+  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 1", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:creator'].text
+    assert_equal "creator", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:title'].text
+    assert_equal "tag 1", doc.elements['OAI-PMH/ListRecords/record/metadata/oai_dc:dc/dc:subject'].text
+  end
+  
+  def test_verb_exception
+    doc = REXML::Document.new(@simple_provider.process_verb('NoVerb'))
+    assert doc.elements["/OAI-PMH/error"].attributes["code"] == 'badVerb'
+  end
+  
 end

data/test/test_helper.rb

@@ -1,2 +1,106 @@
 require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/oaipmh'
+
+class Record
+  attr_accessor :id, :titles, :creator, :tags, :sets, :updated_at
+  
+  def initialize(id, titles, creator, tags, sets)
+    @id = id;
+    @titles = titles
+    @creator = creator
+    @tags = tags
+    @sets = sets
+    @updated_at = Time.new.utc
+  end
+  
+  # Override Object.id
+  def id
+    @id
+  end
+  
+  def in_set(spec)
+    @sets.each { |set| return true if set.spec == spec }
+    false
+  end
+  
+end
+
+class OneSet < OaiPmh::Set
+  
+  def name
+    "Test Set"
+  end
+  
+  def spec
+    "A"
+  end
+  
+  def description
+    "A long winded description of this set."
+  end
+  
+end
+
+class TwoSet < OaiPmh::Set
+  
+  def name
+    "Not so test Set"
+  end
+  
+  def spec
+    "A:B"
+  end
+  
+  def description
+    "A short winded description of this set."
+  end
+  
+end
+
+
+
+
+class SimpleModel
+  include OaiPmh::Model
+  
+  RECORDS = [
+    Record.new(1, ['title 1', 'title 2'], 'creator', ['tag 1', 'tag 2'], [OneSet.new]),
+    Record.new(2, ['title 3', 'title 4'], 'creator', ['tag 3', 'tag 4'], [OneSet.new]),
+    Record.new(3, ['title 5', 'title 6'], 'creator', ['tag 5', 'tag 6'], [OneSet.new]),
+    Record.new(4, ['title 7', 'title 8'], 'creator', ['tag 9', 'tag 8'], [OneSet.new, TwoSet.new]),
+    Record.new(5, ['title 9', 'title 10'], 'creator', ['tag 9', 'tag 10'], [OneSet.new, TwoSet.new]),
+    ]
+    
+  class << self
+    def oai_earliest
+      Time.parse("2006-10-31T00:00:00Z")
+    end
+    
+    def oai_sets
+      [OneSet.new, TwoSet.new]
+    end
+    
+    def oai_find(selector, opts = {})
+      if selector == :all
+        if opts[:set]
+          return RECORDS.select { |rec| rec.in_set(opts[:set]) }
+        else
+          return RECORDS
+        end
+      else
+        RECORDS.each do |record|
+          return record if record.id.to_s == selector
+        end
+      end
+    end
+  end
+end
+
+class MappedModel < SimpleModel
+
+  def self.map_oai_dc
+    {:title => :creator, :creator => :titles, :subject => :tags}
+  end
+
+end
+

metadata

@@ -3,31 +3,31 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: oaipmh
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-11-02 00:00:00 -05:00
-summary: description of gem
+  version: 0.0.2
+date: 2006-11-07 00:00:00 -05:00
+summary: OAI-PMH Provider
 require_paths: 
 - lib
-email: your contact email for bug fixes and info
+email: will.groppe@gmail.com
 homepage: http://oaipmh.rubyforge.org
 rubyforge_project: oaipmh
-description: description of gem
+description: OAI-PMH Provider
 autorequire: oaipmh
 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: 1.8.2
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 post_install_message: 
 authors: 
-- will
+- Will Groppe
 files: 
 - README
 - CHANGELOG
@@ -44,6 +44,7 @@ files:
 - lib/oaipmh/metadata.rb
 - lib/oaipmh/model.rb
 - lib/oaipmh/provider.rb
+- lib/oaipmh/set.rb
 - lib/oaipmh/version.rb
 - lib/oaipmh/extensions/camping.rb
 - lib/oaipmh/metadata/oai_dc.rb
@@ -70,5 +71,31 @@ 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.1.4
+    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: