fieldhand 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1f8b4934a70d78dda2f03bb151deea7ed553424
-  data.tar.gz: f39842d9de77f6a43203f6795ef35836ac5efbff
+  metadata.gz: c1ca08a8fb6ab7682f308d7cb2ffe4ac3cc0829d
+  data.tar.gz: dea8d65de365fb51ef9788e4cfd4c34dd11af2b4
 SHA512:
-  metadata.gz: 6ce68385c9352deabd07c6f60ef904853c934a79d1488a88abbffaed9c1802e59f06437501cc23f79b68bbacc801608c758085753373525e9484d4c0b566c181
-  data.tar.gz: 22c515794f85150b621f0a8ef0d7af25505590a707ff86b8972e5751c69cf5a0bc46508cfb53b5d8ebe5458be778d10b9d69c1cfd13e731b92806b1de69e7cec
+  metadata.gz: e797e8d9625730ac9bed36bbeaae6fb8d490695e6b165a94f7e48ea0b743d8c4f95322bbd3c119533a2a446a5014a1e90fd1adcc96a003bceba83cc61a8a9fa1
+  data.tar.gz: '0295cc11eb9ad3f6c6782022cf1f06953aa4675ef608a32c9dc9cb363f1733750f08bedd3e69870d1973d031e8ed6366a1ff509a951818bcb3985fe72d1db6c6'

data/README.md

