ezid-client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 044a6bd05e5a81f2990f4d865515af5f1679e853
-  data.tar.gz: 7d45fe9bca596a17562812f5a6adf4ef73649665
+  metadata.gz: 038635d432049119e82aac80465380671287358b
+  data.tar.gz: cfd504d17c9468dffbbb58196f32da8b5f8e1516
 SHA512:
-  metadata.gz: 49710a5dd7aed59d88ae6e2463267ee429534d46597096684d16236d8d54c7eeb8bced1f12b7ed196f8e8eba8c7a2e9505244ec8a97d6c6b60019279e8a50ad8
-  data.tar.gz: 7084e2afebd769a138109732c01e6017eea687f6c1eb3f3ced5f84e18862dad2f4030a7830271d97cbceb88c69d9024d615b9a3b053da4d6f172615e2798149d
+  metadata.gz: 8ff054e688b99800e83f6b1f811100aa45b94d45786cf59de54fdba71189235a2c73c86c1e626dcdaf1c6658e928aa1abf2170c842653cfe4be1b33140705068
+  data.tar.gz: 77f959afe84560d65cac696df47cd85c1e9b26ca6d2cdfa8289d1fb96acd0f581326790c2c82606251373e0ff7c86b4ed1028b7bdb7e9e050816176181fdb1bc

data/README.md

@@ -21,9 +21,11 @@ Or install it yourself as:
 
 ## Basic Resource-oriented Usage (CRUD)
 
-See the test suite for more examples.
+*See the test suite for more examples.*
 
