sdr-client 2.12.0 → 2.13.0.beta1

data/lib/sdr_client/redesigned_client/upload_files.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SdrClient
+  class RedesignedClient
+    # The file uploading part of a deposit
+    class UploadFiles
+      # @param [Hash<String,DirectUploadRequest>] file_metadata map of relative filepaths to file metadata
+      # @param [Hash<String,String>] filepath_map map of relative filepaths to absolute filepaths
+      def self.upload(file_metadata:, filepath_map:)
+        new(file_metadata: file_metadata, filepath_map: filepath_map).upload
+      end
+
+      # @param [Hash<String,DirectUploadRequest>] file_metadata map of relative filepaths to file metadata
+      # @param [Hash<String,String>] filepath_map map of relative filepaths to absolute filepaths
+      def initialize(file_metadata:, filepath_map:)
+        @file_metadata = file_metadata
+        @filepath_map = filepath_map
+      end
+
+      # @return [Array<DirectUploadResponse>] the responses from the server for the uploads
+      def upload
+        file_metadata.map do |filepath, metadata|
+          direct_upload(metadata.to_json).tap do |response|
+            # ActiveStorage modifies the filename provided in response, so setting here with the relative filename
+            response.filename = filepath
+            upload_file(response)
+            logger.info("Upload of #{filepath} complete")
+          end
+        end
+      end
+
+      private
+
+      attr_reader :file_metadata, :filepath_map
+
+      def logger
+        SdrClient::RedesignedClient.config.logger
+      end
+
+      def client
+        SdrClient::RedesignedClient.instance
+      end
+
+      def path
+        '/v1/direct_uploads'
+      end
+
+      def direct_upload(metadata_json)
+        logger.info("Starting an upload request: #{metadata_json}")
+        response = client.post(path: path, body: metadata_json)
+
+        logger.info("Response from server: #{response}")
+        DirectUploadResponse.new(response)
+      end
+
+      def upload_file(response)
+        logger.info("Uploading `#{response.filename}' to #{response.direct_upload.fetch('url')}")
+
+        client.put(
+          path: response.direct_upload.fetch('url'),
+          body: ::File.open(filepath_map[response.filename]),
+          headers: {
+            'content-type' => response.content_type,
+            'content-length' => response.byte_size.to_s
+          },
+          expected_status: 204
+        )
+      end
+    end
+  end
+end

data/lib/sdr_client/redesigned_client/upload_files_metadata_builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SdrClient
+  class RedesignedClient
+    # Collecting all the metadata about the files for a deposit
+    class UploadFilesMetadataBuilder
+      # @param [Array<String>] files a list of relative filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      # @param [String] basepath path to which files are relative
+      # @return [Hash<String, DirectUploadRequest>] the metadata for uploading the files
+      def self.build(files:, mime_types:, basepath:)
+        new(files: files, mime_types: mime_types, basepath: basepath).build
+      end
+
+      # @param [Array<String>] files a list of absolute filepaths to upload
+      # @param [Hash<String,String>] mime_types a map of filenames to mime types
+      # @param [String] basepath path to which files are relative
+      def initialize(files:, mime_types:, basepath:)
+        @files = files
+        @mime_types = mime_types
+        @basepath = basepath
+      end
+
+      attr_reader :files, :mime_types, :basepath
+
+      # @return [Hash<String, DirectUploadRequest>] the metadata for uploading the files
+      def build
+        files.each_with_object({}) do |filepath, obj|
+          obj[filepath] = DirectUploadRequest.from_file(absolute_filepath_for(filepath),
+                                                        file_name: filepath,
+                                                        content_type: mime_types[filepath])
+        end
+      end
+
+      def absolute_filepath_for(filepath)
+        ::File.join(basepath, filepath)
+      end
+    end
+  end
+end

data/lib/sdr_client/redesigned_client.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'logger'
+require 'shellwords'
+require 'singleton'
+require 'timeout'
+
+module SdrClient
+  # The SDR client reimagined, built using patterns successfully used in other client gems we maintain
+  class RedesignedClient
+    include Singleton
+
+    class << self
+      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      def configure(url:, email: nil, password: nil, token_refresher: nil, token: default_token,
+                    request_options: default_request_options, logger: default_logger)
+        if email.blank? && password.blank? && !token_refresher.respond_to?(:call)
+          raise ArgumentError, 'email and password cannot be blank without a custom token refresher callable'
+        end
+
+        instance.config = Config.new(
+          token: token,
+          url: url,
+          email: email,
+          password: password,
+          request_options: request_options,
+          logger: logger,
+          token_refresher: token_refresher
+        )
+
+        instance
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+
+      # For the initial token, use a dummy value to avoid hitting any APIs
+      # during configuration, allowing `with_token_refresh_when_unauthorized` to handle
+      # auto-magic token refreshing. Why not immediately get a valid token? Our apps
+      # commonly invoke client `.configure` methods in the initializer in all
+      # application environments, even those that are never expected to
+      # connect to production APIs, such as local development machines.
+      #
+      # NOTE: `nil` and blank string cannot be used as dummy values here as
+      # they lead to a malformed request to be sent, which triggers an
+      # exception not rescued by `with_token_refresh_when_unauthorized`
+      def default_token
+        'a temporary dummy token to avoid hitting the API before it is needed'
+      end
+
+      def default_logger
+        Logger.new($stdout)
+      end
+
+      def default_request_options
+        {
+          read_timeout: default_timeout,
+          timeout: default_timeout
+        }
+      end
+
+      # NOTE: This is the number of seconds it roughly takes for H2 to
+      #       successfully shunt ~10GB files over to SDR API
+      def default_timeout
+        900
+      end
+
+      delegate :config, :connection, :deposit_model, :job_status, :find, :update_model, :build_and_deposit,
+               to: :instance
+    end
+
+    attr_accessor :config
+
+    def deposit_model(...)
+      Deposit.deposit_model(...)
+    end
+
+    def job_status(...)
+      JobStatus.new(...)
+    end
+
+    def find(...)
+      Find.run(...)
+    end
+
+    def update_model(...)
+      UpdateResource.run(...)
+    end
+
+    def build_and_deposit(...)
+      Metadata.deposit(...)
+    end
+
+    # Send an authenticated GET request
+    # @param path [String] the path to the SDR API request
+    def get(path:)
+      response = with_token_refresh_when_unauthorized do
+        connection.get(path)
+      end
+
+      UnexpectedResponse.call(response) unless response.success?
+
+      return nil if response.body.blank?
+
+      JSON.parse(response.body).with_indifferent_access
+    end
+
+    # Send an authenticated POST request
+    # @param path [String] the path to the SDR API request
+    # @param body [String] the body of the SDR API request
+    # @param headers [Hash] extra headers to add to the SDR API request
+    # @param expected_status [Integer] override if all 2xx statuses aren't success conditions
+    def post(path:, body:, headers: {}, expected_status: nil) # rubocop:disable Metrics/MethodLength
+      response = with_token_refresh_when_unauthorized do
+        connection.post(path) do |request|
+          request.body = body
+          request.headers = default_headers.merge(headers)
+        end
+      end
+
+      if expected_status
+        UnexpectedResponse.call(response) if response.status != expected_status
+      elsif !response.success?
+        UnexpectedResponse.call(response)
+      end
+
+      return nil if response.body.blank?
+
+      JSON.parse(response.body).with_indifferent_access
+    end
+
+    # Send an authenticated PUT request
+    # @param path [String] the path to the SDR API request
+    # @param body [String] the body of the SDR API request
+    # @param headers [Hash] extra headers to add to the SDR API request
+    # @param params [Hash] query parameters to add to the SDR API request
+    # @param expected_status [Integer] override if all 2xx statuses aren't success conditions
+    def put(path:, body:, headers: {}, params: {}, expected_status: nil) # rubocop:disable Metrics/MethodLength
+      response = with_token_refresh_when_unauthorized do
+        connection.put(path) do |request|
+          request.body = body
+          request.headers = default_headers.merge(headers)
+          request.params = params if params.present?
+        end
+      end
+
+      if expected_status
+        UnexpectedResponse.call(response) if response.status != expected_status
+      elsif !response.success?
+        UnexpectedResponse.call(response)
+      end
+
+      return nil if response.body.blank?
+
+      JSON.parse(response.body).with_indifferent_access
+    end
+
+    private
+
+    Config = Struct.new(:url, :email, :password, :token, :logger,
+                        :request_options, :token_refresher, keyword_init: true)
+
+    def connection
+      Faraday.new(
+        url: SdrClient::RedesignedClient.config.url,
+        headers: default_headers,
+        request: SdrClient::RedesignedClient.config.request_options
+      ) do |conn|
+        conn.adapter :net_http
+      end
+    end
+
+    def default_headers
+      {
+        accept: 'application/json',
+        content_type: 'application/json',
+        Authorization: "Bearer #{config.token}"
+      }
+    end
+
+    def with_token_refresh_when_unauthorized
+      response = yield
+
+      # if unauthorized, token has likely expired. try to get a new token and then retry the same request(s).
+      if response.status == 401
+        config.token = config.token_refresher ? config.token_refresher.call : Authenticator.token
+        response = yield
+      end
+
+      response
+    end
+  end
+end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '2.12.0'
+  VERSION = '2.13.0.beta1'
 end

