ezid-client 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbe64c4c33da9f4e797d596ea878a03b79757e23
-  data.tar.gz: 899e1b115a2d2be8c7958c6143c97e3d308df923
+  metadata.gz: f0b9d3dc7c1df7191bb249e09e448ef6a5f55957
+  data.tar.gz: 18456cea4f31aa57fe04e7aa8f2c60c9d05eb1a6
 SHA512:
-  metadata.gz: 5c720cbfa1e104e7b371b7374e9714a0a4b4a1a7e264d58ef49e85f74ce41c4b4e25a5c987965ffc0b6b6179adbbeffec5dc4b4124471ed243264d16ff2f85ca
-  data.tar.gz: b23da5c4d41d643e541683f799c830f979d68a212229ebdd3930bb9f6a65733a2ceecbcfaf28dd5c83d49bfe2b7eba086408dd0d5c17ac4cc41867556cbef7ef
+  metadata.gz: a97573030689afb7beef02c8cc3d38a3b0efd830537ff780f51a20211a3cb1dd19cf78a06d17aa87bcf59664d3062bdbfc40f039f3ce6b4c85874887e898b944
+  data.tar.gz: 49ead39cafe8695052078fa86c92f17f21679240cc83d78f010bf9a95c88126024fb380b3ec1b37584723a67938e663559900357988db15a5248526846f65c12

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.0.0
 cache: 
   - bundler
-env: SPEC_OPTS="--tag ~type:feature"
+env: SPEC_OPTS="--tag ~type:integration"
 notifications:
   email:
     - lib-drs@duke.edu

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ezid-client.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -2,6 +2,9 @@
 
 EZID API Version 2 bindings. See http://ezid.cdlib.org/doc/apidoc.html.
 