@@ -2,9 +2,21 @@
 
 A Ruby library for harvesting metadata from [OAI-PMH](https://www.openarchives.org/OAI/openarchivesprotocol.html) repositories.
 
-**Current version:** 0.1.0  
+**Current version:** 0.2.0  
 **Supported Ruby versions:** 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2
 
+## Installation
+
+```
+gem install fieldhand -v '~> 0.2'
+```
+
+Or, in your `Gemfile`:
+
+```ruby
+gem 'fieldhand', '~> 0.2'
+```
+
 ## Usage
 
 ```ruby
@@ -48,14 +60,17 @@ repository.get('oai:www.example.com:12345')
   * [`#admin_emails`](#fieldhandidentifyadmin_emails)
   * [`#compression`](#fieldhandidentifycompression)
   * [`#descriptions`](#fieldhandidentifydescriptions)
+  * [`#response_date`](#fieldhandidentifyresponse_date)
 * [`Fieldhand::MetadataFormat`](#fieldhandmetadataformat)
   * [`#prefix`](#fieldhandmetadataformatprefix)
   * [`#schema`](#fieldhandmetadataformatschema)
   * [`#namespace`](#fieldhandmetadataformatnamespace)
+  * [`#response_date`](#fieldhandmetadataformatresponse_date)
 * [`Fieldhand::Set`](#fieldhandset)
   * [`#spec`](#fieldhandsetspec)
   * [`#name`](#fieldhandsetname)
   * [`#descriptions`](#fieldhandsetdescriptions)
+  * [`#response_date`](#fieldhandsetresponse_date)
 * [`Fieldhand::Record`](#fieldhandrecord)
   * [`#deleted?`](#fieldhandrecorddeleted)
   * [`#status`](#fieldhandrecordstatus)
@@ -64,12 +79,14 @@ repository.get('oai:www.example.com:12345')
   * [`#sets`](#fieldhandrecordsets)
   * [`#metadata`](#fieldhandrecordmetadata)
   * [`#about`](#fieldhandrecordabout)
+  * [`#response_date`](#fieldhandrecordresponse_date)
 * [`Fieldhand::Header`](#fieldhandheader)
   * [`#deleted?`](#fieldhandheaderdeleted)
   * [`#status`](#fieldhandheaderstatus)
   * [`#identifier`](#fieldhandheaderidentifier)
   * [`#datestamp`](#fieldhandheaderdatestamp)
   * [`#sets`](#fieldhandheadersets)
+  * [`#response_date`](#fieldhandheaderresponse_date)
 * [`Fieldhand::NetworkError`](#fieldhandnetworkerror)
 * [`Fieldhand::ProtocolError`](#fieldhandprotocolerror)
   * [`Fieldhand::BadArgumentError`](#fieldhandbadargumenterror)
@@ -276,6 +293,15 @@ Returns XML elements describing this repository as an `Array` of [`Ox::Element`]
 
 As descriptions can be in any format, Fieldhand doesn't attempt to parse descriptions but leaves parsing to the client.
 
+#### `Fieldhand::Identify#response_date`
+
+```ruby
+repository.identify.response_date
+#=> 2017-05-08 11:21:38 +0100
+```
+
+Return the time and date that the response was sent.
+
 ### `Fieldhand::MetadataFormat`
 
 A class to represent a metadata format available from a repository.
@@ -307,6 +333,15 @@ repository.metadata_formats.first.namespace
 
 Return the XML Namespace URI for the format as a [`URI`][URI].
 
+#### `Fieldhand::MetadataFormat#response_date`
+
+```ruby
+repository.metadata_formats.first.response_date
+#=> 2017-05-08 11:21:38 +0100
+```
+
+Return the time and date that the response was sent.
+
 ### `Fieldhand::Set`
 
 A class representing an optional construct for grouping items for the purpose of selective harvesting.
@@ -338,6 +373,15 @@ repository.sets.first.descriptions
 
 Return an `Array` of [`Ox::Element`][Element]s of any optional and repeatable containers that may hold community-specific XML-encoded data about the set.
 
+#### `Fieldhand::Set#response_date`
+
+```ruby
+repository.sets.first.response_date
+#=> 2017-05-08 11:21:38 +0100
+```
+
+Return the time and date that the response was sent.
+
 ### `Fieldhand::Record`
 
 A class representing a [record](https://www.openarchives.org/OAI/openarchivesprotocol.html#Record) from the repository:
@@ -411,6 +455,15 @@ repository.records.first.about
 
 Return an `Array` of [`Ox::Element`][Element]s of any optional and repeatable containers holding data about the metadata part of the record.
 
+#### `Fieldhand::Record#response_date`
+
+```ruby
+repository.records.first.response_date
+#=> 2017-05-08 11:21:38 +0100
+```
+
+Return the time and date that the response was sent.
+
 ### `Fieldhand::Header`
 
 A class representing the [header](https://www.openarchives.org/OAI/openarchivesprotocol.html#header) of a record:
@@ -472,6 +525,15 @@ repository.identifiers.first.sets
 
 Return an `Array` of `String` [set specs](#fieldhandsetspec) indicating set memberships of this record.
 
+#### `Fieldhand::Header#response_date`
+
+```ruby
+repository.identifiers.first.response_date
+#=> 2017-05-08 11:21:38 +0100
+```
+
+Return the time and date that the response was sent.
+
 ### `Fieldhand::NetworkError`
 
 An error (descended from `StandardError`) to represent any network issues encountered during interaction with the repository. Any underlying exception is exposed in Ruby 2.1 onwards through [`Exception#cause`](https://ruby-doc.org/core-2.1.0/Exception.html#method-i-cause).

data/lib/fieldhand/header.rb

@@ -13,10 +13,11 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#header
   class Header
-    attr_reader :element
+    attr_reader :element, :response_date
 
-    def initialize(element)
+    def initialize(element, response_date = Time.now)
       @element = element
+      @response_date = response_date
     end
 
     def deleted?

data/lib/fieldhand/identify.rb

@@ -6,10 +6,11 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#Identify
   class Identify
-    attr_reader :element
+    attr_reader :element, :response_date
 
-    def initialize(element)
+    def initialize(element, response_date = Time.now)
       @element = element
+      @response_date = response_date
     end
 
     def name

data/lib/fieldhand/metadata_format.rb

@@ -5,10 +5,11 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#ListMetadataFormats
   class MetadataFormat
-    attr_reader :element
+    attr_reader :element, :response_date
 
-    def initialize(element)
+    def initialize(element, response_date = Time.now)
       @element = element
+      @response_date = response_date
     end
 
     def to_s

data/lib/fieldhand/paginator.rb

@@ -1,3 +1,4 @@
+require 'fieldhand/datestamp'
 require 'fieldhand/logger'
 require 'ox'
 require 'cgi'
@@ -46,13 +47,14 @@ module Fieldhand
 
       loop do
         document = ::Ox.parse(request(query.merge('verb' => verb)))
+        response_date = document.root.locate('responseDate[0]/^String').map { |date| Datestamp.parse(date) }.first
 
         document.root.locate('error').each do |error|
           convert_error(error)
         end
 
         document.root.locate(path).each do |item|
-          yield item
+          yield item, response_date
         end
 
         resumption_token = document.root.locate('?/resumptionToken/^String').first

data/lib/fieldhand/record.rb

@@ -5,10 +5,11 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#Record
   class Record
-    attr_reader :element
+    attr_reader :element, :response_date
 
-    def initialize(element)
+    def initialize(element, response_date = Time.now)
       @element = element
+      @response_date = response_date
     end
 
     def deleted?

data/lib/fieldhand/repository.rb

@@ -23,7 +23,7 @@ module Fieldhand
     def identify
       paginator.
         items('Identify', 'Identify').
-        map { |identify| Identify.new(identify) }.
+        map { |identify, response_date| Identify.new(identify, response_date) }.
         first
     end
 
@@ -35,8 +35,8 @@ module Fieldhand
 
       paginator.
         items('ListMetadataFormats', 'ListMetadataFormats/metadataFormat', arguments).
-        each do |format|
-          yield MetadataFormat.new(format)
+        each do |format, response_date|
+          yield MetadataFormat.new(format, response_date)
         end
     end
 
@@ -45,8 +45,8 @@ module Fieldhand
 
       paginator.
         items('ListSets', 'ListSets/set').
-        each do |set|
-          yield Set.new(set)
+        each do |set, response_date|
+          yield Set.new(set, response_date)
         end
     end
 
@@ -57,8 +57,8 @@ module Fieldhand
 
       paginator.
         items('ListRecords', 'ListRecords/record', query).
-        each do |record|
-          yield Record.new(record)
+        each do |record, response_date|
+          yield Record.new(record, response_date)
         end
     end
 
@@ -69,8 +69,8 @@ module Fieldhand
 
       paginator.
         items('ListIdentifiers', 'ListIdentifiers/header', query).
-        each do |header|
-          yield Header.new(header)
+        each do |header, response_date|
+          yield Header.new(header, response_date)
         end
     end
 
@@ -82,7 +82,7 @@ module Fieldhand
 
       paginator.
         items('GetRecord', 'GetRecord/record', query).
-        map { |record| Record.new(record) }.
+        map { |record, response_date| Record.new(record, response_date) }.
         first
     end
 

data/lib/fieldhand/set.rb

@@ -3,10 +3,11 @@ module Fieldhand
   #
   # See https://www.openarchives.org/OAI/openarchivesprotocol.html#Set
   class Set
-    attr_reader :element
+    attr_reader :element, :response_date
 
-    def initialize(element)
+    def initialize(element, response_date = Time.now)
       @element = element
+      @response_date = response_date
     end
 
     def to_s

data/spec/fieldhand/header_spec.rb

@@ -34,5 +34,14 @@ module Fieldhand
         expect(header.datestamp).to eq(::Date.new(2001, 1, 1))
       end
     end
+
+    describe '#response_date' do
+      it 'returns the passed response date' do
+        element = ::Ox.parse('<header/>')
+        header = described_class.new(element, ::Time.utc(2001, 1, 1, 0, 0, 0))
+
+        expect(header.response_date).to eq(::Time.utc(2001, 1, 1, 0, 0, 0))
+      end
+    end
   end
 end

data/spec/fieldhand/identify_spec.rb

@@ -39,5 +39,14 @@ module Fieldhand
         expect(identify.earliest_datestamp).to eq(::Date.new(1990, 2, 1))
       end
     end
+
+    describe '#response_date' do
+      it 'returns the passed response date' do
+        element = ::Ox.parse('<Identify/>')
+        identify = described_class.new(element, ::Time.utc(2001, 1, 1, 0, 0, 0))
+
+        expect(identify.response_date).to eq(::Time.utc(2001, 1, 1, 0, 0, 0))
+      end
+    end
   end
 end

data/spec/fieldhand/metadata_format_spec.rb

@@ -11,5 +11,14 @@ module Fieldhand
         expect(format.to_s).to eq('xoai')
       end
     end
+
+    describe '#response_date' do
+      it 'returns the passed response date' do
+        element = ::Ox.parse('<metadataFormat/>')
+        format = described_class.new(element, ::Time.utc(2001, 1, 1, 0, 0, 0))
+
+        expect(format.response_date).to eq(::Time.utc(2001, 1, 1, 0, 0, 0))
+      end
+    end
   end
 end

data/spec/fieldhand/record_spec.rb

@@ -34,5 +34,14 @@ module Fieldhand
         expect(record.about.size).to eq(2)
       end
     end
+
+    describe '#response_date' do
+      it 'returns the passed response date' do
+        element = ::Ox.parse('<record/>')
+        record = described_class.new(element, ::Time.utc(2001, 1, 1, 0, 0, 0))
+
+        expect(record.response_date).to eq(::Time.utc(2001, 1, 1, 0, 0, 0))
+      end
+    end
   end
 end

data/spec/fieldhand/set_spec.rb

@@ -27,5 +27,14 @@ module Fieldhand
         expect(set.to_s).to eq('A')
       end
     end
+
+    describe '#response_date' do
+      it 'returns the passed response date' do
+        element = ::Ox.parse('<set/>')
+        set = described_class.new(element, ::Time.utc(2001, 1, 1, 0, 0, 0))
+
+        expect(set.response_date).to eq(::Time.utc(2001, 1, 1, 0, 0, 0))
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Mucur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: An OAI-PMH harvester