data/lib/sdr_client.rb

@@ -12,7 +12,9 @@ loader = Zeitwerk::Loader.for_gem
 loader.ignore(
   "#{__dir__}/sdr-client.rb",
   "#{__dir__}/sdr_client/cli.rb",
-  "#{__dir__}/sdr_client/cli/config.rb"
+  "#{__dir__}/sdr_client/cli/config.rb",
+  "#{__dir__}/sdr_client/redesigned_client/cli.rb",
+  "#{__dir__}/sdr_client/redesigned_client/cli/config.rb"
 )
 loader.inflector.inflect(
   'md5' => 'MD5',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0.beta1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,6 +115,7 @@ email:
 executables:
 - remove_w3cdtf_encoding_from_event_dates
 - sdr
+- sdr_redesigned
 extensions: []
 extra_rdoc_files: []
 files:
@@ -134,6 +135,7 @@ files:
 - config/settings.yml
 - exe/remove_w3cdtf_encoding_from_event_dates
 - exe/sdr
+- exe/sdr_redesigned
 - lib/sdr-client.rb
 - lib/sdr_client.rb
 - lib/sdr_client/background_job_results.rb
@@ -166,6 +168,36 @@ files:
 - lib/sdr_client/find.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
+- lib/sdr_client/redesigned_client.rb
+- lib/sdr_client/redesigned_client/authenticator.rb
+- lib/sdr_client/redesigned_client/cli.rb
+- lib/sdr_client/redesigned_client/cli/config.rb
+- lib/sdr_client/redesigned_client/cli/credentials.rb
+- lib/sdr_client/redesigned_client/cli/update.rb
+- lib/sdr_client/redesigned_client/create_resource.rb
+- lib/sdr_client/redesigned_client/deposit.rb
+- lib/sdr_client/redesigned_client/direct_upload_request.rb
+- lib/sdr_client/redesigned_client/direct_upload_response.rb
+- lib/sdr_client/redesigned_client/file.rb
+- lib/sdr_client/redesigned_client/file_set.rb
+- lib/sdr_client/redesigned_client/file_type_file_set_strategy.rb
+- lib/sdr_client/redesigned_client/find.rb
+- lib/sdr_client/redesigned_client/image_file_set_strategy.rb
+- lib/sdr_client/redesigned_client/job_status.rb
+- lib/sdr_client/redesigned_client/matching_file_grouping_strategy.rb
+- lib/sdr_client/redesigned_client/metadata.rb
+- lib/sdr_client/redesigned_client/operations/md5.rb
+- lib/sdr_client/redesigned_client/operations/mime_type.rb
+- lib/sdr_client/redesigned_client/operations/sha1.rb
+- lib/sdr_client/redesigned_client/request_builder.rb
+- lib/sdr_client/redesigned_client/single_file_grouping_strategy.rb
+- lib/sdr_client/redesigned_client/structural_grouper.rb
+- lib/sdr_client/redesigned_client/structural_metadata_builder.rb
+- lib/sdr_client/redesigned_client/unexpected_response.rb
+- lib/sdr_client/redesigned_client/update_dro_with_file_identifiers.rb
+- lib/sdr_client/redesigned_client/update_resource.rb
+- lib/sdr_client/redesigned_client/upload_files.rb
+- lib/sdr_client/redesigned_client/upload_files_metadata_builder.rb
 - lib/sdr_client/unexpected_response.rb
 - lib/sdr_client/update.rb
 - lib/sdr_client/version.rb
@@ -192,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api