dor-services-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0938b1979de1f6767e88044a77182623502a0ee923d445fd11d892f83c9c81c
-  data.tar.gz: d091617c14b075d111980b1052ab0662382362bbbdd2ffe943609c4d94f997ee
+  metadata.gz: cbe8578f95f4533b0b91fe9a3c47ede0d1ba51db157e5f015928ba7b5b1fe19e
+  data.tar.gz: b3e4e136c27186b625b86ebc138d59f032e03f1f6c908f65ee6c7206c73c7143
 SHA512:
-  metadata.gz: 121eecbb6172914d1bd345167ae7f92064c815c17634f2e017cf1c39617368da597e4d0cb9598c7d907cff64e3d7740d4916f174ba3d1c33b5b2e57b7eb66087
-  data.tar.gz: 99ce5863977ec58b8b315ed91867eeb8c1f2f31efe763f045ca0519676d0b03842bdf9095f67bee5e9ea5bd041c3ddf939c26dd792d68f645eabd591594e4b67
+  metadata.gz: 933595fee0dbdec82b6d46c5b1bb63ed0cf4022d702ae97df1c294a8688d14e080fc893303ea981def0f9d8d86d08afff16517811a1e26fbd611258023259025
+  data.tar.gz: fd88271153d2c461cedacfb7447c22fc4c47b87db50c5d44b8484a9f63fdb56ebc285006605ee5280a43688aa4461dae8cf3cb72f0d29dffec496e7a33531e76

data/dor-services-client.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 6'
   spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'nokogiri', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/dor/services/client.rb

@@ -4,6 +4,7 @@ require 'dor/services/client/version'
 require 'singleton'
 require 'faraday'
 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/objects'
@@ -16,6 +17,13 @@ module Dor
     class Client
       class Error < StandardError; end
 
+      # Error that is raised when the remote server returns some unexpected response
+      # this could be any 4xx or 5xx status.
+      class UnexpectedResponse < Error; end
+
+      # Error that is raised when the remote server returns some unparsable response
+      class MalformedResponse < Error; end
+
       DEFAULT_VERSION = 'v1'
 
       include Singleton
@@ -40,68 +48,85 @@ module Dor
         @release_tags ||= ReleaseTags.new(connection: connection, version: DEFAULT_VERSION)
       end
 
-      def self.configure(url:, username: nil, password: nil)
-        instance.url = url
-        instance.username = username
-        instance.password = password
-        # Force connection to be re-established when `.configure` is called
-        instance.connection = nil
-      end
+      class << self
+        def configure(url:, username: nil, password: nil)
+          instance.url = url
+          instance.username = username
+          instance.password = password
+          # Force connection to be re-established when `.configure` is called
+          instance.connection = nil
+        end
 
-      # Creates a new object in DOR
-      # @return [HashWithIndifferentAccess] the response, which includes a :pid
-      def self.register(params:)
-        instance.objects.register(params: params)
-      end
+        delegate :objects, :files, :workflow, :workspace, :release_tags, to: :instance
+        private :objects, :files, :workflow, :workspace, :release_tags
 
-      # @param [String] object the identifier for the object
-      # @param [String] filename the name of the file to retrieve
-      # @return [String] the file contents from the workspace
-      def self.retrieve_file(object:, filename:)
-        instance.files.retrieve(object: object, filename: filename)
-      end
+        # Creates a new object in DOR
+        # @return [HashWithIndifferentAccess] the response, which includes a :pid
+        delegate :register, to: :objects
 
-      # @param [String] object the identifier for the object
-      # @return [Array<String>] the list of filenames in the workspace
-      def self.list_files(object:)
-        instance.files.list(object: object)
-      end
+        # @param [String] object the identifier for the object
+        # @param [String] filename the name of the file to retrieve
+        # @return [String] the file contents from the workspace
+        def retrieve_file(object:, filename:)
+          files.retrieve(object: object, filename: filename)
+        end
 
