oaipmh 0.0.1

data/README

@@ -0,0 +1,3 @@
+README for oaipmh
+=================
+

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+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"
+RUBYFORGE_PROJECT = "oaipmh"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES = %w(  )
+
+
+NAME = "oaipmh"
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (Oaipmh::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "oaipmh documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+desc "Packages up oaipmh gem."
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") { |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+}
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = NAME
+        s.version = VERS
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "CHANGELOG"]
+        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+        s.summary = DESCRIPTION
+        s.description = DESCRIPTION
+        s.author = AUTHOR
+        s.email = EMAIL
+        s.homepage = HOMEPATH
+        s.executables = BIN_FILES
+        s.rubyforge_project = RUBYFORGE_PROJECT
+        s.bindir = "bin"
+        s.require_path = "lib"
+        s.autorequire = "oaipmh"
+
+        #s.add_dependency('activesupport', '>=1.3.1')
+        #s.required_ruby_version = '>= 1.8.2'
+
+        s.files = %w(README CHANGELOG Rakefile) +
+          Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+          Dir.glob("ext/**/*.{h,c,rb}") +
+          Dir.glob("examples/**/*.rb") +
+          Dir.glob("tools/*.rb")
+        
+        # s.extensions = FileList["ext/**/extconf.rb"].to_a
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+    p.gem_spec = spec
+end
+
+task :install do
+  name = "#{NAME}-#{VERS}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

data/lib/oaipmh.rb

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

data/lib/oaipmh/constants.rb

@@ -0,0 +1,31 @@
+module OaiPmh
+
+  module Const
+  
+    # OAI defines six verbs with various allowable options.
+    VERBS = {
+      'Identify' => [],
+      'ListMetadataFormats' => [],
+      'ListSets' => [:token],
+      'GetRecord' => [:id, :from, :until, :set, :prefix, :token],
+      'ListIdentifiers' => [:from, :until, :set, :prefix, :token],
+      'ListRecords' => [:from, :until, :set, :prefix, :token]
+      }.freeze
+      
+    # Common to many data source, and sadly also a method on object.
+    RESERVED_WORDS = %{type}.freeze
+    
+    # Default configuration of a repository
+    DEFAULTS = {  
+      :name => 'Open Archives Initiative Data Provider',
+      :url => 'unknown',
+      :prefix => 'oai:localhost',
+      :email => 'nobody@localhost',
+      :deletes => 'no',
+      :granularity => 'YYYY-MM-DDThh:mm:ssZ',
+      :formats => OaiPmh::METADATA
+    }.freeze
+
+  end
+  
+end

data/lib/oaipmh/exceptions.rb

@@ -0,0 +1,72 @@
+module OaiPmh
+
+  # Standard error responses for problems serving OAI content.  These
+  # messages will be wrapped in an XML response to the client.
+
+  class OAIException < RuntimeError
+    attr_reader :code
+
+    def initialize(code, message)
+      super(message)
+      @code = code
+    end
+  end
+
+  class ArgumentException < OAIException
+    def initialize()
+      super('badArgument', 'The request includes ' \
+      'illegal arguments, is missing required arguments, includes a ' \
+      'repeated argument, or values for arguments have an illegal syntax.')
+    end
+  end
+
+  class VerbException < OAIException
+    def initialize()
+      super('badVerb', 'Value of the verb argument is not a legal OAI-PMH '\
+      'verb, the verb argument is missing, or the verb argument is repeated.')
+    end
+  end
+
+  class FormatException < OAIException
+    def initialize()
+      super('cannotDisseminateFormat', 'The metadata format identified by '\
+        'the value given for the metadataPrefix argument is not supported '\
+        'by the item or by the repository.')
+    end
+  end
+
+  class IdException < OAIException
+    def initialize()
+      super('idDoesNotExist', 'The value of the identifier argument is '\
+        'unknown or illegal in this repository.')
+    end
+  end
+
+  class NoMatchException < OAIException
+    def initialize()
+      super('noRecordsMatch', 'The combination of the values of the from, '\
+      'until, set and metadataPrefix arguments results in an empty list.')
+    end
+  end
+
+  class MetadataFormatException
+    def initialize()
+      super('noMetadataFormats', 'There are no metadata formats available '\
+        'for the specified item.')
+    end
+  end
+
+  class SetException < OAIException
+    def initialize()
+      super('noSetHierarchy', 'This repository does not support sets.')
+    end
+  end
+
+  class ResumptionTokenException < OAIException
+    def initialize()
+      super('badResumptionToken', 'The value of the resumptionToken argument '\
+      'is invalid or expired.')
+    end
+  end
+
+end

