oai_talia 0.0.14 → 0.0.15

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

@@ -65,7 +65,7 @@ module OAI::Provider
         total = model.count(:id, :conditions => conditions)
         if @limit && total > @limit
           select_partial(
-            ResumptionToken.new(options.merge({:last => 0})))
+            ResumptionToken.new(last_id(conditions), options.merge({:last => 0}), nil, total))
         else
           model.find(:all, :conditions => conditions)
         end

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

@@ -34,6 +34,12 @@ module OAI::Provider
       model.find(:first, 
         :order => "#{timestamp_field} desc").send(timestamp_field)
     end
+    
+    def last_id(conditions)
+      model.find(:first, :conditions => conditions,
+        :order => "#{timestamp_field} desc").id
+    end
+    
     # A model class is expected to provide a method Model.sets that
     # returns all the sets the model supports.  See the 
     # activerecord_provider tests for an example.   
@@ -46,8 +52,8 @@ module OAI::Provider
       conditions = sql_conditions(options)
       if :all == selector
         total = model.count(:id, :conditions => conditions)
-        if @limit && total > @limit
-          select_partial(ResumptionToken.new(options.merge({:last => 0})))
+        if(@limit && total > @limit)
+          select_partial(ResumptionToken.new(last_id(conditions), options.merge({:last => 0}), nil, total))
         else
           model.find(:all, :conditions => conditions)
         end
@@ -78,13 +84,7 @@ module OAI::Provider
       token = ResumptionToken.parse(token_string)
       total = model.count(:id, :conditions => token_conditions(token))
     
-      if @limit < total
-        select_partial(token)
-      else # end of result set
-        model.find(:all, 
-          :conditions => token_conditions(token), 
-          :limit => @limit, :order => "#{model.primary_key} asc")
-      end
+      select_partial(token)
     end
     
     # select a subset of the result set, and return it with a
@@ -96,7 +96,6 @@ module OAI::Provider
         :order => "#{model.primary_key} asc")
       raise OAI::ResumptionTokenException.new unless records
       offset = records.last.send(model.primary_key.to_sym)
-      
       PartialResult.new(records, token.next(offset))
     end
     
@@ -121,17 +120,29 @@ module OAI::Provider
     # build a sql conditions statement from an OAI options hash
     def sql_conditions(opts)
       sql = []
-      sql << "#{timestamp_field} >= ?" << "#{timestamp_field} <= ?" 
-      sql << "set = ?" if opts[:set]
-      esc_values = [sql.join(" AND ")]
-      esc_values << get_time(opts[:from]).localtime << get_time(opts[:until]).localtime #-- OAI 2.0 hack - UTC fix from record_responce 
-      esc_values << opts[:set] if opts[:set]
+      values = []
+      
+      if(opts[:set])
+        sql << "set = ?"
+        values << opts[:set]
+      end
+      
+      if(opts[:from])
+        sql << "#{timestamp_field} >= ?"
+        values << get_time(opts[:from])
+      end
+      
+      if(opts[:until])
+        sql << "#{timestamp_field} <= ?"
+        values << get_time(opts[:until])
+      end
       
-      return esc_values
+      values.unshift(sql.join(' AND '))
     end
     
+    #-- OAI 2.0 hack - UTC fix from record_responce 
     def get_time(time)
-      time.kind_of?(Time) ? time : Time.parse(time)
+      (time.kind_of?(Time) ? time : Time.parse(time)).localtime
     end
     
   end

data/lib/oai/provider/model.rb

@@ -45,6 +45,11 @@ module OAI::Provider
       raise NotImplementedError.new
     end
     
+    # Should return the last id of this model
+    def last_id(conditions)
+      raise NotImplementedError.new
+    end
+    
     def sets
       nil
     end

data/lib/oai/provider/response.rb

@@ -142,7 +142,7 @@ module OAI
           def internalize(hash = {})
             internal = {}
             hash.keys.each do |key|
