fieldhand 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67cb8ee7c5ff120c78181ef597a9f2ea46ed4e51
-  data.tar.gz: c83dbeb7abe6832c9e2b65fef55689c195c63805
+  metadata.gz: 49c63105b6f0895f33b4efdff65a657f4b18e7bb
+  data.tar.gz: 824b068c57fdf22120f0f0a49d88e3cf73d1bc3d
 SHA512:
-  metadata.gz: b5adbfea0e91229dce93d0e95a4daca0d206cb7746875f956c912e4934170b152e8afd3719ab851190a7f5c57a1b3f852db14b0f73a06aaffda9ad29ca09ad4a
-  data.tar.gz: 667cc59bb4b785d383eeb3314483bc3a05ba66ada5843d27d3998e2d75baf0605ea35de2cc83949bafaf31115a2389b8975bf1523bc66b69ee7b6effb996ba3c
+  metadata.gz: ac9af26d76794bc1a1578df816b5e69fb82f151623a28d448a9446f54d2f3536ffad6dce0b8a1d29713d5d19beefda50689093472e93663cf3f2a2ebc66c4208
+  data.tar.gz: 2211e6803c30a037d7b5a34ba42b6005eddc50536eaa4a2bc428e245d33fb272a78f021561f1d77bc0efeb2e12d0c9eac48fbb93437775304c446d02d5105b99

data/README.md

@@ -2,19 +2,19 @@
 
 A Ruby library for harvesting metadata from [OAI-PMH](https://www.openarchives.org/OAI/openarchivesprotocol.html) repositories.
 
-**Current version:** 0.5.0  
+**Current version:** 0.6.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.5'
+gem install fieldhand -v '~> 0.6'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.5'
+gem 'fieldhand', '~> 0.6'
 ```
 
 ## Usage
@@ -49,7 +49,7 @@ repository.get('oai:www.example.com:12345')
   * [`#sets`](#fieldhandrepositorysets)
   * [`#records([arguments])`](#fieldhandrepositoryrecordsarguments)
   * [`#identifiers([arguments])`](#fieldhandrepositoryidentifiersarguments)
-  * [`#get(identifier[, arguments])`](#fieldhandgetidentifier-arguments)
+  * [`#get(identifier[, arguments])`](#fieldhandrepositorygetidentifier-arguments)
 * [`Fieldhand::Identify`](#fieldhandidentify)
   * [`#name`](#fieldhandidentifyname)
   * [`#base_url`](#fieldhandidentifybase_url)
@@ -77,6 +77,7 @@ repository.get('oai:www.example.com:12345')
   * [`#identifier`](#fieldhandrecordidentifier)
   * [`#datestamp`](#fieldhandrecorddatestamp)
   * [`#sets`](#fieldhandrecordsets)
+  * [`#to_xml`](#fieldhandrecordto_xml)
   * [`#metadata`](#fieldhandrecordmetadata)
   * [`#about`](#fieldhandrecordabout)
   * [`#response_date`](#fieldhandrecordresponse_date)
@@ -437,6 +438,15 @@ repository.records.first.sets
 
 Return an `Array` of `String` [set specs](#fieldhandsetspec) indicating set memberships of this record.
 
+#### `Fieldhand::Record#to_xml`
+
+```ruby
+repository.records.first.to_xml
+#=> "<record><metadata>...</metadata><record>"
+```
+
+Return the record as a `String` of XML.
+
 #### `Fieldhand::Record#metadata`
 
 ```ruby
@@ -540,13 +550,13 @@ Return the time and date that the response was sent.
 
 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).
 
-#### `Fieldhand::ResponseError`
+### `Fieldhand::ResponseError`
 
-An error (descended from `NetworkError`) to represent any issues in the response from the repository.  
-If the HTTP request is not successful (returning a status code other than 200), 
+An error (descended from `NetworkError`) to represent any issues in the response from the repository.
+If the HTTP request is not successful (returning a status code other than 200),
 a `ResponseError` exception will be raised containing the error message and the response object.
 
-##### Fieldhand::ResponseError#response
+#### `Fieldhand::ResponseError#response`
 
 ```ruby
 begin
@@ -559,11 +569,15 @@ rescue Fieldhand::ResponseError => e
 end
 ```
 
-Returns the unsuccessful `Net::HTTPResponse` that caused this error or `nil` if no response was available.
+Returns the unsuccessful
+[`Net::HTTPResponse`](https://ruby-doc.org/stdlib/libdoc/net/http/rdoc/Net/HTTPResponse.html)
+that caused this error.
 
 ### `Fieldhand::ProtocolError`
 
-The parent error class (descended from `StandardError`) for any errors returned by a repository as defined in the [protocol's Error and Exception Conditions](https://www.openarchives.org/OAI/openarchivesprotocol.html#ErrorConditions).
+The parent error class (descended from `StandardError`) for any errors returned
+by a repository as defined in the [protocol's Error and Exception
+Conditions](https://www.openarchives.org/OAI/openarchivesprotocol.html#ErrorConditions).
 
 This can be used to rescue all the following child error types.
 

data/lib/fieldhand/record.rb

@@ -45,11 +45,16 @@ module Fieldhand
       header.sets
     end
 
+    # Return this whole item as a string
+    def to_xml
+      Ox.dump(element, :encoding => 'utf-8')
+    end
+
     # Return the single manifestation of the metadata of this item as a string, if present.
     #
     # As metadata can be in any format, Fieldhand does not attempt to parse it but leave that to the user.
     def metadata
-      @metadata ||= element.locate('metadata[0]').map { |metadata| Ox.dump(metadata) }.first
+      @metadata ||= element.locate('metadata[0]').map { |metadata| Ox.dump(metadata, :encoding => 'utf-8') }.first
     end
 
     # Return any about elements describing the metadata of this record as an array of strings.

data/spec/fieldhand/record_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'fieldhand/record'
 require 'ox'
 
@@ -33,6 +35,46 @@ module Fieldhand
 
         expect(record.metadata).to eq("\n<metadata>Foo</metadata>\n")
       end
+
+      it 'returns the metadata with unicode characters as a string' do
+        element = ::Ox.parse('<record><metadata>ψFooϨ</metadata></record>')
+        record = described_class.new(element)
+
+        expect(record.metadata).to eq("\n<metadata>ψFooϨ</metadata>\n")
+      end
+    end
+
+    describe '#to_xml' do
+      it 'returns the whole element even if there is no metadata as a string' do
+        element = ::Ox.parse('<record/>')
+        record = described_class.new(element)
+
+        expect(record.to_xml).to eq("\n<record/>\n")
+      end
+
+      it 'returns the whole element as a string' do
+        element = ::Ox.parse("<record><metadata>Foo</metadata></record>")
+        record = described_class.new(element)
+
+        expect(record.to_xml).to eq(<<-XML)
+
+<record>
+  <metadata>Foo</metadata>
+</record>
+        XML
+      end
+
+      it 'returns the whole element with unicode characters as a string' do
+        element = ::Ox.parse("<record><metadata>ψFooϨ</metadata></record>")
+        record = described_class.new(element)
+
+        expect(record.to_xml).to eq(<<-XML)
+
+<record>
+  <metadata>ψFooϨ</metadata>
+</record>
+        XML
+      end
     end
 
     describe '#about' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Paul Mucur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox