dor-workflow-client 3.4.2 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eac84de233115bd296697bf85c88d1d6ea530d563bec65e5730ee8d3fb82826
-  data.tar.gz: 3e5b8036c01e95bc9d6ae2abc6a68e0bc3368ad3a36faf54ecb47f5a6b412fec
+  metadata.gz: 282db0ca244d39fff241a2a30face5c69f101762aba3355a078da50eccae6e49
+  data.tar.gz: 34342d7f0f0808aec6ce8bf59de2fde85f9154c656940da008928404b74e0224
 SHA512:
-  metadata.gz: 7a1b57fe59f764112f31295aba8ed695a0c81da63d78d7eb3c5558370694ace019aeae586f621e5f0ec48f33bef2f65da87e35b6cda5be11e3a1c78308a95739
-  data.tar.gz: 599edcdf8f87d328a618aa46c65b5a37393e58a827a8131ebe0e58c39806cbc6f4fa4fc500ecc6e44c370d00cba93659841332b3daef2ac8a3e68944761bca0d
+  metadata.gz: 0fb6baead7b56ee334ad8c100e541fb45fdef6d0053b98b440ceb2982801fced53280c7a15718d7c5d0983f89adf452f5ba2daa8c7c81b4718cbac1ff4274a3b
+  data.tar.gz: 7515e44eac0411fac130ca5661237161ce8ee60def8c8384ba4fc7ef35d72013455ed8f77ff54b770df72afe6099cef20eaa55a14791c35bd8b13d17c7d35899

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
-notifications:
-  email: false
+cache: bundler
 
 rvm:
   - 2.5.3
@@ -9,3 +8,14 @@ env:
   - "RAILS_VERSION=4.2.11.1"
   - "RAILS_VERSION=5.2.3"
   - "RAILS_VERSION=6.0.0"
+
+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
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email: false

data/README.md

@@ -1,4 +1,6 @@
 [![Build Status](https://travis-ci.org/sul-dlss/dor-workflow-client.svg?branch=master)](https://travis-ci.org/sul-dlss/dor-workflow-client)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fba77ff479c468f8510f/test_coverage)](https://codeclimate.com/github/sul-dlss/dor-services-client/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fba77ff479c468f8510f/maintainability)](https://codeclimate.com/github/sul-dlss/dor-services-client/maintainability)
 [![Gem Version](https://badge.fury.io/rb/dor-workflow-client.svg)](https://badge.fury.io/rb/dor-workflow-client)
 
 # dor-workflow-client gem

data/lib/dor/workflow/client.rb

@@ -22,7 +22,7 @@ module Dor
     # Create and update workflows
     class Client
       # From Workflow Service's admin/Process.java
-      VALID_STATUS = %w[waiting completed error queued skipped hold].freeze
+      VALID_STATUS = %w[waiting completed error queued skipped].freeze
 
       attr_accessor :requestor
 
@@ -66,6 +66,10 @@ module Dor
         @version_routes ||= VersionRoutes.new(requestor: requestor)
       end
 
+      def workflow_template(name)
+        WorkflowTemplate.new(requestor: requestor).retrieve(name)
+      end
+
       private
 
       # Among other things, a distinct method helps tests mock default logger

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

@@ -3,7 +3,7 @@
 module Dor
   module Workflow
     class Client
-      VERSION = '3.4.2'
+      VERSION = '3.5.0'
     end
   end
 end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dor
+  module Workflow
+    class Client
+      # Makes requests relating to a workflow template
+      class WorkflowTemplate
+        def initialize(requestor:)
+          @requestor = requestor
+        end
+
+        # Retrieves a representation of the workflow template
+        #
+        # @param [String] workflow_name The name of the workflow you want to retrieve
+        # @return [Hash] a representation of the workflow template
+        # @example:
+        #   retrieve('assemblyWF') => '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"},...]}'
+        #
+        def retrieve(workflow_name)
+          body = requestor.request "workflow_templates/#{workflow_name}"
+          JSON.parse(body)
+        end
+
+        private
+
+        attr_reader :requestor
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
 require 'simplecov'
 SimpleCov.start do
   add_filter 'spec'
 end
 
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'byebug'
 require 'dor/workflow/client'
 require 'webmock/rspec'

data/spec/workflow/client/workflow_template_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Dor::Workflow::Client::WorkflowTemplate do
+  let(:data) { '{"processes":[{"name":"start-assembly"},{"name":"content-metadata-create"}]}' }
+  let(:mock_requestor) { instance_double(Dor::Workflow::Client::Requestor, request: data) }
+
+  let(:routes) { described_class.new(requestor: mock_requestor) }
+
+  describe '#retrieve' do
+    subject(:workflow_template) { routes.retrieve('accessionWF') }
+
+    it 'returns a workflow' do
+      expect(workflow_template['processes']).to eq [{ 'name' => 'start-assembly' },
+                                                    { 'name' => 'content-metadata-create' }]
+      expect(mock_requestor).to have_received(:request).with('workflow_templates/accessionWF')
+    end
+  end
+end

data/spec/workflow/client_spec.rb

@@ -185,6 +185,21 @@ RSpec.describe Dor::Workflow::Client do
     end
   end
 
+  describe '#workflow_template' do
+    subject(:workflow_template) { client.workflow_template('etdSubmitWF') }
+
+    let(:workflow_template_client) { instance_double Dor::Workflow::Client::WorkflowTemplate, retrieve: 'data' }
+
+    before do
+      allow(Dor::Workflow::Client::WorkflowTemplate).to receive(:new).and_return(workflow_template_client)
+    end
+
+    it 'delegates to the client' do
+      expect(workflow_template).to eq 'data'
+      expect(workflow_template_client).to have_received(:retrieve).with('etdSubmitWF')
+    end
+  end
+
   describe '#workflow_status' do
     let(:repo) { @repo }
     let(:druid) { @druid }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-workflow-client
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.5.0
 platform: ruby
 authors:
 - Willy Mene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2019-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -217,6 +217,7 @@ files:
 - lib/dor/workflow/client/version.rb
 - lib/dor/workflow/client/version_routes.rb
 - lib/dor/workflow/client/workflow_routes.rb
+- lib/dor/workflow/client/workflow_template.rb
 - lib/dor/workflow/response/process.rb
 - lib/dor/workflow/response/update.rb
 - lib/dor/workflow/response/workflow.rb
@@ -229,6 +230,7 @@ files:
 - spec/workflow/client/lifecycle_routes_spec.rb
 - spec/workflow/client/requestor_spec.rb
 - spec/workflow/client/workflow_routes_spec.rb
+- spec/workflow/client/workflow_template_spec.rb
 - spec/workflow/client_spec.rb
 homepage: https://consul.stanford.edu/display/DOR/DOR+services#DORservices-initializeworkflow
 licenses: []
@@ -248,8 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides convenience methods to work with the DOR Workflow Service
@@ -261,4 +262,5 @@ test_files:
 - spec/workflow/client/lifecycle_routes_spec.rb
 - spec/workflow/client/requestor_spec.rb
 - spec/workflow/client/workflow_routes_spec.rb
+- spec/workflow/client/workflow_template_spec.rb
 - spec/workflow/client_spec.rb