ezid-client 1.6.0 → 1.9.0

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/lib/ezid/requests/request.rb

@@ -1,9 +1,10 @@
-require "delegate"
-require "uri"
-require "net/http"
-require "forwardable"
+require 'delegate'
+require 'uri'
+require 'net/http'
+require 'forwardable'
+require 'date'
 
-require_relative "../responses/response"
+require_relative '../responses/response'
 
 module Ezid
   #
@@ -31,7 +32,7 @@ module Ezid
       end
 
       def short_name
-        name.split("::").last.sub("Request", "")
+        name.split('::').last.sub('Request', '')
       end
     end
 
@@ -42,13 +43,24 @@ module Ezid
     def initialize(client, *args)
       @client = client
       super build_request
-      set_content_type("text/plain", charset: "UTF-8")
+      set_content_type('text/plain', charset: 'UTF-8')
     end
 
     # Executes the request and returns the response
     # @return [Ezid::Response] the response
     def execute
-      response_class.new(get_response_for_request)
+      retries = 0
+      begin
+        response_class.new(get_response_for_request)
+      rescue Net::HTTPServerException, UnexpectedResponseError => e
+        if retries < 2
+          sleep 15
+          retries += 1
+          retry
+        else
+          raise
+        end
+      end
     end
 
     # The request URI
@@ -91,6 +103,7 @@ module Ezid
 
     def get_response_for_request
       connection.start do |conn|
+        self['Accept'] = 'text/plain'
         add_authentication if authentication_required?
         add_metadata if has_metadata?
         conn.request(__getobj__)
@@ -113,7 +126,7 @@ module Ezid
     # Adds authentication data to the request
     def add_authentication
       if session.open?
-        self["Cookie"] = session.cookie
+        self['Cookie'] = session.cookie
       else
         basic_auth(user, password)
       end

data/lib/ezid/responses/response.rb

@@ -14,6 +14,19 @@ module Ezid
     # Error response status
     ERROR = "error".freeze
 
+    def initialize(http_response)
+      super
+
+      unless __getobj__.code =~ /2\d\d/
+        raise Error, "HTTP response error: %s %s" %
+                     [ __getobj__.code, __getobj__.message ]
+      end
+
+      unless status_line =~ /^(#{SUCCESS}|#{ERROR}): /
+        raise UnexpectedResponseError, __getobj__.body
+      end
+    end
+
     # The response status -- "success" or "error"
     # @return [String] the status
     def status

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/integration/batch_download_spec.rb

@@ -1,18 +1,18 @@
 require 'tempfile'
 
 module Ezid
-  RSpec.describe BatchDownload do
+  RSpec.describe BatchDownload, ezid: true do
 
     subject do
       a_week_ago = (Time.now - (7*24*60*60)).to_i
       described_class.new(:anvl, compression: "zip", permanence: "test", status: "public", createdAfter: a_week_ago)
     end
 
-    its(:download_url) { is_expected.to match(/\Ahttp:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/) }
-
     specify {
+      expect(subject.download_url).to match(/\Ahttps:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/)
+      expect(subject.url).to match(/\Ahttps:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/)
       Dir.mktmpdir do |tmpdir|
-        expect(subject.download_file(path: tmpdir))
+        expect(subject.file(path: tmpdir))
           .to match(/\A#{tmpdir}\/\w+\.zip\z/)
       end
     }

data/spec/integration/client_spec.rb

@@ -1,7 +1,7 @@
 require "time"
 
 module Ezid
-  RSpec.describe Client, integration: true do
+  RSpec.describe Client, ezid: true do
 
     shared_examples "an EZID client" do |client|
       it "should mint and modify" do

data/spec/integration/identifier_spec.rb

@@ -1,5 +1,5 @@
 module Ezid
-  RSpec.describe Identifier, integration: true do
+  RSpec.describe Identifier, ezid: true do
 
     before {
       @identifier = described_class.mint(TEST_ARK_SHOULDER, target: "http://example.com")
@@ -38,7 +38,8 @@ module Ezid
       end
       describe "delete" do
         subject { described_class.mint(TEST_ARK_SHOULDER, status: "reserved") }
-        it "deletes the identifier" do
+        # Getting 400 Bad Request response - DCS 3/22/21
+        xit "deletes the identifier" do
           subject.delete
           expect(subject).to be_deleted
           expect { described_class.find(subject.id) }.to raise_error(IdentifierNotFoundError)

data/spec/spec_helper.rb

@@ -15,6 +15,8 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
+require "byebug"
+
 require "rspec/its"
 
 require "ezid/test_helper"
@@ -61,7 +63,7 @@ RSpec.configure do |config|
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  config.warnings = false
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
@@ -76,7 +78,7 @@ RSpec.configure do |config|
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 5
+  #config.profile_examples = 5
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

data/spec/unit/{batch_enumerator_spec.rb → batch_spec.rb}

@@ -1,7 +1,7 @@
-require 'ezid/batch_enumerator'
+require 'ezid/batch'
 
 module Ezid
-  RSpec.describe BatchEnumerator do
+  RSpec.describe Batch do
 
     let(:batch_file) { File.expand_path("../../fixtures/anvl_batch.txt", __FILE__) }
 

data/spec/unit/client_spec.rb

@@ -1,7 +1,15 @@
 module Ezid
   RSpec.describe Client do
 
+    let(:http_response) { double }
+
+    before do
+      allow(http_response).to receive(:value) { nil }
+      allow(http_response).to receive(:code) { '200' }
+    end
+
     describe "initialization without a block" do
+      let(:http_response) { double }
       it "should not login" do
         expect_any_instance_of(described_class).not_to receive(:login)
         described_class.new
@@ -151,9 +159,33 @@ EOS
     end
 
     describe "error handling" do
-      let(:http_response) { double(body: "error: bad request - no such identifier") }
-      it "should raise an exception" do
-        expect { subject.get_identifier_metadata("invalid") }.to raise_error(Error)
+      let(:stub_response) { GetIdentifierMetadataResponse.new(http_response) }
+      before do
+        allow(GetIdentifierMetadataRequest).to receive(:execute).with(subject, "invalid") { stub_response }
+      end
+
+      describe "HTTP error response" do
+        before do
+          allow(http_response).to receive(:code) { '500' }
+          allow(http_response).to receive(:message) { 'Internal Server Error' }
+        end
+        it "should raise an exception" do
+          expect { subject.get_identifier_metadata("invalid") }.to raise_error(Error)
+        end
+      end
+
+      describe "EZID API error response" do
+        let(:http_response) { double(body: "error: bad request - no such identifier") }
+        it "should raise an exception" do
+          expect { subject.get_identifier_metadata("invalid") }.to raise_error(Error)
+        end
+      end
+
+      describe "Unexpected response" do
+        let(:http_response) { double(body: "<html>\n<head><title>Ouch!</title></head>\n<body>Help!</body>\n</html>") }
+        it "should raise an exception" do
+          expect { subject.get_identifier_metadata("invalid") }.to raise_error(UnexpectedResponseError)
+        end
       end
     end
   end

data/spec/unit/identifier_spec.rb

@@ -1,6 +1,39 @@
 module Ezid
   RSpec.describe Identifier do
+
     describe "class methods" do
+
+      describe ".load" do
+        subject { described_class.load("ark:/99999/fk4086hs23", metadata) }
+        describe "with ANVL metadata" do
+          let(:metadata) do
+            <<-EOS
+_updated: 1488227717
+_target: http://example.com
+_profile: erc
+_ownergroup: apitest
+_owner: apitest
+_export: yes
+_created: 1488227717
+_status: public
+            EOS
+          end
+          its(:remote_metadata) {
+            is_expected.to eq({"_updated"=>"1488227717",
+                               "_target"=>"http://example.com",
+                               "_profile"=>"erc",
+                               "_ownergroup"=>"apitest",
+                               "_owner"=>"apitest",
+                               "_export"=>"yes",
+                               "_created"=>"1488227717",
+                               "_status"=>"public"})
+          }
+        end
+        describe "with nil" do
+          let(:metadata) { nil }
+          its(:remote_metadata) { is_expected.to be_empty }
+        end
+      end
       describe ".create" do
         describe "with id and metadata args" do
           it "instantiates a new Identifier and saves it" do
@@ -63,6 +96,7 @@ module Ezid
     end
 
     describe "instance methods" do
+
       describe "#initialize" do
         before {
           allow(described_class).to receive(:defaults) { defaults }
@@ -129,7 +163,7 @@ module Ezid
             its(:client) { is_expected.to_not eq(client) }
           end
         end
-      end
+      end # initialize
 
       describe "#update" do
         let(:metadata) { {"status" => "unavailable"} }
@@ -172,12 +206,23 @@ module Ezid
       end
 
       describe "#load_metadata" do
+        subject { described_class.new("id") }
         let(:metadata) { "_profile: erc" }
-        before { allow(subject).to receive(:id) { "id" } }
         it "replaces the remote metadata with metadata from EZID" do
           expect(subject.client).to receive(:get_identifier_metadata).with("id") { double(id: "id", metadata: metadata) }
-          expect(subject.remote_metadata).to receive(:replace).with(metadata)
           subject.load_metadata
+          expect(subject.remote_metadata).to eq({"_profile"=>"erc"})
+          expect(subject).to be_persisted
+        end
+      end
+
+      describe "#load_metadata!" do
+        subject { described_class.new("id") }
+        let(:metadata) { "_profile: erc" }
+        it "replaces the remote metadata with the provided metadata" do
+          subject.load_metadata!(metadata)
+          expect(subject.remote_metadata).to eq({"_profile"=>"erc"})
+          expect(subject).to be_persisted
         end
       end
 
@@ -323,23 +368,11 @@ module Ezid
           context "when the status is \"unavailable\"" do
             let(:status) { "#{Status::UNAVAILABLE} | whatever" }
             context "and no reason is given" do
-              it "logs a warning" do
-                pending "https://github.com/duke-libraries/ezid-client/issues/46"
-                allow_message_expectations_on_nil
-                expect(subject.logger).to receive(:warn)
-                subject.unavailable!
-              end
               it "does not change the status" do
                 expect { subject.unavailable! }.not_to change(subject, :status)
               end
             end
             context "and a reason is given" do
-              it "logs a warning" do
-                pending "https://github.com/duke-libraries/ezid-client/issues/46"
-                allow_message_expectations_on_nil
-                expect(subject.logger).to receive(:warn)
-                subject.unavailable!("because")
-              end
               it "should change the status" do
                 expect { subject.unavailable!("because") }.to change(subject, :status).from(status).to("#{Status::UNAVAILABLE} | because")
               end
@@ -382,5 +415,11 @@ module Ezid
         end
       end
     end
+
+    describe "#metadata" do
+      it "is frozen" do
+        expect { subject.metadata["foo"] = "bar" }.to raise_error(RuntimeError)
+      end
+    end
   end
 end