ezid-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c3a0edbc74bbd749bf0c099fa07cad69bfebcdb
-  data.tar.gz: 4fdea290531b0f68d4d652a17b800585a4514f34
+  metadata.gz: 7525ff60fc6c37fafa16197480ff8612fb0d7cd0
+  data.tar.gz: 2d7a986b67c23cf09722b4ccfb27d70913a2ef5e
 SHA512:
-  metadata.gz: 8eecfcf10284ab9c6ccbe0916547d704d75ee3b0e9b8d6da0ff4dcadbe35a3d698400f741483c5529f6ce1809caee462b812d76356231ac06732d3ebbac49f7f
-  data.tar.gz: 0c137cf93d57cff8186821ace6125ca390833ed8a07327d1cffb50e708a8dae374594e374fe3f2cd603e725295b8e0c367645cb3639c568ca230e48814f3b01d
+  metadata.gz: a681531c12267fd6b849d59ce37a533cd2e9e00c8f8f43deb54e646fff4772f881ba7e84e1d118545bcec90e0531f87647bf35c51c0c6b1d06a978b39ef0aa66
+  data.tar.gz: 87b9bc72d63e31e934ec4849b79f2307ac73ad34cabbcf21faf4a10c69f3f23e0e65ec58e8e080cfb37019f270fdd0eeb6404c636b48431944ee18535c8a7288

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/ezid/client.rb

@@ -1,5 +1,4 @@
 require_relative "api"
-require_relative "identifier"
 require_relative "request"
 require_relative "response"
 require_relative "metadata"

data/lib/ezid/metadata.rb

@@ -12,7 +12,7 @@ module Ezid
     # The metadata elements hash
     attr_reader :elements
 
-    def_delegators :elements, :each, :empty?, :[], :[]=
+    def_delegators :elements, :each, :keys, :values, :empty?, :[], :[]=
 
     # EZID metadata profiles
     PROFILES = %w( erc dc datacite crossref )
@@ -45,8 +45,10 @@ module Ezid
     # EZID metadata field/value separator
     ANVL_SEPARATOR = ": "
 
-    # Characters to escape on output to EZID
-    ESCAPE_RE = /[%:\r\n]/
+    # Characters to escape in element values on output to EZID
+    ESCAPE_VALUES_RE = /[%\r\n]/
+
+    ESCAPE_KEYS_RE = /[%:\r\n]/
 
     # Character sequence to unescape from EZID
     UNESCAPE_RE = /%\h\h/
@@ -68,7 +70,7 @@ module Ezid
     # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
     # @return [String] the ANVL output
     def to_anvl
-      lines = map { |element| element.map { |e| escape(e) }.join(ANVL_SEPARATOR) }
+      lines = escape_keys.zip(escape_values).map { |e| e.join(ANVL_SEPARATOR) }
       lines.join("\n").force_encoding(Encoding::UTF_8)
     end
 
@@ -120,12 +122,21 @@ module Ezid
       hsh.keys.map(&:to_s).zip(hsh.values).to_h
     end
 
+    def escape_keys
+      keys.map { |k| escape(ESCAPE_KEYS_RE, k) }
+    end
+
+    def escape_values
+      values.map { |v| escape(ESCAPE_VALUES_RE, v) }
+    end
+
     # Escape value 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 value [String] the value to escape
     # @return [String] the escaped value
-    def escape(value)
-      value.gsub(ESCAPE_RE) { |m| URI.encode(m) }
+    def escape(re, value)
+      value.gsub(re) { |m| URI.encode_www_form_component(m) }
     end
 
     # Unescape value from EZID host (or other source)
@@ -133,7 +144,7 @@ module Ezid
     # @param value [String] the value to unescape
     # @return [String] the unescaped value
     def unescape(value)
-      value.gsub(UNESCAPE_RE) { |m| URI.decode(m) }
+      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

data/spec/lib/ezid/metadata_spec.rb

@@ -1,19 +1,26 @@
 module Ezid
   RSpec.describe Metadata do
+
     describe "method missing" do
-      context "for an internal metadata element name w/o leading underscore" do
+      context "for an internal element name w/o leading underscore" do
         it "should call the reader method" do
           expect(subject).to receive(:reader).with("_status")
           subject.status
         end
       end
-      context "for an internal writable metadata element name + '=' and w/o leading underscore" do
+      context "for an internal writable element name + '=' and w/o leading underscore" do
         it "should call the writer method" do
           expect(subject).to receive(:writer).with("_status", "public")
           subject.status = "public"
         end
       end
+      context "for an internal readonly element name + '=' and w/o leading underscore" do
+        it "should not call the writer method" do
+          expect { subject.created = "1416507086" }.to raise_error
+        end
+      end
     end
+
     describe "internal element reader" do
       context "for a datetime element" do
         before { subject["_created"] = "1416507086" }
@@ -28,12 +35,14 @@ module Ezid
         end
       end
     end
+
     describe "internal element writer" do
       before { subject["_status"] = "reserved" }
       it "should set the element" do
         expect { subject.status = "public" }.to change { subject["_status"] }.from("reserved").to("public")
       end
     end
+
     describe "ANVL output" do
       let(:metadata) { described_class.new(_updated: "1416507086",
                                            _target: "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
@@ -54,9 +63,51 @@ _export: yes
 _created: 1416507086
 _status: public")
       end
+      describe "escaping" do
+        context "of element names" do
+          it "should escape a colon"
+          it "should escape a line feed"
+          it "should escape a carriage return"
+          it "should escape a percent sign"
+        end
+        context "of element values" do
+          it "should escape a line feed"
+          it "should escape a carriage return"
+          it "should escape a percent sign"
+        end
+      end
     end
-    describe "coercion" do
 
+    describe "coercion" do
+      context "of a string" do
+        let(:data) { "\
+_updated: 1416507086
+_target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
+_profile: erc
+_ownergroup: apitest
+_owner: apitest
+_export: yes
+_created: 1416507086
+_status: public" }
+        subject { described_class.new(data) }
+        it "should coerce the data into a hash" do
+          expect(subject.elements).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
+        it "should stringify the keys"
+      end
+      context "of an Ezid::Metadata instance" do
+        it "should return the elements hash"
+      end
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - dchandekstark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,6 @@ files:
 - lib/ezid/client.rb
 - lib/ezid/configuration.rb
 - lib/ezid/error.rb
-- lib/ezid/identifier.rb
 - lib/ezid/logger.rb
 - lib/ezid/metadata.rb
 - lib/ezid/request.rb
@@ -108,7 +107,6 @@ files:
 - lib/ezid/session.rb
 - lib/ezid/test_helper.rb
 - spec/lib/ezid/client_spec.rb
-- spec/lib/ezid/identifier_spec.rb
 - spec/lib/ezid/metadata_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/duke-libraries/ezid-client
@@ -137,6 +135,5 @@ 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/spec_helper.rb

data/lib/ezid/identifier.rb

@@ -1,129 +0,0 @@
-require "forwardable"
-
-require_relative "metadata"
-
-module Ezid
-  #
-  # An EZID identifier resource.
-  #
-  # Identifier objects are instantiated by the class methods `create', `mint' and `find'.
-  #
-  # @api public 
-  class Identifier
-    extend Forwardable
-
-    attr_reader :id
-
-    def_delegators :metadata, :status
-
-    private_class_method :new
-
-    class << self
-      # Creates and EZID identifier
-      def create(id, metadata=nil)
-        response = Client.create_identifier(id, metadata)
-        new(response.identifier)
-      end
-
-      # Mints an EZID identifier
-      def mint(shoulder=nil, metadata=nil)
-        response = Client.mint_identifier(metadata)
-        identifier = new(response.identifier)
-      end
-
-      # Find an EZID indentifier
-      def find(id)
-        response = Client.get_identifier_metadata(id)
-        new(response.identifier, response.metadata)
-      end
-    end
-
-    def initialize(id, metadata=nil)
-      @id = id
-      @metadata = Metadata.new(metadata)
-    end
-
-    # The identifier metadata, cached locally
-    # @return [Ezid::Metadata] the metadata
-    def metadata
-      reload if @metadata.empty?
-      @metadata
-    end
-
-    # The identifier which this identifier is shadowed by, or nil.
-    # @return [Ezid::Identifier] the shadowing identifier
-    def shadowed_by
-      Identifer.new(metadata.shadowedby) if metadata.shadowedby
-    end
-
-    # The identifer which this identifier shadows, or nil.
-    # @return [Ezid::Identifier] the shadowed identifier
-    def shadows
-      Identifier.new(metadata.shadows) if metadata.shadows
-    end
-
-    # Retrieve the current metadata for the identifier from EZID
-    # @return [Ezid::Identifier] the identifier
-    def reload
-      response = client.get_identifier_metadata(id)
-      @metadata = response.metadata
-      self
-    end
-
-    # Clears the metadata on the identifier object
-    # @return [Ezid::Identifier] the identifier
-    def reset
-      @metadata = Metadata.new
-      self
-    end
-
-    # Returns an EZID client
-    # @return [Ezid::Client] the client
-    def client
-      @client ||= Client.new
-    end
-
-    # Deletes the identifier - caution!
-    def delete
-      response = client.delete_identifier(id)
-      reset
-      freeze
-      response.message
-    end
-
-    # Sends the metadata to EZID - caution!
-    def update(metadata)
-      response = client.modify_identifier_metadata(metadata)
-      reset
-      response.message
-    end
-
-    def make_public!
-      update(_status: Metadata::PUBLIC)
-    end
-
-    def make_unavailable!
-      update(_status: Metadata::UNAVAILABLE)
-    end
-
-    def public?
-      status == Metadata::PUBLIC
-    end
-
-    def reserved?
-      status == Metadata::RESERVED
-    end
-
-    def unavailable?
-      status == Metadata::UNAVAILABLE
-    end
-
-    private
-
-    def remove(*elements)
-      metadata = elements.map { |el| [el, ""] }.to_h
-      update(metadata)
-    end
-
-  end
-end

data/spec/lib/ezid/identifier_spec.rb

@@ -1,5 +0,0 @@
-module Ezid
-  RSpec.describe Identifier do
-
-  end
-end