oai 0.1.0 → 0.2.0

data/lib/oai/client.rb

@@ -206,8 +206,7 @@ module OAI
       case @parser
       when 'libxml'
         begin
-          parser = XML::Parser.new()
-          parser.string = xml
+          parser = XML::Parser.string()
           return parser.parse
         rescue XML::Parser::ParseError => e
           raise OAI::Exception, 'response not well formed XML: '+e, caller

data/lib/oai/client/record.rb

@@ -10,11 +10,12 @@ module OAI
   
   class Record
     include OAI::XPath
-    attr_accessor :header, :metadata
+    attr_accessor :header, :metadata, :about
 
     def initialize(element)
       @header = OAI::Header.new xpath_first(element, './/header')
       @metadata = xpath_first(element, './/metadata')
+      @about = xpath_first(element, './/about')
     end
 
     # a convenience method which digs into the header status attribute

data/lib/oai/client/response.rb

@@ -2,22 +2,17 @@ module OAI
 
   # An OAI::Response contains entries and a resumption token. If a resumption token is present, 
   # then you must use it to fetch the rest of the entries for your query. For example:
-  #   # List all records
-  #   i = 1
-  #   begin 
-  #     response = client.list_records
-  #     while response.entries.size > 0    
-  #       response.entries.each { |entry|
-  #         puts "<b>#{i}</b> #{entry.header.identifier}<br/>"
-  #         i +=1
-  #       }
-  #       token = response.resumption_token
-  #       response = client.list_records :resumption_token => token if token
-  #     end
-  #   rescue OAI::Exception => e
-  #     puts 'No records to process'
-  #   end
-  #   puts "Done processing #{i} records"
+  #  # List all records in a given set
+  #  client = OAI::Client.new 'http://my-oai-provider.example.com/oai'
+  #  response = client.list_records :set => 'my_set_name'
+  #  while response.entries.count > 0
+  #    response.entries.each { |entry|
+  #      puts entry.header.identifier
+  #    }
+  #    token = response.resumption_token
+  #    # Note: You do not need to pass the options hash again, just the verb and the resumption token
+  #    response = client.list_records :resumption_token => token if token
+  #  end
 
   class Response
     include OAI::XPath

data/lib/oai/harvester.rb

@@ -1,3 +1,4 @@
+require 'time'
 require 'zlib'
 require 'net/smtp'
 require 'yaml'

data/lib/oai/harvester/harvest.rb

@@ -72,7 +72,7 @@ module OAI
         
         file = Tempfile.new('oai_data')
         gz = Zlib::GzipWriter.new(file)
-        gz << "<? xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
+        gz << "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"
         gz << "<records>"
         begin
           response = client.list_records(options)

data/lib/oai/provider.rb

@@ -55,6 +55,7 @@ end
 #    repository_url 'http://localhost/provider'
 #    record_prefix 'oai:localhost'
 #    admin_email 'root@localhost'
+#    sample_identifier 'oai:pubmedcentral.gov:13900'
 #    source_model MyModel.new
 #  end
 #
@@ -97,6 +98,7 @@ end
 #     record_prefix 'oai:blog'
 #     admin_email 'root@localhost'
 #     source_model OAI::Provider::ActiveRecordWrapper.new(Post)
+#     sample_identifier 'oai:pubmedcentral.gov:13900'
 #   end
 #
 # Create a custom controller:
@@ -184,7 +186,7 @@ module OAI::Provider
     
     class << self
       attr_reader :formats
-      attr_accessor :name, :url, :prefix, :email, :delete_support, :granularity, :model
+      attr_accessor :name, :url, :prefix, :email, :delete_support, :granularity, :model, :identifier, :description
 
       def register_format(format)
         @formats ||= {}
@@ -218,6 +220,8 @@ module OAI::Provider
       alias_method :deletion_support,   :delete_support=  
       alias_method :update_granularity, :granularity=     
       alias_method :source_model,       :model=
+      alias_method :sample_id,          :identifier=
+      alias_method :extra_description,  :description=
       
     end
 
@@ -228,6 +232,7 @@ module OAI::Provider
     Base.admin_email 'nobody@localhost'
     Base.deletion_support OAI::Const::Delete::TRANSIENT
     Base.update_granularity OAI::Const::Granularity::HIGH
+    Base.sample_id '13900'
 
     Base.register_format(OAI::Provider::Metadata::DublinCore.instance)
     

data/lib/oai/provider/model.rb

@@ -17,6 +17,8 @@ module OAI::Provider
   # available_formats - if overridden, individual records should return an 
   # array of prefixes for all formats in which that record is available, 
   # if other than ["oai_dc"]
+  # about - if overridden, should return a String or Array of XML Strings to
+  # insert into the OAI Record <about> chunks.
   #
   # == Resumption Tokens
   #
@@ -68,7 +70,11 @@ module OAI::Provider
     def deleted?
       false
     end
-    
+
+    # can return a String or Array of XML Strings add as OAI Record <about> chunks.
+    def about record
+      nil
+    end
   end
   
 end

data/lib/oai/provider/model/activerecord_wrapper.rb

@@ -24,7 +24,7 @@ module OAI::Provider
         )
       end
     end
-    
+
     def earliest
       model.find(:first, 
         :order => "#{timestamp_field} asc").send(timestamp_field)
@@ -65,6 +65,22 @@ module OAI::Provider
       false
     end    
     