data/lib/oaipmh/extensions/camping.rb

@@ -0,0 +1,22 @@
+require 'oaipmh'
+
+module OaiPmh
+  module Extensions
+    module Camped
+  
+      def self.included(mod)
+        instance_eval(%{module #{mod}::Controllers
+          class Oai
+            def get
+              @headers['Content-Type'] = 'text/xml'
+              provider = OaiPmh::Provider.new
+              provider.process_verb(@input.delete('verb'), @input.merge(:url => "http:"+URL(Oai).to_s))
+            end
+          end
+        end
+        })
+      end
+      
+    end
+  end
+end

data/lib/oaipmh/helpers.rb

@@ -0,0 +1,60 @@
+module OaiPmh
+  module Helpers
+    
+    # Output the OAI-PMH header
+    def header
+      @xml = Builder::XmlMarkup.new
+      @xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      @xml.tag!('OAI-PMH',
+        'xmlns' => "http://www.openarchives.org/OAI/2.0/",
+        'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+        'xsi:schemaLocation' => %{http://www.openarchives.org/OAI/2.0/
+          http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd}) do 
+        @xml.responseDate Time.now.utc.xmlschema
+        yield
+      end
+    end
+
+    # Echo the request parameters back to the client. See spec.
+    def echo_params(verb, opts)
+      @xml.request(@url, {:verb => verb}.merge(opts))
+    end
+  
+    def build_scope_hash
+      params = {}
+      params[:from] = parse_date(@opts[:from]) if @opts[:from]
+      params[:until] = parse_date(@opts[:until]) if @opts[:until]
+      params[:set] = @opts[:set] if @opts[:set]
+      params
+    end
+
+    # Use of Chronic here is mostly for human interactions.  It's
+    # nice to be able to say '?verb=ListRecords&from=October&until=November'
+    def parse_date(dt_string)
+      # Oddly Chronic doesn't parse an UTC encoded datetime.  
+      # Luckily Time does
+      dt = Chronic.parse(dt_string) || Time.parse(dt_string)
+      dt.strftime("%Y-%m-%d %H:%M:%S")
+    end
+  
+    # Massage the options until they are bit more palatable.
+    def ensure_valid(verb, opts)
+      return {} unless opts
+      popts = {}
+      opts.keys.each do |k|
+        # Ensure they are all lowercase symbols
+        nk = k.to_s.downcase.intern
+        popts[nk] = opts[k]
+      end
+      # shorten the big ugly long ones
+      popts[:id] = popts.delete(:identifier) if popts[:identifier]
+      popts[:prefix] = popts.delete(:metadataprefix) if popts[:metadataprefix]
+      popts[:token] = popts.delete(:resumptiontoken) if popts[:resumptiontoken]
+
+      raise ArgumentException.new unless popts.empty? || 
+        (popts.keys - OaiPmh::Const::VERBS[verb]).empty?
+        popts
+    end
+  
+  end
+end

data/lib/oaipmh/metadata.rb

@@ -0,0 +1,14 @@
+require 'oaipmh/metadata/oai_dc'
+module OaiPmh
+
+  METADATA = {}
+    
+  def OaiPmh.register_metadata_class(metadata_class)
+    METADATA[metadata_class.to_s] = metadata_class
+  end
+  
+  OaiPmh.register_metadata_class(Metadata::OaiDc)
+
+end
+
+

