ezid-client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 024d805940fcc9a0ccbe8ed0e6e80177d05393f6
-  data.tar.gz: e488fafa09132f630a2047cd4008fd653a9a221a
+  metadata.gz: 044a6bd05e5a81f2990f4d865515af5f1679e853
+  data.tar.gz: 7d45fe9bca596a17562812f5a6adf4ef73649665
 SHA512:
-  metadata.gz: 3f32330825caf59ba03f3e7765226fe5f9aaef98877a12c9ac1396ac98a2511863f57f9b2619adea40d425b9b09ae5c97b311614d1b9e21a52ec4007217a9511
-  data.tar.gz: 4972d261b297f95f763499c92882fe1600238a3e5865bd510b41dc780ba33904f22b17f95fc1c87ff9aaeddfdb6e761b53c1159d9d011f920e7bfc7818a433e5
+  metadata.gz: 49710a5dd7aed59d88ae6e2463267ee429534d46597096684d16236d8d54c7eeb8bced1f12b7ed196f8e8eba8c7a2e9505244ec8a97d6c6b60019279e8a50ad8
+  data.tar.gz: 7084e2afebd769a138109732c01e6017eea687f6c1eb3f3ced5f84e18862dad2f4030a7830271d97cbceb88c69d9024d615b9a3b053da4d6f172615e2798149d

data/README.md

@@ -1,4 +1,4 @@
-# Ezid::Client
+# EZID Client
 
 EZID API Version 2 bindings. See http://ezid.cdlib.org/doc/apidoc.html.
 
