ezid-client 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b09cc8d07326bf5ec70e376feb37a7958018724
-  data.tar.gz: a95378e37e305a0dd79e127b654bcd41a6d4e658
+  metadata.gz: 024d805940fcc9a0ccbe8ed0e6e80177d05393f6
+  data.tar.gz: e488fafa09132f630a2047cd4008fd653a9a221a
 SHA512:
-  metadata.gz: 2d07041e9bf5961f6b5f5def5936f24f08553d789032de6c9c1cebeba0da4e848b5b8f34515995f6e52646df916f7cf234b52c228a63cd64bef0ae3e36ec9bf4
-  data.tar.gz: c35e0ab65837eb7d4bfbfc3f6b2a29cf645e68b1c2862e2fbd1013d6a2096e646671291e423daeffa3b9a16e8502b2b3054e6b5d65f7bacb0d0590af272687ab
+  metadata.gz: 3f32330825caf59ba03f3e7765226fe5f9aaef98877a12c9ac1396ac98a2511863f57f9b2619adea40d425b9b09ae5c97b311614d1b9e21a52ec4007217a9511
+  data.tar.gz: 4972d261b297f95f763499c92882fe1600238a3e5865bd510b41dc780ba33904f22b17f95fc1c87ff9aaeddfdb6e761b53c1159d9d011f920e7bfc7818a433e5

data/README.md

@@ -71,7 +71,7 @@ I, [2014-12-04T15:12:48.853964 #86734]  INFO -- : EZID DELETE ark:/99999/fk4n58p
 
 ## Metadata handling
 
-See `Ezid::Metadata`.
+See `Ezid::Metadata` class and examples in `spec/unit/metadata_spec.rb`.
 
 ## Authentication
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/ezid-client.gemspec

@@ -19,9 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> 2.0"
 
-  spec.add_dependency "activesupport", "~> 4.0"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/lib/ezid/client.rb

@@ -12,6 +12,7 @@ module Ezid
   # EZID client
   #
   # @api public
+  #
   class Client
 
     class << self

data/lib/ezid/identifier.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Ezid
   #
   # Represents an EZID identifier as a resource.
@@ -5,10 +7,14 @@ module Ezid
   # @api public
   #
   class Identifier
+    extend Forwardable
 
     attr_reader :id, :client
     attr_accessor :shoulder, :metadata
 
+    def_delegators :metadata, *(Metadata.elements.readers)
+    def_delegators :metadata, *(Metadata.elements.writers)
+
     # Attributes to display on inspect
     INSPECT_ATTRS = %w( id status target created )
 

data/lib/ezid/metadata.rb

@@ -1,16 +1,16 @@
 require "delegate"
-require_relative "metadata_elements"
+require "singleton"
 
 module Ezid
   #
   # EZID metadata collection for an identifier
   #
+  # @note Although this API is not private, its direct use is discouraged.
+  #   Instead use the metadata element accessors through Ezid::Identifier.
   # @api public
   #
   class Metadata < SimpleDelegator
 
-    include MetadataElements
-
     # EZID metadata field/value separator
     ANVL_SEPARATOR = ": "
 
@@ -25,7 +25,7 @@ module Ezid
     ESCAPE_NAMES_RE = /[%:\r\n]/
 
     # Character sequence to unescape from EZID
-    # http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
+    # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
     UNESCAPE_RE = /%\h\h/
 
     # A comment line
@@ -37,6 +37,99 @@ module Ezid
     # A line ending
     LINE_ENDING_RE = /\r?\n/
     
+    # A metadata element
+    Element = Struct.new(:name, :writer)
+    
+    # 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
+      }.freeze
+
+    # 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
+
+    # Metadata element registry
+    class ElementRegistry < SimpleDelegator
+      include Singleton
+
+      def initialize
+        super(Hash.new)
+      end
+
+      def readers
+        keys
+      end
+
+      def writers
+        keys.select { |k| self[k].writer }.map(&:to_s).map { |k| k.concat("=") }.map(&:to_sym)
+      end
+    end
+
+    def self.initialize!
+      register_elements
+      define_element_accessors
+    end
+
+    def self.elements
+      ElementRegistry.instance
+    end
+
+    def self.register_elements
+      register_profile_elements
+      register_reserved_elements
+      elements.freeze
+    end
+
+    def self.define_element_accessors
+      elements.each do |accessor, element|
+        define_method(accessor) { reader(element.name) }
+      
+        if element.writer
+          define_method("#{accessor}=") { |value| writer(element.name, value) }
+        end
+      end
+    end
+
+    def self.register_element(accessor, element, opts={})
+      writer = opts.fetch(:writer, true)
+      elements[accessor] = Element.new(element, writer).freeze
+    end
+
+    def self.register_profile_elements
+      PROFILES.each do |profile, profile_elements|
+        profile_elements.each do |element|
+          register_element("#{profile}_#{element}".to_sym, "#{profile}.#{element}")
+        end
+        register_element(profile.to_sym, profile) unless profile == "dc"
+      end
+    end
+
+    def self.register_reserved_elements
+      RESERVED_ELEMENTS.each do |element|
+        accessor = ((element == "_crossref") ? element : element.sub("_", "")).to_sym
+        register_element(accessor, element, writer: RESERVED_READWRITE_ELEMENTS.include?(element))
+      end
+    end
+
+    private_class_method :register_element, :register_elements, :register_reserved_elements, 
+                         :register_profile_elements, :define_element_accessors
+
     def initialize(data={})
       super(coerce(data))
     end
@@ -56,59 +149,74 @@ module Ezid
 
     private
 
-    # Coerce data into a Hash of elements
-    def coerce(data)
-      data.to_h
-    rescue NoMethodError
-      coerce_string(data)
-    end
+      def reader(element)
+        value = self[element]
+        if RESERVED_TIME_ELEMENTS.include?(element)
+          time = value.to_i
+          value = (time == 0) ? nil : Time.at(time).utc
+        end
+        value
+      end
 
-    # Escape elements hash keys and values
-    def escape_elements(hsh)
-      hsh.each_with_object({}) do |(n, v), memo|
-        memo[escape_name(n)] = escape_value(v)
+      def writer(element, value)
+        self[element] = value
       end
-    end
 
-    # Escape an element name
-    def escape_name(n)
-      escape(ESCAPE_NAMES_RE, n)
-    end
+      # Coerce data into a Hash of elements
+      def coerce(data)
+        data.to_h
+      rescue NoMethodError
+        coerce_string(data)
+      end
 
-    # Escape an element value
-    def escape_value(v)
-      escape(ESCAPE_VALUES_RE, v)
-    end
+      # Escape elements hash keys and values
+      def escape_elements(hsh)
+        hsh.each_with_object({}) do |(n, v), memo|
+          memo[escape_name(n)] = escape_value(v)
+        end
+      end
 
-    # Escape string for sending to EZID host
-    # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
-    # @param re [Regexp] the regular expression to match for escaping
-    # @param s [String] the string to escape
-    # @return [String] the escaped string
-    def escape(re, s)
-      s.gsub(re) { |m| URI.encode_www_form_component(m.force_encoding(Encoding::UTF_8)) }
-    end
+      # Escape an element name
+      def escape_name(n)
+        escape(ESCAPE_NAMES_RE, n)
+      end
 
-    # Unescape value from EZID host (or other source)
-    # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
-    # @param value [String] the value to unescape
-    # @return [String] the unescaped value
-    def unescape(value)
-      value.gsub(UNESCAPE_RE) { |m| URI.decode_www_form_component(m) }
-    end
-    
-    # Coerce a string of metadata (e.g., from EZID host) into a Hash
-    # @note EZID host does not send comments or line continuations.
-    # @param data [String] the string to coerce
-    # @return [Hash] the hash of coerced data
-    def coerce_string(data)
-      data.gsub!(COMMENT_RE, "")
-      data.gsub!(LINE_CONTINUATION_RE, " ")
-      data.split(LINE_ENDING_RE).each_with_object({}) do |line, memo|
-        element, value = line.split(ANVL_SEPARATOR, 2)
-        memo[unescape(element.strip)] = unescape(value.strip)
+      # Escape an element value
+      def escape_value(v)
+        escape(ESCAPE_VALUES_RE, v)
+      end
+
+      # Escape string for sending to EZID host
+      # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
+      # @param re [Regexp] the regular expression to match for escaping
+      # @param s [String] the string to escape
+      # @return [String] the escaped string
+      def escape(re, s)
+        s.gsub(re) { |m| URI.encode_www_form_component(m.force_encoding(Encoding::UTF_8)) }
+      end
+
+      # Unescape value from EZID host (or other source)
+      # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
+      # @param value [String] the value to unescape
+      # @return [String] the unescaped value
+      def unescape(value)
+        value.gsub(UNESCAPE_RE) { |m| URI.decode_www_form_component(m) }
+      end
+      
+      # Coerce a string of metadata (e.g., from EZID host) into a Hash
+      # @note EZID host does not send comments or line continuations.
+      # @param data [String] the string to coerce
+      # @return [Hash] the hash of coerced data
+      def coerce_string(data)
+        data.gsub!(COMMENT_RE, "")
+        data.gsub!(LINE_CONTINUATION_RE, " ")
+        data.split(LINE_ENDING_RE).each_with_object({}) do |line, memo|
+          element, value = line.split(ANVL_SEPARATOR, 2)
+          memo[unescape(element.strip)] = unescape(value.strip)
+        end
       end
-    end
 
   end
 end
+
+Ezid::Metadata.initialize!

data/lib/ezid/request.rb

@@ -7,6 +7,7 @@ module Ezid
   # A request to the EZID service.
   #
   # @api private
+  #
   class Request < SimpleDelegator
 
     HOST = "https://ezid.cdlib.org"

data/lib/ezid/response.rb

@@ -5,6 +5,7 @@ module Ezid
   # A response from the EZID service.
   #
   # @api private
+  #
   class Response < SimpleDelegator
 
     # Success response status

data/lib/ezid/session.rb

@@ -3,6 +3,7 @@ module Ezid
   # An EZID session
   #
   # @api private
+  #
   class Session
 
     attr_reader :cookie

data/lib/ezid/status.rb

@@ -1,4 +1,10 @@
 module Ezid
+  #
+  # A response to an EZID status request
+  #
+  # @see Ezid::Response
+  # @api private
+  #
   class Status < SimpleDelegator
 
     SUBSYSTEMS = %w( noid ldap datacite )

data/spec/unit/identifier_spec.rb

@@ -183,5 +183,26 @@ module Ezid
       end
     end
 
+    describe "boolean status methods" do
+      context "when the status is 'public'" do
+        before { allow(subject.metadata).to receive(:status) { Identifier::PUBLIC } }
+        it { is_expected.to be_public } 
+        it { is_expected.not_to be_reserved }
+        it { is_expected.not_to be_unavailable }
+      end
+      context "when the status is 'reserved'" do
+        before { allow(subject.metadata).to receive(:status) { Identifier::RESERVED } }
+        it { is_expected.not_to be_public } 
+        it { is_expected.to be_reserved }
+        it { is_expected.not_to be_unavailable }
+      end
+      context "when the status is 'unavailable'" do
+        before { allow(subject.metadata).to receive(:status) { Identifier::UNAVAILABLE } }
+        it { is_expected.not_to be_public } 
+        it { is_expected.not_to be_reserved }
+        it { is_expected.to be_unavailable }
+      end
+    end
+
   end
 end

data/spec/unit/metadata_spec.rb

@@ -3,11 +3,11 @@ module Ezid
     
     describe "reserved elements" do
       describe "readers" do
-        Metadata::RESERVED_ELEMENTS.each do |element|
-          next if element == "_crossref"
+        Metadata::RESERVED_ELEMENTS.each do |element|   
           it "should have a reader for '#{element}'" do
             expect(subject).to receive(:reader).with(element)
-            subject.send(element.sub("_", ""))
+            reader = (element == "_crossref") ? element : element.sub("_", "")
+            subject.send(reader)
           end
         end
         describe "for time-based elements" do
@@ -27,7 +27,8 @@ module Ezid
           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")
+            writer = ((element == "_crossref") ? element : element.sub("_", "")).concat("=")
+            subject.send(writer, "value")
           end      
         end
       end
@@ -51,6 +52,15 @@ module Ezid
               end
             end
           end
+          next if profile == "dc"
+          it "should have a reader for '#{profile}'" do
+            expect(subject).to receive(:reader).with(profile)
+            subject.send(profile)
+          end
+          it "should have a writer for '#{profile}'" do
+            expect(subject).to receive(:writer).with(profile, "value")
+            subject.send("#{profile}=", "value")
+          end
         end
       end
     end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-06 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'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 description: Ruby client for EZID API Version 2 (http://ezid.cdlib.org/doc/apidoc.html)
 email:
 - dchandekstark@gmail.com
@@ -88,7 +74,6 @@ files:
 - lib/ezid/error.rb
 - lib/ezid/identifier.rb
 - lib/ezid/metadata.rb
-- lib/ezid/metadata_elements.rb
 - lib/ezid/request.rb
 - lib/ezid/response.rb
 - lib/ezid/session.rb
@@ -98,7 +83,6 @@ files:
 - 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:
@@ -130,5 +114,4 @@ test_files:
 - 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/lib/ezid/metadata_elements.rb

@@ -1,145 +0,0 @@
-require "active_support"
-
-module Ezid
-  #
-  # EZID metadata elements
-  #
-  # @note Intended to be used only as included in Ezid::Metadata.
-  #
-  module MetadataElements
-    extend ActiveSupport::Concern
-    
-    # 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
-      # "_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_element_accessors
-      
-      element_accessor *PROFILE_ELEMENTS
-
-      # "_crossref" does not get a reserved accessor because of the "crossref" element.
-      element_accessor "_crossref"
-    end
-
-    module ClassMethods
-      # 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
-
-      # 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
-
-      # 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
-            return nil if time == 0 # value is nil or empty string                                                    
-            Time.at(time).utc
-          end
-        end
-      end
-
-      # 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)
-          end
-        end
-      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     
-          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) }
-          define_method("#{element}=") { |value| writer(element, value) }
-        end
-      end
-    end
-
-    private
-
-    def reader(element)
-      self[element]
-    end
-
-    def writer(element, value)
-      self[element] = value
-    end
-
-  end
-end

data/spec/unit/metadata_elements_spec.rb

@@ -1,43 +0,0 @@
-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