RubyGems - ezid-client - Versions diffs - 1.5.0 → 1.9.0.rc1 - Mend

ezid-client 1.5.0 → 1.9.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

checksums.yaml +5 -5
data/.github/workflows/ruby.yml +35 -0
data/README.md +59 -13
data/Rakefile +6 -6
data/VERSION +1 -1
data/ezid-client.gemspec +5 -3
data/lib/ezid/batch.rb +42 -0
data/lib/ezid/batch_download.rb +35 -21
data/lib/ezid/client.rb +11 -10
data/lib/ezid/configuration.rb +11 -4
data/lib/ezid/error.rb +2 -0
data/lib/ezid/identifier.rb +57 -20
data/lib/ezid/metadata.rb +11 -1
data/lib/ezid/metadata_transforms/datacite.rb +72 -0
data/lib/ezid/requests/request.rb +22 -9
data/lib/ezid/responses/response.rb +13 -0
data/spec/fixtures/anvl_batch.txt +39 -0
data/spec/fixtures/datacite_xml/empty.xml +1 -0
data/spec/fixtures/datacite_xml/populated.xml +1 -0
data/spec/integration/batch_download_spec.rb +21 -0
data/spec/integration/client_spec.rb +1 -1
data/spec/integration/identifier_spec.rb +3 -2
data/spec/spec_helper.rb +4 -2
data/spec/unit/batch_spec.rb +34 -0
data/spec/unit/client_spec.rb +35 -3
data/spec/unit/identifier_spec.rb +54 -15
data/spec/unit/metadata_spec.rb +2 -0
data/spec/unit/metadata_transform_datacite_spec.rb +169 -0
metadata +60 -21
data/.travis.yml +0 -9
data/spec/unit/batch_download_spec.rb +0 -5

data/spec/unit/batch_spec.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'ezid/batch'
+module Ezid
+  RSpec.describe Batch do
+    let(:batch_file) { File.expand_path("../../fixtures/anvl_batch.txt", __FILE__) }
+    subject { described_class.new(:anvl, batch_file) }
+    its(:count) { is_expected.to eq 4 }
+    specify {
+      subject.each do |id|
+        expect(id).to be_a(Identifier)
+      end
+    }
+    specify {
+      batch_array = subject.to_a
+      expect(batch_array.length).to eq 4
+    }
+    specify {
+      ids = subject.map(&:id)
+      expect(ids).to eq ["ark:/99999/fk4086hs23", "ark:/99999/fk4086hs23/123", "ark:/99999/fk40p1bb85", "ark:/99999/fk40z7fh7x"]
+    }
+    specify {
+      id = subject.first
+      expect(id.target).to eq "http://example.com"
+    }
+  end
+end

data/spec/unit/client_spec.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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

data/spec/unit/metadata_spec.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'time'
 module Ezid
   RSpec.describe Metadata do
     describe "initializer" do

data/spec/unit/metadata_transform_datacite_spec.rb ADDED Viewed

@@ -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 CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.9.0.rc1
 platform: ruby
 authors:
 - David Chandek-Stark
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -30,34 +30,62 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
+- !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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -93,9 +121,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -103,12 +131,14 @@ files:
 - VERSION
 - ezid-client.gemspec
 - lib/ezid-client.rb
+- lib/ezid/batch.rb
 - lib/ezid/batch_download.rb
 - lib/ezid/client.rb
 - lib/ezid/configuration.rb
 - 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
@@ -137,20 +167,25 @@ files:
 - lib/ezid/session.rb
 - 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
 - spec/spec_helper.rb
 - spec/unit/batch_download_request_spec.rb
-- spec/unit/batch_download_spec.rb
+- spec/unit/batch_spec.rb
 - 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:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,25 +193,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.3
-signing_key:
+rubygems_version: 3.0.8
+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
 - spec/spec_helper.rb
 - spec/unit/batch_download_request_spec.rb
-- spec/unit/batch_download_spec.rb
+- spec/unit/batch_spec.rb
 - 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