data/lib/oaipmh/metadata/oai_dc.rb

@@ -0,0 +1,84 @@
+# = OaiPmh::Metadata::OaiDc
+#
+# Copyright (C) 2006 William Groppe
+#
+# Will Groppe mailto:wfg@artstor.org
+#
+# Only one form of metadata is supported out of the box.  Dublin Core is the 
+# most basic form of metadata, and the one recommended for support in all
+# OAI-PMH repositories.
+#
+# To add additional metadata types it's easiest just to subclass 
+# OaiPmh::Metadata::OaiDc.  Subclasses should override header(xml) to ouput a 
+# valid metadata header.  They should also set defaults for prefix, schema,
+# namespace, element_ns, and fields.
+#
+# === Example
+#  class CdwaLite < OaiPmh::Metadata::OaiDc
+#    prefix = 'cdwalite'
+#    schema = 'http://www.getty.edu/CDWA/CDWALite/CDWALite-xsd-draft-009c2.xsd'
+#    namespace = 'http://www.getty.edu/CDWA/CDWALite'
+#    element_ns = 'cdwalite'
+#    fields = [] # using to_cdwalite in model
+#
+#    def self.header(xml)
+#      xml.tag!('cdwalite:cdwalite',
+#       'xmlns:cdwalite' => "http://www.getty.edu/CDWA/CDWALite",
+#       'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+#       'xsi:schemaLocation' => 
+#         %{http://www.getty.edu/CDWA/CDWALite 
+#           http://www.getty.edu/CDWA/CDWALite/CDWALite-xsd-draft-009c2.xsd}) do
+#         yield xml
+#      end
+#    end
+#  end
+#
+#  # Now register the new metadata class
+#  OaiPmh.register_metadata_class(CdwaLite)
+#
+module OaiPmh::Metadata
+
+  class OaiDc
+    # Defaults
+    DEFAULTS = {:prefix => 'oai_dc',
+                :schema => 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd',
+                :namespace =>  'http://www.language-archives.org/OLAC/0.2/',
+                :element_ns => 'dc',
+                :fields => %w(title creator subject description publisher
+                              contributor date type format identifier
+                              source language relation coverage rights)
+               }
+    
+    # Create accessors.
+    DEFAULTS.each_key do |proc|
+      class_eval %{ def self.#{proc}; DEFAULTS[:#{proc}]; end }
+      class_eval %{ def self.#{proc}=(value); DEFAULTS[:#{proc}]=value; end }
+    end
+        
+    
+    class << self
+      def header(xml)
+        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
+          yield xml
+        end
+      end
+      
+      def to_s
+        DEFAULTS[:prefix]
+      end
+      
+      def validate(document)
+        raise RuntimeError, "Validation not yet implemented."
+      end
+    end
+
+  end
+
+  
+end

data/lib/oaipmh/model.rb

@@ -0,0 +1,34 @@
+# = model.rb
+#
+# Copyright (C) 2006 William Groppe
+#
+# Will Groppe mailto: wfg@artstor.org
+#
+#
+# Implementing a model from scratch requires overridding three methods from
+# OaiPmh::Model
+#
+# * oai_earliest - should provide the earliest possible timestamp
+# * oai_sets - if you want to support sets
+# * oai_find(selector, opts) - selector can be either a record id, or :all for
+# finding all matches.  opts is a hash of query parameters.  Valid parameters
+# include :from, :until, :set, :token, and :prefix.  Any errors in the
+# parameters should raise a OaiPmh::ArgumentException.
+#
+module OaiPmh
+  module Model
+    
+    def self.oai_earliest
+      Time.now.utc
+    end
+    
+    def self.oai_sets
+      nil
+    end
+    
+    def self.oai_find(selector, opts={})
+      []
+    end
+    
+  end
+end

data/lib/oaipmh/provider.rb

@@ -0,0 +1,421 @@
+# = provider.rb
+#
+# 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
+#
+# 
+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
+      
+      def model(value)
+        @@options[:model] = value
+      end
+      
+    end
+    
+    def initialize
+      @config = OaiPmh::Const::DEFAULTS.merge(@@options)
+    end
+    
+    def identify
+      process_verb 'Identify'
+    end
+
+    def list_metadata_formats
+      process_verb 'ListMetadataFormats'
+    end
+    
+    def list_sets(opts = {})
+      process_verb 'ListSets', opts
+    end
+    
+    def get_record(id, opts = {})
+      process_verb 'GetRecord', opts.merge(:id => id)
+    end
+    
+    def list_identifiers(opts = {})
+      process_verb 'ListIdentifiers', opts
+    end
+
+    def list_records(opts = {})
+      process_verb 'ListRecords', opts
+    end
+    
+    # xml_response = process_verb('ListRecords', :from => 'October', :until => 'November') # thanks Chronic!
+    #
+    # If you are implementing a web interface using process_verb is the
+    # preferred way.  See extensions/camping.rb
+    def process_verb(verb = nil, opts = {})
+      header do
+        begin
+          raise VerbException.new unless verb && 
+            OaiPmh::Const::VERBS.keys.include?(verb)
+
+          # Allow the request to pass in a 
+          @url = opts['url'] ? opts.delete('url') : @config[:url]
+          
+          echo_params(verb, opts)
+          
+          @opts = ensure_valid(verb, opts)
+          
+          @model = @config[:model]
+    
+          # Pull out the requested metadata format.  Important for GetRecord, 
+          # ListRecords, ListIdentifiers?  Default to 'oai_dc'
+          @format = @opts[:prefix] ? @opts[:prefix] : "oai_dc"
+
+          # Rubify the verb for calling method
+          call = verb.gsub(/[A-Z]/) {|m| "_#{m.downcase}"}.sub(/^\_/,'')
+          send("#{call}_response")
+          
+        rescue
+          if $!.respond_to?(:code)
+            @xml.error $!.to_s, :code => $!.code
+          else
+            puts $!.message
+            puts $!.backtrace.join("\n")
+          end
+        end
+      end
+    end
+    
+    private
+    
+    def identify_response
+      @xml.Identify do
+        @xml.repositoryName @config[:name]
+        @xml.baseURL @url
+        @xml.protocolVersion 2.0
+        @config[:email].to_a.each do |email|
+          @xml.adminEmail email
+        end
+        @xml.earliestDatestamp earliest
+        @xml.deleteRecord @config[:delete]
+        @xml.granularity @config[:granularity]
+      end
+    end
+    
+    def list_sets_response
+      raise SetException.new unless sets
+      @xml.ListSets do |ls|
+        oai_sets.each do |ms|
+          @xml.set do |set|
+            @xml.setSpec ms.spec
+            @xml.setName ms.name
+          end
+        end
+      end
+    end
+    
+    def list_metadata_formats_response
+      @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")
+          end
+        end
+      end
+    end
+    
+    def list_identifiers_response
+      raise FORMAT_ERROR unless @config[:formats].include? @format
+        records = find :all
+
+      raise RECORDS_ERROR if records.nil? || records.empty?
+
+      @xml.ListIdentifiers do
+        records.each do |record|
+          metadata_header record
+        end
+      end
+    end
+    
+    def get_record_response
+      raise FormatException.new unless @config[:formats].include? @format
+      
+      rec = @opts[:id].gsub("#{@config[:prefix]}/", "")
+
+      record = find rec
+
+      raise IdException.new unless record
+
+      @xml.GetRecord do
+        @xml.record do 
+          metadata_header record
+          metadata record
+        end
+      end
+    end
+    
+    def list_records_response
+      raise FormatException.new unless @config[:formats].include? @format
+
+      records = find :all
+
+      raise NoMatchException.new if records.nil? || records.empty?
+
+      @xml.ListRecords do
+        records.each do |record|
+          @xml.record do 
+            metadata_header record
+            metadata record
+          end
+        end  
+      end  
+    end
+    
+    def find(selector)
+      return nil unless @model
+      
+      # Try oai finder methods first
+      begin
+        return @model.oai_find(selector, @opts)
+      rescue NoMethodError
+        begin
+          # Try an ActiveRecord finder call
+          return @model.find(selector, build_scope_hash)
+        rescue 
+        end
+      end
+      nil
+    end
+    
+    def earliest
+      return DateTime.new unless @model
+      
+      # Try oai finder methods first
+      begin
+        return @model.oai_earliest
+      rescue NoMethodError
+        begin
+          # Try an ActiveRecord finder call
+          return @model.find(:first, :order => "updated_at asc").updated_at
+        rescue 
+        end
+      end
+      nil
+    end
+
+    def sets
+      return nil unless @model
+      
+      # Try oai finder methods first
+      begin
+        return @model.oai_sets
+      rescue NoMethodError
+      end
+      nil
+    end
+      
+    # 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]
+      end
+    end
+
+
+    # metadata - core routine for delivering metadata records
+    #
+    def metadata(record)
+      if record.respond_to?("to_#{@format}")
+        @xml.metadata do
+          str = record.send("to_#{@format}")
+          # Strip off the xml header if we got one.
+          str.sub!(/<\?xml.*?\?>/, '')
+          @xml << str
+        end
+      else
+        map = record.respond_to?("map_#{@format}") ? 
+          instance_eval("record.map_#{@format}") : {}
+
+        mdformat = @config[:formats][@format]
+        @xml.metadata do
+          mdformat.header(@xml) do 
+            mdformat.fields.each do |field|
+              set = value_for(field, record, map)
+              set.each do |mdv|
+                instance_eval("@xml.#{mdformat.element_ns} :#{field}, %{#{mdv}}")
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # We try a bunch of different methods to get the data from the model.
+    #
+    # 1) See if the model will hand us the entire record in the requested
+    #    format.  Example:  if the model defines 'to_oai_dc' we call that
+    #    method and append the result to the xml stream.
+    # 2) Check if the model defines a field mapping for the field of 
+    #    interest.
+    # 3) Try calling the pluralized name method on the model.
+    # 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
+      end
+    
+      begin
+        return record.send("#{field.pluralize}").to_a
+      rescue
+        unless OaiPmh::Const::RESERVED_WORDS.include?(field)
+          begin
+            return record.send("#{field}").to_a
+          rescue
+            return []
+          end
+        end
+      end
+      []
+    end
+    
+  end
+  
+end

data/lib/oaipmh/version.rb

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

data/test/oaipmh_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class OaipmhTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/oaipmh'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+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
+require_paths: 
+- lib
+email: your contact email for bug fixes and info
+homepage: http://oaipmh.rubyforge.org
+rubyforge_project: oaipmh
+description: description of gem
+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: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- will
+files: 
+- README
+- CHANGELOG
+- Rakefile
+- test/oaipmh_test.rb
+- test/test_helper.rb
+- lib/oaipmh
+- lib/oaipmh.rb
+- lib/oaipmh/constants.rb
+- lib/oaipmh/exceptions.rb
+- lib/oaipmh/extensions
+- lib/oaipmh/helpers.rb
+- lib/oaipmh/metadata
+- lib/oaipmh/metadata.rb
+- lib/oaipmh/model.rb
+- lib/oaipmh/provider.rb
+- lib/oaipmh/version.rb
+- lib/oaipmh/extensions/camping.rb
+- lib/oaipmh/metadata/oai_dc.rb
+test_files: []
+
+rdoc_options: 
+- --quiet
+- --title
+- oaipmh documentation
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+extra_rdoc_files: 
+- README
+- CHANGELOG
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+