-              internal[key.to_s.gsub(/([A-Z])/, '_\1').downcase.intern] = hash[key].dup
+              internal[key.to_s.gsub(/([A-Z])/, '_\1').downcase.intern] = hash[key].nil? ? nil : hash[key].dup
             end
 
             # Convert date formated strings into internal time values

data/lib/oai/provider/resumption_token.rb

@@ -9,7 +9,8 @@ module OAI::Provider
   # provides several helper methods for dealing with resumption tokens.
   #
   class ResumptionToken
-    attr_reader :prefix, :set, :from, :until, :last, :expiration, :total
+    attr_reader :prefix, :set, :from, :until, :last, :expiration, :last_id
+    attr_accessor :total
 
     # parses a token string and returns a ResumptionToken
     def self.parse(token_string)
@@ -17,6 +18,8 @@ module OAI::Provider
         options = {}
         matches = /(.+):(\d+)$/.match(token_string)
         options[:last] = matches.captures[1].to_i
+        last_id = nil
+        total = nil
         
         parts = matches.captures[0].split('.')
         options[:metadata_prefix] = parts.shift
@@ -28,9 +31,13 @@ module OAI::Provider
             options[:from] = Time.parse(part.sub(/^f\(/, '').sub(/\)$/, ''))
           when /^u/
             options[:until] = Time.parse(part.sub(/^u\(/, '').sub(/\)$/, ''))
+          when /^l/
+            last_id = part.sub(/^l\(/, '').sub(/\)$/, '')
+          when /^t/
+            total = part.sub(/^t\(/, '').sub(/\)$/, '')
           end
         end
-        self.new(options)
+        self.new(last_id, options, nil, total)
       rescue => err
         raise ResumptionTokenException.new
       end
@@ -41,7 +48,7 @@ module OAI::Provider
       return token_string.split('.')[0]
     end
 
-    def initialize(options, expiration = nil, total = nil)
+    def initialize(last_id, options, expiration = nil, total = nil)
       @prefix = options[:metadata_prefix]
       @set = options[:set]
       @last = options[:last]
@@ -49,6 +56,7 @@ module OAI::Provider
       @until = options[:until] if options[:until]
       @expiration = expiration if expiration
       @total = total if total
+      @last_id = last_id
     end
           
     # convenience method for setting the offset of the next set of results
@@ -66,7 +74,13 @@ module OAI::Provider
     # output an xml resumption token
     def to_xml
       xml = Builder::XmlMarkup.new
-      xml.resumptionToken(encode_conditions, hash_of_attributes)
+      token_content = if(last_id.to_s == last.to_s)
+        [] # Empty token required on last page of results
+      else
+        [encode_conditions, hash_of_attributes]
+      end
+      
+      xml.resumptionToken(*token_content)
       xml.target!
     end
     
@@ -91,6 +105,8 @@ module OAI::Provider
       encoded_token << ".s(#{set})" if set
       encoded_token << ".f(#{self.from.utc.xmlschema})" if self.from
       encoded_token << ".u(#{self.until.utc.xmlschema})" if self.until
+      encoded_token << ".t(#{self.total})" if(self.total)
+      encoded_token << ".l(#{last_id})"
       encoded_token << ":#{last}"
     end
 

data/test/activerecord_provider/tc_simple_paging_provider.rb

@@ -8,17 +8,21 @@ class SimpleResumptionProviderTest < Test::Unit::TestCase
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_not_nil token
     doc = Document.new(@provider.list_records(:resumption_token => token))
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_not_nil token
     assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     doc = Document.new(@provider.list_records(:resumption_token => token))
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_not_nil token
     assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     doc = Document.new(@provider.list_records(:resumption_token => token))
-    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
-    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
   end
   
   def test_from_and_until
@@ -41,8 +45,9 @@ class SimpleResumptionProviderTest < Test::Unit::TestCase
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
     doc = Document.new(@provider.list_records(:resumption_token => token))
