add OAI Record <about /> block

Author: cbeer

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

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 @@ def find(selector, options={})
     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

lib/oai/provider/response/get_record.rb

@@ -14,6 +14,7 @@ def to_xml
           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 @@ def to_xml
 
 end
 
-    
+    

lib/oai/provider/response/list_records.rb

@@ -15,6 +15,7 @@ def to_xml
             r.record do
               header_for rec
               data_for rec unless deleted?(rec)
+              about_for rec unless deleted?(rec)
             end
           end
 

lib/oai/provider/response/record_response.rb

@@ -26,6 +26,21 @@ def data_for(record)
         @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
 

test/client/tc_get_record.rb

@@ -9,13 +9,15 @@ def test_get_one
     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', 
       response.record.header.identifier
 
     # 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

test/provider/models.rb

@@ -231,5 +231,14 @@ def initialize(limit = nil)
     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