dor-services-client 1.12.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78f715a39b9f224746efdd2cdbbe6bc15ff133d115f5374a0375cb7fe9435774
-  data.tar.gz: c0808ad279301664e35953d8cee374e64a3b5dc2f217480491de71b29539239d
+  metadata.gz: c1b796894976f47f34597c9016231df83a46aee0af90e9b7ed3d7ad81c298ff2
+  data.tar.gz: 6dbd6db2e1ae676f325129d375ec00a5f36a845749ccf0459f791d933804a839
 SHA512:
-  metadata.gz: 7361d4e2c6ee0e183c5c16ba8c4da4f4437a2abdd90a19f7a979e4244adaaa3f3cd40bfa2751bab746ba2eda1ca267314b2f99216f7176ab9e1cb8cc6ad887fb
-  data.tar.gz: 92f1c9ab4d60ab63146b49aac208969a3c6a0dcd40607be0c960bace46b5248c19c5d2f9720515c076eee3b45dd1cfd6738fadbffb4e89eb9c110824225ae104
+  metadata.gz: 3b663973452421419199197c6704960d81963ec8be42743740f55f20f9b248fe546fe60dbcfe5d7773fe8a353520cb38ed90dcdc2525ceff10889e21944f88cc
+  data.tar.gz: 7d109c200f4c709fa57c2577f4e117e6f9d98bac29e71437f1dbd32ba61d4175175eee40c727c7662a166af1733a52c5092f03d1d30428b425935b6658de1141

data/README.md

@@ -59,6 +59,7 @@ objects_client.register(params: {})
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
 object_client.publish
+
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_metadata
 object_client.notify_goobi
@@ -66,8 +67,10 @@ object_client.version.current
 object_client.version.openable?(**params)
 object_client.version.open(**params)
 object_client.version.close(**params)
+
 # Get the Dublin Core XML representation
 object_client.metadata.dublin_core
+
 # Get the public descriptive XML representation
 object_client.metadata.descriptive
 object_client.files.retrieve(filename: filename_string)
@@ -79,15 +82,9 @@ object_client.sdr.current_version
 object_client.sdr.metadata(datastream: dsid)
 object_client.sdr.signature_catalog
 
-object_client.workflow.create(wf_name: workflow_name_string)
-
 # Create and remove workspaces
 object_client.workspace.create(source: object_path_string)
 object_client.workspace.cleanup
-
-# For retrieving a workflow template
-workflows_client = Dor::Services::Client.workflows
-workflows_client.initial(name: workflow_name)
 ```
 
 ## Development

data/dor-services-client.gemspec

@@ -23,7 +23,6 @@ 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 'moab-versioning', '~> 4.0'
   spec.add_dependency 'nokogiri', '~> 1.8'

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

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
-require 'deprecation'
-
 module Dor
   module Services
     class Client
       # 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
 
         # @param object_identifier [String] the pid for the object
@@ -32,10 +27,6 @@ module Dor
           @files ||= Files.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
-        def workflow
-          @workflow ||= Workflow.new(connection: connection, version: api_version, object_identifier: object_identifier)
-        end
-
         def workspace
           @workspace ||= Workspace.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
@@ -100,21 +91,6 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        def current_version
-          version.current
-        end
-        deprecation_deprecate current_version: 'use version.current instead'
-
-        def open_new_version(**params)
-          version.open(**params)
-        end
-        deprecation_deprecate open_new_version: 'use version.open instead'
-
-        def close_version(**params)
-          version.close(**params)
-        end
-        deprecation_deprecate close_version: 'use version.close instead'
-
         private
 
         def object_path

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

@@ -1,15 +1,10 @@
 # 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)
@@ -29,14 +24,6 @@ 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)

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

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

data/lib/dor/services/client.rb

@@ -64,10 +64,6 @@ module Dor
         @objects ||= Objects.new(connection: connection, version: DEFAULT_VERSION)
       end
 
-      def workflows
-        @workflows ||= Workflows.new(connection: connection, version: DEFAULT_VERSION)
-      end
-
       class << self
         # @param [String] url
         # @param [String] token a bearer token for HTTP auth
@@ -84,7 +80,7 @@ module Dor
           self
         end
 
-        delegate :objects, :object, :workflows, to: :instance
+        delegate :objects, :object, to: :instance
       end
 
       attr_writer :url, :token, :token_header, :connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -31,20 +31,6 @@ 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
@@ -202,8 +188,6 @@ files:
 - 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
-- lib/dor/services/client/workflows.rb
 - lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    class Client
-      # API calls that are about workflow
-      class Workflow < VersionedService
-        extend Deprecation
-        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:)
-          super(connection: connection, version: version)
-          @object_identifier = object_identifier
-        end
-
-        # Begin a new workflow
-        # @param wf_name [String] the name of the workflow
-        # @raises [UnexpectedResponse] if the request is unsuccessful.
-        # @return nil
-        def create(wf_name:)
-          resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object_identifier}/apo_workflows/#{wf_name}"
-          end
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
-        end
-        deprecation_deprecate create: 'Create will be removed. Use dor-workflow-client instead'
-
-        private
-
-        attr_reader :object_identifier
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Services
-    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
-        def initial(name:)
-          resp = connection.get do |req|
-            req.url "#{api_version}/workflows/#{name}/initial"
-            # asking the service to return XML
-            req.headers['Accept'] = 'application/xml'
-          end
-          return resp.body if resp.success?
-
-          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
-end