ezid-client 1.6.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fea39a10be4faa6f53fc90a1e47912aac563852b
-  data.tar.gz: 7812a50e289a44f48d2f7da5d160e87178f5aad2
+SHA256:
+  metadata.gz: 6de69095537c80864a186b0089180182a74d08b2f6d9caddbab4628133919ef5
+  data.tar.gz: fefce462bfcb82b6297b5af267c3c9fe5bd49808675892634cf00df004ebd488
 SHA512:
-  metadata.gz: 31a187c0ba4f9352093a87e1f86d963ea6d2204a564a81ccef9f4e63990afd709e479c72003a305db1db62c8fe224abea4ce8b335f431cf81e130d257a0e0761
-  data.tar.gz: 473bc07ee2231bf9d538097898796e11867162844024f494fddc33add670a44822b4be1ced89c60987328cf1deb1c30bbed4974919c92733ce9f893b74edbba9
+  metadata.gz: 48ccd47fc68d90bcb867aee4a6880b1a9385cca28470611659d970db01e4a714538ff0f79268cbbcb4617ae6970e0a0c4ac9c640f283e1ed9d723d38d1a0d87d
+  data.tar.gz: 697963d59a8dff29f4da1d78c48eb54a2cf500900b56301a2f18f892067ee7624cb8d601aa2d07a91372b8a8f614e114254a8b820e9a9108754cc902fac2e6b8

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec ./spec/unit/

data/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"
 ```
@@ -253,11 +296,10 @@ require "ezid/test_helper"
 
 The module provides constants:
 
-- `TEST_ARK_SHOULDER` => "ark:/99999/fk4"
-- `TEST_DOI_SHOULDER` => "doi:10.5072/FK2"
-- `TEST_USER` => "apitest"
-- `TEST_HOST` => "ezid.cdlib.org"
-- `TEST_PORT` => 443
+- `EZID_TEST_SHOULDER` => "doi:10.5072/FK2"
+- `EZID_TEST_USER` => "apitest"
+- `EZID_TEST_HOST` => "ezid.cdlib.org"
+- `EZID_TEST_PORT` => 443
 
 The test user password is not provided - contact EZID and configure as above - or use your own EZID credentials, since all accounts can mint/create on the test shoulders.
 
@@ -283,3 +325,7 @@ In order to run the integration tests successfully, you must supply the password
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Acknowledgments
+
+- Justin Gondron (jgondron) contributed Datacite compatibility code (added in v1.8.0).

data/Rakefile

@@ -5,18 +5,18 @@ desc "Run all specs in spec directory"
 RSpec::Core::RakeTask.new(:spec)
 
 desc "Run the ci build (no integration tests)"
-task :ci do
-  system "rspec . -t ~deprecated -t ~integration"
+RSpec::Core::RakeTask.new(:ci) do |t|
+  t.rspec_opts = "--tag '~deprecated' --tag '~ezid'"
 end
 
 desc "Run tests of deprecated functionality"
-task :deprecated do
-  system "rspec . -t deprecated"
+RSpec::Core::RakeTask.new(:deprecated) do |t|
+  t.rspec_opts = "--tag deprecated"
 end
 
 desc "Run the integration tests"
-task :integration do
-  system "rspec . -t integration"
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.rspec_opts = "--tag integration"
 end
 
 task default: :spec

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.9.0

data/ezid-client.gemspec

@@ -17,12 +17,14 @@ 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_dependency "nokogiri"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec-its", "~> 1.2"
 end

data/lib/ezid/{batch_enumerator.rb → batch.rb}

@@ -1,5 +1,5 @@
 module Ezid
-  class BatchEnumerator
+  class Batch
     include Enumerable
 
     attr_reader :format, :batch_file
@@ -25,7 +25,7 @@ module Ezid
         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

data/lib/ezid/batch_download.rb

@@ -84,6 +84,8 @@ module Ezid
       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 @@ module Ezid
       fullpath
     end
 
+    alias_method :file, :download_file
+
     private
 
     def download_uri

data/lib/ezid/client.rb

@@ -44,12 +44,11 @@ module Ezid
       end
     end
 
-    attr_reader :user, :password, :host, :port, :use_ssl, :timeout
+    attr_reader :user, :password, :host, :port, :timeout
 
     def initialize(opts = {})
       @host = opts[:host] || config.host
       @port = (opts[:port] || config.port).to_i
-      @use_ssl = opts[:use_ssl] || config.use_ssl
       @timeout = (opts[:timeout] || config.timeout).to_i
       @user = opts[:user] || config.user
       @password = opts[:password] || config.password
@@ -60,6 +59,12 @@ module Ezid
       end
     end
 
+    def use_ssl
+      warn "[DEPRECATION] `use_ssl` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+      true
+    end
+
     def inspect
       "#<#{self.class.name} connection=#{connection.inspect}, " \
         "user=#{user.inspect}, session=#{logged_in? ? 'OPEN' : 'CLOSED'}>"
@@ -188,15 +193,11 @@ module Ezid
 
     private
 
-    def use_ssl?
-      use_ssl || port == 443
-    end
-
     def build_connection
-      conn = Net::HTTP.new(host, port)
-      conn.use_ssl = use_ssl?
-      conn.read_timeout = timeout
-      conn
+      Net::HTTP.new(host, port).tap do |conn|
+        conn.use_ssl = true
+        conn.read_timeout = timeout
+      end
     end
 
     def handle_response(response, request_name)

data/lib/ezid/configuration.rb

@@ -20,9 +20,6 @@ module Ezid
     # EZID TCP/IP port
     attr_accessor :port
 
-    # Use HTTPS?
-    attr_accessor :use_ssl
-
     # HTTP read timeout (seconds)
     attr_accessor :timeout
 
@@ -44,7 +41,6 @@ module Ezid
       @password         = ENV["EZID_PASSWORD"]
       @host             = ENV["EZID_HOST"] || HOST
       @port             = ENV["EZID_PORT"] || PORT
-      @use_ssl          = true if ENV["EZID_USE_SSL"] == true.to_s
       @timeout          = ENV["EZID_TIMEOUT"] || TIMEOUT
       @default_shoulder = ENV["EZID_DEFAULT_SHOULDER"]
     end
@@ -67,5 +63,16 @@ module Ezid
       Metadata
     end
 
+    def use_ssl
+      warn "[DEPRECATION] `use_ssl` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+      true
+    end
+
+    def use_ssl=(*)
+      warn "[DEPRECATION] `use_ssl=` is deprecated and will be removed in ezid-client v2.0." \
+           " EZID requires SSL as of April 30, 2017."
+    end
+
   end
 end

data/lib/ezid/error.rb

@@ -8,4 +8,6 @@ module Ezid
   class NotAllowedError < Error; end
 
   class DeletionError < Error; end
+
+  class UnexpectedResponseError < Error; end
 end

data/lib/ezid/identifier.rb

@@ -65,10 +65,25 @@ module Ezid
       # @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
@@ -76,9 +91,10 @@ module Ezid
       # @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 @@ module Ezid
     # @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 @@ module Ezid
     # @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 @@ module Ezid
       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,8 +320,8 @@ module Ezid
     end
 
     def reset_metadata
-      metadata.clear unless metadata.empty?
-      remote_metadata.clear unless remote_metadata.empty?
+      local_metadata.clear
+      remote_metadata.clear
     end
 
     protected
@@ -302,7 +335,7 @@ module Ezid
     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,7 +344,7 @@ module Ezid
     end
 
     def modify
-      client.modify_identifier(id, metadata)
+      client.modify_identifier(id, local_metadata)
     end
 
     def create_or_mint
@@ -319,12 +352,12 @@ module Ezid
     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 @@ module Ezid
       update_metadata(self.class.defaults)
     end
 
+    def load_remote_metadata(metadata)
+      remote_metadata.replace(metadata)
+    end
+
   end
 end