-      # Initializes a new workflow
-      # @param object [String] the pid for the object
-      # @param wf_name [String] the name of the workflow
-      # @raises [Error] if the request is unsuccessful.
-      # @return nil
-      def self.initialize_workflow(object:, wf_name:)
-        instance.workflow.create(object: object, wf_name: wf_name)
-      end
+        # Get the preserved file contents
+        # @param [String] object the identifier for the object
+        # @param [String] filename the name of the file to retrieve
+        # @param [Integer] version the version of the file to retrieve
+        # @return [String] the file contents from the SDR
+        delegate :preserved_content, to: :files
+
+        # @param [String] object the identifier for the object
+        # @return [Array<String>] the list of filenames in the workspace
+        def list_files(object:)
+          files.list(object: object)
+        end
 
-      # Initializes a new workspace
-      # @param object [String] the pid for the object
-      # @param source [String] the path to the object
-      # @raises [Error] if the request is unsuccessful.
-      # @return nil
-      def self.initialize_workspace(object:, source:)
-        instance.workspace.create(object: object, source: source)
-      end
+        # Initializes a new workflow
+        # @param object [String] the pid for the object
+        # @param wf_name [String] the name of the workflow
+        # @raises [UnexpectedResponse] if the request is unsuccessful.
+        # @return nil
+        def initialize_workflow(object:, wf_name:)
+          workflow.create(object: object, wf_name: wf_name)
+        end
 
-      # Creates a new release tag for the object
-      # @param object [String] the pid for the object
-      # @param release [Boolean]
-      # @param what [String]
-      # @param to [String]
-      # @param who [String]
-      # @return [Boolean] true if successful
-      def self.create_release_tag(object:, release:, what:, to:, who:)
-        instance.release_tags.create(object: object, release: release, what: what, to: to, who: who)
+        # Initializes a new workspace
+        # @param object [String] the pid for the object
+        # @param source [String] the path to the object
+        # @raises [UnexpectedResponse] if the request is unsuccessful.
+        # @return nil
+        def initialize_workspace(object:, source:)
+          workspace.create(object: object, source: source)
+        end
+
+        # Creates a new release tag for the object
+        # @param object [String] the pid for the object
+        # @param release [Boolean]
+        # @param what [String]
+        # @param to [String]
+        # @param who [String]
+        # @return [Boolean] true if successful
+        def create_release_tag(object:, release:, what:, to:, who:)
+          release_tags.create(object: object, release: release, what: what, to: to, who: who)
+        end
+
+        # Publish a new object
+        # @param object [String] the pid for the object
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        delegate :publish, to: :objects
       end
 
-      # Publish a new object
+      # Gets the current version number for the object
       # @param object [String] the pid for the object
-      # @raise [Error] when the response is not successful.
-      # @return [boolean] true on success
-      def self.publish(object:)
-        instance.objects.publish(object: object)
+      # @raise [UnexpectedResponse] when the response is not successful.
+      # @raise [MalformedResponse] when the response is not parseable.
+      # @return [Integer] the current version
+      def self.current_version(object:)
+        instance.objects.current_version(object: object)
       end
 
       attr_writer :url, :username, :password, :connection

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

@@ -5,18 +5,39 @@ module Dor
     class Client
       # API calls relating to files
       class Files < VersionedService
+        # Get the contents from the workspace
+        # @param [String] object the identifier for the object
+        # @param [String] filename the name of the file to retrieve
+        # @return [String] the file contents from the workspace
         def retrieve(object:, filename:)
           resp = connection.get do |req|
-            req.url "#{version}/objects/#{object}/contents/#{filename}"
+            req.url "#{api_version}/objects/#{object}/contents/#{filename}"
           end
           return unless resp.success?
 
           resp.body
         end
 
+        # Get the preserved file contents
+        # @param [String] object the identifier for the object
+        # @param [String] filename the name of the file to retrieve
+        # @param [Integer] version the version of the file to retrieve
+        # @return [String] the file contents from the SDR
+        def preserved_content(object:, filename:, version:)
+          resp = connection.get do |req|
+            req.url "#{api_version}/sdr/objects/#{object}/content/#{CGI.escape(filename)}?version=#{version}"
+          end
+          return unless resp.success?
+
+          resp.body
+        end
+
+        # Get the list of files in the workspace
+        # @param [String] object the identifier for the object
+        # @return [Array<String>] the list of filenames in the workspace
         def list(object:)
           resp = connection.get do |req|
