dor-services-client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875495ec63471d10398a445d157995ea10d279be90f83f6fd00de0587dbd9eda
-  data.tar.gz: df2c81d982fd112a808806ab41eaade32edcac05be679dbbfc5bdb5ab5c4625c
+  metadata.gz: bfe6441b14958a78f3b20690780ee260abaecaf92341ce8775c8735e311b9a1f
+  data.tar.gz: 73d11d588c9ab1274415229f2d051f2dda45c4f3a900a4428d564a7d1fc38dd5
 SHA512:
-  metadata.gz: 5fd7d69b9ea0a9282be2d6c7e5be789f20df33f6870633fb3fe248b2963c5d1cf3f6c0b6ab2b1659107f490ac4825a32f417643b3b8e55b5d3a25dbd06eb908e
-  data.tar.gz: 1869bd7147d957bbb5568110ce6e389eefee1956d911bac2eda31f5fa379ff57d44a97c697503b6b0a5b7f27786a2a1288b9b7b1b23b3e0a2ca2dd77dc6c3a2a
+  metadata.gz: ee530c3203266a71c5f0e6fc0bf2563f46b03fae774cf29595378dc324e4e8d2ef86116eb72126908639620716e8b15cbe52408c062ed5db284f87867cc090d6
+  data.tar.gz: 3e90b21e6be05de21faf18b68836c7592b9e8bc3575c4f8cb75397945ea1158392561e51ca89ba3950f008e55817c7aee2dc75433e829a6f8d3ad9b325167f8e

data/README.md

@@ -25,27 +25,28 @@ Or install it yourself as:
 
 ## Usage
 
-To configure the client, you may do so globally (say, in a Rails initializer):
+To configure and use the client, here's an example:
 
 ```ruby
 require 'dor/services/client'
 
-Dor::Services::Client.configure(url: Settings.DOR_SERVICES.URL,
-                                username: Settings.DOR_SERVICES.USER,
-                                password: Settings.DOR_SERVICES.PASS)
-```
-
-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.)
+def do_the_thing
+  # This API endpoint returns JSON
+  response = client.register(params: { druid: 'druid:123' })
+  response[:pid] # => 'druid:123'
+end
 
-Then you can invoke methods on the client that correspond to dor-services-app API requests, e.g.:
+private
 
-```ruby
-# This API endpoint returns JSON
-response = Dor::Services::Client.register(params: { druid: 'druid:123' })
-response[:pid]
-# => 'druid:123'
+def client
+  @client ||= Dor::Services::Client.configure(url: Settings.DOR_SERVICES.URL,
+                                              username: Settings.DOR_SERVICES.USER,
+                                              password: Settings.DOR_SERVICES.PASS)
+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.)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/dor-services-client.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 6'
+  spec.add_dependency 'deprecation'
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'nokogiri', '~> 1.8'
 

data/lib/dor/services/client.rb

@@ -7,8 +7,10 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/delegation'
 require 'dor/services/client/versioned_service'
 require 'dor/services/client/files'
+require 'dor/services/client/object'
 require 'dor/services/client/objects'
 require 'dor/services/client/release_tags'
+require 'dor/services/client/sdr'
 require 'dor/services/client/workflow'
 require 'dor/services/client/workspace'
 
@@ -28,10 +30,18 @@ module Dor
 
       include Singleton
 
+      def object(object)
+        Object.new(connection: connection, version: DEFAULT_VERSION, object: object)
+      end
+
       def objects
         @objects ||= Objects.new(connection: connection, version: DEFAULT_VERSION)
       end
 
+      def sdr
+        @sdr ||= SDR.new(connection: connection, version: DEFAULT_VERSION)
+      end
+
       def files
         @files ||= Files.new(connection: connection, version: DEFAULT_VERSION)
       end
@@ -123,7 +133,6 @@ module Dor
 
         # Notify goobi system of a new object
         delegate :notify_goobi, to: :objects
-
       end
 
       # Gets the current version number for the object

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'deprecation'
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about a repository object
+      class Object < VersionedService
+        # @param object [String] the pid for the object
+        def initialize(connection:, version:, object:)
+          super(connection: connection, version: version)
+          @object = object
+        end
+
+        # Publish a new object
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def publish
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object}/publish"
+          end
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          true
+        end
+
+        # Notify the external Goobi system for a new object that was registered in DOR
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def notify_goobi
+          resp = connection.post do |req|
+            req.url "#{object_path}/notify_goobi"
+          end
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          true
+        end
+
+        # Get the current_version for a DOR object. This comes from Dor::VersionMetadataDS
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] the version identifier
+        def current_version
+          resp = connection.get do |req|
+            req.url "#{object_path}/versions/current"
+          end
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          resp.body
+        end
+
+        private
+
+        attr_reader :object
+
+        def object_path
+          "#{api_version}/objects/#{object}"
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
+require 'deprecation'
 
 module Dor
   module Services
     class Client
-      # API calls that are about a repository object
+      # API calls that are about a repository objects
       class Objects < VersionedService
+        extend Deprecation
+
         # Creates a new object in DOR
         # @return [HashWithIndifferentAccess] the response, which includes a :pid
         def register(params:)
@@ -19,26 +22,18 @@ module Dor
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [boolean] true on success
         def publish(object:)
-          resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object}/publish"
-          end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
-
-          true
+          Object.new(connection: connection, version: api_version, object: object).publish
         end
+        deprecation_deprecate publish: 'Use Dor::Client.object(obj).publish instead'
 
         # Notify the external Goobi system for a new object that was registered in DOR
         # @param object [String] the pid for the object
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [boolean] true on success
         def notify_goobi(object:)
-          resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object}/notify_goobi"
-          end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
-
-          true
+          Object.new(connection: connection, version: api_version, object: object).notify_goobi
         end
+        deprecation_deprecate notify_goobi: 'Use Dor::Client.object(obj).notify_goobi instead'
 
         # Gets the current version number for the object
         # @param object [String] the pid for the object
@@ -46,16 +41,9 @@ module Dor
         # @raise [MalformedResponse] when the response is not parseable.
         # @return [Integer] the current version
         def current_version(object:)
-          xml = current_version_response(object: object)
-          begin
-            doc = Nokogiri::XML xml
-            raise if doc.root.name != 'currentVersion'
-
-            return Integer(doc.text)
-          rescue StandardError
-            raise MalformedResponse, "Unable to parse XML from current_version API call: #{xml}"
-          end
+          SDR.new(connection: connection, version: api_version).current_version(object: object)
         end
+        deprecation_deprecate current_version: 'Use Dor::Client.sdr.current_version instead'
 
         private
 
@@ -74,22 +62,6 @@ module Dor
 
           raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})"
         end
-
-        # make the request to the server for the currentVersion xml
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the raw xml from the server
-        def current_version_response(object:)
-          resp = connection.get do |req|
-            req.url current_version_path(object: object)
-          end
-          return resp.body if resp.success?
-
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object}"
-        end
-
-        def current_version_path(object:)
-          "#{api_version}/sdr/objects/#{object}/current_version"
-        end
       end
     end
   end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about preserved objects
+      class SDR < VersionedService
+        # Gets the current version number for the object
+        # @param object [String] the pid for the object
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @raise [MalformedResponse] when the response is not parseable.
+        # @return [Integer] the current version
+        def current_version(object:)
+          xml = current_version_response(object: object)
+          begin
+            doc = Nokogiri::XML xml
+            raise if doc.root.name != 'currentVersion'
+
+            return Integer(doc.text)
+          rescue StandardError
+            raise MalformedResponse, "Unable to parse XML from current_version API call: #{xml}"
+          end
+        end
+
+        private
+
+        # make the request to the server for the currentVersion xml
+        # @raises [UnexpectedResponse] on an unsuccessful response from the server
+        # @returns [String] the raw xml from the server
+        def current_version_response(object:)
+          resp = connection.get do |req|
+            req.url current_version_path(object: object)
+          end
+          return resp.body if resp.success?
+
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object}"
+        end
+
+        def current_version_path(object:)
+          "#{api_version}/sdr/objects/#{object}/current_version"
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '0.7.0'
+      VERSION = '0.8.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +165,10 @@ files:
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
 - lib/dor/services/client/files.rb
+- lib/dor/services/client/object.rb
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/release_tags.rb
+- lib/dor/services/client/sdr.rb
 - lib/dor/services/client/version.rb
 - lib/dor/services/client/versioned_service.rb
 - lib/dor/services/client/workflow.rb
@@ -176,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app