ezid-client 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c31b00b1504e025803a1ef72dfcb420b6a04aa4c
-  data.tar.gz: 6068b93b00a3b4c4769a84b4cc77f67d9f9a23f3
+  metadata.gz: ab1d0301b2fdef9d87602338269625d3f5f6b32f
+  data.tar.gz: 6f1ffabe1d6e126c2ffe39ff5dc091a528144c03
 SHA512:
-  metadata.gz: 964c5b5fa7491962e4c5eb304aeef24869cda17cb6b27bf69e743fa3c43595187e649262c2f1b23ae7e0c229e4015fc5f6380c56547064eb2c37ccd75eabd649
-  data.tar.gz: 9d4df17ad7ad5478a6c17073e618a7a4eb3f0f55e4a8f06ea4c3e260e5727d6e3f4966a8cce830d8e9958f73f06b8e071a5083b82f24f88bb7eb8460a914dbf9
+  metadata.gz: 726c74c5346c4ca85128b4716ef565c888059fb5f3ee1575b04896ca8ba5bf68212e7a699b68dd051251917a05d86bf0f0f465b75feb1b801e195aef17a9d08b
+  data.tar.gz: 8809f5f2ebd0bfe9a2893738368b3442565c171f81dc08e50333c912ea7c173ecc2a130368c4de451929a09ff4a01ee3127df79c4ab4fce5bb8d3e3b851c6fd5

data/README.md

@@ -296,11 +296,10 @@ require "ezid/test_helper"
 
 The module provides constants:
 
-- `TEST_ARK_SHOULDER` => "ark:/99999/fk4"
-- `TEST_DOI_SHOULDER` => "doi:10.5072/FK2"
-- `TEST_USER` => "apitest"
-- `TEST_HOST` => "ezid.cdlib.org"
-- `TEST_PORT` => 443
+- `EZID_TEST_SHOULDER` => "doi:10.5072/FK2"
+- `EZID_TEST_USER` => "apitest"
+- `EZID_TEST_HOST` => "ezid.cdlib.org"
+- `EZID_TEST_PORT` => 443
 
 The test user password is not provided - contact EZID and configure as above - or use your own EZID credentials, since all accounts can mint/create on the test shoulders.
 
@@ -326,3 +325,7 @@ In order to run the integration tests successfully, you must supply the password
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Acknowledgments
+
+- Justin Gondron (jgondron) contributed Datacite compatibility code (added in v1.8.0).

data/VERSION

@@ -1 +1 @@
-1.7.1
+1.8.0

data/ezid-client.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 2.1"
 
   spec.add_dependency "hashie", "~> 3.4", ">= 3.4.3"
+  spec.add_dependency "nokogiri"
 
   spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec-its", "~> 1.2"

data/lib/ezid/client.rb

@@ -44,12 +44,11 @@ module Ezid
       end
     end
 
-    attr_reader :user, :password, :host, :port, :use_ssl, :timeout
+    attr_reader :user, :password, :host, :port, :timeout
 
     def initialize(opts = {})
       @host = opts[:host] || config.host
       @port = (opts[:port] || config.port).to_i
-      @use_ssl = opts[:use_ssl] || config.use_ssl
       @timeout = (opts[:timeout] || config.timeout).to_i
       @user = opts[:user] || config.user
       @password = opts[:password] || config.password
@@ -60,6 +59,12 @@ module Ezid
       end
     end
 
+    def use_ssl
+      warn "[DEPRECATION] `use_ssl` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+      true
+    end
+
     def inspect
       "#<#{self.class.name} connection=#{connection.inspect}, " \
         "user=#{user.inspect}, session=#{logged_in? ? 'OPEN' : 'CLOSED'}>"
@@ -188,15 +193,11 @@ module Ezid
 
     private
 
-    def use_ssl?
-      use_ssl || port == 443
-    end
-
     def build_connection
-      conn = Net::HTTP.new(host, port)
-      conn.use_ssl = use_ssl?
-      conn.read_timeout = timeout
-      conn
+      Net::HTTP.new(host, port).tap do |conn|
+        conn.use_ssl = true
+        conn.read_timeout = timeout
+      end
     end
 
     def handle_response(response, request_name)

data/lib/ezid/configuration.rb

@@ -20,9 +20,6 @@ module Ezid
     # EZID TCP/IP port
     attr_accessor :port
 
-    # Use HTTPS?
-    attr_accessor :use_ssl
-
     # HTTP read timeout (seconds)
     attr_accessor :timeout
 
@@ -44,7 +41,6 @@ module Ezid
       @password         = ENV["EZID_PASSWORD"]
       @host             = ENV["EZID_HOST"] || HOST
       @port             = ENV["EZID_PORT"] || PORT
-      @use_ssl          = true unless ENV["EZID_USE_SSL"] == false.to_s
       @timeout          = ENV["EZID_TIMEOUT"] || TIMEOUT
       @default_shoulder = ENV["EZID_DEFAULT_SHOULDER"]
     end
@@ -67,5 +63,16 @@ module Ezid
       Metadata
     end
 
+    def use_ssl
+      warn "[DEPRECATION] `use_ssl` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+      true
+    end
+
+    def use_ssl=(*)
+      warn "[DEPRECATION] `use_ssl=` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+    end
+
   end
 end

data/lib/ezid/identifier.rb

@@ -320,8 +320,8 @@ module Ezid
     end
 
     def reset_metadata
-      local_metadata.clear unless local_metadata.empty?
-      remote_metadata.clear unless remote_metadata.empty?
+      local_metadata.clear
+      remote_metadata.clear
     end
 
     protected

data/lib/ezid/metadata.rb

@@ -1,4 +1,5 @@
 require "hashie"
+require_relative "metadata_transforms/datacite"
 
 module Ezid
   #
@@ -85,7 +86,12 @@ module Ezid
     end
 
     def replace(data)
-      super coerce(data)
+      hsh = coerce(data)
+
+      # Perform additional profile transforms
+      MetadataTransformDatacite.inverse(hsh) if hsh["_profile"] == "datacite"
+
+      super hsh
     end
 
     # Output metadata in EZID ANVL format
@@ -94,6 +100,10 @@ module Ezid
     def to_anvl(include_readonly = true)
       hsh = to_h
       hsh.reject! { |k, v| READONLY.include?(k) } unless include_readonly
+
+      # Perform additional profile transforms
+      MetadataTransformDatacite.transform(hsh) if profile == "datacite"
+
       lines = hsh.map do |name, value|
         element = [escape(ESCAPE_NAMES_RE, name), escape(ESCAPE_VALUES_RE, value)]
         element.join(ANVL_SEPARATOR)

data/lib/ezid/metadata_transforms/datacite.rb

@@ -0,0 +1,72 @@
+require "nokogiri"
+
+module Ezid
+  class MetadataTransformDatacite
+
+    # Transforms the provided metadata hash into the appropriate format for datacite. Removes all "datacite.*" keys
+    # and transforms these to the appropriate datacite xml. The resultant xml is then added to a single "datacite" key.
+    def self.transform(hsh)
+      # Render the datacite xml
+      resource_opts = {
+        "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+        "xmlns" => "http://datacite.org/schema/kernel-4",
+        "xsi:schemaLocation" => "http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd"
+      }
+      xml_builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") { |builder|
+        builder.resource(resource_opts) {
+          builder.identifier(identifierType: hsh["datacite.identifiertype"] || "DOI") {
+            builder.text hsh["datacite.identifier"]
+          }
+          builder.creators {
+            builder.creator {
+              builder.creatorName hsh["datacite.creator"]
+            }
+          }
+          builder.titles {
+            builder.title hsh["datacite.title"]
+          }
+          builder.publisher hsh["datacite.publisher"]
+          builder.publicationYear hsh["datacite.publicationyear"]
+          builder.resourceType(resourceTypeGeneral: hsh["datacite.resourcetypegeneral"]) {
+            builder.text hsh["datacite.resourcetype"]
+          }
+          builder.descriptions {
+            builder.description(descriptionType: "Abstract") {
+              builder.text hsh["datacite.description"]
+            }
+          }
+        }
+      }
+      # Using this save option to prevent NG from rendering new lines and tabs
+      # between nodes. This to help with a cleaner anvl conversion. Similarly,
+      # the sub should just remove the new line after the xml header that NG
+      # adds, ex:
+      #   <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<resource ...
+      xml = xml_builder
+        .to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+        .sub("\n", "")
+
+
+      # Transform the hash
+      hsh.reject! { |k, v| k =~ /^datacite\./ }
+      hsh["datacite"] = xml
+    end
+
+    # Transforms the provided datacite metadata hash into the format appropriate for the Metadata class.
+    # Extracts appropriate fields from the datacite xml and creates the corresponding "datacite.*" keys
+    def self.inverse(hsh)
+      xml = Nokogiri::XML(hsh["datacite"])
+      xmlns = "http://datacite.org/schema/kernel-4"
+      hsh["datacite.identifier"] = xml.at_xpath("/ns:resource/ns:identifier/text()", ns: xmlns).to_s
+      hsh["datacite.identifiertype"] = xml.at_xpath("/ns:resource/ns:identifier/attribute::identifierType", ns: xmlns).to_s
+      hsh["datacite.creator"] = xml.at_xpath("/ns:resource/ns:creators/ns:creator/ns:creatorName/text()", ns: xmlns).to_s
+      hsh["datacite.title"] = xml.at_xpath("/ns:resource/ns:titles/ns:title/text()", ns: xmlns).to_s
+      hsh["datacite.publisher"] = xml.at_xpath("/ns:resource/ns:publisher/text()", ns: xmlns).to_s
+      hsh["datacite.publicationyear"] = xml.at_xpath("/ns:resource/ns:publicationYear/text()", ns: xmlns).to_s
+      hsh["datacite.resourcetype"] = xml.at_xpath("/ns:resource/ns:resourceType/text()", ns: xmlns).to_s
+      hsh["datacite.resourcetypegeneral"] = xml.at_xpath("/ns:resource/ns:resourceType/attribute::resourceTypeGeneral", ns: xmlns).to_s
+      hsh["datacite.description"] = xml.at_xpath("/ns:resource/ns:descriptions/ns:description/text()", ns: xmlns).to_s
+      hsh.delete("datacite")
+    end
+  end
+end

data/spec/fixtures/datacite_xml/empty.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://datacite.org/schema/kernel-4" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd"><identifier identifierType="DOI"></identifier><creators><creator><creatorName/></creator></creators><titles><title/></titles><publisher/><publicationYear/><resourceType resourceTypeGeneral=""></resourceType><descriptions><description descriptionType="Abstract"></description></descriptions></resource>

data/spec/fixtures/datacite_xml/populated.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://datacite.org/schema/kernel-4" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd"><identifier identifierType="TestIdentifierType">TestIdentifier</identifier><creators><creator><creatorName>TestCreatorName</creatorName></creator></creators><titles><title>TestTitle</title></titles><publisher>TestPublisher</publisher><publicationYear>TestPublicationYear</publicationYear><resourceType resourceTypeGeneral="TestResourceTypeGeneral">TestResourceType</resourceType><descriptions><description descriptionType="Abstract">TestDescription</description></descriptions></resource>

data/spec/unit/metadata_transform_datacite_spec.rb

@@ -0,0 +1,169 @@
+module Ezid
+  RSpec.describe MetadataTransformDatacite do
+    describe "#transform" do
+      before(:each) do
+        described_class.transform(test_hash)
+      end
+
+      context "when there are no datacite fields" do
+        let(:test_hash) { {} }
+        let(:expected_xml) { File.read("spec/fixtures/datacite_xml/empty.xml") }
+
+        it "populates a datacite xml field with all required fields as empty" do
+          expect(test_hash["datacite"]).to eq(expected_xml)
+        end
+      end
+
+      context "when there are datacite fields" do
+        let(:test_hash) { {
+          "datacite.identifier" => "TestIdentifier",
+          "datacite.identifiertype" => "TestIdentifierType",
+          "datacite.creator" => "TestCreatorName",
+          "datacite.title"   => "TestTitle",
+          "datacite.publisher" => "TestPublisher",
+          "datacite.publicationyear" => "TestPublicationYear",
+          "datacite.resourcetype" => "TestResourceType",
+          "datacite.resourcetypegeneral" => "TestResourceTypeGeneral",
+          "datacite.description" => "TestDescription",
+          "some.other.field" => "SomeOtherValue",
+        } }
+        let(:expected_xml) { File.read("spec/fixtures/datacite_xml/populated.xml") }
+
+        it "populates a datacite xml field using values from the datacite.* fields" do
+          expect(test_hash["datacite"]).to eq(expected_xml)
+        end
+
+        it "removes the datacite.* fields from the hash" do
+          expect(test_hash.keys).not_to include(
+            "datacite.identifer",
+            "datacite.identifiertype",
+            "datacite.creator",
+            "datacite.title",
+            "datacite.publisher",
+            "datacite.publicationyear",
+            "datacite.resourcetype",
+            "datacite.resourcetypegeneral",
+            "datacite.description",
+          )
+        end
+
+        it "does not remove other fields" do
+          expect(test_hash).to include("some.other.field")
+        end
+      end
+    end
+
+    describe "#inverse" do
+      let(:test_hash) { {
+        "datacite" => test_xml,
+        "some.other.field" => "SomeOtherValue"
+      } }
+
+      before(:each) do
+        described_class.inverse(test_hash)
+      end
+
+
+      context "when there are no datacite fields" do
+        let(:expected_hash) { {
+          "datacite.identifier" => "",
+          "datacite.identifiertype" => "DOI",
+          "datacite.creator" => "",
+          "datacite.description" => "",
+          "datacite.publicationyear" => "",
+          "datacite.publisher" => "",
+          "datacite.resourcetype" => "",
+          "datacite.resourcetypegeneral" => "",
+          "datacite.title" => "",
+        } }
+        let(:test_xml) { File.read("spec/fixtures/datacite_xml/empty.xml") }
+
+        it "populates all required fields as empty" do
+          expect(test_hash).to include(expected_hash)
+        end
+      end
+
+      context "when there are datacite fields" do
+        let(:expected_hash) { {
+          "datacite.identifier" => "TestIdentifier",
+          "datacite.identifiertype" => "TestIdentifierType",
+          "datacite.creator" => "TestCreatorName",
+          "datacite.title"   => "TestTitle",
+          "datacite.publisher" => "TestPublisher",
+          "datacite.publicationyear" => "TestPublicationYear",
+          "datacite.resourcetype" => "TestResourceType",
+          "datacite.resourcetypegeneral" => "TestResourceTypeGeneral",
+          "datacite.description" => "TestDescription",
+        } }
+        let(:test_xml) { File.read("spec/fixtures/datacite_xml/populated.xml") }
+
+        it "populates all fields from the datacite.* fields" do
+          expect(test_hash).to include(expected_hash)
+        end
+
+        it "removes the datacite field" do
+          expect(test_hash).not_to include("datacite")
+        end
+
+        it "does not remove other fields" do
+          expect(test_hash).to include("some.other.field")
+        end
+      end
+    end
+
+    describe "#transform then #inverse" do
+      let(:test_hash) { {
+        "datacite.identifier" => "TestIdentifier",
+        "datacite.identifiertype" => "TestIdentifierType",
+        "datacite.creator" => "TestCreatorName",
+        "datacite.title"   => "TestTitle",
+        "datacite.publisher" => "TestPublisher",
+        "datacite.publicationyear" => "TestPublicationYear",
+        "datacite.resourcetype" => "TestResourceType",
+        "datacite.resourcetypegeneral" => "TestResourceTypeGeneral",
+        "datacite.description" => "TestDescription",
+        "some.other.field" => "SomeOtherValue",
+      } }
+
+      before(:each) do
+        described_class.transform(test_hash)
+        described_class.inverse(test_hash)
+      end
+
+      it "is a lossless transformation" do
+        expect(test_hash).to eq({
+          "datacite.identifier" => "TestIdentifier",
+          "datacite.identifiertype" => "TestIdentifierType",
+          "datacite.creator" => "TestCreatorName",
+          "datacite.title"   => "TestTitle",
+          "datacite.publisher" => "TestPublisher",
+          "datacite.publicationyear" => "TestPublicationYear",
+          "datacite.resourcetype" => "TestResourceType",
+          "datacite.resourcetypegeneral" => "TestResourceTypeGeneral",
+          "datacite.description" => "TestDescription",
+          "some.other.field" => "SomeOtherValue",
+        })
+      end
+    end
+
+    describe "#inverse then #transform" do
+      let(:test_xml) { File.read("spec/fixtures/datacite_xml/empty.xml") }
+      let(:test_hash) { {
+        "datacite" => test_xml,
+        "some.other.field" => "SomeOtherValue"
+      } }
+
+      before(:each) do
+        described_class.inverse(test_hash)
+        described_class.transform(test_hash)
+      end
+
+      it "is a lossless transformation" do
+        expect(test_hash).to eq({
+          "datacite" => test_xml,
+          "some.other.field" => "SomeOtherValue"
+        })
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +138,7 @@ files:
 - lib/ezid/error.rb
 - lib/ezid/identifier.rb
 - lib/ezid/metadata.rb