+[![Gem Version](https://badge.fury.io/rb/ezid-client.svg)](http://badge.fury.io/rb/ezid-client)
+[![Build Status](https://travis-ci.org/duke-libraries/ezid-client.svg?branch=master)](https://travis-ci.org/duke-libraries/ezid-client)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +19,9 @@ Or install it yourself as:
 
     $ gem install ezid-client
 
-## Resource-oriented Usage (CRUD)
+## Basic Resource-oriented Usage (CRUD)
+
+See the test suite for more examples.
 
 Create (Mint)
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/ezid-client.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.name          = "ezid-client"
   spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
-  spec.authors       = ["dchandekstark"]
+  spec.authors       = ["David Chandek-Stark"]
   spec.email         = ["dchandekstark@gmail.com"]
   spec.summary       = "Ruby client for EZID API Version 2"
   spec.description   = "Ruby client for EZID API Version 2 (http://ezid.cdlib.org/doc/apidoc.html)"

data/lib/ezid/identifier.rb

@@ -1,16 +1,25 @@
 module Ezid
+  #
+  # Represents an EZID identifier as a resource.
+  #
+  # @api public
+  #
   class Identifier
 
     attr_reader :id, :client
     attr_accessor :shoulder, :metadata
 
+    # Attributes to display on inspect
     INSPECT_ATTRS = %w( id status target created )
 
+    # EZID status terms
     PUBLIC = "public"
     RESERVED = "reserved"
     UNAVAILABLE = "unavailable"
 
     class << self
+      # Creates or mints an identifier (depending on arguments)
+      # @see #save
       # @return [Ezid::Identifier] the new identifier
       # @raise [Ezid::Error]
       def create(attrs = {})
@@ -18,6 +27,7 @@ module Ezid
         identifier.save
       end
 
+      # Retrieves an identifier
       # @return [Ezid::Identifier] the identifier
       # @raise [Ezid::Error] if the identifier does not exist in EZID
       def find(id)
@@ -31,7 +41,7 @@ module Ezid
       @id = args.delete(:id)
       @shoulder = args.delete(:shoulder)
       @metadata = Metadata.new(args.delete(:metadata))
-      update_attributes(args)
+      update_metadata(args)
       @deleted = false
     end
 
@@ -65,8 +75,12 @@ module Ezid
       reload
     end
 
-    def update_attributes(attrs={})
+    # Updates the metadata 
+    # @param attrs [Hash] the metadata
+    # @return [Ezid::Identifier] the identifier
+    def update_metadata(attrs={})
       attrs.each { |k, v| send("#{k}=", v) }
+      self
     end
 
     # Is the identifier persisted?
@@ -82,13 +96,16 @@ module Ezid
       @deleted
     end
 
+    # Updates the metadata and saves the identifier
+    # @param data [Hash] a hash of metadata
     # @return [Ezid::Identifier] the identifier
     # @raise [Ezid::Error]
-    def update(data)
-      metadata.update(data)
+    def update(data={})
+      update_metadata(data)
       save
     end
 
+    # Reloads the metadata from EZID (local changes will be lost!)
     # @return [Ezid::Identifier] the identifier
     # @raise [Ezid::Error]
     def reload
@@ -96,13 +113,14 @@ module Ezid
       self
     end
 
-    # Empties the (local) metadata
+    # Empties the (local) metadata (changes will be lost!)
     # @return [Ezid::Identifier] the identifier
     def reset
       clear_metadata
       self
     end
 
+    # Deletes the identifier from EZID
     # @return [Ezid::Identifier] the identifier
     # @raise [Ezid::Error]
     def delete
@@ -112,28 +130,36 @@ module Ezid
       reset
     end
 
-    def method_missing(name, *args)
-      return metadata.send(name, *args) if metadata.respond_to?(name)
-      super
-    end
-
+    # Is the identifier reserved?
+    # @return [Boolean]
     def reserved?
       status == RESERVED
     end
 
+    # Is the identifier public?
+    # @return [Boolean]
     def public?
       status == PUBLIC
     end
 
+    # Is the identifier unavailable?
+    # @return [Boolean]
     def unavailable?
       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
       response = client.get_identifier_metadata(id)
-      @metadata.replace(response.metadata)
+      @metadata = Metadata.new(response.metadata)
     end
 
     def clear_metadata

data/lib/ezid/metadata.rb

@@ -54,36 +54,13 @@ module Ezid
       to_anvl
     end
 
-    # Adds metadata to the collection
-    # @param data [String, Hash, Ezid::Metadata] the data to add
-    # @return [Ezid::Metadata] the updated metadata
-    def update(data)
-      __getobj__.update(coerce(data))
-      self
-    end
-
-    # Replaces the collection with new metadata
-    # @param data [String, Hash, Ezid::Metadata] the metadata replacing the current metadata
-    # @return [Ezid::Metadata] the replaced metadata
-    def replace(data)
-      __getobj__.replace(coerce(data))
-      self
-    end
-
     private
 
     # Coerce data into a Hash of elements
     def coerce(data)
-      begin
-        stringify_keys(data.to_h)
-      rescue NoMethodError
-        coerce_string(data)
-      end
-    end
-
-    # Coerce hash keys to strings
-    def stringify_keys(hsh)
-      hsh.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+      data.to_h
+    rescue NoMethodError
+      coerce_string(data)
     end
 
     # Escape elements hash keys and values

data/lib/ezid/metadata_elements.rb

@@ -1,43 +1,85 @@
 require "active_support"
 
 module Ezid
+  #
+  # EZID metadata elements
+  #
+  # @note Intended to be used only as included in Ezid::Metadata.
+  #
   module MetadataElements
     extend ActiveSupport::Concern
     
-    DC_ELEMENTS = %w( creator title publisher date type )
-    DATACITE_ELEMENTS = %w( creator title publisher publicationyear resourcetype )
-    ERC_ELEMENTS = %w( who what when )
+    # Metadata profiles
+    PROFILES = {
+      "dc"       => %w( creator title publisher date type ).freeze,
+      "datacite" => %w( creator title publisher publicationyear resourcetype ).freeze,
+      "erc"      => %w( who what when ).freeze,
+      "crossref" => [].freeze
+      }
 
+    # Elements for metadata profiles (values may include multiple elements)
+    PROFILE_ELEMENTS = PROFILES.keys - ["dc"]
+
+    # EZID reserved metadata elements that have time values
+    # @see http://ezid.cdlib.org/doc/apidoc.html#internal-metadata
     RESERVED_TIME_ELEMENTS = %w( _created _updated )
+
+    # EZID reserved metadata elements that are read-only
+    # @see http://ezid.cdlib.org/doc/apidoc.html#internal-metadata
     RESERVED_READONLY_ELEMENTS = %w( _owner _ownergroup _shadows _shadowedby _datacenter _created _updated )
+
+    # EZID reserved metadata elements that may be set by clients
+    # @see http://ezid.cdlib.org/doc/apidoc.html#internal-metadata
     RESERVED_READWRITE_ELEMENTS = %w( _coowners _target _profile _status _export _crossref )
+
+    # All EZID reserved metadata elements
+    # @see http://ezid.cdlib.org/doc/apidoc.html#internal-metadata
     RESERVED_ELEMENTS = RESERVED_READONLY_ELEMENTS + RESERVED_READWRITE_ELEMENTS + RESERVED_TIME_ELEMENTS
 
     included do
-      reserved_accessor *(RESERVED_READWRITE_ELEMENTS - ["_crossref"])
-      reserved_reader *(RESERVED_READONLY_ELEMENTS - RESERVED_TIME_ELEMENTS)
-      reserved_time_reader *RESERVED_TIME_ELEMENTS
+      # "_crossref" does not get a reserved accessor because of the "crossref" element.
+      reserved_element_accessor *(RESERVED_READWRITE_ELEMENTS - ["_crossref"])
+      reserved_element_reader *(RESERVED_READONLY_ELEMENTS - RESERVED_TIME_ELEMENTS)
+      reserved_element_time_reader *RESERVED_TIME_ELEMENTS
 
-      profile_accessor :dc, *DC_ELEMENTS
-      profile_accessor :datacite, *DATACITE_ELEMENTS
-      profile_accessor :erc, *ERC_ELEMENTS
+      profile_element_accessors
       
-      element_accessor "datacite", "crossref", "_crossref"
+      element_accessor *PROFILE_ELEMENTS
+
+      # "_crossref" does not get a reserved accessor because of the "crossref" element.
+      element_accessor "_crossref"
     end
 
     module ClassMethods
-      def reserved_accessor(*elements)
-        reserved_reader(*elements)
-        reserved_writer(*elements)
+      # Creates an accessor for each reserved element
+      # @see .reserved_element_reader
+      # @see .reserved_element_writer
+      # @param elements [Array<String>] a list of elements
+      def reserved_element_accessor(*elements)
+        reserved_element_reader(*elements)
+        reserved_element_writer(*elements)
       end
 
-      def reserved_reader(*elements)
+      # Creates a reader for each reserved element
+      #   The leading underscore of the element is removed from the reader name
+      #   -- e.g.
+      #
+      #   def status
+      #     reader("_status")
+      #   end
+      #
+      # @param elements [Array<String>] a list of elements
+      def reserved_element_reader(*elements)
         elements.each do |element|
           define_method(element.sub("_", "")) { reader(element) }
         end
       end
 
-      def reserved_time_reader(*elements)
+      # Creates a reader for each time-based reserved element
+      #   The reader will return a Time instance for the value (or nil if not present)
+      # @see .reserved_element_reader
+      # @param elements [Array<String>] a list of elements
+      def reserved_element_time_reader(*elements)
         elements.each do |element|
           define_method(element.sub("_", "")) do
             time = reader(element).to_i
@@ -47,7 +89,16 @@ module Ezid
         end
       end
 
-      def reserved_writer(*elements)
+      # Creates a writer for each reserved element
+      #   The leading underscore of the element is removed from the reader name
+      #   -- e.g.
+      #
+      #   def status=(value)
+      #     writer("_status", value)
+      #   end
+      #
+      # @param elements [Array<String>] a list of elements
+      def reserved_element_writer(*elements)
         elements.each do |element|
           define_method("#{element.sub('_', '')}=") do |value| 
             writer(element, value)
@@ -55,18 +106,23 @@ module Ezid
         end
       end
 
-      def profile_accessor(profile, *elements)
-        elements.each do |element|
-          define_method("#{profile}_#{element}") do
-            reader("#{profile}.#{element}")
-          end
+      # Creates a accessors for all metadata profile elements
+      def profile_element_accessors
+        PROFILES.each do |profile, elements|
+          elements.each do |element|
+            define_method("#{profile}_#{element}") do
+              reader("#{profile}.#{element}")
+            end
         
-          define_method("#{profile}_#{element}=") do |value|
-            writer("#{profile}.#{element}", value)
-          end     
+            define_method("#{profile}_#{element}=") do |value|
+              writer("#{profile}.#{element}", value)
+            end     
+          end
         end
       end
 
+      # Creates an accessor for each element
+      # @param elements [Array<String>] a list of elements
       def element_accessor(*elements)
         elements.each do |element|
           define_method(element) { reader(element) }

data/spec/integration/client_spec.rb

@@ -0,0 +1,66 @@
+module Ezid
+  RSpec.describe Client, type: :integration do
+
+    shared_examples "an EZID client" do |client|
+      it "should mint and modify" do      
+        minted = client.mint_identifier(ARK_SHOULDER, "_status: reserved")
+        expect(minted).to be_success
+        @id = minted.id
+        modified = client.modify_identifier(@id, "dc.title" => "Test")
+        expect(modified).to be_success
+        retrieved = client.get_identifier_metadata(@id)
+        expect(retrieved).to be_success
+        expect(retrieved.metadata).to match(/dc.title: Test/)
+        deleted = client.delete_identifier(@id)
+        expect(deleted).to be_success
+        expect { client.get_identifier_metadata(@id) }.to raise_error
+      end
+    end
+
+    describe "initialization with a block" do
+      it "should wrap the block in a session" do
+        expect_any_instance_of(described_class).to receive(:login).and_call_original
+        expect_any_instance_of(described_class).to receive(:logout).and_call_original
+        described_class.new do |client|
+          expect(client.session).to be_open
+        end
+      end
+    end    
+
+    describe "authentication" do
+      describe "#login" do
+        it "should open a session" do
+          expect(subject.session).to be_closed
+          subject.login
+          expect(subject.session).to be_open
+        end
+      end
+      describe "#logout" do
+        before { subject.login }
+        it "should close the session" do
+          expect(subject.session).to be_open
+          subject.logout
+          expect(subject.session).to be_closed
+        end
+      end
+      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)
+        end
+      end
+    end
+
+    describe "identifier lifecycle management" do
+      describe "with a session" do
+        Client.new do |client|
+          it_behaves_like "an EZID client", client
+        end
+      end
+      describe "without a session" do
+        it_behaves_like "an EZID client", Client.new
+      end
+    end
+
+  end
+end

data/spec/integration/identifier_spec.rb

@@ -0,0 +1,21 @@
+module Ezid
+  RSpec.describe Identifier do
+
+    it "should handle CRUD operations", type: :integration 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
+
+  end
+end

data/spec/spec_helper.rb

@@ -15,6 +15,9 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
+require 'coveralls'
+Coveralls.wear!
+
 require "ezid-client"
 
 Ezid::Client.configure do |config|

data/spec/{lib/ezid → unit}/client_spec.rb

@@ -1,48 +1,13 @@
 module Ezid
   RSpec.describe Client do
 
-    describe "initialization" do
-      describe "without a block" do
-        it "should not login" do
-          expect_any_instance_of(described_class).not_to receive(:login)
-          described_class.new
-        end
-      end
-      describe "with a block", type: :feature do
-        it "should wrap the block in a session" do
-          expect_any_instance_of(described_class).to receive(:login).and_call_original
-          expect_any_instance_of(described_class).to receive(:logout).and_call_original
-          described_class.new do |client|
-            expect(client.session).to be_open
-          end
-        end
+    describe "initialization without a block" do
+      it "should not login" do
+        expect_any_instance_of(described_class).not_to receive(:login)
+        described_class.new
       end
     end    
 
-    describe "authentication", type: :feature do
-      describe "#login" do
-        it "should open a session" do
-          expect(subject.session).to be_closed
-          subject.login
-          expect(subject.session).to be_open
-        end
-      end
-      describe "#logout" do
-        before { subject.login }
-        it "should close the session" do
-          expect(subject.session).to be_open
-          subject.logout
-          expect(subject.session).to be_closed
-        end
-      end
-      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)
-        end
-      end
-    end
-
     describe "#create_identifier" do
       let(:id) { "ark:/99999/fk4fn19h88" }
       let(:http_response) { double(body: "success: ark:/99999/fk4fn19h88") }
@@ -121,29 +86,6 @@ EOS
       end
     end
 
-    describe "#modify_identifier", type: :feature do
-      before do
-        @id = described_class.new.mint_identifier(ARK_SHOULDER).id
-      end
-      subject { described_class.new.modify_identifier(@id, "dc.title" => "Test") }
-      it "should update the metadata" do
-        expect(subject).to be_success
-        response = described_class.new.get_identifier_metadata(@id)
-        expect(response.metadata).to match(/dc.title: Test/)
-      end
-    end
-
-    describe "#delete_identifier", type: :feature do
-      before do
-        @id = described_class.new.mint_identifier(ARK_SHOULDER, "_status" => "reserved").id
-      end
-      subject { described_class.new.delete_identifier(@id) }
-      it "should delete the identifier" do
-        expect(subject).to be_success
-        expect { described_class.new.get_identifier_metadata(@id) }.to raise_error
-      end
-    end
-
     describe "server status" do
       let(:http_response) do
         double(body: <<-EOS

data/spec/{lib/ezid → unit}/identifier_spec.rb

@@ -61,7 +61,7 @@ module Ezid
     
     describe "#update" do
       let(:id) { "ark:/99999/fk4fn19h88" }
-      let(:metadata) { {"_status" => "unavailable"} }
+      let(:metadata) { {"status" => "unavailable"} }
       subject { described_class.new(id: id) }
       before do
         allow(subject).to receive(:persisted?) { true }
@@ -70,7 +70,7 @@ module Ezid
         end
       end
       it "should update the metadata" do
-        expect(subject.metadata).to receive(:update).with(metadata)
+        expect(subject).to receive(:update_metadata).with(metadata)
         subject.update(metadata)
       end
       it "should save the identifier" do
@@ -86,8 +86,8 @@ module Ezid
       before do
         allow(subject.client).to receive(:get_identifier_metadata).with(id) { double(metadata: metadata) }
       end
-      it "should update the metadata from EZID" do
-        expect(subject.metadata).to receive(:replace).with(metadata)
+      it "should reinitialize the metadata from EZID" do
+        expect(Metadata).to receive(:new).with(metadata)
         subject.reload
       end
     end
@@ -183,21 +183,5 @@ module Ezid
       end
     end
 
-    it "should handle CRUD operations", type: :feature do
-      # create (mint)
-      identifier = Ezid::Identifier.create(shoulder: ARK_SHOULDER)
-      expect(identifier.status).to eq("public")
-      # update
-      identifier.target = "http://example.com"
-      identifier.save
-      # retrieve
-      identifier = Ezid::Identifier.find(identifier.id)
-      expect(identifier.target).to eq("http://example.com")
-      # delete
-      identifier = Ezid::Identifier.create(shoulder: ARK_SHOULDER, status: "reserved")
-      identifier.delete
-      expect { Ezid::Identifier.find(identifier.id) }.to raise_error
-    end
-
   end
 end

data/spec/unit/metadata_elements_spec.rb

@@ -0,0 +1,43 @@
+require "delegate"
+
+module Ezid
+  RSpec.describe MetadataElements do
+
+    before do
+      class TestMetadata < SimpleDelegator
+        def initialize
+          super(Hash.new)
+        end
+        include MetadataElements
+      end
+    end
+    after do
+      Ezid.remove_const(:TestMetadata)
+    end
+
+    describe "reserved reader" do
+
+    end
+    
+    describe "reserved writer" do
+
+    end
+
+    describe "reserved time reader" do
+
+    end
+    
+    describe "reserved accessor" do
+
+    end
+
+    describe "profile accessor" do
+
+    end
+
+    describe "element accessor" do
+
+    end
+
+  end
+end

data/spec/unit/metadata_spec.rb

@@ -0,0 +1,141 @@
+module Ezid
+  RSpec.describe Metadata do
+    
+    describe "reserved elements" do
+      describe "readers" do
+        Metadata::RESERVED_ELEMENTS.each do |element|
+          next if element == "_crossref"
+          it "should have a reader for '#{element}'" do
+            expect(subject).to receive(:reader).with(element)
+            subject.send(element.sub("_", ""))
+          end
+        end
+        describe "for time-based elements" do
+          Metadata::RESERVED_TIME_ELEMENTS.each do |element|
+            context "\"#{element}\"" do
+              before { subject[element] = "1416507086" }
+              it "should have a reader than returns a Time instance" do
+                expect(subject).to receive(:reader).with(element).and_call_original
+                expect(subject.send(element.sub("_", ""))).to eq(Time.parse("2014-11-20 13:11:26 -0500"))
+              end
+            end
+          end
+        end
+      end
+      describe "writers" do
+        Metadata::RESERVED_READWRITE_ELEMENTS.each do |element|
+          next if element == "_crossref"
+          it "should have a writer for '#{element}'" do
+            expect(subject).to receive(:writer).with(element, "value")
+            subject.send("#{element.sub('_', '')}=", "value")
+          end      
+        end
+      end
+    end
+    describe "metadata profiles" do
+      Metadata::PROFILES.each do |profile, elements|
+        describe "the '#{profile}' metadata profile" do
+          describe "readers" do
+            elements.each do |element|            
+              it "should have a reader for '#{profile}.#{element}'" do
+                expect(subject).to receive(:reader).with("#{profile}.#{element}")
+                subject.send("#{profile}_#{element}")
+              end
+            end
+          end
+          describe "writers" do
+            elements.each do |element|            
+              it "should have a writer for '#{profile}.#{element}'" do
+                expect(subject).to receive(:writer).with("#{profile}.#{element}", "value")
+                subject.send("#{profile}_#{element}=", "value")
+              end
+            end
+          end
+        end
+      end
+    end
+
+    describe "ANVL output" do
+      let(:elements) do 
+        { "_target" => "http://example.com/path%20with%20spaces",
+          "_erc" => "who: Proust, Marcel\nwhat: Remembrance of Things Past",
+          "_status" => "public" }
+      end
+      subject { described_class.new(elements) }
+      it "should output the proper format and escape" do
+        expect(subject.to_anvl).to eq("\
+_target: http://example.com/path%2520with%2520spaces
+_erc: who: Proust, Marcel%0Awhat: Remembrance of Things Past
+_status: public")
+      end
+      describe "encoding" do
+        before do
+          subject.each_key { |k| subject[k] = subject[k].force_encoding(Encoding::US_ASCII) }
+        end
+        it "should be encoded in UTF-8" do
+          expect(subject.to_anvl.encoding).to eq(Encoding::UTF_8)
+        end
+      end
+    end
+
+    describe "coercion" do
+      subject { described_class.new(data) }
+      context "of nil" do
+        let(:data) { nil }
+        it "should create an empty hash" do
+          expect(subject).to eq({})
+        end
+      end
+      context "of a string" do
+        let(:data) do <<-EOS
+_updated: 1416507086
+_target: http://example.com/path%2520with%2520spaces
+_profile: erc
+_erc: who: Proust, Marcel%0Awhat: Remembrance of Things Past
+_ownergroup: apitest
+_owner: apitest
+_export: yes
+_created: 1416507086
+_status: public
+EOS
+        end
+        it "should treat the string as an ANVL document, splitting into keys and values and unescaping" do
+          expect(subject).to eq({ "_updated" => "1416507086",
+                                  "_target" => "http://example.com/path%20with%20spaces",
+                                  "_profile" => "erc",
+                                  "_erc" => "who: Proust, Marcel\nwhat: Remembrance of Things Past",
+                                  "_ownergroup" => "apitest",
+                                  "_owner" => "apitest",
+                                  "_export" => "yes",
+                                  "_created" => "1416507086",
+                                  "_status" => "public" })
+        end
+      end
+      context "of a hash-like object" do
+        let(:hsh) do 
+          { "_updated" => "1416507086",
+            "_target" => "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
+            "_profile" => "erc",
+            "_ownergroup" => "apitest",
+            "_owner" => "apitest",
+            "_export" => "yes",
+            "_created" => "1416507086",
+            "_status" => "public" }
+        end
+        context "which is a normal Hash" do
+          let(:data) { hsh }
+          it "should set the metadata to the hash" do
+            expect(subject).to eq(hsh)
+          end
+        end
+        context "which is a Metadata instance" do
+          let(:data) { Metadata.new(hsh) }
+          it "should set the metadata to the hash" do
+            expect(subject).to eq(hsh)
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
-- dchandekstark
+- David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Ruby client for EZID API Version 2 (http://ezid.cdlib.org/doc/apidoc.html)
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,10 +93,13 @@ files:
 - lib/ezid/response.rb
 - lib/ezid/session.rb
 - lib/ezid/status.rb
-- spec/lib/ezid/client_spec.rb
-- spec/lib/ezid/identifier_spec.rb
-- spec/lib/ezid/metadata_spec.rb
+- spec/integration/client_spec.rb
+- spec/integration/identifier_spec.rb
 - spec/spec_helper.rb
+- spec/unit/client_spec.rb
+- spec/unit/identifier_spec.rb
+- spec/unit/metadata_elements_spec.rb
+- spec/unit/metadata_spec.rb
 homepage: https://github.com/duke-libraries/ezid-client
 licenses:
 - BSD-3-Clause
@@ -107,12 +110,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -122,7 +125,10 @@ signing_key:
 specification_version: 4
 summary: Ruby client for EZID API Version 2
 test_files:
-- spec/lib/ezid/client_spec.rb
-- spec/lib/ezid/identifier_spec.rb
-- spec/lib/ezid/metadata_spec.rb
+- spec/integration/client_spec.rb
+- spec/integration/identifier_spec.rb
 - spec/spec_helper.rb
+- spec/unit/client_spec.rb
+- spec/unit/identifier_spec.rb
+- spec/unit/metadata_elements_spec.rb
+- spec/unit/metadata_spec.rb

data/spec/lib/ezid/metadata_spec.rb

@@ -1,288 +0,0 @@
-module Ezid
-  RSpec.describe Metadata do
-    
-    let(:elements) do
-        { "_updated" => "1416507086",
-          "_target" => "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-          "_profile" => "erc",
-          "_ownergroup" => "apitest",
-          "_owner" => "apitest",
-          "_export" => "yes",
-          "_created" => "1416507086",
-          "_status" => "public" }
-    end
-    subject { described_class.new(elements) }
-
-    it "should have a non-leading-underscore reader for each reserved element, except '_crossref'" do
-      Metadata::RESERVED_ELEMENTS.each do |element|
-        next if element == "_crossref"
-        expect(subject).to respond_to(element.sub("_", ""))
-      end      
-    end
-
-    describe "element reader aliases for datetime elements" do
-      it "should return Time values" do
-        expect(subject.created).to eq Time.parse("2014-11-20 13:11:26 -0500")
-        expect(subject.updated).to eq Time.parse("2014-11-20 13:11:26 -0500")
-      end
-    end
-
-    it "should have a non-leading-underscore writer for each writable reserved element, except '_crossref'" do
-      Metadata::RESERVED_READWRITE_ELEMENTS.each do |element|
-        next if element == "_crossref"
-        expect(subject).to respond_to("#{element.sub('_', '')}=")
-      end      
-    end    
-
-    describe "#update" do
-      it "should coerce the data"
-      it "should update the delegated hash"
-    end
-
-    describe "#replace" do
-      it "should coerce the data"
-      it "should call `replace' on the delegated hash"
-    end
-
-    describe "ANVL output" do
-      it "should output the proper format" do
-        expect(subject.to_anvl).to eq("\
-_updated: 1416507086
-_target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
-_profile: erc
-_ownergroup: apitest
-_owner: apitest
-_export: yes
-_created: 1416507086
-_status: public")
-      end
-      describe "encoding" do
-        before do
-          subject.each_key { |k| subject[k] = subject[k].force_encoding(Encoding::US_ASCII) }
-        end
-        it "should be encoded in UTF-8" do
-          expect(subject.to_anvl.encoding).to eq(Encoding::UTF_8)
-        end
-      end
-      describe "escaping" do
-        before do
-          subject["_target"] = "http://example.com/path%20with%20spaces"
-          subject["dc.title"] = "A really long title\nneeds a line feed"
-          subject["dc.creator"] = "David Chandek-Stark\r\nJim Coble"
-        end
-        it "should escape a line feed" do
-          expect(subject.to_anvl).to match(/dc.title: A really long title%0Aneeds a line feed/)
-        end
-        it "should escape a carriage return" do
-          expect(subject.to_anvl).to match(/dc.creator: David Chandek-Stark%0D%0AJim Coble/)
-        end
-        it "should escape a percent sign" do
-          expect(subject.to_anvl).to match(/_target: http:\/\/example.com\/path%2520with%2520spaces/)
-        end
-      end
-    end
-
-    describe "coercion" do
-      subject { described_class.new(data) }
-      context "of nil" do
-        let(:data) { nil }
-        it "should return an empty hash" do
-          expect(subject).to eq({})
-        end
-      end
-      context "of a string" do
-        let(:data) do <<-EOS
-_updated: 1416507086
-_target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
-_profile: erc
-_ownergroup: apitest
-_owner: apitest
-_export: yes
-_created: 1416507086
-_status: public
-EOS
-        end
-        it "should coerce the data into a hash" do
-          expect(subject).to eq({"_updated" => "1416507086",
-                                 "_target" => "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-                                 "_profile" => "erc",
-                                 "_ownergroup" => "apitest",
-                                 "_owner" => "apitest",
-                                 "_export" => "yes",
-                                 "_created" => "1416507086",
-                                 "_status" => "public"})
-        end
-      end
-      context "of a hash" do
-        let(:data) do
-          { _updated: "1416507086",
-            _target: "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-            _profile: "erc",
-            _ownergroup: "apitest",
-            _owner: "apitest",
-            _export: "yes",
-            _created: "1416507086",
-            _status: "public" }
-        end
-        it "should stringify the keys" do
-          expect(subject).to eq({"_updated" => "1416507086",
-                                  "_target" => "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-                                  "_profile" => "erc",
-                                  "_ownergroup" => "apitest",
-                                  "_owner" => "apitest",
-                                  "_export" => "yes",
-                                  "_created" => "1416507086",
-                                  "_status" => "public"})
-        end
-      end
-      context "of a Metadata instance" do
-        let(:hsh) do 
-          { "_updated" => "1416507086",
-            "_target" => "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-            "_profile" => "erc",
-            "_ownergroup" => "apitest",
-            "_owner" => "apitest",
-            "_export" => "yes",
-            "_created" => "1416507086",
-            "_status" => "public" }
-        end
-        let(:data) { Metadata.new(hsh) }
-        it "should have the same hash" do
-          expect(subject).to eq(hsh)
-        end
-      end
-    end
-
-    describe "profiles" do
-      describe "dc" do
-        describe "readers" do
-          before do
-            subject.update("dc.title" => "Testing Profiles",
-                           "dc.creator" => "Kermit the Frog",
-                           "dc.publisher" => "Duke University",
-                           "dc.date" => "2004",
-                           "dc.type" => "Text")
-          end
-          it "should have a reader for each element" do
-            expect(subject.dc_title).to eq("Testing Profiles")
-            expect(subject.dc_creator).to eq("Kermit the Frog")
-            expect(subject.dc_publisher).to eq("Duke University")
-            expect(subject.dc_date).to eq("2004")
-            expect(subject.dc_type).to eq("Text")
-          end
-        end
-        describe "writers" do
-          before do
-            subject.dc_title = "Run of the Mill"
-            subject.dc_creator = "Jack Bean"
-            subject.dc_publisher = "Random Housing"
-            subject.dc_date = "1967"
-            subject.dc_type = "Physical Object"
-          end
-          it "should have a writer for each element" do
-            expect(subject["dc.title"]).to eq "Run of the Mill"
-            expect(subject["dc.creator"]).to eq "Jack Bean"
-            expect(subject["dc.publisher"]).to eq "Random Housing"
-            expect(subject["dc.date"]).to eq "1967"
-            expect(subject["dc.type"]).to eq "Physical Object"
-          end
-        end
-      end
-      describe "erc" do
-        describe "readers" do
-          before do
-            subject.update("erc.what" => "Testing Profiles",
-                            "erc.who" => "Kermit the Frog",
-                            "erc.when" => "2004")
-          end
-          it "should have a reader for each element" do
-            expect(subject.erc_what).to eq("Testing Profiles")
-            expect(subject.erc_who).to eq("Kermit the Frog")
-            expect(subject.erc_when).to eq("2004")
-          end
-        end
-        describe "writers" do
-          before do
-            subject.erc_what = "Run of the Mill"
-            subject.erc_who = "Jack Bean"
-            subject.erc_when = "1967"
-          end
-          it "should have a writer for each element" do
-            expect(subject["erc.what"]).to eq "Run of the Mill"
-            expect(subject["erc.who"]).to eq "Jack Bean"
-            expect(subject["erc.when"]).to eq "1967"
-          end
-        end
-      end
-      describe "crossref" do
-        describe "xml document reader" do
-          before do
-            subject["crossref"] = "<xml/>" 
-          end
-          it "should return the xml" do
-            expect(subject.crossref).to eq "<xml/>"
-        end
-      end
-      describe "xml document writer" do
-        before do
-          subject.crossref = "<yml/>"
-        end
-        it "should set the 'crossref' metadata element" do
-          expect(subject["crossref"]).to eq "<yml/>"
-        end
-      end
-      end
-      describe "datacite" do
-        describe "element readers" do
-          before do
-            subject.update("datacite.title" => "Testing Profiles",
-                           "datacite.creator" => "Kermit the Frog",
-                           "datacite.publisher" => "Duke University",
-                           "datacite.publicationyear" => "2004",
-                           "datacite.resourcetype" => "Text")
-          end
-          it "should have a reader for each element" do
-            expect(subject.datacite_title).to eq("Testing Profiles")
-            expect(subject.datacite_creator).to eq("Kermit the Frog")
-            expect(subject.datacite_publisher).to eq("Duke University")
-            expect(subject.datacite_publicationyear).to eq("2004")
-            expect(subject.datacite_resourcetype).to eq("Text")
-          end
-        end
-        describe "element writers" do
-          before do
-            subject.datacite_title = "Run of the Mill"
-            subject.datacite_creator = "Jack Bean"
-            subject.datacite_publisher = "Random Housing"
-            subject.datacite_publicationyear = "1967"
-            subject.datacite_resourcetype = "Physical Object"
-          end
-          it "should have a writer for each element" do
-            expect(subject["datacite.title"]).to eq "Run of the Mill"
-            expect(subject["datacite.creator"]).to eq "Jack Bean"
-            expect(subject["datacite.publisher"]).to eq "Random Housing"
-            expect(subject["datacite.publicationyear"]).to eq "1967"
-            expect(subject["datacite.resourcetype"]).to eq "Physical Object"
-          end
-        end
-        describe "xml document reader" do
-          before do
-            subject["datacite"] = "<xml/>" 
-          end
-          it "should return the xml" do
-            expect(subject.datacite).to eq "<xml/>"
-          end
-        end
-        describe "xml document writer" do
-          before do
-            subject.datacite = "<yml/>"
-          end
-          it "should set the 'datacite' metadata element" do
-            expect(subject["datacite"]).to eq "<yml/>"
-          end
-        end
-      end
-    end
-
-  end
-end