dor-services-client 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d21a10048e6c6a968aab94efe1343d0ccd8b516aa7400e38dbf7db600cdda10c
-  data.tar.gz: e3eb26fe950f1bf8b8c4c34a2ee8b24e082bd4a8aa0938a5c856a48090f5d498
+  metadata.gz: 3ebc90d8d21ff990c42ec2836981cc9f9f58ecb0381a563b02beaa9f7f1c4192
+  data.tar.gz: a6c3e9486eb2b3bd734eec127721d8f17bbee913718e5038fa37b9910be0c2c2
 SHA512:
-  metadata.gz: 0b2580ebf1b1b536a9934248a8d55cc0d8f956f9a438befcf48042a4ca26e309a167f4f4174439e1b4866e228482a922cc9add40b99aacc7a96a3fc817a9633d
-  data.tar.gz: 5ac1721da5515fd5a42be65b2bb3e59a9c03bae2a30fd52d1b9065e143a7874d616272a190b1dd6eb5ac4563fee1f3d4ec534f758ff78390a4d3bcaa383a4b8b
+  metadata.gz: 21e178424afe1d89adb1f2aa6f372eac45d3e5a04da66839494acb95780d370e50b09c26e43efe7d9093cb57940dab8c5306ee62b4a57763f9f4e558c88fc63a
+  data.tar.gz: 907c84790debd06e77586f9f636fcbdc9c2d621a266c54aeee920a2de7ef468c3de43b15eee0e9624a53e5c0f2b31bbac84de5612d1488c992a930e57c693493

data/README.md

@@ -59,10 +59,14 @@ 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
 object_client.current_version
 object_client.open_new_version(**params)
 object_client.close_version(**params)
+# Return the Dublin Core XML representation
+object_client.metadata.dublin_core
 object_client.files.retrieve(filename: filename_string)
 object_client.files.preserved_content(filename: filename_string, version: version_string)
 object_client.files.list

data/lib/dor/services/client.rb

@@ -56,10 +56,19 @@ module Dor
       end
 
       class << self
-        def configure(url:, username: nil, password: nil)
+        # @param [String] url
+        # @param [String] username
+        # @param [String] password
+        # @param [String] token a bearer token for HTTP auth
+        # @param [String] token_header ('Authorization') set this to something if you are also using
+        #                              basic auth, or the headers will collide
+        def configure(url:, username: nil, password: nil, token: nil, token_header: 'Authorization')
           instance.url = url
           instance.username = username
           instance.password = password
+          instance.token = token
+          instance.token_header = token_header
+
           # Force connection to be re-established when `.configure` is called
           instance.connection = nil
 
@@ -69,11 +78,11 @@ module Dor
         delegate :objects, :object, :workflows, to: :instance
       end
 
-      attr_writer :url, :username, :password, :connection
+      attr_writer :url, :username, :password, :token, :token_header, :connection
 
       private
 
-      attr_reader :username, :password
+      attr_reader :username, :password, :token, :token_header
 
       def url
         @url || raise(Error, 'url has not yet been configured')
@@ -86,9 +95,10 @@ module Dor
           # @note when username & password are nil, this line is required else
           #       the Faraday instance will be passed an empty block, which
           #       causes the adapter not to be set. Thus, everything breaks.
-          conn.adapter    Faraday.default_adapter
+          conn.adapter Faraday.default_adapter
           conn.basic_auth username, password if username && password
           conn.headers[:user_agent] = user_agent
+          conn.headers[token_header] = "Bearer #{token}" if token
         end
       end
 

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: tru
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about retrieving metadata
+      class Metadata < VersionedService
+        # @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
+
+        # @return [String] The Dublin Core XML representation of the object
+        def dublin_core
+          resp = connection.get do |req|
+            req.url "#{base_path}/dublin_core"
+          end
+          return resp.body if resp.success?
+          return if resp.status == 404
+
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+        end
+
+        # @return [String] The descriptive metadata XML representation of the object
+        def descriptive
+          resp = connection.get do |req|
+            req.url "#{base_path}/descriptive"
+          end
+          return resp.body if resp.success?
+          return if resp.status == 404
+
+          raise UnexpectedResponse, "#{resp.reason_phrase}: #{resp.status} (#{resp.body}) for #{object_identifier}"
+        end
+
+        private
+
+        attr_reader :object_identifier
+
+        def base_path
+          "#{api_version}/objects/#{object_identifier}/metadata"
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,7 @@ require 'dor/services/client/release_tags'
 require 'dor/services/client/sdr'
 require 'dor/services/client/workflow'
 require 'dor/services/client/workspace'
+require 'dor/services/client/metadata'
 
 module Dor
   module Services
@@ -25,6 +26,10 @@ module Dor
           @sdr ||= SDR.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
+        def metadata
+          @metadata ||= Metadata.new(connection: connection, version: api_version, object_identifier: object_identifier)
+        end
+
         def files
           @files ||= Files.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
@@ -67,6 +72,19 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
+        # Pull in metadata from Symphony and update descMetadata
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [boolean] true on success
+        def refresh_metadata
+          resp = connection.post do |req|
+            req.url "#{object_path}/refresh_metadata"
+          end
+          return true if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
         # Notify the external Goobi system for a new object that was registered in DOR
         # @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 = '1.7.0'
+      VERSION = '1.8.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,6 +180,7 @@ files:
 - lib/dor/services/client.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/files.rb
+- lib/dor/services/client/metadata.rb
 - lib/dor/services/client/object.rb
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/release_tags.rb