+- lib/ezid/metadata_transforms/datacite.rb
 - lib/ezid/proxy_identifier.rb
 - lib/ezid/requests/batch_download_request.rb
 - lib/ezid/requests/create_identifier_request.rb
@@ -139,6 +168,8 @@ files:
 - lib/ezid/status.rb
 - lib/ezid/test_helper.rb
 - spec/fixtures/anvl_batch.txt
+- spec/fixtures/datacite_xml/empty.xml
+- spec/fixtures/datacite_xml/populated.xml
 - spec/integration/batch_download_spec.rb
 - spec/integration/client_spec.rb
 - spec/integration/identifier_spec.rb
@@ -148,6 +179,7 @@ files:
 - spec/unit/client_spec.rb
 - spec/unit/identifier_spec.rb
 - spec/unit/metadata_spec.rb
+- spec/unit/metadata_transform_datacite_spec.rb
 - spec/unit/proxy_identifier_spec.rb
 homepage: https://github.com/duke-libraries/ezid-client
 licenses:
@@ -169,12 +201,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby client for EZID API Version 2
 test_files:
 - spec/fixtures/anvl_batch.txt
+- spec/fixtures/datacite_xml/empty.xml
+- spec/fixtures/datacite_xml/populated.xml
 - spec/integration/batch_download_spec.rb
 - spec/integration/client_spec.rb
 - spec/integration/identifier_spec.rb
@@ -184,4 +218,5 @@ test_files:
 - spec/unit/client_spec.rb
 - spec/unit/identifier_spec.rb
 - spec/unit/metadata_spec.rb
+- spec/unit/metadata_transform_datacite_spec.rb
 - spec/unit/proxy_identifier_spec.rb