+    def respond_to?(m, *args)
+      if m =~ /^map_/ 
+        model.respond_to?(m, *args)
+      else
+        super
+      end
+    end
+
+    def method_missing(m, *args, &block)
+      if m =~ /^map_/
+        model.send(m, *args, &block)
+      else
+        super
+      end
+    end
+
     protected
     
     # Request the next set in this sequence.
@@ -120,7 +136,7 @@ module OAI::Provider
       sql << "#{timestamp_field} >= ?" << "#{timestamp_field} <= ?" 
       sql << "set = ?" if opts[:set]
       esc_values = [sql.join(" AND ")]
-      esc_values << Time.parse(opts[:from]).localtime << Time.parse(opts[:until]).localtime #-- OAI 2.0 hack - UTC fix from record_responce 
+      esc_values << Time.parse(opts[:from].to_s).localtime << Time.parse(opts[:until].to_s).localtime.to_s #-- OAI 2.0 hack - UTC fix from record_responce 
       esc_values << opts[:set] if opts[:set]
       
       return esc_values

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

@@ -14,6 +14,7 @@ module OAI::Provider::Response
           r.record do 
             header_for record
             data_for record unless deleted?(record)
+            about_for record unless deleted?(record)
           end
         end
       end
@@ -23,4 +24,4 @@ module OAI::Provider::Response
 
 end
     
-    
+    

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

@@ -16,7 +16,19 @@ module OAI::Provider::Response
           r.earliestDatestamp Time.parse(provider.model.earliest.to_s).utc.xmlschema
           r.deletedRecord provider.delete_support.to_s
           r.granularity provider.granularity
+          r.description do
+            r.tag! 'oai-identifier', 'xmlns' => 'http://www.openarchives.org/OAI/2.0/oai-identifier', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', 'xsi:schemaLocation' => 'http://www.openarchives.org/OAI/2.0/oai-identifier http://www.openarchives.org/OAI/2.0/oai-identifier.xsd' do
+              r.scheme 'oai'
+              r.repositoryIdentifier provider.prefix.gsub(/oai:/, '')
+              r.delimiter ':'
+              r.sampleIdentifier "#{provider.prefix}:#{provider.identifier}"
+            end
+          end
+          if provider.description
+            r.target! << provider.description
+          end
         end
+
       end
     end
     

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

@@ -15,6 +15,7 @@ module OAI::Provider::Response
             r.record do
               header_for rec
               data_for rec unless deleted?(rec)
+              about_for rec unless deleted?(rec)
             end
           end
 

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

@@ -26,6 +26,21 @@ module OAI::Provider::Response
         @builder.target! << provider.format(requested_format).encode(provider.model, record)
       end
     end
+
+    # about - core routine for delivering about records
+    #
+    def about_for(record)
+      return unless provider.model.respond_to? :about
+
+      about = provider.model.about(record)
+      return if about.nil? 
+
+      Array(about).each do |a|
+        @builder.about do
+          @builder.target! << a
+        end 
+      end
+    end
     
     private
     

data/test/client/tc_get_record.rb

@@ -9,6 +9,7 @@ class GetRecordTest < Test::Unit::TestCase
     assert_kind_of OAI::Record, response.record
     assert_kind_of REXML::Element, response.record.metadata
     assert_kind_of OAI::Header, response.record.header
+    assert_kind_of REXML::Element, response.record.about
 
     # minimal check that the header is working
     assert_equal 'oai:test/3', 
@@ -16,6 +17,7 @@ class GetRecordTest < Test::Unit::TestCase
 
     # minimal check that the metadata is working
     #assert 'en', response.record.metadata.elements['.//dc:language'].text
+    assert_equal 'Ruby OAI test data', response.record.about.elements['.//dc:publisher'].text
   end
 
   def test_missing_identifier

data/test/provider/models.rb

@@ -231,5 +231,14 @@ class ComplexModel < TestModel
     generate_records(250, Time.parse("December 25 2005"), [set_four, set_three_four])
   end
   
+  def about record
+    <<-eos 
+    <oai_dc:dc 
+          xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/"
+          xmlns:dc="http://purl.org/dc/elements/1.1/">
+          <dc:publisher>Ruby OAI test data</dc:publisher>
+    </oai_dc:dc>
+    eos
+  end
 end
 

data/test/provider/tc_provider.rb

@@ -5,6 +5,13 @@ class OaiTest < Test::Unit::TestCase
   def setup
     @mapped_provider = MappedProvider.new
     @big_provider = BigProvider.new
+    @described_provider = DescribedProvider.new
+  end
+
+  def test_additional_description
+    doc = REXML::Document.new(@described_provider.identify)
+    assert_equal "oai:test:13900", doc.elements['OAI-PMH/Identify/description/oai-identifier/sampleIdentifier'].text
+    assert_not_nil doc.elements['OAI-PMH/Identify/my_custom_xml']
   end
   
   def test_list_identifiers_for_correct_xml

data/test/provider/test_helper.rb

@@ -33,4 +33,13 @@ class ComplexProvider < Provider::Base
   repository_url 'http://localhost'
   record_prefix 'oai:test'
   source_model ComplexModel.new(100)
-end
+end
+
+class DescribedProvider < Provider::Base
+  repository_name 'Described PRovider'
+  repository_url 'http://localhost'
+  record_prefix 'oai:test'
+  source_model SimpleModel.new
+  sample_id '13900'
+  extra_description "<my_custom_xml />"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: oai
 bindir: bin
 cert_chain: []
-date: 2012-06-01 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -75,6 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +227,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1260822851612593558
+      hash: 1810922164571931912
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -204,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1260822851612593558
+      hash: 1810922164571931912
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24