-Create (Mint)
+**Create** (Mint/Create)
+
+[Mint an identifier on a shoulder](http://ezid.cdlib.org/doc/apidoc.html#operation-mint-identifier)
 
 ```ruby
 >> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4")
@@ -38,7 +40,33 @@ I, [2014-12-04T15:06:03.249793 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523
 => "http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523"
 ```
 
-Retrieve (Get)
+A default shoulder can be configured:
+
+```ruby
+Ezid::Client.configure do |config|
+  config.default_shoulder = "ark:/99999/fk4"
+end
+```
+
+Then identifiers can minted on the default shoulder:
+
+```ruby
+>> identifier = Ezid::Identifier.create
+I, [2014-12-09T11:22:34.499860 #32279]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk43f4wd4v
+I, [2014-12-09T11:22:35.317181 #32279]  INFO -- : EZID GET ark:/99999/fk43f4wd4v -- success: ark:/99999/fk43f4wd4v
+=> #<Ezid::Identifier id="ark:/99999/fk43f4wd4v" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk43f4wd4v" created="2014-12-09 16:22:35 UTC">
+```
+
+[Create a specific identifier](http://ezid.cdlib.org/doc/apidoc.html#operation-create-identifier)
+
+```ruby
+>> identifier = Ezid::Identifier.create(id: "ark:/99999/fk4rx9d523/12345")
+I, [2014-12-09T11:21:42.077297 #32279]  INFO -- : EZID CREATE ark:/99999/fk4rx9d523/12345 -- success: ark:/99999/fk4rx9d523/12345
+I, [2014-12-09T11:21:42.808534 #32279]  INFO -- : EZID GET ark:/99999/fk4rx9d523/12345 -- success: ark:/99999/fk4rx9d523/12345
+=> #<Ezid::Identifier id="ark:/99999/fk4rx9d523/12345" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523/12345" created="2014-12-09 16:21:42 UTC">
+```
+
+**Retrieve** (Get Metadata)
 
 ```ruby
 >> identifier = Ezid::Identifier.find("ark:/99999/fk4rx9d523")
@@ -46,18 +74,24 @@ I, [2014-12-04T15:07:00.648676 #86655]  INFO -- : EZID GET ark:/99999/fk4rx9d523
 => #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://ezid.cdlib.org/id/ark:/99999/fk4rx9d523" created="2014-12-04 20:06:02 UTC">
 ```
 
-Update (Modify)
+**Update** (Modify)
 
 ```ruby
+>> identifier.target
+=> "http://ezid.cdlib.org/id/ark:/99999/fk43f4wd4v"
 >> identifier.target = "http://example.com"
 => "http://example.com"
 >> identifier.save
-I, [2014-12-04T15:11:57.263906 #86734]  INFO -- : EZID MODIFY ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
-I, [2014-12-04T15:11:58.099128 #86734]  INFO -- : EZID GET ark:/99999/fk4rx9d523 -- success: ark:/99999/fk4rx9d523
-=> #<Ezid::Identifier id="ark:/99999/fk4rx9d523" status="public" target="http://example.com" created="2014-12-04 20:06:02 UTC">
+I, [2014-12-09T11:24:26.321801 #32279]  INFO -- : EZID MODIFY ark:/99999/fk43f4wd4v -- success: ark:/99999/fk43f4wd4v
+I, [2014-12-09T11:24:27.039288 #32279]  INFO -- : EZID GET ark:/99999/fk43f4wd4v -- success: ark:/99999/fk43f4wd4v
+=> #<Ezid::Identifier id="ark:/99999/fk43f4wd4v" status="public" target="http://example.com" created="2014-12-09 16:22:35 UTC">
+>> identifier.target
+=> "http://example.com"
 ```
 
-Delete
+**Delete** 
+
+*Identifier status must be "reserved" to delete.* http://ezid.cdlib.org/doc/apidoc.html#operation-delete-identifier
 
 ```ruby
 >> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4", status: "reserved")
@@ -73,6 +107,33 @@ I, [2014-12-04T15:12:48.853964 #86734]  INFO -- : EZID DELETE ark:/99999/fk4n58p
 
 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.
 
+**Setting default metadata values**
+
+Default metadata values can be set:
+
+```ruby
+Ezid::Client.configure do |config|
+  # set multiple defaults with a hash
+  config.identifier.defaults = {status: "reserved", profile: "dc"}
+  # or set individual elements
+  config.identifier.defaults[:status] = "reserved"
+  config.identifier.defaults[:profile] = "dc"
+end
+```
+
+Then new identifiers will receive the defaults:
+
+```ruby
+>> identifier = Ezid::Identifier.create(shoulder: "ark:/99999/fk4")
+I, [2014-12-09T11:38:37.335136 #32279]  INFO -- : EZID MINT ark:/99999/fk4 -- success: ark:/99999/fk4zs2w500
+I, [2014-12-09T11:38:38.153546 #32279]  INFO -- : EZID GET ark:/99999/fk4zs2w500 -- success: ark:/99999/fk4zs2w500
+=> #<Ezid::Identifier id="ark:/99999/fk4zs2w500" status="reserved" target="http://ezid.cdlib.org/id/ark:/99999/fk4zs2w500" created="2014-12-09 16:38:38 UTC">
+>> identifier.profile
+=> "dc"
+>> identifier.status
+=> "reserved"
+```
+
 ## Authentication
 
 Credentials can be provided in any -- or a combination -- of these ways:
@@ -94,7 +155,29 @@ end
 client = Ezid::Client.new(user: "eziduser", password: "ezidpass")
 ```
 
-## Running the tests
+## Test Helper
+
+If you have tests that (directly or indirectly) use `ezid-client` you may want to require the test helper module:
+
+```ruby
+require "ezid/test_helper"
+```
+
+The module provides constants:
+
+- `TEST_ARK_SHOULDER` => "ark:/99999/fk4"
+- `TEST_DOI_SHOULDER` => "doi:10.5072/FK2"
+- `TEST_USER` => "apitest"
+
+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.
+
+A convenience method `ezid_test_mode!` is provided to configure the client to:
+
+- authenticate as `TEST_USER`
+- use `TEST_ARK_SHOULDER` as the default shoulder
+- log to the null device (instead of default STDERR)
+
+## Running the ezid-client tests
 
 See http://ezid.cdlib.org/doc/apidoc.html#testing-the-api.
 

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/ezid/test_helper.rb

@@ -0,0 +1,24 @@
+require "ezid-client"
+
+module Ezid
+  module TestHelper
+
+    TEST_ARK_SHOULDER = "ark:/99999/fk4"
+    TEST_DOI_SHOULDER = "doi:10.5072/FK2"
+    TEST_USER = "apitest"
+
+    def ezid_test_mode!
+      Ezid::Client.configure do |config|
+        config.user = TEST_USER
+        # Contact EZID for password
+        # config.password = "********"
+        config.logger = Logger.new(File::NULL)
+        config.default_shoulder = TEST_ARK_SHOULDER
+      end
+    end
+
+  end
+end
+
+include Ezid::TestHelper
+

data/spec/integration/client_spec.rb

@@ -3,7 +3,7 @@ module Ezid
 
     shared_examples "an EZID client" do |client|
       it "should mint and modify" do      
-        minted = client.mint_identifier(ARK_SHOULDER, "_status: reserved")
+        minted = client.mint_identifier(TEST_ARK_SHOULDER, "_status: reserved")
         expect(minted).to be_success
         @id = minted.id
         modified = client.modify_identifier(@id, "dc.title" => "Test")
@@ -46,7 +46,7 @@ module Ezid
       describe "without a session" do
         it "should send the user name and password" do
           expect_any_instance_of(Net::HTTP::Post).to receive(:basic_auth).with(subject.user, subject.password).and_call_original
-          subject.mint_identifier(ARK_SHOULDER)
+          subject.mint_identifier(TEST_ARK_SHOULDER)
         end
       end
     end

data/spec/integration/identifier_spec.rb

@@ -6,14 +6,14 @@ module Ezid
     describe "CRUD operations" do
       describe "create" do
         describe "with a shoulder" do
-          subject { described_class.create(shoulder: ARK_SHOULDER) }
+          subject { described_class.create(shoulder: TEST_ARK_SHOULDER) }
           it "should mint an identifier" do
             expect(subject).to be_a(described_class)
-            expect(subject.id).to match(/#{ARK_SHOULDER}/)
+            expect(subject.id).to match(/#{TEST_ARK_SHOULDER}/)
           end
         end
         describe "with an id" do
-          let(:minted) { described_class.create(shoulder: ARK_SHOULDER) }
+          let(:minted) { described_class.create(shoulder: TEST_ARK_SHOULDER) }
           subject { described_class.create(id: "#{minted}/123") }
           it "should create the identifier" do
             expect(subject).to be_a(described_class)
@@ -23,7 +23,7 @@ module Ezid
       end
 
       describe "retrieve" do
-        let(:minted) { described_class.create(shoulder: ARK_SHOULDER, target: "http://example.com") }
+        let(:minted) { described_class.create(shoulder: TEST_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)
@@ -33,7 +33,7 @@ module Ezid
       end
 
       describe "update" do
-        subject { described_class.create(shoulder: ARK_SHOULDER, target: "http://google.com") }
+        subject { described_class.create(shoulder: TEST_ARK_SHOULDER, target: "http://google.com") }
         before do
           subject.target = "http://example.com"
           subject.save
@@ -44,7 +44,7 @@ module Ezid
       end
 
       describe "delete" do
-        subject { described_class.create(shoulder: ARK_SHOULDER, status: "reserved") }
+        subject { described_class.create(shoulder: TEST_ARK_SHOULDER, status: "reserved") }
         before { subject.delete }
         it "should delete the identifier" do
           expect { described_class.find(subject.id) }.to raise_error

data/spec/spec_helper.rb

@@ -18,17 +18,8 @@
 require 'coveralls'
 Coveralls.wear!
 
-require "ezid-client"
-
-Ezid::Client.configure do |config|
-  config.user = "apitest"
-  # Contact EZID for password
-  # config.password = "********"
-  config.logger = Logger.new(File::NULL)
-end
-
-ARK_SHOULDER = "ark:/99999/fk4"
-DOI_SHOULDER = "doi:10.5072/FK2"
+require "ezid/test_helper"
+ezid_test_mode!
 
 RSpec.configure do |config|
 

data/spec/unit/client_spec.rb

@@ -25,8 +25,8 @@ module Ezid
     describe "#mint_identifier" do
       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) }
+        before { allow(Request).to receive(:execute).with(:Post, "/shoulder/#{TEST_ARK_SHOULDER}") { stub_response } }
+        subject { described_class.new.mint_identifier(TEST_ARK_SHOULDER) }
         it "should be a succes" do
           expect(subject).to be_success
           expect(subject.id).to eq("ark:/99999/fk4fn19h88")
@@ -44,8 +44,8 @@ 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) }
+        before { allow(Request).to receive(:execute).with(:Post, "/shoulder/#{TEST_DOI_SHOULDER}") { stub_response } }
+        subject { described_class.new.mint_identifier(TEST_DOI_SHOULDER, metadata) }
         it "should be a sucess" do          
           expect(subject).to be_success
           expect(subject.id).to eq("doi:10.5072/FK2TEST")
@@ -57,14 +57,15 @@ EOS
         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 }         
+            allow(Request).to receive(:execute).with(:Post, "/shoulder/#{TEST_ARK_SHOULDER}") { stub_response } 
+            allow(Client.config).to receive(:default_shoulder) { TEST_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
+          before { allow(Client.config).to receive(:default_shoulder) { nil } }
           it "should raise an exception" do
             expect { described_class.new.mint_identifier }.to raise_error
           end

data/spec/unit/identifier_spec.rb

@@ -2,7 +2,7 @@ module Ezid
   RSpec.describe Identifier do
 
     describe ".create" do
-      let(:attrs) { {shoulder: ARK_SHOULDER, profile: "dc", target: "http://example.com"} }
+      let(:attrs) { {shoulder: TEST_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 }
@@ -59,7 +59,7 @@ module Ezid
           expect(subject.status).to eq("reserved")
         end
         context "when explicit arguments override the defaults" do
-          subject { described_class.new(shoulder: ARK_SHOULDER, status: "public") }
+          subject { described_class.new(shoulder: TEST_ARK_SHOULDER, status: "public") }
           it "should override the defaults" do
             expect(subject.profile).to eq("dc")
             expect(subject.status).to eq("public")
@@ -150,13 +150,14 @@ module Ezid
         end
         context "and `id' is not present" do
           context "and `shoulder' is present" do
-            before { allow(subject).to receive(:shoulder) { ARK_SHOULDER } }
+            before { allow(subject).to receive(:shoulder) { TEST_ARK_SHOULDER } }
             it "should mint the identifier" do
-              expect(subject.client).to receive(:mint_identifier).with(ARK_SHOULDER, {}) { double(id: "id") }
+              expect(subject.client).to receive(:mint_identifier).with(TEST_ARK_SHOULDER, {}) { double(id: "id") }
               subject.save
             end
           end
           context "and `shoulder' is not present" do
+            before { allow(Client.config).to receive(:default_shoulder) { nil } }
             it "should raise an exception" do
               expect { subject.save }.to raise_error
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Chandek-Stark
@@ -78,6 +78,7 @@ files:
 - lib/ezid/response.rb
 - lib/ezid/session.rb
 - lib/ezid/status.rb
+- lib/ezid/test_helper.rb
 - spec/integration/client_spec.rb
 - spec/integration/identifier_spec.rb
 - spec/spec_helper.rb