dor-services-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b750e59b5465e3b4c75b7122071f3398618ec9c861ac0494c77956ba97b3a1a
-  data.tar.gz: 1a86fa9cf387b199fc3560a101d889ab9287e1183c2b32f165d7f87503d9a6c6
+  metadata.gz: 8647a5b059a14045feb35bb4fe72147cc44854dfb88e19c7af98132a719ba8aa
+  data.tar.gz: 715989551938b54347651a53e3221a46d68d7e7d455ac6ac65e7e0bb766f38d2
 SHA512:
-  metadata.gz: 11b7a35b2a9be2bbf1abff74c8a17ab5fdf3725fb45423b8f148d15bfe28a8eda16ece00a9d7e4d8e6d59f937ba34c1d88a224ff8ffb3a8f6f50d364561e3dbe
-  data.tar.gz: 4738fc58390fd1465299c7df58c2cf5af700231e63ee6f02486f3ad852f8cb251d895da4bee11072917925a7cc39e48a45fcf7990881f5a90dee23573e1d8ca6
+  metadata.gz: 9ce7568f2fbd9b2672eb5879a68bc07fc7b29f092f8ec2fa4c00c9683a199f6801a3c3386a8f81ff60d4de10ad861a07e7722c32146ab9d9c5e6d9091195366e
+  data.tar.gz: f1b77e539cde7590cc63270eb577dfa95131f9a4b893c5ff4efc87c53c3705557034516cf0b3ea7dd3ee07a58a6c1d4503c29d401de283fe8226c8c27a8f2305

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

@@ -5,10 +5,10 @@ module Dor
     class Client
       # API calls relating to files
       class Files < VersionedService
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         # Get the contents from the workspace
@@ -16,7 +16,7 @@ module Dor
         # @return [String] the file contents from the workspace
         def retrieve(filename:)
           resp = connection.get do |req|
-            req.url "#{api_version}/objects/#{object_id}/contents/#{filename}"
+            req.url "#{api_version}/objects/#{object_identifier}/contents/#{filename}"
           end
           return unless resp.success?
 
@@ -29,7 +29,7 @@ module Dor
         # @return [String] the file contents from the SDR
         def preserved_content(filename:, version:)
           resp = connection.get do |req|
-            req.url "#{api_version}/sdr/objects/#{object_id}/content/#{CGI.escape(filename)}?version=#{version}"
+            req.url "#{api_version}/sdr/objects/#{object_identifier}/content/#{CGI.escape(filename)}?version=#{version}"
           end
           return unless resp.success?
 
@@ -40,7 +40,7 @@ module Dor
         # @return [Array<String>] the list of filenames in the workspace
         def list
           resp = connection.get do |req|
-            req.url "#{api_version}/objects/#{object_id}/contents"
+            req.url "#{api_version}/objects/#{object_identifier}/contents"
           end
           return [] unless resp.success?
 
@@ -50,7 +50,7 @@ module Dor
 
         private
 
-        attr_reader :object_id
+        attr_reader :object_identifier
       end
     end
   end

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

@@ -11,34 +11,34 @@ module Dor
     class Client
       # API calls that are about a repository object
       class Object < VersionedService
-        attr_reader :object_id
+        attr_reader :object_identifier
 
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
-          raise ArgumentError, "The `object_id` parameter must be an identifier string: #{object_id.inspect}" unless object_id.is_a?(String)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
+          raise ArgumentError, "The `object_identifier` parameter must be an identifier string: #{object_identifier.inspect}" unless object_identifier.is_a?(String)
 
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         def sdr
-          @sdr ||= SDR.new(connection: connection, version: api_version, object_id: object_id)
+          @sdr ||= SDR.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
         def files
-          @files ||= Files.new(connection: connection, version: api_version, object_id: object_id)
+          @files ||= Files.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
         def workflow
-          @workflow ||= Workflow.new(connection: connection, version: api_version, object_id: object_id)
+          @workflow ||= Workflow.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
         def workspace
-          @workspace ||= Workspace.new(connection: connection, version: api_version, object_id: object_id)
+          @workspace ||= Workspace.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
         def release_tags
-          @release_tags ||= ReleaseTags.new(connection: connection, version: api_version, object_id: object_id)
+          @release_tags ||= ReleaseTags.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
         # Publish a new object
@@ -88,7 +88,7 @@ module Dor
         # @return [String] the current version
         def open_new_version(**params)
           version = open_new_version_response(**params)
-          raise MalformedResponse, "Version of #{object_id} is empty" if version.empty?
+          raise MalformedResponse, "Version of #{object_identifier} is empty" if version.empty?
 
           version
         end
@@ -112,7 +112,7 @@ module Dor
         private
 
         def object_path
-          "#{api_version}/objects/#{object_id}"
+          "#{api_version}/objects/#{object_identifier}"
         end
 
         def raise_exception_based_on_response!(response)

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

@@ -5,10 +5,10 @@ module Dor
     class Client
       # API calls that are about a repository object
       class ReleaseTags < VersionedService
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         # Creates a new release tag for the object
@@ -27,7 +27,7 @@ module Dor
             release: release
           }
           resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object_id}/release_tags"
+            req.url "#{api_version}/objects/#{object_identifier}/release_tags"
             req.headers['Content-Type'] = 'application/json'
             req.body = params.to_json
           end
@@ -39,7 +39,7 @@ module Dor
 
         private
 
-        attr_reader :object_id
+        attr_reader :object_identifier
       end
     end
   end

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

@@ -7,10 +7,10 @@ module Dor
     class Client
       # API calls that are about preserved objects
       class SDR < VersionedService
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         # Gets the current version number for the object
@@ -31,7 +31,7 @@ module Dor
 
         private
 
-        attr_reader :object_id
+        attr_reader :object_identifier
 
         # make the request to the server for the currentVersion xml
         # @raises [UnexpectedResponse] on an unsuccessful response from the server
@@ -42,11 +42,11 @@ module Dor
           end
           return resp.body if resp.success?
 
-          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_id}"
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
         end
 
         def current_version_path
-          "#{api_version}/sdr/objects/#{object_id}/current_version"
+          "#{api_version}/sdr/objects/#{object_identifier}/current_version"
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '1.1.0'
+      VERSION = '1.1.1'
     end
   end
 end

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

@@ -5,10 +5,10 @@ module Dor
     class Client
       # API calls that are about workflow
       class Workflow < VersionedService
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         # Begin a new workflow
@@ -17,14 +17,14 @@ module Dor
         # @return nil
         def create(wf_name:)
           resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object_id}/apo_workflows/#{wf_name}"
+            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
 
         private
 
-        attr_reader :object_id
+        attr_reader :object_identifier
       end
     end
   end

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

@@ -5,10 +5,10 @@ module Dor
     class Client
       # API calls that are about the DOR workspace
       class Workspace < VersionedService
-        # @param object_id [String] the pid for the object
-        def initialize(connection:, version:, object_id:)
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
           super(connection: connection, version: version)
-          @object_id = object_id
+          @object_identifier = object_identifier
         end
 
         # Initializes a new workspace
@@ -17,7 +17,7 @@ module Dor
         # @return nil
         def create(source:)
           resp = connection.post do |req|
-            req.url "#{api_version}/objects/#{object_id}/initialize_workspace"
+            req.url "#{api_version}/objects/#{object_identifier}/initialize_workspace"
             req.params['source'] = source
           end
           raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
@@ -25,7 +25,7 @@ module Dor
 
         private
 
-        attr_reader :object_id
+        attr_reader :object_identifier
       end
     end
   end

data/lib/dor/services/client.rb

@@ -37,9 +37,9 @@ module Dor
         # Return memoized object instance if object identifier value is the same
         # This allows us to test the client more easily in downstream codebases,
         # opening up stubbing without requiring `any_instance_of`
-        return @object if @object&.object_id == object_identifier
+        return @object if @object&.object_identifier == object_identifier
 
-        @object = Object.new(connection: connection, version: DEFAULT_VERSION, object_id: object_identifier)
+        @object = Object.new(connection: connection, version: DEFAULT_VERSION, object_identifier: object_identifier)
       end
 
       # @return [Dor::Services::Client::Objects] an instance of the `Client::Objects` class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport