Merge pull request #5 from bess/master

Added code example to demo resumption tokens

Author: edsu

lib/oai/client.rb

@@ -98,7 +98,7 @@ def initialize(base_url, options={})
 
     # Equivalent to a Identify request. You'll get back a OAI::IdentifyResponse
     # object which is essentially just a wrapper around a REXML::Document 
-    # for the response. If you are created your client using the libxml 
+    # for the response. If you created your client using the libxml 
     # parser then you will get an XML::Node object instead.
 
     def identify

lib/oai/client/response.rb

@@ -1,4 +1,24 @@
 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"
+
   class Response
     include OAI::XPath
     attr_reader :doc, :resumption_token