-    assert_equal 25, doc.elements["/OAI-PMH/ListRecords"].to_a.size
-    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_equal 26, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
   end
 
   def setup

data/test/provider/models.rb

@@ -64,12 +64,9 @@ class TestModel < OAI::Provider::Model
         raise OAI::ResumptionTokenException.new unless @limit
         begin
           token = ResumptionToken.parse(opts[:resumption_token])
+          token.total = @groups.size
 
-          if token.last < @groups.size - 1
-            PartialResult.new(@groups[token.last], token.next(token.last + 1))
-          else
-            @groups[token.last]
-          end
+          PartialResult.new(@groups[token.last], token.next(token.last + 1))
         rescue
           raise OAI::ResumptionTokenException.new
         end
@@ -88,7 +85,7 @@ class TestModel < OAI::Provider::Model
         if @limit && records.size > @limit
           @groups = generate_chunks(records, @limit)
           return PartialResult.new(@groups[0], 
-            ResumptionToken.new(opts.merge({:last => 1})))
+            ResumptionToken.new(@groups.size, opts.merge({:last => 1}), nil, records.size))
         end
         return records
       end

data/test/provider/tc_functional_tokens.rb

@@ -34,10 +34,11 @@ class ResumptionTokenFunctionalTest < Test::Unit::TestCase
     assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
     assert_equal 101, doc.elements["/OAI-PMH/ListRecords"].to_a.size
     token = doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
-
+    
     doc = Document.new(@provider.list_records(:resumption_token => token))
-    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
-    assert_equal 100, doc.elements["/OAI-PMH/ListRecords"].to_a.size
+    assert_not_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"]
+    assert_nil doc.elements["/OAI-PMH/ListRecords/resumptionToken"].text
+    assert_equal 101, doc.elements["/OAI-PMH/ListRecords"].to_a.size
   end
     
 end

data/test/provider/tc_resumption_tokens.rb

@@ -5,17 +5,24 @@ class ResumptionTokenTest < Test::Unit::TestCase
   include OAI::Provider
   
   def setup
-    @token = ResumptionToken.new(
+    @token = ResumptionToken.new(2, {
       :from => Time.utc(2005,"jan",1,17,0,0),
       :until => Time.utc(2005,"jan",31,17,0,0),
       :set => "A",
       :metadata_prefix => "oai_dc", 
-      :last => 1
+      :last => 1 }
+    )
+    @last_token = ResumptionToken.new(1, {
+      :from => Time.utc(2005,"jan",1,17,0,0),
+      :until => Time.utc(2005,"jan",31,17,0,0),
+      :set => "A",
+      :metadata_prefix => "oai_dc", 
+      :last => 1 }
     )
   end
 
   def test_resumption_token_options_encoding
-    assert_equal "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z)",
+    assert_equal "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z).l(2)",
       @token.to_s
   end
   
@@ -33,7 +40,7 @@ class ResumptionTokenTest < Test::Unit::TestCase
 
   def test_resumption_token_parsing
     new_token = ResumptionToken.parse(
-      "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z):1"
+      "oai_dc.s(A).f(2005-01-01T17:00:00Z).u(2005-01-31T17:00:00Z).l(2):1"
     )
     assert_equal @token, new_token
   end
@@ -43,4 +50,10 @@ class ResumptionTokenTest < Test::Unit::TestCase
     assert_equal "#{@token.to_s}:#{@token.last}", doc.elements['/resumptionToken'].text
   end
     
+  def test_last_resumption_token_to_xml
+    doc = REXML::Document.new(@last_token.to_xml)
+    assert_not_nil doc.elements['/resumptionToken']
+    assert_nil doc.elements['/resumptionToken'].text
+  end  
+    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oai_talia
 version: !ruby/object:Gem::Version 
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors: 
 - Ed Summers