-            req.url "#{version}/objects/#{object}/contents"
+            req.url "#{api_version}/objects/#{object}/contents"
           end
           return [] unless resp.success?
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'nokogiri'
+
 module Dor
   module Services
     class Client
@@ -8,29 +10,72 @@ module Dor
         # Creates a new object in DOR
         # @return [HashWithIndifferentAccess] the response, which includes a :pid
         def register(params:)
+          json = register_response(params: params)
+          JSON.parse(json).with_indifferent_access
+        end
+
+        # Publish a new object
+        # @param object [String] the pid for the object
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def publish(object:)
           resp = connection.post do |req|
-            req.url "#{version}/objects"
+            req.url "#{api_version}/objects/#{object}/publish"
+          end
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          true
+        end
+
+        # 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 registration request to the server
+        # @raises [UnexpectedResponse] on an unsuccessful response from the server
+        # @returns [String] the raw JSON from the server
+        def register_response(params:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects"
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
             req.body = params.to_json
           end
-          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          return resp.body if resp.success?
 
-          JSON.parse(resp.body).with_indifferent_access
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})"
         end
 
-        # Publish a new object
-        # @param object [String] the pid for the object
-        # @raise [Error] when the response is not successful.
-        # @return [boolean] true on success
-        def publish(object:)
-          resp = connection.post do |req|
-            req.url "#{version}/objects/#{object}/publish"
+        # 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
-          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          return resp.body if resp.success?
 
-          true
+          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

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

@@ -11,6 +11,7 @@ module Dor
         # @param what [String]
         # @param to [String]
         # @param who [String]
+        # @raises [UnexpectedResponse] if the request is unsuccessful.
         # @return [Boolean] true if successful
         # rubocop:disable Metrics/MethodLength
         def create(object:, release:, what:, to:, who:)
@@ -21,11 +22,11 @@ module Dor
             release: release
           }
           resp = connection.post do |req|
-            req.url "#{version}/objects/#{object}/release_tags"
+            req.url "#{api_version}/objects/#{object}/release_tags"
             req.headers['Content-Type'] = 'application/json'
             req.body = params.to_json
           end
-          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
 
           true
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '0.4.0'
+      VERSION = '0.5.0'
     end
   end
 end

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

@@ -7,12 +7,12 @@ module Dor
       class VersionedService
         def initialize(connection:, version:)
           @connection = connection
-          @version = version
+          @api_version = version
         end
 
         private
 
-        attr_reader :connection, :version
+        attr_reader :connection, :api_version
       end
     end
   end

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

@@ -8,13 +8,13 @@ module Dor
         # Begin a new workflow
         # @param object [String] the pid for the object
         # @param wf_name [String] the name of the workflow
-        # @raises [Error] if the request is unsuccessful.
+        # @raises [UnexpectedResponse] if the request is unsuccessful.
         # @return nil
         def create(object:, wf_name:)
           resp = connection.post do |req|
-            req.url "#{version}/objects/#{object}/apo_workflows/#{wf_name}"
+            req.url "#{api_version}/objects/#{object}/apo_workflows/#{wf_name}"
           end
-          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
         end
       end
     end

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

@@ -4,18 +4,18 @@ module Dor
   module Services
     class Client
       # API calls that are about the DOR workspace
-      class Workspace  < VersionedService
+      class Workspace < VersionedService
         # Initializes a new workspace
         # @param object [String] the pid for the object
         # @param source [String] the path to the object
-        # @raises [Error] if the request is unsuccessful.
+        # @raises [UnexpectedResponse] if the request is unsuccessful.
         # @return nil
         def create(object:, source:)
           resp = connection.post do |req|
-            req.url "#{version}/objects/#{object}/initialize_workspace"
+            req.url "#{api_version}/objects/#{object}/initialize_workspace"
             req.params['source'] = source
           end
-          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -45,6 +45,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement