ezid-client 1.5.0 → 1.9.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e7662a25f1a8f0b0c027298428ed9ee5714137c
-  data.tar.gz: ae70777a70f7ffb50fb00e49e3c86c305e0721d0
+SHA256:
+  metadata.gz: 992d846692204d2ee3317ba756f1f70448a1194fb8e2d7cf129dd9b7f270919e
+  data.tar.gz: 3dba7c268214d865b85425cfb18ad3dd5f2e23d1b8a0c21ed14366b4aaae283c
 SHA512:
-  metadata.gz: 68d2a8953cdf238fb34fbb861129b2a34a1e42e1aded1f3a56e3ed720507a67f4313ca67ed6ffe5e59567769c5556fedcf52ebdd69a9e500c0fb1e0893db9bf2
-  data.tar.gz: 8a0763e0ff8922e9ae2b0c946acf16c8da5f9b64296235efc9f5a5aac2204bd234cf897cecb3af4d87a363f7aba2d95571ce8f15f7557f6ef21d02eed49aaba9
+  metadata.gz: 161c7c1037a3016c2399b24e3f6fb6addfd91988e3b97149da907bd5461a72b29eb9058d403067b9a166ba6eea40bd58fd7f291a11100a698b93e24a9d228159
+  data.tar.gz: 3538d1792458f2d53ee81868249c3217112994aea0da67e1023eda3526bc98246282b90d87a346287e12f7eadd24874a48f5d521f055ea5a34d1130844832b87

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.5.0
+1.9.0.rc1

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.rb

@@ -0,0 +1,42 @@
+module Ezid
+  class Batch
+    include Enumerable
+
+    attr_reader :format, :batch_file
+
+    def initialize(format, batch_file)
+      @format = format
+      @batch_file = batch_file
+    end
+
+    def each(&block)
+      case format
+      when :anvl
+        each_anvl(&block)
+      when :xml
+        each_xml(&block)
+      when :csv
+        each_csv(&block)
+      end
+    end
+
+    def each_anvl(&block)
+      File.open(batch_file, "rb") do |f|
+        while record = f.gets("")
+          head, metadata = record.split(/\n/, 2)
+          id = head.sub(/\A::/, "").strip
+          yield Identifier.load(id, metadata)
+        end
+      end
+    end
+
+    def each_xml
+      raise NotImplementedError
+    end
+
+    def each_csv
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/ezid/batch_download.rb

@@ -40,6 +40,7 @@ module Ezid
 
     # Parameters
     property :format, required: true # {anvl|csv|xml}
+    property :compression            # {gzip|zip}
     property :column                 # repeatable
     property :notify                 # repeatable
     property :convertTimestamps      # {yes|no}
@@ -83,40 +84,53 @@ 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
       tries = 0
-      begin
-        tries += 1
-        download = Net::HTTP.get_response(download_uri)
-        download.value
-      rescue Net::HTTPServerException => e
-        if download.is_a?(Net::HTTPNotFound)
-          if tries < MAX_DOWNLOAD_TRIES
-            print "Download file not yet available (attempt #{tries} of #{MAX_DOWNLOAD_TRIES})."
-            puts " Trying again in #{DOWNLOAD_RETRY_INTERVAL} second(s) ..."
-            sleep DOWNLOAD_RETRY_INTERVAL
-            retry
-          else
-            raise BatchDownloadError,
-                  "Maximum download attempts (#{MAX_DOWNLOAD_TRIES}) reached unsuccessfully."
+      ready = false
+
+      print "Checking for download "
+      Net::HTTP.start(download_uri.host, download_uri.port) do |http|
+        while tries < MAX_DOWNLOAD_TRIES
+          tries += 1
+          sleep DOWNLOAD_RETRY_INTERVAL
+          print "."
+          response = http.head(download_uri.path)
+          if response.code == '200'
+            ready = true
+            break
           end
-        else
-          raise
         end
-      else
-        File.open(fullpath, "wb") do |f|
-          f.write(download.body)
+      end
+      puts
+
+      unless ready
+        raise BatchDownloadError,
+              "Download not ready after checking #{MAX_DOWNLOAD_TRIES} times."
+      end
+
+      File.open(fullpath, "wb") do |f|
+        Net::HTTP.start(download_uri.host, download_uri.port) do |http|
+          http.request_get(download_uri.path) do |response|
+            response.read_body do |chunk|
+              f.write(chunk)
+            end
+          end
         end
-        puts "File successfully download to #{fullpath}."
       end
+
+      fullpath
     end
 
+    alias_method :file, :download_file
+
     private
 
     def download_uri
-      URI(download_url)
+      @download_uri ||= URI(download_url)
     end
 
     def download_filename

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