Merge branch 'release-1.7.0'

.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - 2.3.1
   - 2.2
   - 2.1
-  - 2.0.0
 cache:
   - bundler
 script: "bundle exec rake ci"

README.md

@@ -33,9 +33,11 @@ Or install it yourself as:
 >> identifier = Ezid::Identifier.mint("ark:/99999/fk4")
 I, [2016-03-01T22:20:08.505323 #35148]  INFO -- : EZID MintIdentifier -- success: ark:/99999/fk4tq65d6k
 => #<Ezid::Identifier id=ark:/99999/fk4tq65d6k>
+
 >> identifier.status
 I, [2016-03-01T22:20:22.323650 #35148]  INFO -- : EZID GetIdentifierMetadata -- success: ark:/99999/fk4tq65d6k
 => "public"
+
 >> identifier.target
 => "http://ezid.cdlib.org/id/ark:/99999/fk4tq65d6k"
 ```
@@ -87,11 +89,14 @@ I, [2014-12-04T15:07:00.648676 #86655]  INFO -- : EZID GetIdentifierMetadata --
 ```
 >> identifier.target
 => "http://ezid.cdlib.org/id/ark:/99999/fk43f4wd4v"
+
 >> identifier.target = "http://example.com"
 => "http://example.com"
+
 >> identifier.save
 I, [2014-12-09T11:24:26.321801 #32279]  INFO -- : EZID ModifyIdentifier -- success: ark:/99999/fk43f4wd4v
 => #<Ezid::Identifier id="ark:/99999/fk43f4wd4v">
+
 >> identifier.target
 I, [2014-12-09T11:24:27.039288 #32279]  INFO -- : EZID GetIdentifierMetadata -- success: ark:/99999/fk43f4wd4v
 => "http://example.com"
@@ -107,6 +112,7 @@ I, [2014-12-09T11:24:27.039288 #32279]  INFO -- : EZID GetIdentifierMetadata --
 >> identifier = Ezid::Identifier.mint("ark:/99999/fk4", status: "reserved")
 I, [2016-03-01T22:26:08.645858 #36701]  INFO -- : EZID MintIdentifier -- success: ark:/99999/fk4pz5fm1b
 => #<Ezid::Identifier id=ark:/99999/fk4pz5fm1b>
+
 >> identifier.delete
 I, [2016-03-01T22:26:14.829731 #36701]  INFO -- : EZID GetIdentifierMetadata -- success: ark:/99999/fk4pz5fm1b
 I, [2016-03-01T22:26:15.711390 #36701]  INFO -- : EZID DeleteIdentifier -- success: ark:/99999/fk4pz5fm1b
@@ -120,22 +126,57 @@ See http://ezid.cdlib.org/doc/apidoc.html#parameters. Repeated values should be
 *Added in v1.3.0:* `Ezid::BatchDownload` class.
 
 ```
->> batch = Ezid::BatchDownload.new(:csv)
+>> batch_download = Ezid::BatchDownload.new(:csv)
  => #<Ezid::BatchDownload format=:csv>
->> batch.column = ["_id", "_target"]
+ 
+>> batch_download.column = ["_id", "_target"]
  => ["_id", "_target"]
->> batch.createdAfter = Date.today.to_time
+ 
+>> batch_download.createdAfter = Date.today.to_time
  => 2016-02-24 00:00:00 -0500
->> batch
+ 
+>> batch_download
  => #<Ezid::BatchDownload column=["_id", "_target"] createdAfter=1456290000 format=:csv>
->> batch.download_url
+ 
+>> batch_download.url
 I, [2016-02-24T18:03:40.828005 #1084]  INFO -- : EZID BatchDownload -- success: http://ezid.cdlib.org/download/4a63401e17.csv.gz
  => "http://ezid.cdlib.org/download/4a63401e17.csv.gz"
->> batch.download_file
-File successfully download to /current/working/directory/4a63401e17.csv.gz.
- => nil
+ 
+>> batch_download.file
+ => /current/working/directory/4a63401e17.csv.gz
  ```
 
+## Batch
+
+*Added in v1.6.0.* `Ezid::Batch` class.
+
+**Version 1.7.0 upgrade note:** This class was originally named `Ezid::BatchEnumerator`, but it is not a Ruby enumerator. `Ezid::Batch` is the new name with the same API.
+
+```
+>> require 'ezid/batch'
+ => true
+ 
+>> batch = Ezid::Batch.new(:anvl, "spec/fixtures/anvl_batch.txt")
+ => #<Ezid::Batch:0x007f87a8900308 @format=:anvl, @batch_file="spec/fixtures/anvl_batch.txt">
+ 
+>> id = batch.first
+ => #<Ezid::Identifier id=ark:/99999/fk4086hs23>
+ 
+>> id.target
+ => "http://example.com"
+
+>> puts id.metadata
+_updated: 1488227717
+_target: http://example.com
+_profile: erc
+_ownergroup: apitest
+_owner: apitest
+_export: yes
+_created: 1488227717
+_status: public
+ => nil
+```
+
 ## Metadata handling
 
 Accessors are provided to ease the use of 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):
@@ -145,6 +186,7 @@ Accessors are provided to ease the use of EZID [reserved metadata elements](http
 ```
 >> identifier.status                 # reads "_status" element
 => "public"
+
 >> identifier.status = "unavailable" # writes "_status" element
 => "unavailable"
 ```
@@ -159,6 +201,7 @@ Notes:
 ```
 >> identifier.dc_type           # reads "dc.type" element
 => "Collection"
+
 >> identifier.dc_type = "Image" # writes "dc.type" element
 => "Image"
 ```

VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

ezid-client.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 2.0"
+  spec.required_ruby_version = "~> 2.1"
 
   spec.add_dependency "hashie", "~> 3.4", ">= 3.4.3"
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec-its", "~> 1.2"
 end

lib/ezid/batch_enumerator.rb → lib/ezid/batch.rb

@@ -1,5 +1,5 @@
 module Ezid
-  class BatchEnumerator
+  class Batch
     include Enumerable
 
     attr_reader :format, :batch_file
@@ -25,7 +25,7 @@ def each_anvl(&block)
         while record = f.gets("")
           head, metadata = record.split(/\n/, 2)
           id = head.sub(/\A::/, "").strip
-          yield Ezid::Identifier.new(id, metadata: metadata)
+          yield Identifier.load(id, metadata)
         end
       end
     end

lib/ezid/batch_download.rb

@@ -84,6 +84,8 @@ def download_url
       get_response.download_url
     end
 
+    alias_method :url, :download_url
+
     def download_file(path: nil)
       path ||= Dir.getwd
       fullpath = File.directory?(path) ? File.join(path, download_filename) : path
@@ -123,6 +125,8 @@ def download_file(path: nil)
       fullpath
     end
 
+    alias_method :file, :download_file
+
     private
 
     def download_uri

lib/ezid/identifier.rb

@@ -65,20 +65,36 @@ def mint(*args)
       # @return [Ezid::Identifier] the identifier
       # @raise [Ezid::IdentifierNotFoundError]
       def modify(id, metadata)
-        i = allocate
-        i.id = id
-        i.update_metadata(metadata)
-        i.modify!
+        allocate.tap do |i|
+          i.id = id
+          i.update_metadata(metadata)
+          i.modify!
+        end
+      end
+
+      # Loads an identifier with provided remote metadata
+      # The main purpose is to provide an API in a batch processing
+      # context to instantiate Identifiers from a BatchDownload.
+      # @see #load_metadata!
+      # @param id [String] the EZID identifier
+      # @param metadata [String, Hash, Ezid::Metadata] the provided metadata
+      # @return [Ezid::Identifier] the identifier
+      def load(id, metadata = nil)
+        allocate.tap do |i|
+          i.id = id
+          i.load_metadata!(metadata)
+        end
       end
 
       # Retrieves an identifier
       # @param id [String] the EZID identifier to find
       # @return [Ezid::Identifier] the identifier
       # @raise [Ezid::IdentifierNotFoundError] if the identifier does not exist in EZID
       def find(id)
-        i = allocate
-        i.id = id
-        i.load_metadata
+        allocate.tap do |i|
+          i.id = id
+          i.load_metadata
+        end
       end
     end
 
@@ -132,9 +148,14 @@ def to_s
     # @return [Ezid::Metadata] the metadata
     def metadata(_=nil)
       if !_.nil?
-        warn "[DEPRECATION] The parameter of `metadata` is deprecated and will be removed in 2.0. (called from #{caller.first})"
+        warn "[DEPRECATION] The parameter of `metadata` is ignored and will be removed in 2.0. " \
+             "(called from #{caller.first})"
       end
-      @metadata ||= Metadata.new
+      remote_metadata.merge(local_metadata).freeze
+    end
+
+    def local_metadata
+      @local_metadata ||= Metadata.new
     end
 
     def remote_metadata
@@ -172,7 +193,7 @@ def modify!
     # @param attrs [Hash] the metadata
     # @return [Ezid::Identifier] the identifier
     def update_metadata(attrs={})
-      metadata.update(attrs)
+      local_metadata.update(attrs)
       self
     end
 
@@ -203,13 +224,25 @@ def reload
       load_metadata
     end
 
-    # Loads the metadata from EZID
+    # Loads the metadata from EZID and marks the identifier as persisted.
     # @return [Ezid::Identifier] the identifier
-    # @raise [Ezid::Error]
+    # @raise [Ezid::Error] the identifier is not found or other error.
     def load_metadata
       response = client.get_identifier_metadata(id)
-      # self.remote_metadata = Metadata.new(response.metadata)
-      remote_metadata.replace(response.metadata)
+      load_remote_metadata(response.metadata)
+      persists!
+      self
+    end
+
+    # Loads provided metadata and marks the identifier as persisted.
+    # The main purpose is to provide an API in a batch processing
+    # context to instantiate Identifiers from a BatchDownload.
+    # @see Ezid::BatchEnumerator
+    # @see .load
+    # @param metadata [String, Hash, Ezid::Metadata] the provided metadata
+    # @return [Ezid::Identifier] the identifier
+    def load_metadata!(metadata)
+      load_remote_metadata(metadata)
       persists!
       self
     end
@@ -287,7 +320,7 @@ def client
     end
 
     def reset_metadata
-      metadata.clear unless metadata.empty?
+      local_metadata.clear unless local_metadata.empty?
       remote_metadata.clear unless remote_metadata.empty?
     end
 
@@ -302,7 +335,7 @@ def method_missing(*args)
     private
 
     def local_or_remote_metadata(*args)
-      value = metadata.send(*args)
+      value = local_metadata.send(*args)
       if value.nil? && persisted?
         load_metadata if remote_metadata.empty?
         value = remote_metadata.send(*args)
@@ -311,20 +344,20 @@ def local_or_remote_metadata(*args)
     end
 
     def modify
-      client.modify_identifier(id, metadata)
+      client.modify_identifier(id, local_metadata)
     end
 
     def create_or_mint
       id ? create : mint
     end
 
     def mint
-      response = client.mint_identifier(shoulder, metadata)
+      response = client.mint_identifier(shoulder, local_metadata)
       self.id = response.id
     end
 
     def create
-      client.create_identifier(id, metadata)
+      client.create_identifier(id, local_metadata)
     end
 
     def persist
@@ -340,5 +373,9 @@ def apply_default_metadata
       update_metadata(self.class.defaults)
     end
 
+    def load_remote_metadata(metadata)
+      remote_metadata.replace(metadata)
+    end
+
   end
 end

spec/integration/batch_download_spec.rb

@@ -1,18 +1,18 @@
 require 'tempfile'
 
 module Ezid
-  RSpec.describe BatchDownload do
+  RSpec.describe BatchDownload, integration: true do
 
     subject do
       a_week_ago = (Time.now - (7*24*60*60)).to_i
       described_class.new(:anvl, compression: "zip", permanence: "test", status: "public", createdAfter: a_week_ago)
     end
 
-    its(:download_url) { is_expected.to match(/\Ahttp:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/) }
-
     specify {
+      expect(subject.download_url).to match(/\Ahttp:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/)
+      expect(subject.url).to match(/\Ahttp:\/\/ezid\.cdlib\.org\/download\/\w+\.zip\z/)
       Dir.mktmpdir do |tmpdir|
-        expect(subject.download_file(path: tmpdir))
+        expect(subject.file(path: tmpdir))
           .to match(/\A#{tmpdir}\/\w+\.zip\z/)
       end
     }

spec/spec_helper.rb

@@ -76,7 +76,7 @@
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 5
+  #config.profile_examples = 5
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

spec/unit/batch_enumerator_spec.rb → spec/unit/batch_spec.rb

@@ -1,7 +1,7 @@
-require 'ezid/batch_enumerator'
+require 'ezid/batch'
 
 module Ezid
-  RSpec.describe BatchEnumerator do
+  RSpec.describe Batch do
 
     let(:batch_file) { File.expand_path("../../fixtures/anvl_batch.txt", __FILE__) }