oai 0.2.1 → 0.3.0

data/README.md

@@ -2,15 +2,17 @@ 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 
+library for Ruby. [OAI-PMH](http://openarchives.org) 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 
+using a feed format like [RSS](http://www.rssboard.org/rss-specification) or 
+[Atom](http://www.atomenabled.org/). 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
+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
@@ -25,12 +27,23 @@ 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
+  response = client.list_records
+  # Get the first page of records
+  response.each do |record| 
+    puts record.metadata
+  end
+  # Get the second page of records
+  response = client.list_records(:resumption_token => response.resumption_token)
+  response.each do |record|
+    puts record.metadata
+  end
+  # Get all pages together (may take a *very* long time to complete)
+  client.list_records.full.each do |record|
     puts record.metadata
   end
 ```
 
-See OAI::Client for more details
+See {OAI::Client} for more details
 
 Server
 ------
@@ -47,36 +60,28 @@ The OAI provider library handles serving local content to other clients. Here's
   end
 ```
 
-See OAI::Provider for more details
+See {OAI::Provider} for more details
 
 Interactive Harvester
 ---------------------
 
-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.
+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
+See {OAI::Harvester::Shell} for more details
 
 Installation
 ------------
 
-Normally the best way to install oai is from rubyforge using the gem
-command line tool:
+Normally the best way to install oai is as part of your `Gemfile`:
 
-```
-  % gem install oai
-```
-
-If you're reading this you've presumably got the tarball or zip distribution.
-So you'll need to:
+    source :rubygems
+    gem 'oai'
 
-```
-  % rake package
-  % gem install pkg/oai-x.y.z.gem 
-```
+Alternately it can be installed globally using RubyGems:
 
-Where x.y.z is the version of the gem that was generated.
+    $ gem install oai
 
 License
 -------
 
-[Public Domain](http://creativecommons.org/publicdomain/zero/1.0/)
+[![CC0 - Public Domain](http://i.creativecommons.org/p/zero/1.0/88x15.png)](http://creativecommons.org/publicdomain/zero/1.0/)

data/Rakefile

@@ -10,11 +10,11 @@ end
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
-require 'rdoc/task'
+require 'yard'
 
-task :default => ["test"]
+task :default => ["test", "yard"]
 
-task :test => ["test:client", "test:provider"]
+task :test => ["test:client", "test:provider", "test:activerecord_provider"]
 
 namespace :test do
   Rake::TestTask.new('client') do |t|
@@ -44,10 +44,12 @@ namespace :test do
     if RUBY_VERSION =~ /^1.8/
       Rake::Task['rcov:client'].invoke
       Rake::Task['rcov:provider'].invoke
+      Rake::Task['rcov:activerecord_provider'].invoke
     else
       ENV['COVERAGE'] = 'true'
       Rake::Task['test:client'].invoke
       Rake::Task['test:provider'].invoke
+      Rake::Task['test:activerecord_provider'].invoke
     end
 
     system("open coverage/index.html") if (PLATFORM['darwin'] if Kernel.const_defined? :PLATFORM) || (RUBY_PLATFORM =~ /darwin/ if Kernel.const_defined? :RUBY_PLATFORM)
@@ -72,45 +74,17 @@ if RUBY_VERSION =~ /^1.8/
       t.verbose = true
       t.rcov_opts = ['--aggregate coverage.data', '--text-summary']
     end
-  end
-end
 
-task 'test:activerecord_provider' => :create_database
-
-task :environment do 
-  unless defined? OAI_PATH
-    OAI_PATH = File.dirname(__FILE__) + '/lib/oai'
-    $LOAD_PATH << OAI_PATH
-    $LOAD_PATH << File.dirname(__FILE__) + '/test'
-  end
-end
-
-task :drop_database => :environment do
-  %w{rubygems active_record yaml}.each { |lib| require lib }
-  require 'activerecord_provider/database/ar_migration'
-  require 'activerecord_provider/config/connection'
-  begin
-    OAIPMHTables.down
-  rescue
+    Rcov::RcovTask.new('activerecord_provider') do |t|
+      t.libs << ['lib', 'test/activerecord_provider']
+      t.pattern = 'test/activerecord_provider/tc_*.rb'
+      t.verbose = true
+      t.rcov_opts = ['--aggregate coverage.data', '--text-summary']
+    end
   end
 end
 
-task :create_database => :drop_database do
-  OAIPMHTables.up
-end
-
-task :load_fixtures => :create_database do
-  require 'test/activerecord_provider/models/dc_field'
-  fixtures = YAML.load_file(
-    File.join('test', 'activerecord_provider', 'fixtures', 'dc.yml')
-  )
-  fixtures.keys.sort.each do |key|
-    DCField.create(fixtures[key])
-  end
-end
-  
-Rake::RDocTask.new('doc') do |rd|
-  rd.rdoc_files.include("lib/**/*.rb", "README.md")
-  rd.main = 'README.md'
-  rd.rdoc_dir = 'doc'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb"]
+  t.options = ['--output-dir', 'doc']
 end

data/examples/providers/dublin_core.rb

@@ -4,7 +4,7 @@ require 'camping/session'
 require 'oai/provider'
 
 # Extremely simple demo Camping application to illustrate OAI Provider integration
-# with Camping. 
+# with Camping.
 #
 # William Groppe 2/1/2007
 #
@@ -13,9 +13,9 @@ Camping.goes :DublinCore
 
 module DublinCore
   include Camping::Session
-  
-  FIELDS = ['title', 'creator', 'subject', 'description', 
-    'publisher', 'contributor', 'date', 'type', 'format', 
+
+  FIELDS = ['title', 'creator', 'subject', 'description',
+    'publisher', 'contributor', 'date', 'type', 'format',
     'identifier', 'source', 'language', 'relation', 'coverage', 'rights']
 
   def DublinCore.create
@@ -23,7 +23,7 @@ module DublinCore
     DublinCore::Models.create_schema :assume =>
       (DublinCore::Models::Obj.table_exists? ? 1.0 : 0.0)
   end
-  
+
 end
 
 module DublinCore::Models
@@ -32,7 +32,7 @@ module DublinCore::Models
   Base.default_timezone = :utc
 
   class Obj < Base # since Object is reserved
-    has_and_belongs_to_many :fields, :join_table => 'dublincore_field_links', 
+    has_and_belongs_to_many :fields, :join_table => 'dublincore_field_links',
       :foreign_key => 'obj_id', :association_foreign_key => 'field_id'
     DublinCore::FIELDS.each do |field|
       class_eval(%{
@@ -44,68 +44,68 @@ module DublinCore::Models
       });
     end
   end
-  
+
   class Field < Base
-    has_and_belongs_to_many :objs, :join_table => 'dublincore_field_links', 
+    has_and_belongs_to_many :objs, :join_table => 'dublincore_field_links',
       :foreign_key => 'field_id', :association_foreign_key => 'obj_id'
     validates_presence_of :field_type, :message => "can't be blank"
-    
+
     # Support sorting by value
     def <=>(other)
       self.to_s <=> other.to_s
     end
-      
+
     def to_s
       value
     end
   end
-  
+
   DublinCore::FIELDS.each do |field|
     module_eval(%{
       class DC#{field.capitalize} < Field; end
     })
   end
-  
+
   # OAI Provider configuration
   class CampingProvider < OAI::Provider::Base
     repository_name 'Camping Test OAI Repository'
     source_model ActiveRecordWrapper.new(Obj)
   end
-  
+
   class CreateTheBasics < V 1.0
     def self.up
       create_table :dublincore_objs, :force => true do |t|
         t.column  :source, :string
         t.column  :created_at,  :datetime
         t.column  :updated_at,  :datetime
-      end 
-      
+      end
+
       create_table :dublincore_field_links, :id => false, :force => true do |t|
         t.column  :obj_id, :integer, :null => false
         t.column  :field_id,  :integer, :null => false
       end
-      
+
       create_table :dublincore_fields, :force => true do |t|
         t.column  :field_type,  :string,  :limit => 30, :null => false
         t.column  :value,       :text,  :null => false
       end
-      
+
       add_index :dublincore_fields, [:field_type, :value], :uniq => true
       add_index :dublincore_field_links, :field_id
       add_index :dublincore_field_links, [:obj_id, :field_id]
     end
-    
+
     def self.down
       drop_table :dublincore_objs
       drop_table :dublincore_field_links
       drop_table :dublincore_fields
     end
   end
-  
+
 end
 
 module DublinCore::Controllers
-  
+
   # Now setup a URL('/oai' by default) to handle OAI requests
   class Oai
     def get
@@ -114,13 +114,13 @@ module DublinCore::Controllers
       provider.process_request(@input.merge(:url => "http:"+URL(Oai).to_s))
     end
   end
-  
+
   class Index < R '/', '/browse/(\w+)', '/browse/(\w+)/page/(\d+)'
     def get(field = nil, page = 1)
       @field = field
       @page = page.to_i
       @browse = {}
-      if !@field 
+      if !@field
         FIELDS.each do |field|
           @browse[field] = Field.count(
             :conditions => ["field_type = ?", "DC#{field.capitalize}"])
@@ -129,11 +129,11 @@ module DublinCore::Controllers
         @count = @browse.keys.size
       else
         @count = Field.count(:conditions => ["field_type = ?", "DC#{@field.capitalize}"])
-        fields = Field.find(:all, 
+        fields = Field.find(:all,
           :conditions => ["field_type = ?", "DC#{@field.capitalize}"],
-          :order => "value asc", :limit => DublinCore::LIMIT, 
+          :order => "value asc", :limit => DublinCore::LIMIT,
           :offset => (@page - 1) * DublinCore::LIMIT)
-          
+
         fields.each do |field|
           @browse[field] = field.objs.size
         end
@@ -141,14 +141,14 @@ module DublinCore::Controllers
       render :browse
     end
   end
-  
+
   class Search < R '/search', '/search/page/(\d+)'
-    
+
     def get(page = 1)
       @page = page.to_i
       if input.terms
         @state.terms = input.terms if input.terms
-      
+
         start = Time.now
         ids = search(input.terms, @page - 1)
         finish = Time.now
@@ -158,31 +158,31 @@ module DublinCore::Controllers
         @count = 0
         @objs = []
       end
-      
+
       render :search
     end
-    
+
   end
-  
+
   class LinkedTo < R '/linked/(\d+)', '/linked/(\d+)/page/(\d+)'
     def get(field, page = 1)
       @page = page.to_i
       @field = field
       @count = Field.find(field).objs.size
-      @objs = Field.find(field).objs.find(:all, 
-        :limit => DublinCore::LIMIT, 
+      @objs = Field.find(field).objs.find(:all,
+        :limit => DublinCore::LIMIT,
         :offset => (@page - 1) * DublinCore::LIMIT)
       render :records
     end
   end
-  
+
   class Add
     def get
       @obj = Obj.create
       render :edit
     end
   end
-  
+
   class View < R '/view/(\d+)'
     def get obj_id
       obj = Obj.find(obj_id)
@@ -198,13 +198,13 @@ module DublinCore::Controllers
       end
     end
   end
-  
+
   class Edit < R '/edit', '/edit/(\d+)'
     def get obj_id
       @obj = Obj.find obj_id
       render :edit
     end
-    
+
     def post
       case input.action
       when 'Save'
@@ -220,10 +220,10 @@ module DublinCore::Controllers
         redirect View, @obj
       when 'Discard'
         @obj = Obj.find input.obj_id
-        
+
         # Get rid of completely empty records
         @obj.destroy if @obj.fields.empty?
-        
+
         if Obj.exists?(@obj.id)
           redirect View, @obj
         else
@@ -235,7 +235,7 @@ module DublinCore::Controllers
       end
     end
   end
-  
+
   class DataAdd < R '/data/add'
     def post
       if input.field_value && !input.field_value.empty?
@@ -246,7 +246,7 @@ module DublinCore::Controllers
       redirect Edit, input.obj_id
     end
   end
-  
+
   class Style < R '/styles.css'
     def get
       @headers["Content-Type"] = "text/css; charset=utf-8"
@@ -266,7 +266,7 @@ module DublinCore::Controllers
         .totals { font-size: 60%; margin-left: .25em; vertical-align: super; }
         .field_labels { font-size: 60%; margin-left: 1em; vertical-align: super; }
         h2 {color: #CC6600; padding: 0; margin-bottom: .15em; font-size: 160%;}
-        h3.header { padding:0; margin:0; position: relative; top: -2.8em; 
+        h3.header { padding:0; margin:0; position: relative; top: -2.8em;
           padding-bottom: .25em; padding-right: 5em; font-size: 80%; }
         h1.header a { color: #FF9900; text-decoration: none;
           font: bold 250% "Trebuchet MS",Trebuchet,Georgia, Serif;
@@ -294,7 +294,7 @@ module DublinCore::Controllers
 end
 
 module DublinCore::Helpers
-  
+
   def paginate(klass, term = nil)
     @total_pages = count/DublinCore::LIMIT + 1
     div.pagination do
@@ -310,14 +310,14 @@ module DublinCore::Helpers
       end
     end
   end
-  
+
   private
-  
+
   def link_if(string, klass, term, page)
     return "#{string} " if (@page == page || 1 > page || page > @total_pages)
     a(string, :href => term.nil? ? R(klass, page) : R(klass, term, page)) << " "
   end
-  
+
   def page_window
     return 1..@total_pages if @total_pages < 9
     size = @total_pages > 9 ? 9 : @total_pages
@@ -325,11 +325,11 @@ module DublinCore::Helpers
     start = @total_pages - size if start+size > @total_pages
     start..start+size
   end
-  
+
 end
 
 module DublinCore::Views
-  
+
   def layout
     html do
       head do
@@ -353,7 +353,7 @@ module DublinCore::Views
       end
     end
   end
-  
+
   def browse
     if @browse.empty?
       p 'No objects found, try adding one.'
@@ -367,17 +367,17 @@ module DublinCore::Views
       paginate(Index, @field) if @count > DublinCore::LIMIT
     end
   end
-  
+
   def delete_success
     p "Delete was successful"
   end
-    
+
   def search
     p.results { span "#{count} results for '#{@state.terms}'"; span.tiny "(#{@search_time} secs)" }
     ul.undecorated do
       @result.keys.sort.each do |record|
         li do
-          a(record.value, :href => R(LinkedTo, record.id)) 
+          a(record.value, :href => R(LinkedTo, record.id))
           span.totals "(#{@result[record]})"
           span.field_labels "#{record.field_type.sub(/^DC/, '').downcase} "
         end
@@ -385,20 +385,20 @@ module DublinCore::Views
     end
     paginate(Search) if @count > DublinCore::LIMIT
   end
-  
+
   def edit
     h3 "Editing Record"
     p "To remove a field entry, just remove it's content."
     _form(@obj, :action => R(Edit, @obj))
   end
-  
+
   def records
     @objs.each { |obj| _obj(obj) }
     paginate(LinkedTo, @field) if @count > DublinCore::LIMIT
   end
-        
+
   def _obj(obj, edit = false)
-    table.obj :cellspacing => 0 do
+    table.obj(:cellspacing => 0) do
       _edit_controls(obj, edit)
       DublinCore::FIELDS.each do |field|
         obj.send(field.pluralize.intern).each_with_index do |value, index|
@@ -406,8 +406,8 @@ module DublinCore::Views
             td.label { 0 == index ? "#{field}(s)" : "&nbsp;" }
             if edit
               td.value do
-                input :name => value.class, 
-                  :type => 'text', 
+                input :name => value.class,
+                  :type => 'text',
                   :value => value.to_s
               end
             else
@@ -418,7 +418,7 @@ module DublinCore::Views
       end
     end
   end
-  
+
   def _form(obj, action)
     form.controls(:method => 'post', :action => R(Edit)) do
       input :type => 'hidden', :name => 'obj_id', :value => obj.id
@@ -446,7 +446,7 @@ module DublinCore::Views
       end
     end
   end
-  
+
   def _edit_controls(obj, edit)
     tr.controls do
       td :colspan => 2 do
@@ -455,8 +455,8 @@ module DublinCore::Views
       end
     end
   end
-    
-  
+
+
   def _key_value(key, value)
     if value > 0
       if key.kind_of?(DublinCore::Models::Field)
@@ -470,5 +470,5 @@ module DublinCore::Views
       span.totals "(#{value})"
     end
   end
-          
+
 end