ezid-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7525ff60fc6c37fafa16197480ff8612fb0d7cd0
-  data.tar.gz: 2d7a986b67c23cf09722b4ccfb27d70913a2ef5e
+  metadata.gz: 40cb3555f7bca7cbb5a29841afc004e9d00ebeaa
+  data.tar.gz: 07da9b35895929c94079f2ef82a24e511bb6f89a
 SHA512:
-  metadata.gz: a681531c12267fd6b849d59ce37a533cd2e9e00c8f8f43deb54e646fff4772f881ba7e84e1d118545bcec90e0531f87647bf35c51c0c6b1d06a978b39ef0aa66
-  data.tar.gz: 87b9bc72d63e31e934ec4849b79f2307ac73ad34cabbcf21faf4a10c69f3f23e0e65ec58e8e080cfb37019f270fdd0eeb6404c636b48431944ee18535c8a7288
+  metadata.gz: 6eb587dffe69c56bd119fcfbebcd06e58d3bc6cf4f7a5a5dcced275411b675e70ebebb0dcf1c19e21e4369b9673235d439860893be455c6e8d1b85f5de11284a
+  data.tar.gz: c29ec20b8fd8dae31c8e4e60afe0210c460b9817e6367c2284a9fe2045d43638705891dce0a148ad8ce8fc14e00ea70561ba878a963614d1c351e850cfaa0a82

data/README.md

@@ -85,10 +85,6 @@ I, [2014-11-20T13:18:47.213566 #86059]  INFO -- : success: authentication creden
 => #<Ezid::Client:0x007faa5a712350 , @user="apitest", @password="********">
 ```
 
-## Resource-oriented Usage
-
-Experimental -- see `Ezid::Identifier`.
-
 ## Metadata handling
 
 See `Ezid::Metadata`.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ezid/metadata.rb

@@ -37,10 +37,6 @@ module Ezid
 
     # EZID internal metadata elements
     INTERNAL_ELEMENTS = (INTERNAL_READONLY_ELEMENTS + INTERNAL_READWRITE_ELEMENTS).freeze
-
-    # Internal metadata element which are datetime values
-    # @note EZID outputs datetime info as epoch seconds.
-    DATETIME_ELEMENTS = %w( _created _updated ).freeze
     
     # EZID metadata field/value separator
     ANVL_SEPARATOR = ": "
@@ -70,8 +66,7 @@ module Ezid
     # @see http://ezid.cdlib.org/doc/apidoc.html#request-response-bodies
     # @return [String] the ANVL output
     def to_anvl
-      lines = escape_keys.zip(escape_values).map { |e| e.join(ANVL_SEPARATOR) }
-      lines.join("\n").force_encoding(Encoding::UTF_8)
+      escape_keys.zip(escape_values).map { |e| e.join(ANVL_SEPARATOR) }.join("\n")
     end
 
     def to_s
@@ -86,23 +81,45 @@ module Ezid
       self
     end
 
-    # method_missing is used to provide internal element readers and writers
-    def method_missing(name, *args)
-      if INTERNAL_ELEMENTS.include?(element = "_#{name}")
-        reader(element) 
-      elsif name.to_s.end_with?("=") && INTERNAL_READWRITE_ELEMENTS.include?(element = "_#{name}".sub("=", ""))
-        writer(element, args.first) 
-      else
-        super
-      end
+    # Identifier status
+    # @return [String] the status
+    def status
+      reader("_status")
+    end
+
+    # The time the identifier was created
+    # @return [Time] the time
+    def created
+      value = reader("_created")
+      return Time.at(value.to_i) if value
+      value
+    end
+
+    # The time the identifier was last updated
+    # @return [Time] the time
+    def updated
+      value = reader("_updated")
+      return Time.at(value.to_i) if value
+      value
+    end
+
+    # The identifier's preferred metadata profile
+    # @see http://ezid.cdlib.org/doc/apidoc.html#metadata-profiles
+    # @return [String] the profile
+    def profile
+      reader("_profile")
+    end
+
+    # The identifier's target URL
+    # @return [String] the URL
+    def target
+      reader("_target")
     end
 
     private
 
     def reader(element)
-      value = self[element]
-      return Time.at(value.to_i) if DATETIME_ELEMENTS.include?(element) && !value.nil?
-      value
+      self[element]
     end
 
     def writer(element, value)
@@ -136,7 +153,7 @@ module Ezid
     # @param value [String] the value to escape
     # @return [String] the escaped value
     def escape(re, value)
-      value.gsub(re) { |m| URI.encode_www_form_component(m) }
+      value.gsub(re) { |m| URI.encode_www_form_component(m, Encoding::UTF_8) }
     end
 
     # Unescape value from EZID host (or other source)

data/spec/lib/ezid/metadata_spec.rb

@@ -1,59 +1,46 @@
 module Ezid
   RSpec.describe Metadata do
-
-    describe "method missing" 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 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
+    
+    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
+    before { subject.instance_variable_set(:@elements, elements) }
+    describe "#status" do
+      it "should return the status" do
+        expect(subject.status).to eq("public")
       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
+    describe "#target" do
+      it "should return the target URL" do
+        expect(subject.target).to eq("http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87")
       end
     end
-
-    describe "internal element reader" do
-      context "for a datetime element" do
-        before { subject["_created"] = "1416507086" }
-        it "should return a Time" do          
-          expect(subject.created).to be_a(Time)
-        end
+    describe "#profile" do
+      it "should return the profile" do
+        expect(subject.profile).to eq("erc")
       end
-      context "for a non-datetime element" do
-        before { subject["_status"] = "public" }
-        it "should return the value" do
-          expect(subject.status).to eq("public")
-        end
+    end
+    describe "#created" do
+      it "should return the creation time" do
+        expect(subject.created).to be_a(Time)
       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")
+    describe "#updated" do
+      it "should return the last update time" do
+        expect(subject.updated).to be_a(Time)
       end
     end
 
     describe "ANVL output" do
-      let(:metadata) { described_class.new(_updated: "1416507086",
-                                           _target: "http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87",
-                                           _profile: "erc",
-                                           _ownergroup: "apitest",
-                                           _owner: "apitest",
-                                           _export: "yes",
-                                           _created: "1416507086",
-                                           _status: "public") }
       it "should output the proper format" do
-        expect(metadata.to_anvl).to eq("\
+        expect(subject.to_anvl).to eq("\
 _updated: 1416507086
 _target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
 _profile: erc
@@ -63,24 +50,36 @@ _export: yes
 _created: 1416507086
 _status: public")
       end
+      describe "encoding" do
+        before do
+          subject.each_key { |k| subject[k] = subject[k].force_encoding("US_ASCII") }
+        end
+      end
+      it "should be encoded in UTF-8" do
+        expect(subject.to_anvl.encoding).to eq(Encoding::UTF_8)
+      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"
+        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
-        context "of element values" do
-          it "should escape a line feed"
-          it "should escape a carriage return"
-          it "should escape a percent sign"
+        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 a string" do
-        let(:data) { "\
+        let(:data) do <<-EOS
 _updated: 1416507086
 _target: http://ezid.cdlib.org/id/ark:/99999/fk4fn19h87
 _profile: erc
@@ -88,8 +87,9 @@ _ownergroup: apitest
 _owner: apitest
 _export: yes
 _created: 1416507086
-_status: public" }
-        subject { described_class.new(data) }
+_status: public
+EOS
+        end
         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",
@@ -102,10 +102,26 @@ _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"
+        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.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
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ezid-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - dchandekstark