dor-services-client 7.4.0 → 7.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5a1f99d266d396b3a463a2bd357123aa1d68b967c99a959c57fa00f3e3a6e4e
-  data.tar.gz: b5fa2927a2895ddb1505d2e0caea432089babd0065c28c3ddc580d131ef9bb90
+  metadata.gz: 8d879cd3b73b2dba4e04252bc66d32552a2ddbcb8935a4f59136d08a9741fa54
+  data.tar.gz: 6b6f48eb757a52ad7aa4f8b60abc8d8798131a31281018373725d14ce57cc0dd
 SHA512:
-  metadata.gz: fceeb4329d3b5c2f74d5f469896eb9f60484a9677253d8e47e5591eed1ae724d6014e7811adba986eca83ef76da41945f6b57f4309344f4ba5059c5768d70929
-  data.tar.gz: 767ec0e6ef1520f3bf2bee9bab789e709c657dce6eeb91f3d376560cfe3b55fa1c36d9635e0ccc9fc97e4d35133bd5a3c679bc97dc5869ae81ad0a938bc26905
+  metadata.gz: d050e0e58cd9b00aef611e2ceef7766d6c607536c94c03fbc5bb30123e084e72338ae22e073c2686b31ac3dd9ac7dae55a24557e6c472656575264f1c9ca5045
+  data.tar.gz: 2b9aef700ce2328cf8267685d82507cecc4dd5200b11dd4d76107bcb30e97b2ee045f35ba543e4a43d422baec6dd4d44be2b5bb5091447a3b085b1823b5d9055

data/.circleci/config.yml

@@ -1,35 +1,10 @@
 version: 2.1
-
-jobs:
+orbs:
+  ruby-rails: sul-dlss/ruby-rails@2.0.0
+workflows:
   build:
-    docker:
-      - image: circleci/ruby:2.7.1
-        environment:
-          CC_TEST_REPORTER_ID: 47b57fbbf65654b17f33b6ff4a108ce2abed31a86468033f20eb4d4e9e09935a
-          RAILS_ENV: test
-    steps:
-      - checkout
-      - run:
-          name: Install Bundler
-          command: gem install bundler
-      - run:
-          name: Which bundler?
-          command: bundle -v
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-      - run:
-          name: Lint using rubocop
-          command: bundle exec rubocop
-      - run:
-          name: Setup Code Climate test-reporter
-          command: |
-            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
-      - run:
-          name: rspec
-          command: bundle exec rspec
-      - run:
-          name: upload test coverage report to Code Climate
-          command: ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+    jobs:
+      - ruby-rails/lint:
+          name: lint
+      - ruby-rails/test-gem:
+          name: test

data/.rubocop.yml

@@ -1,7 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7 # dor-services-app can't be 3 due to fedora3
   SuggestExtensions: false
 
 Metrics/BlockLength:
@@ -81,3 +84,47 @@ Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
   Enabled: true
 Naming/InclusiveLanguage: # (new in 1.18)
   Enabled: true
+
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,22 +1,86 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2021-03-17 17:24:07 UTC using RuboCop version 1.11.0.
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2022-01-14 01:12:44 UTC using RuboCop version 1.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 2
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
-  Max: 22
+  Exclude:
+    - 'lib/dor/services/client/marcxml.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 11
+  Exclude:
+    - 'lib/dor/services/client/transfer.rb'
+
+# Offense count: 4
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/dor/services/client/async_result_spec.rb'
+    - 'spec/dor/services/client/metadata_spec.rb'
+    - 'spec/dor/services/client/object_version_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Max, CountAsOne.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/dor/services/client/metadata_spec.rb'
+
+# Offense count: 6
+RSpec/IdenticalEqualityAssertion:
+  Exclude:
+    - 'spec/dor/services/client_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: Max.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/dor/services/client/async_result_spec.rb'
+    - 'spec/dor/services/client/background_job_results_spec.rb'
+    - 'spec/dor/services/client/events_spec.rb'
+    - 'spec/dor/services/client/object_spec.rb'
+    - 'spec/dor/services/client/response_error_formatter_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: AllowSubject, Max.
+RSpec/MultipleMemoizedHelpers:
+  Exclude:
+    - 'spec/dor/services/client/objects_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+RSpec/MultipleSubjects:
+  Exclude:
+    - 'spec/dor/services/client/object_spec.rb'
+
+# Offense count: 13
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/dor/services/client/accession_spec.rb'
+    - 'spec/dor/services/client/background_job_results_spec.rb'
+    - 'spec/dor/services/client/metadata_spec.rb'
+    - 'spec/dor/services/client/objects_spec.rb'
+    - 'spec/dor/services/client_spec.rb'
+
+# Offense count: 4
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/dor/services/client/object_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/dor/services/client/response_error_formatter_spec.rb'
 
 # Offense count: 1
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -25,7 +89,7 @@ Style/Documentation:
 
 # Offense count: 77
 # Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
   Max: 164

data/README.md

@@ -96,6 +96,9 @@ object_client.update(params: dro)
 # Publish an object (push to PURL)
 object_client.publish(workflow: 'releaseWF', lane_id: 'low')
 
+# Unpublish an object (yank from PURL)
+object_client.unpublish()
+
 # Shelve an object (push to Stacks)
 object_client.shelve(lane_id: 'low')
 

data/dor-services-client.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.6'
+  spec.required_ruby_version = '>= 2.7', '< 4' # dor-services-app needs 2.7 due to fedora3
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
-  spec.add_dependency 'cocina-models', '~> 0.62.0' # leave pinned to patch level until cocina-models hits 1.0
+  spec.add_dependency 'cocina-models', '~> 0.63.1' # leave pinned to patch level until cocina-models hits 1.0
   spec.add_dependency 'deprecation', '>= 0'
   spec.add_dependency 'faraday', '>= 0.15', '< 2'
   spec.add_dependency 'zeitwerk', '~> 2.1'
@@ -35,6 +35,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 1.0'
-  spec.add_development_dependency 'simplecov', '~> 0.17.0' # CodeClimate cannot use SimpleCov >= 0.18.0 for generating test coverage
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -83,7 +83,7 @@ module Dor
           Transfer.new(**parent_params)
         end
 
-        delegate :publish, :preserve, :shelve, to: :transfer
+        delegate :publish, :unpublish, :preserve, :shelve, to: :transfer
 
         def mutate
           Mutate.new(**parent_params)

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

@@ -14,9 +14,9 @@ module Dor
         # Publish an object (send to PURL)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
-        # @param [String] workflow ('accessionWF') which workflow to callback to.
+        # @param [String] workflow (nil) which workflow to callback to.
         # @param [String] lane_id for prioritization (default or low)
-        # @return [boolean] true on success
+        # @return [String] the URL of the background job on dor-service-app
         def publish(workflow: nil, lane_id: nil)
           query_params = [].tap do |params|
             params << "workflow=#{workflow}" if workflow
@@ -32,6 +32,19 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # Unpublish an object (yank from to PURL)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] the URL of the background job on dor-service-app
+        def unpublish
+          resp = connection.post do |req|
+            req.url "#{object_path}/unpublish"
+          end
+          return resp.headers['Location'] if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
         # Preserve an object (send to SDR)
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '7.4.0'
+      VERSION = '7.7.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.7.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.63.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.62.0
+        version: 0.63.1
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -164,19 +164,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -237,16 +251,20 @@ files:
 - lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="