dor-services-client 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed804aaf2e6cd1c85b743b0d625fa2dc8448996bf395ecb29c1b0ba60d0b655
-  data.tar.gz: 172a883790b9eb3f2c3f68214a4e6014c10670ee0ad1285f814b87e4ff9f38be
+  metadata.gz: 78f715a39b9f224746efdd2cdbbe6bc15ff133d115f5374a0375cb7fe9435774
+  data.tar.gz: c0808ad279301664e35953d8cee374e64a3b5dc2f217480491de71b29539239d
 SHA512:
-  metadata.gz: 82368e50a6b9eb2b732dabfca101a0ae5bbde981501995e472815dac0433b7f05637f983d39b1164c2252018db7c7551f8a0b84ab5a4b94b640e213483615028
-  data.tar.gz: a7321922ea212bf4f5c8c6df67b079d698353ee096c6739bbc08c5813d6d525a19bd3a93606383344b68c4fb1792222d5b79f465d1e3abed53dcd6fa042039aa
+  metadata.gz: 7361d4e2c6ee0e183c5c16ba8c4da4f4437a2abdd90a19f7a979e4244adaaa3f3cd40bfa2751bab746ba2eda1ca267314b2f99216f7176ab9e1cb8cc6ad887fb
+  data.tar.gz: 92f1c9ab4d60ab63146b49aac208969a3c6a0dcd40607be0c960bace46b5248c19c5d2f9720515c076eee3b45dd1cfd6738fadbffb4e89eb9c110824225ae104

data/.travis.yml

@@ -9,7 +9,5 @@ before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -40,12 +40,12 @@ private
 
 def client
   @client ||= Dor::Services::Client.configure(url: Settings.dor_services.url,
-                                              username: Settings.dor_services.user,
-                                              password: Settings.dor_services.pass)
+                                              token: Settings.dor_services.token,
+                                              token_header: Settings.dor_services.token_header)
 end
 ```
 
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**. The `username` and `password` arguments are optional. (If you are working in a project where the credentials are embedded in the URL, that ought to work just fine as well.)
+Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**. The `token` and `token_header` arguments are optional (though when using the client with staging and production servers, you will always need to supply these in practice). For more about dor-services-app's token-based authentication, see [its README](https://github.com/sul-dlss/dor-services-app#authentication).
 
 ## API Coverage
 
@@ -63,7 +63,7 @@ object_client.publish
 object_client.refresh_metadata
 object_client.notify_goobi
 object_client.version.current
-object_client.version.openeable?(**params)
+object_client.version.openable?(**params)
 object_client.version.open(**params)
 object_client.version.close(**params)
 # Get the Dublin Core XML representation

data/lib/dor/services/client/error_faraday_middleware.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      # This wraps any faraday connection errors with dor-service-client errors
+      # This wraps any faraday connection errors with dor-services-client errors
       class ErrorFaradayMiddleware < Faraday::Response::Middleware
         def call(env)
           @app.call(env)

data/lib/dor/services/client/object.rb

@@ -8,6 +8,7 @@ module Dor
       # API calls that are about a repository object
       class Object < VersionedService
         extend Deprecation
+        self.deprecation_horizon = 'dor-services-client version 2.0'
 
         attr_reader :object_identifier
 

data/lib/dor/services/client/object_version.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require 'deprecation'
+
 module Dor
   module Services
     class Client
       # API calls that are about versions
       class ObjectVersion < VersionedService
+        extend Deprecation
+        self.deprecation_horizon = 'dor-services-client 2.0.0'
+
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
@@ -24,14 +29,25 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # TODO: remove this deprecation once
+        #       https://github.com/sul-dlss/dor-services-app/issues/322 is
+        #       merged and all DSC clients have moved to using `#openable?`
+        def openeable?(**params)
+          openable?(**params)
+        end
+        deprecation_deprecate openeable?: 'use version.openable? instead'
+
         # Determines if a new version can be opened for a DOR object.
         # @param params [Hash] optional params (see dor-services-app)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [Boolean] true if a new version can be opened
         # rubocop:disable Metrics/MethodLength
-        def openeable?(**params)
+        def openable?(**params)
           resp = connection.get do |req|
+            # TODO: correct the typo below once
+            #       https://github.com/sul-dlss/dor-services-app/issues/322 is
+            #       merged and all running DSA instances have been deployed
             req.url "#{object_path}/versions/openeable"
             req.params = params
           end

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '1.11.0'
+      VERSION = '1.12.0'
     end
   end
 end

data/lib/dor/services/client/workflow.rb

@@ -6,7 +6,7 @@ module Dor
       # API calls that are about workflow
       class Workflow < VersionedService
         extend Deprecation
-        self.deprecation_horizon = 'dor-service-client version 2.0'
+        self.deprecation_horizon = 'dor-services-client version 2.0.0'
 
         # @param object_identifier [String] the pid for the object
         def initialize(connection:, version:, object_identifier:)
@@ -24,7 +24,7 @@ module Dor
           end
           raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
         end
-        deprecation_deprecate create: 'Create will be removed. Use dor-workflow-service instead'
+        deprecation_deprecate create: 'Create will be removed. Use dor-workflow-client instead'
 
         private
 

data/lib/dor/services/client/workflows.rb

@@ -5,6 +5,9 @@ module Dor
     class Client
       # API calls that are about workflows
       class Workflows < VersionedService
+        extend Deprecation
+        self.deprecation_horizon = 'dor-services-client version 2.0.0'
+
         # Get the initial XML for a workflow
         # @param name [String] the name of the xml
         # @return [String] the response
@@ -18,6 +21,7 @@ module Dor
 
           raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})"
         end
+        deprecation_deprecate initial: 'Initial will be removed. Use dor-workflow-client instead'
       end
     end
   end

data/lib/dor/services/client.rb

@@ -70,15 +70,11 @@ module Dor
 
       class << self
         # @param [String] url
-        # @param [String] username
-        # @param [String] password
         # @param [String] token a bearer token for HTTP auth
         # @param [String] token_header ('Authorization') set this to something if you are also using
         #                              basic auth, or the headers will collide
-        def configure(url:, username: nil, password: nil, token: nil, token_header: 'Authorization')
+        def configure(url:, token: nil, token_header: 'Authorization')
           instance.url = url
-          instance.username = username
-          instance.password = password
           instance.token = token
           instance.token_header = token_header
 
@@ -91,31 +87,28 @@ module Dor
         delegate :objects, :object, :workflows, to: :instance
       end
 
-      attr_writer :url, :username, :password, :token, :token_header, :connection
+      attr_writer :url, :token, :token_header, :connection
 
       private
 
-      attr_reader :username, :password, :token, :token_header
+      attr_reader :token, :token_header
 
       def url
         @url || raise(Error, 'url has not yet been configured')
       end
 
-      # rubocop:disable  Metrics/AbcSize
       def connection
         @connection ||= Faraday.new(url) do |conn|
           conn.use ErrorFaradayMiddleware
 
-          # @note when username & password are nil, this line is required else
+          # @note when token & token_header are nil, this line is required else
           #       the Faraday instance will be passed an empty block, which
           #       causes the adapter not to be set. Thus, everything breaks.
           conn.adapter Faraday.default_adapter
-          conn.basic_auth username, password if username && password
           conn.headers[:user_agent] = user_agent
           conn.headers[token_header] = "Bearer #{token}" if token
         end
       end
-      # rubocop:enable  Metrics/AbcSize
 
       def user_agent
         "dor-services-client #{Dor::Services::Client::VERSION}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app