@@ -71,7 +71,7 @@ I, [2014-12-04T15:12:48.853964 #86734]  INFO -- : EZID DELETE ark:/99999/fk4n58p
 
 ## Metadata handling
 
-See `Ezid::Metadata` class and examples in `spec/unit/metadata_spec.rb`.
+Although "EZID imposes no requirements on the presence or form of citation metadata"[*](http://ezid.cdlib.org/doc/apidoc.html#metadata-requirements-mapping), `ezid-client` is intended to support the EZID [reserved metadata elements](http://ezid.cdlib.org/doc/apidoc.html#internal-metadata) and [metadata profiles](http://ezid.cdlib.org/doc/apidoc.html#metadata-profiles). While it is possible to use the client to send and receive any metadata, the object methods are geared towards the defined elements.  Therefore it was seen fit, for example, to map the method `Ezid::Identifier#status` to the "_status" element.  Likewise, all the reserved elements, except for "_crossref", have readers and -- for user-writable elements -- writers without the leading underscores.  Since there are both "_crossref" and "crossref" elements, their accessors match the elements names.  Similarly, accessors for metadata profile elements use underscores in place of dots -- for example, `Ezid::Identifer#dc_title` and `#dc_title=` for the "dc.title" element.
 
 ## Authentication
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/ezid/client.rb

@@ -107,7 +107,8 @@ module Ezid
     # @param metadata [String, Hash, Ezid::Metadata] metadata to set
     # @raise [Ezid::Error]
     # @return [Ezid::Response] the response
-    def mint_identifier(shoulder, metadata=nil)
+    def mint_identifier(shoulder=nil, metadata=nil)
+      shoulder ||= config.default_shoulder
       raise Error, "Shoulder missing -- cannot mint identifier." unless shoulder
       response = Request.execute(:Post, "/shoulder/#{shoulder}") do |request|
         add_authentication(request)

data/lib/ezid/configuration.rb

@@ -10,42 +10,43 @@ module Ezid
   class Configuration
 
     # EZID user name
-    #   Default: value of EZID_USER environment variable
+    #   Default: value of `EZID_USER` environment variable
     attr_accessor :user
 
     # EZID password
-    #   Default: value of EZID_PASSWORD environment variable
+    #   Default: value of `EZID_PASSWORD` environment variable
     attr_accessor :password
 
     # Ruby logger instance
     #   Default device: STDERR
     attr_writer :logger
 
-    # Default metadata profile
+    # Default metadata profile - "erc" (EZID default), "dc", "datacite", or "crossref"
+    # If set, new identifiers (created or minted) will set the "_profile" element to 
+    # this value.
     # attr_accessor :default_metadata_profile
 
-    # Default status - set only if default should not "public" (EZID default)
+    # Default status - "public" (EZID default), "reserved", or "unavailable"
+    # If set, new identifiers (created or minted) will set the "_status" element to
+    # this value.
     # attr_accessor :default_status
 
-    # Default shoulder for minting
-    # attr_accessor :default_shoulder
-
-    # Hash of options to pass to Net::HTTP.start
-    # attr_accessor :http_request_options
+    # Default shoulder for minting (scheme + NAAN + shoulder)
+    # @example "ark:/99999/fk4"
+    attr_accessor :default_shoulder
 
     def initialize
       @user = ENV["EZID_USER"]
       @password = ENV["EZID_PASSWORD"]
-      # @http_request_options = default_http_request_options
     end
 
     def logger
       @logger ||= Logger.new(STDERR)
     end
 
-    # def default_http_request_options
-    #   { use_ssl: true }
-    # end
+    def identifier
+      Identifier
+    end
 
   end
 end

data/lib/ezid/identifier.rb

@@ -23,7 +23,9 @@ module Ezid
     RESERVED = "reserved"
     UNAVAILABLE = "unavailable"
 
-    class << self
+    class << self      
+      attr_accessor :defaults
+
       # Creates or mints an identifier (depending on arguments)
       # @see #save
       # @return [Ezid::Identifier] the new identifier
@@ -42,13 +44,14 @@ module Ezid
       end
     end
 
+    self.defaults = {}
+
     def initialize(args={})
       @client = args.delete(:client) || Client.new
       @id = args.delete(:id)
       @shoulder = args.delete(:shoulder)
-      @metadata = Metadata.new(args.delete(:metadata))
-      update_metadata(args)
       @deleted = false
+      init_metadata(args)
     end
 
     def inspect
@@ -73,11 +76,7 @@ module Ezid
     #   with an error status.
     def save
       raise Error, "Cannot save a deleted identifier." if deleted?
-      if persisted?
-        modify
-      else
-        create_or_mint
-      end
+      persisted? ? modify : create_or_mint
       reload
     end
 
@@ -154,13 +153,6 @@ module Ezid
       status == UNAVAILABLE
     end
 
-    protected
-
-    def method_missing(name, *args)
-      return metadata.send(name, *args) if metadata.respond_to?(name)
-      super
-    end
-
     private
 
     def refresh_metadata
@@ -177,13 +169,7 @@ module Ezid
     end
 
     def create_or_mint
-      if id
-        create
-      elsif shoulder
-        mint
-      else
-        raise Error, "Unable to create or mint identifier when neither `id' nor `shoulder' present."
-      end
+      id ? create : mint
     end
 
     def mint
@@ -195,8 +181,9 @@ module Ezid
       client.create_identifier(id, metadata)
     end
 
-    def init_metadata(args={})
+    def init_metadata(args)
+      @metadata = Metadata.new(args.delete(:metadata))
+      update_metadata(self.class.defaults.merge(args))
     end
-
   end
 end

data/spec/integration/identifier_spec.rb

@@ -1,21 +1,55 @@
+
+
 module Ezid
   RSpec.describe Identifier do
 
-    it "should handle CRUD operations" do
-      # create (mint)
-      identifier = described_class.create(shoulder: ARK_SHOULDER)
-      expect(identifier.status).to eq("public")
-      # update
-      identifier.target = "http://example.com"
-      identifier.save
-      # retrieve
-      identifier = described_class.find(identifier.id)
-      expect(identifier.target).to eq("http://example.com")
-      # delete
-      identifier = described_class.create(shoulder: ARK_SHOULDER, status: "reserved")
-      identifier.delete
-      expect { described_class.find(identifier.id) }.to raise_error
-    end
+    describe "CRUD operations" do
+      describe "create" do
+        describe "with a shoulder" do
+          subject { described_class.create(shoulder: ARK_SHOULDER) }
+          it "should mint an identifier" do
+            expect(subject).to be_a(described_class)
+            expect(subject.id).to match(/#{ARK_SHOULDER}/)
+          end
+        end
+        describe "with an id" do
+          let(:minted) { described_class.create(shoulder: ARK_SHOULDER) }
+          subject { described_class.create(id: "#{minted}/123") }
+          it "should create the identifier" do
+            expect(subject).to be_a(described_class)
+            expect(subject.id).to eq("#{minted}/123")
+          end
+        end
+      end
 
+      describe "retrieve" do
+        let(:minted) { described_class.create(shoulder: ARK_SHOULDER, target: "http://example.com") }
+        subject { described_class.find(minted.id) }
+        it "should instantiate the identifier" do
+          expect(subject).to be_a(described_class)
+          expect(subject.id).to eq(minted.id)
+          expect(subject.target).to eq("http://example.com")
+        end
+      end
+
+      describe "update" do
+        subject { described_class.create(shoulder: ARK_SHOULDER, target: "http://google.com") }
+        before do
+          subject.target = "http://example.com"
+          subject.save
+        end
+        it "should update the metadata" do
+          expect(subject.target).to eq("http://example.com")
+        end
+      end
+
+      describe "delete" do
+        subject { described_class.create(shoulder: ARK_SHOULDER, status: "reserved") }
+        before { subject.delete }
+        it "should delete the identifier" do
+          expect { described_class.find(subject.id) }.to raise_error
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -86,7 +86,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 = 10
+  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/client_spec.rb

@@ -23,9 +23,9 @@ module Ezid
     end
 
     describe "#mint_identifier" do
-      before { allow(Request).to receive(:execute) { stub_response } }
       describe "which is an ARK" do
         let(:stub_response) { Response.new(double(body: "success: ark:/99999/fk4fn19h88")) }
+        before { allow(Request).to receive(:execute).with(:Post, "/shoulder/#{ARK_SHOULDER}") { stub_response } }
         subject { described_class.new.mint_identifier(ARK_SHOULDER) }
         it "should be a succes" do
           expect(subject).to be_success
@@ -44,6 +44,7 @@ datacite.publicationyear: 2014
 datacite.resourcetype: Other
 EOS
         end
+        before { allow(Request).to receive(:execute).with(:Post, "/shoulder/#{DOI_SHOULDER}") { stub_response } }
         subject { described_class.new.mint_identifier(DOI_SHOULDER, metadata) }
         it "should be a sucess" do          
           expect(subject).to be_success
@@ -51,6 +52,24 @@ EOS
           expect(subject.shadow_ark).to eq("ark:/99999/fk4fn19h88")
         end
       end
+      describe "when a shoulder is not given" do
+        let(:stub_response) { Response.new(double(body: "success: ark:/99999/fk4fn19h88")) }
+        context "and the :default_shoulder config option is set" do
+          subject { described_class.new.mint_identifier }
+          before do
+            allow(Request).to receive(:execute).with(:Post, "/shoulder/#{ARK_SHOULDER}") { stub_response } 
+            allow(Client.config).to receive(:default_shoulder) { ARK_SHOULDER }         
+          end
+          it "should use the default shoulder" do
+            expect(subject).to be_success
+          end
+        end
+        context "and the :default_shoulder config option is not set" do
+          it "should raise an exception" do
+            expect { described_class.new.mint_identifier }.to raise_error
+          end
+        end
+      end
     end
 
     describe "#get_identifier_metadata" do

data/spec/unit/identifier_spec.rb

@@ -2,91 +2,87 @@ module Ezid
   RSpec.describe Identifier do
 
     describe ".create" do
-      describe "when given an id" do
-        let(:id) { "ark:/99999/fk4zzzzzzz" }
-        subject { described_class.create(id: id) }
-        before do
-          allow_any_instance_of(Client).to receive(:create_identifier).with(id, {}) { double(id: id) }
-          allow_any_instance_of(Client).to receive(:get_identifier_metadata).with(id) { double(metadata: {}) }
-        end
-        it "should create an identifier" do
-          expect(subject).to be_a(described_class)
-          expect(subject.id).to eq(id)
-        end
-      end
-      describe "when given a shoulder (and no id)" do
-        let(:id) { "ark:/99999/fk4fn19h88" }
-        subject { described_class.create(shoulder: ARK_SHOULDER) }
-        before do
-          allow_any_instance_of(Client).to receive(:mint_identifier).with(ARK_SHOULDER, {}) { double(id: id) }
-          allow_any_instance_of(Client).to receive(:get_identifier_metadata).with(id) { double(metadata: {}) }
-        end
-        it "should mint an identifier" do
-          expect(subject).to be_a(described_class)
-          expect(subject.id).to eq(id)
-        end
+      let(:attrs) { {shoulder: ARK_SHOULDER, profile: "dc", target: "http://example.com"} }
+      it "should instantiate a new Identifier and save it" do        
+        expect(described_class).to receive(:new).with(attrs).and_call_original
+        expect_any_instance_of(described_class).to receive(:save) { double }
+        described_class.create(attrs)
       end
       describe "when given neither an id nor a shoulder" do
+        before { allow(described_class).to receive(:defaults) {} }
         it "should raise an exception" do
           expect { described_class.create }.to raise_error
         end
       end
-      describe "with metadata" do
-        it "should send the metadata"
-      end
     end
 
     describe ".find" do
-      describe "when the id exists" do
-        let(:id) { "ark:/99999/fk4fn19h88" }
-        subject { described_class.find(id) }
-        before do
-          allow_any_instance_of(Client).to receive(:get_identifier_metadata).with(id) { double(id: id, metadata: {}) }
+      it "should instantiate a new identifier and reload" do
+        expect(described_class).to receive(:new).with(id: "id").and_call_original
+        expect_any_instance_of(described_class).to receive(:reload) { double }
+        described_class.find("id")
+      end
+    end
+
+    describe ".defaults" do
+      before { @original_defaults = described_class.defaults }
+      after { described_class.defaults = @original_defaults }
+      it "should be settable via client config" do
+        Client.config.identifier.defaults = {status: "reserved"}
+        expect(described_class.defaults).to eq({status: "reserved"})
+      end
+    end
+
+    describe "#initialize" do
+      describe "with metadata" do
+        describe "via the :metadata argument" do
+          subject { described_class.new(metadata: "_profile: dc\n_target: http://example.com") }
+          it "should set the metadata" do
+            expect(subject.profile).to eq("dc")
+            expect(subject.target).to eq("http://example.com")
+          end
         end
-        it "should get the identifier" do
-          expect(subject).to be_a(Identifier)
-          expect(subject.id).to eq(id)
+        describe "via keyword arguments" do
+          subject { described_class.new(profile: "dc", target: "http://example.com") }
+          it "should set the metadata" do
+            expect(subject.profile).to eq("dc")
+            expect(subject.target).to eq("http://example.com")
+          end
         end
       end
-      describe "when the id does not exist" do
-        let(:id) { "ark:/99999/fk4zzzzzzz" }
+      describe "default metadata" do
         before do
-          allow_any_instance_of(Client).to receive(:get_identifier_metadata).with(id).and_raise(Error)
+          allow(described_class).to receive(:defaults) { {profile: "dc", status: "reserved"} }
         end
-        it "should raise an exception" do
-          expect { described_class.find(id) }.to raise_error
+        it "should set the default metadata" do
+          expect(subject.profile).to eq("dc")
+          expect(subject.status).to eq("reserved")
+        end
+        context "when explicit arguments override the defaults" do
+          subject { described_class.new(shoulder: ARK_SHOULDER, status: "public") }
+          it "should override the defaults" do
+            expect(subject.profile).to eq("dc")
+            expect(subject.status).to eq("public")
+          end
         end
       end
     end
     
     describe "#update" do
-      let(:id) { "ark:/99999/fk4fn19h88" }
       let(:metadata) { {"status" => "unavailable"} }
-      subject { described_class.new(id: id) }
-      before do
-        allow(subject).to receive(:persisted?) { true }
-        allow(subject.client).to receive(:modify_identifier).with(id, subject.metadata) do
-          double(id: id, metadata: {})
-        end
-      end
-      it "should update the metadata" do
+      subject { described_class.new(id: "id") }
+      it "should update the metadata and save" do
         expect(subject).to receive(:update_metadata).with(metadata)
-        subject.update(metadata)
-      end
-      it "should save the identifier" do
-        expect(subject).to receive(:save)
+        expect(subject).to receive(:save) { double }
         subject.update(metadata)
       end
     end
 
     describe "#reload" do
-      let(:id) { "ark:/99999/fk4fn19h88" }
-      let(:metadata) { "_created: 1416507086" }
-      subject { described_class.new(id: id) }
-      before do
-        allow(subject.client).to receive(:get_identifier_metadata).with(id) { double(metadata: metadata) }
-      end
+      let(:metadata) { "_profile: erc" }
+      before { allow(subject).to receive(:id) { "id" } }
       it "should reinitialize the metadata from EZID" do
+        expect(subject.client).to receive(:get_identifier_metadata).with("id") { double(id: "id", metadata: metadata) }
         expect(Metadata).to receive(:new).with(metadata)
         subject.reload
       end
@@ -121,31 +117,23 @@ module Ezid
     end
 
     describe "#delete" do
-      let(:id) { "ark:/99999/fk4zzzzzzz" }
-      subject { described_class.new(id: id, status: "reserved") }
-      before do
-        allow_any_instance_of(Client).to receive(:delete_identifier).with(id) { double(id: id) }
-      end
+      subject { described_class.new(id: "id", status: "reserved") }
       it "should delete the identifier" do
-        expect(subject.client).to receive(:delete_identifier).with(id)
+        expect(subject.client).to receive(:delete_identifier).with("id") { double(id: "id") }
         subject.delete
         expect(subject).to be_deleted
       end
     end
 
     describe "#save" do
-      let(:id) { "ark:/99999/fk4zzzzzzz" }
-      before do
-        allow(subject.client).to receive(:get_identifier_metadata).with(id) { double(metadata: {}) }
-      end
+      before { allow(subject).to receive(:reload) { double } }
       context "when the identifier is persisted" do
         before do
-          allow_any_instance_of(Client).to receive(:modify_identifier).with(id, {}) { double(id: id) }
-          allow(subject).to receive(:id) { id }
+          allow(subject).to receive(:id) { "id" }
           allow(subject).to receive(:persisted?) { true }
         end
         it "should modify the identifier" do
-          expect(subject.client).to receive(:modify_identifier).with(id, {})
+          expect(subject.client).to receive(:modify_identifier).with("id", {}) { double(id: "id") }
           subject.save
         end
       end
@@ -154,23 +142,17 @@ module Ezid
           allow(subject).to receive(:persisted?) { false }
         end
         context "and `id' is present" do
-          before do
-            allow(subject).to receive(:id) { id }
-            allow_any_instance_of(Client).to receive(:create_identifier).with(id, {}) { double(id: id) }
-          end
+          before { allow(subject).to receive(:id) { "id" } }
           it "should create the identifier" do
-            expect(subject.client).to receive(:create_identifier).with(id, {})
+            expect(subject.client).to receive(:create_identifier).with("id", {}) { double(id: "id") }
             subject.save
           end
         end
         context "and `id' is not present" do
           context "and `shoulder' is present" do
-            before do
-              allow(subject).to receive(:shoulder) { ARK_SHOULDER }
-              allow_any_instance_of(Client).to receive(:mint_identifier).with(ARK_SHOULDER, {}) { double(id: id) }
-            end
+            before { allow(subject).to receive(:shoulder) { ARK_SHOULDER } }
             it "should mint the identifier" do
-              expect(subject.client).to receive(:mint_identifier).with(ARK_SHOULDER, {})
+              expect(subject.client).to receive(:mint_identifier).with(ARK_SHOULDER, {}) { double(id: "id") }
               subject.save
             end
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler