aspera-cli 4.26.2 → 4.27.1

data/lib/aspera/transfer/parameters.rb

@@ -2,6 +2,7 @@
 
 require 'aspera/log'
 require 'aspera/assert'
+require 'aspera/exec_spec'
 require 'aspera/command_line_builder'
 require 'aspera/temp_file_manager'
 require 'aspera/transfer/error'
@@ -35,19 +36,22 @@ module Aspera
         # because of garbage collection takes any file there
         # this could be refined, as, for example, on macos, temp folder is already user specific
         def file_list_folder
-          @file_list_folder ||= TempFileManager.instance.new_file_path_global('asession_filelists')
+          @file_list_folder ||= TempFileManager.instance.new_dir_path_global('asession_filelists')
         end
 
-        # File list is provided directly with `ascp` arguments
-        # @columns ascp_args [Array,NilClass] `ascp` arguments
+        # Check whether a file list option is already present in the `ascp` argument list
+        # @param ascp_args [Array, nil] `ascp` arguments
+        # @return [Boolean] true if a file list option is present
         def ascp_args_file_list?(ascp_args)
-          ascp_args&.any?{ |i| FILE_LIST_OPTIONS.include?(i)}
+          ascp_args&.any? { |i| FILE_LIST_OPTIONS.include?(i) }
         end
       end
 
       # @param job_spec        [Hash]          Transfer specification
       # @param ascp_args       [Array]         Other `ascp` args
+      # @param wss             [Boolean]       `true`: if both SSH and wss in ts: prefer wss
       # @param quiet           [Boolean]       Remove `ascp` progress bar if `true`
+      # @param file_list       [Boolean]       `true`: provide source list via a temp file, `false`: place directly on command line
       # @param client_ssh_key  [:rsa,:dsa]     Type of Aspera Client SSH key to use.
       # @param trusted_certs   [Array<String>] List of path to trusted certificates stores when using WSS
       # @param check_ignore_cb [Proc]          Callback to check if WSS connection shall ignore certificate validity
@@ -56,6 +60,7 @@ module Aspera
         ascp_args:       nil,
         wss:             true,
         quiet:           true,
+        file_list:       true,
         trusted_certs:   nil,
         client_ssh_key:  nil,
         check_ignore_cb: nil
@@ -63,18 +68,19 @@ module Aspera
         @job_spec = job_spec
         Aspera.assert_type(@job_spec, Hash)
         @ascp_args = ascp_args.nil? ? [] : ascp_args
-        Aspera.assert_array_all(@ascp_args, String){'ascp_args'}
+        Aspera.assert_array_all(@ascp_args, String) { 'ascp_args' }
         @wss = wss
         @quiet = quiet
+        @file_list = file_list
         @trusted_certs = trusted_certs.nil? ? [] : trusted_certs
-        Aspera.assert_type(@trusted_certs, Array){'trusted_certs'}
+        Aspera.assert_type(@trusted_certs, Array) { 'trusted_certs' }
         @client_ssh_key = client_ssh_key.nil? ? :rsa : client_ssh_key.to_sym
         Aspera.assert_values(@client_ssh_key, Ascp::Installation::CLIENT_SSH_KEY_OPTIONS)
         @check_ignore_cb = check_ignore_cb
         @builder = CommandLineBuilder.new(@job_spec, Spec::SCHEMA, CommandLineConverter)
       end
 
-      # either place source files on command line, or add file list file
+      # Place source files on command line or in a temp file list, controlled by @file_list and file_list_folder
       def process_file_list
         # is the file list provided through ascp parameters?
         ascp_file_list_provided = self.class.ascp_args_file_list?(@ascp_args)
@@ -86,33 +92,33 @@ module Aspera
         # transfer spec contains paths ?
         if !ts_paths_array.nil?
           Aspera.assert(!ascp_file_list_provided, 'file list provided both in transfer spec and ascp file list. Remove one of them.')
-          Aspera.assert(ts_paths_array.all?{ |i| i.key?('source')}, "All elements of paths must have a 'source' key")
-          is_pair_list = ts_paths_array.any?{ |i| i.key?('destination')}
-          raise "All elements of paths must be consistent with 'destination' key" if is_pair_list && !ts_paths_array.all?{ |i| i.key?('destination')}
-          if self.class.file_list_folder.nil?
+          Aspera.assert(ts_paths_array.all? { |i| i.key?('source') }, "All elements of paths must have a 'source' key")
+          is_pair_list = ts_paths_array.any? { |i| i.key?('destination') }
+          Aspera.assert(!(is_pair_list && !ts_paths_array.all? { |i| i.key?('destination') })) { "All elements of paths must be consistent with 'destination' key" }
+          if !@file_list || self.class.file_list_folder.nil?
             Aspera.assert(!is_pair_list, 'file pair list is not supported when file list folder is not set')
             # not safe for special characters ? (maybe not, depends on OS)
             Log.log.debug('placing source file list on command line (no file list file)')
-            @builder.add_command_line_options(ts_paths_array.map{ |i| i['source']})
+            @builder.add_command_line_options(ts_paths_array.map { |i| i['source'] })
           else
             # safer option: generate a file list file if there is storage defined for it
             if is_pair_list
               file_list_option = '--file-pair-list'
-              lines = ts_paths_array.each_with_object([]){ |e, m| m.push(e['source'], e['destination'])}
+              lines = ts_paths_array.each_with_object([]) { |e, m| m.push(e['source'], e['destination']) }
             else
               file_list_option = '--file-list'
-              lines = ts_paths_array.map{ |i| i['source']}
+              lines = ts_paths_array.map { |i| i['source'] }
             end
             file_list_file = TempFileManager.instance.new_file_path_in_folder(self.class.file_list_folder)
             Log.dump(:file_list, lines)
             File.write(file_list_file, lines.join("\n"), encoding: 'UTF-8')
-            Log.log.debug{"#{file_list_option}=\n#{File.read(file_list_file)}".red}
+            Log.log.debug { "#{file_list_option}=\n#{File.read(file_list_file)}".red }
           end
         end
         @builder.add_command_line_options("#{file_list_option}=#{file_list_file}") unless file_list_option.nil?
       end
 
-      # @return the list of certificates (option `-i`) to use when token/ssh or wss are used
+      # @return [Array<String>] the list of certificates (option `-i`) to use when token/ssh or wss are used
       def remote_certificates
         certificates_to_use = []
         # use web socket secure for session ?
@@ -150,11 +156,7 @@ module Aspera
 
       # Translate transfer spec to env vars and command line arguments for `ascp`
       def ascp_args
-        env_args = {
-          args: [],
-          env:  {},
-          name: :ascp
-        }
+        exec_spec = Aspera::ExecSpec.new(exec: :ascp)
 
         # Special cases
         @job_spec.delete('source_root') if @job_spec.key?('source_root') && @job_spec['source_root'].empty?
@@ -165,16 +167,16 @@ module Aspera
         # Add ssh or wss certificates
         # (reverse, to keep order, as we unshift)
         remote_certificates&.reverse_each do |cert|
-          env_args[:args].unshift('-i', cert)
+          exec_spec.args.unshift('-i', cert)
         end
 
         case (delete_source = @builder.read_param('delete_source'))
         when true
-          DELETE_EQUIV.each{ |i| @job_spec[i] = true}
+          DELETE_EQUIV.each { |i| @job_spec[i] = true }
         when false
-          DELETE_EQUIV.each{ |i| @job_spec.delete(i)}
+          DELETE_EQUIV.each { |i| @job_spec.delete(i) }
         when nil
-        else Aspera.error_unexpected_value(delete_source){'delete_source'}
+        else Aspera.error_unexpected_value(delete_source) { 'delete_source' }
         end
 
         # process parameters as specified in table
@@ -183,9 +185,9 @@ module Aspera
         base64_destination = false
         # symbol must be index of Ascp::Installation.paths
         if @builder.read_param('use_ascp4')
-          env_args[:name] = :ascp4
+          exec_spec.exec = :ascp4
         else
-          env_args[:name] = :ascp
+          exec_spec.exec = :ascp
           base64_destination = true
         end
         # destination will be base64 encoded, put this before source path arguments
@@ -200,17 +202,17 @@ module Aspera
         destination_folder = Base64.strict_encode64(destination_folder) if base64_destination
         # destination MUST be last command line argument to ascp
         @builder.add_command_line_options(destination_folder)
-        @builder.add_env_args(env_args)
-        env_args[:args].unshift('-q') if @quiet
+        @builder.add_to_exec_spec(exec_spec)
+        exec_spec.args.unshift('-q') if @quiet
         # add fallback cert and key as arguments if needed
         if HTTP_FALLBACK_ACTIVATION_VALUES.include?(@job_spec['http_fallback'])
-          env_args[:args].unshift('-Y', Ascp::Installation.instance.path(:fallback_private_key))
-          env_args[:args].unshift('-I', Ascp::Installation.instance.path(:fallback_certificate))
+          exec_spec.args.unshift('-Y', Ascp::Installation.instance.path(:fallback_private_key))
+          exec_spec.args.unshift('-I', Ascp::Installation.instance.path(:fallback_certificate))
         end
         # disable redis in client, only for ascp, this makes ascp4 fail
-        env_args[:env]['ASPERA_TEST_REDIS_DISABLE'] = 'true' if env_args[:name].eql?(:ascp)
-        Log.log.debug{"ascp args: #{env_args}"}
-        return env_args
+        exec_spec.env['ASPERA_TEST_REDIS_DISABLE'] = 'true' if exec_spec.exec.eql?(:ascp)
+        Log.log.debug { "ascp args: #{exec_spec}" }
+        return exec_spec
       end
       DELETE_EQUIV = %w[remove_after_transfer remove_empty_directories remove_empty_source_directory]
       # `ascp` options to provide a file list

data/lib/aspera/transfer/result.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Aspera
+  module Transfer
+    # Typed result of a transfer operation.
+    # Replaces the ad-hoc Array polymorphism previously returned by agents.
+    #
+    # Agents return one of the three concrete sub-classes:
+    #   Transfer::Result::Success  — all sessions completed successfully
+    #   Transfer::Result::Error    — at least one session failed
+    #   Transfer::Result::Async    — transfer submitted to a daemon; not yet complete
+    class Result
+      # All sessions completed successfully.
+      class Success < Result
+        def to_s
+          'success'
+        end
+      end
+
+      # At least one session failed.
+      class Error < Result
+        # @return [StandardError]
+        attr_reader :exception
+
+        def initialize(exception)
+          super()
+          @exception = exception
+        end
+
+        def to_s
+          "error: #{@exception.message}"
+        end
+      end
+
+      # Transfer submitted to an external daemon; status not yet known.
+      class Async < Result
+        # @return [String] UUID assigned to this background job
+        attr_reader :job_id
+        # @return [String] initial status string (e.g. 'running')
+        attr_reader :status
+
+        def initialize(job_id:, status: 'running')
+          super()
+          @job_id = job_id
+          @status = status
+        end
+
+        # Convenience: export as a plain Hash for serialization / display
+        def to_h
+          {'job_id' => @job_id, 'status' => @status}
+        end
+
+        def to_s
+          "async job_id=#{@job_id} status=#{@status}"
+        end
+      end
+
+      # Factory helpers
+      class << self
+        def success
+          Success.new
+        end
+
+        def error(exception)
+          Error.new(exception)
+        end
+
+        def async(job_id:, status: 'running')
+          Async.new(job_id: job_id, status: status)
+        end
+      end
+    end
+  end
+end

data/lib/aspera/transfer/resumer.rb

@@ -12,20 +12,20 @@ module Aspera
       # @param iter_max      [Integer] Maximum number of executions
       # @param sleep_initial [Integer] Initial wait to re-execute
       # @param sleep_factor  [Integer] Multiplier
-      # @param sleep_max.    [Integer] Max iterations
+      # @param sleep_max     [Integer] Max iterations
       def initialize(
         iter_max: 7,
         sleep_initial: 2,
         sleep_factor:  2,
         sleep_max:     60
       )
-        Aspera.assert_type(iter_max, Integer){k}
+        Aspera.assert_type(iter_max, Integer) { 'iter_max' }
         @iter_max = iter_max
-        Aspera.assert_type(sleep_initial, Integer){k}
+        Aspera.assert_type(sleep_initial, Integer) { 'sleep_initial' }
         @sleep_initial = sleep_initial
-        Aspera.assert_type(sleep_factor, Integer){k}
+        Aspera.assert_type(sleep_factor, Integer) { 'sleep_factor' }
         @sleep_factor = sleep_factor
-        Aspera.assert_type(sleep_max, Integer){k}
+        Aspera.assert_type(sleep_max, Integer) { 'sleep_max' }
         @sleep_max = sleep_max
       end
 
@@ -38,7 +38,7 @@ module Aspera
         # maximum of retry
         remaining_resumes = @iter_max
         sleep_seconds = @sleep_initial
-        Log.log.debug{"retries=#{remaining_resumes}"}
+        Log.log.debug { "retries=#{remaining_resumes}" }
         # try to send the file until ascp is successful
         loop do
           Log.log.debug('Starting task execution')
@@ -48,17 +48,17 @@ module Aspera
             # Exit retry loop if success
             break
           rescue Error => e
-            Log.log.warn{"An error occurred during task: #{e.message}"}
-            Log.log.debug{"Retryable ? #{e.retryable?}"}
+            Log.log.warn { "An error occurred during task: #{e.message}" }
+            Log.log.debug { "Retryable ? #{e.retryable?}" }
             # do not retry non-retryable
             raise unless e.retryable?
             # exit if we exceed the max number of retry
-            raise Error, "Maximum number of retry reached: #{@iter_max}" if remaining_resumes <= 0
+            Aspera.assert(remaining_resumes > 0, type: Error) { "Maximum number of retry reached: #{@iter_max}" }
           end
 
           # take this retry in account
           remaining_resumes -= 1
-          Log.log.warn{"Resuming in #{sleep_seconds} seconds (retry left:#{remaining_resumes})"}
+          Log.log.warn { "Resuming in #{sleep_seconds} seconds (retry left:#{remaining_resumes})" }
 
           # wait a bit before retrying, maybe network condition will be better
           sleep(sleep_seconds)

data/lib/aspera/transfer/spec.rb

@@ -34,7 +34,13 @@ module Aspera
           'sparse_csum' => 'sparse_checksum',
           'full_csum'   => 'full_checksum'
         }
-        private_constant :POLICY_FIX
+        # Multipliers for target_rate suffix (result is in kbps)
+        RATE_SUFFIX_KBPS = {
+          'k' => 1,
+          'm' => 1_000,
+          'g' => 1_000_000
+        }.freeze
+        private_constant :POLICY_FIX, :RATE_SUFFIX_KBPS
         # translate upload/download to send/receive
         def transfer_type_to_direction(transfer_type)
           XFER_TYPE_TO_DIR.fetch(transfer_type)
@@ -45,6 +51,17 @@ module Aspera
           XFER_DIR_TO_TYPE.fetch(direction)
         end
 
+        # Parse a human-readable rate string (as accepted by ascp -l) into an integer kbps value.
+        # Accepted: plain integer (kbps), or integer + suffix k/K (kbps), m/M (x1000 kbps), g/G (x1000000 kbps).
+        # @param value [String] e.g. "100m", "500000", "1g"
+        # @return [Integer] value in kbps
+        def rate_string_to_kbps(value)
+          m = value.to_s.strip.match(/\A(\d+)([kKmMgG])?\z/)
+          Aspera.assert(m) { "Invalid rate value: #{value.inspect}. Expected integer with optional suffix k/K, m/M or g/G." }
+          multiplier = m[2] ? RATE_SUFFIX_KBPS.fetch(m[2].downcase) : 1
+          return m[1].to_i * multiplier
+        end
+
         def fix_transferd_resume_policy(transfer_spec)
           # Fix discrepancy in transfer spec
           transfer_spec['resume_policy'] = POLICY_FIX[transfer_spec['resume_policy']] if transfer_spec.key?('resume_policy')

data/lib/aspera/transfer/spec.schema.yaml

@@ -377,6 +377,7 @@ properties:
     description: Specifies whether to precalculate the job size.
     type: boolean
     x-cli-switch: true
+    x-cli-false: --precalculate-disable
   preserve_access_time:
     description: >-
       Preserve the source-file access timestamps at the destination.
@@ -711,11 +712,11 @@ properties:
       Refer to HSTS manual for more details.
 
       - `follow`: Follow a symbolic link and transfer the contents of the linked file or directory when the link target is in the user's docroot.
-      
+
       - `copy`: Copy only the symbolic link. If a file with the same name exists at the destination, the symbolic link does not replace the file.
-      
+
       - `skip`: Skip-symbolic links. The link or the file to which it points are not transferred.
-      
+
       - `copy+force`: Copy only the symbolic link. If a file with the same name exists at the destination, the symbolic link replaces the file. If the file of the same name at the destination is a symbolic link to a directory, it is not replaced.
     type: string
     enum:
@@ -753,6 +754,14 @@ properties:
     description: Specifies desired speed for the transfer.
     type: integer
     x-cli-option: -l
+  target_rate:
+    description: >-
+      Pseudo-parameter: desired transfer rate as a human-readable string with an optional unit suffix.
+      Converted to `target_rate_kbps` before the transfer is started, overriding it if both are present.
+      Accepted formats: plain integer (kbps), or integer followed by `k`/`K` (kbps), `m`/`M` (x1000 kbps), `g`/`G` (x1000000 kbps).
+      Examples: `100000`, `100000k`, `100m`, `1g`.
+    type: string
+    x-cli-special: true
   title:
     description: Title of the transfer.
     type: string

data/lib/aspera/uri_reader.rb

@@ -7,31 +7,66 @@ require 'aspera/rest'
 require 'aspera/temp_file_manager'
 
 module Aspera
-  # Read some content from some URI, support file: , http: and https: schemes
+  # Read content from a URI; supported schemes: file:, http:, https:, data:
+  #
+  # == file: URL convention
+  # Two equivalent forms are accepted:
+  #
+  #   file:///relative/path    -> relative path "relative/path"
+  #   file:////absolute/path   -> absolute path "/absolute/path"
+  #
+  # A shorter form is also accepted (no authority component):
+  #
+  #   file:relative/path       -> relative path "relative/path"
+  #   file:/absolute/path      -> absolute path "/absolute/path"
+  #
+  # The short form is consistent with RFC 8089 (file:///<path> = absolute,
+  # file:<path> = relative).  Both forms are handled identically by this module.
+  # The canonical form built by {file_url} uses the +file:///+ prefix.
   module UriReader
     SCHEME_FILE = 'file'
     SCHEME_FILE_PFX1 = "#{SCHEME_FILE}:"
+    # Canonical prefix for file: URLs (no host, three slashes).
+    # What follows is the literal path: relative or absolute (starting with a second slash).
     SCHEME_FILE_PFX2 = "#{SCHEME_FILE_PFX1}///"
     private_constant :SCHEME_FILE, :SCHEME_FILE_PFX1, :SCHEME_FILE_PFX2
     class << self
-      # @return [Boolean] true if the URL is a file:// URL
+      # @return [Boolean] true if +url+ uses the file: scheme recognised by this module
       def file?(url)
-        url.start_with?(SCHEME_FILE_PFX2)
+        url.start_with?(SCHEME_FILE_PFX1)
       end
 
-      # @return [String] a file:// URL for the given path
+      # Build a file: URL from +path+.
+      # A relative path yields +file:///path+; an absolute path yields +file:////path+.
+      # @param path [String] relative or absolute file-system path
+      # @return [String] corresponding file: URL
       def file_url(path)
         return "#{SCHEME_FILE_PFX2}#{path}"
       end
 
-      # @return [String] the path of a file:// URL
+      # Extract the file-system path from a file: URL.
+      # Accepts both the canonical +file:///+ form and the short +file:+ form.
+      # Returns the literal path (relative or absolute) without working-directory expansion.
+      # @param url [String] a file: URL (canonical or short form)
+      # @return [String] the literal path encoded in the URL
       def file_path(url)
-        Aspera.assert(file?(url)){"use format: #{file_url('<path>')}"}
-        File.expand_path(url.delete_prefix(SCHEME_FILE_PFX2))
+        Aspera.assert(file?(url)) { "use format: #{file_url('<path>')}" }
+        # Strip canonical prefix "file:///" first (covers relative and absolute canonical forms).
+        # If absent, strip only the short "file:" prefix.
+        return url.start_with?(SCHEME_FILE_PFX2) ? url.delete_prefix(SCHEME_FILE_PFX2) : url.delete_prefix(SCHEME_FILE_PFX1)
       end
 
-      # Read some content from some URI, support file: , http: and https: schemes
+      # Read content from a URI and return it as a String.
+      # Supported schemes: +http+, +https+, +data+, +file+, and bare paths (no scheme).
+      # For file: URLs the path is extracted via {file_path} to respect the module convention
+      # (see module-level documentation).  Ruby's URI parser is not used for file: URLs because
+      # it interprets the three-slash prefix differently (it always produces an absolute path).
+      # Bare paths (no scheme) are passed to File.read directly; leading +/~/+, +/./+, +/../+
+      # are expanded via +File.expand_path+ after stripping the synthetic leading slash added by
+      # URI.
       def read(uri_to_read)
+        # Handle file: URLs directly to honour the file:///relative vs file:////absolute convention.
+        return File.read(file_path(uri_to_read)) if file?(uri_to_read)
         uri = URI.parse(uri_to_read)
         case uri.scheme
         when 'http', 'https'
@@ -43,20 +78,22 @@ module Aspera
           else
             URI.decode_www_form_component(encoded_data)
           end
-        when SCHEME_FILE, NilClass
+        when NilClass
           local_file_path = uri.path
-          raise Error, 'URL shall have a path, check syntax' if local_file_path.nil?
+          Aspera.assert(!local_file_path.nil?, type: Error) { 'URL shall have a path, check syntax' }
           local_file_path = File.expand_path(local_file_path.gsub(%r{^/}, '')) if %r{^/(~|.|..)/}.match?(local_file_path)
           return File.read(local_file_path)
-        else Aspera.error_unexpected_value(uri.scheme){"scheme for [#{uri_to_read}]"}
+        else Aspera.error_unexpected_value(uri.scheme) { "scheme for [#{uri_to_read}]" }
         end
       end
 
-      # @return Path to file with content at URL
+      # Return the local file-system path for the content at +url+, downloading to a temp file if needed.
+      # For file: URLs the path is extracted directly (no download).
+      # For data: and http(s): URLs the content is written to a temporary file and its path is returned.
+      # @return [String] local path to a file containing the URL content
       def read_as_file(url)
         if url.start_with?(SCHEME_FILE_PFX1)
-          # for file scheme, return directly the path
-          # require specific file scheme: the path part is "relative", or absolute if there are 4 slash
+          # file: scheme: extract the literal path encoded in the URL (relative or absolute).
           return file_path(url)
         elsif url.start_with?('data:')
           # download to temp file
@@ -68,7 +105,7 @@ module Aspera
           # download to temp file
           # auto-delete on exit
           temp_file = TempFileManager.instance.new_file_path_global(suffix: File.basename(url))
-          Aspera::Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', save_to_file: temp_file)
+          Aspera::Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', save_to: temp_file)
           return temp_file
         end
       end

data/lib/aspera/web_auth.rb

@@ -2,12 +2,13 @@
 
 require 'aspera/web_server_simple'
 require 'aspera/assert'
+require 'erb'
 
 module Aspera
   # servlet called on callback: it records the callback request
   class WebAuthServlet < WEBrick::HTTPServlet::AbstractServlet
-    # @param server [WEBrick::HTTPServer]
-    # @param web_auth [WebAuth]
+    # @param server   [WEBrick::HTTPServer] the HTTP server instance
+    # @param web_auth [WebAuth]             the WebAuth instance to record the callback
     def initialize(server, web_auth)
       Log.log.debug('WebAuthServlet initialize')
       super(server)
@@ -15,8 +16,8 @@ module Aspera
     end
 
     def service(request, response)
-      Log.log.debug{"received request from browser #{request.request_method} #{request.path}"}
-      Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed){'HTTP verb'}
+      Log.log.debug { "received request from browser #{request.request_method} #{request.path}" }
+      Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed) { 'HTTP verb' }
       additional_info = @web_auth.signal_request(request)
       response.status = 200
       response.content_type = 'text/html'
@@ -91,7 +92,7 @@ module Aspera
         <body>
         <h1>Thank You!</h1>
         <p>You can close this window.</p>
-        <p>#{additional_info}</p>
+        <p>#{ERB::Util.html_escape(additional_info) unless additional_info.nil?}</p>
 
         <!-- JavaScript to generate IBM logos -->
         <script>
@@ -182,7 +183,7 @@ module Aspera
       # last argument (self) is provided to constructor of servlet
       mount(@expected_path, WebAuthServlet, self)
       # server runs in thread
-      Thread.new{start}
+      Thread.new { start }
     end
 
     # Called by web server thread on received request
@@ -201,7 +202,7 @@ module Aspera
     # @return [Hash] the query
     def received_request
       # wait for signal from thread
-      @mutex.synchronize{@cond.wait(@mutex)}
+      @mutex.synchronize { @cond.wait(@mutex) }
       # tell server thread to stop
       shutdown
       return @query

data/lib/aspera/web_server_simple.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 require 'webrick'
-require 'webrick/https'
 require 'aspera/log'
 require 'aspera/assert'
 require 'aspera/hash_ext'
-require 'openssl'
 
 module Aspera
   # Simple WEBrick server with HTTPS support
@@ -14,7 +12,7 @@ module Aspera
     DEFAULT_URL = 'http://localhost:8080'
     GENERIC_ISSUER = '/C=FR/O=Test/OU=Test/CN=Test'
     ONE_YEAR_SECONDS = 365 * 24 * 60 * 60
-    PKCS12_EXT = %w[p12 pfx].map{ |i| ".#{i}"}.freeze
+    PKCS12_EXT = %w[p12 pfx].map { |i| ".#{i}" }.freeze
     CLOCK_SKEW_OFFSET_SEC = 5
 
     private_constant :GENERIC_ISSUER, :ONE_YEAR_SECONDS, :PKCS12_EXT, :CLOCK_SKEW_OFFSET_SEC
@@ -42,9 +40,9 @@ module Aspera
         cert
       end
 
-      # @return a list of Certificates from chain file
+      # @return [Array<OpenSSL::X509::Certificate>] list of Certificates from chain file
       def read_chain_file(chain)
-        File.read(chain).scan(/-----BEGIN CERTIFICATE-----.*?-----END CERTIFICATE-----/m).map{ |i| OpenSSL::X509::Certificate.new(i)}
+        File.read(chain).scan(/-----BEGIN CERTIFICATE-----.*?-----END CERTIFICATE-----/m).map { |i| OpenSSL::X509::Certificate.new(i) }
       end
     end
 
@@ -66,13 +64,18 @@ module Aspera
       when 'http'
         Log.log.debug('HTTP mode')
       when 'https'
+        # Required lazily: webrick/ssl.rb reads OpenSSL::OPENSSL_VERSION at load time,
+        # a constant CosmoRuby's OpenSSL shim does not define, so requiring it
+        # unconditionally at file load would break any command in a Cosmo build
+        # even when no HTTPS server is ever started.
+        require 'webrick/https'
         webrick_options[:SSLEnable] = true
         if cert.nil? && key.nil?
           webrick_options[:SSLCertName] = [['CN', WEBrick::Utils.getservername]]
         elsif cert && PKCS12_EXT.include?(File.extname(cert).downcase)
           # PKCS12
           Log.log.debug('Using PKCS12 certificate')
-          raise Error, 'PKCS12 requires a key (password)' if key.nil?
+          Aspera.assert(!key.nil?, type: Error) { 'PKCS12 requires a key (password)' }
           pkcs12 = OpenSSL::PKCS12.new(File.read(cert), key)
           webrick_options[:SSLCertificate] = pkcs12.certificate
           webrick_options[:SSLPrivateKey] = pkcs12.key
@@ -90,27 +93,27 @@ module Aspera
             OpenSSL::X509::Certificate.new(File.read(cert))
           end
           webrick_options[:SSLExtraChainCert] = read_chain_file(chain) unless chain.nil?
-          raise Error, 'key and cert do not match' unless webrick_options[:SSLCertificate].public_key.to_der == webrick_options[:SSLPrivateKey].public_key.to_der
+          Aspera.assert(webrick_options[:SSLCertificate].public_key.to_der == webrick_options[:SSLPrivateKey].public_key.to_der, type: Error) { 'key and cert do not match' }
         end
       end
       # call constructor of parent class, but capture STDERR
       # self signed certificate generates characters on STDERR
       # see create_self_signed_cert in webrick/ssl.rb
-      Log.capture_stderr{super(webrick_options)}
+      Log.capture_stderr { super(webrick_options) }
     end
 
     # blocking
     def start
-      Log.log.info{"Listening on #{@uri}"}
+      Log.log.info { "Listening on #{@uri}" }
       # kill (-TERM) for graceful shutdown
-      handler = proc{shutdown}
-      %i{INT TERM}.each{ |sig| trap(sig, &handler)}
+      handler = proc { shutdown }
+      %i{INT TERM}.each { |sig| trap(sig, &handler) }
       super
     end
 
     # log web server access ( option AccessLog )
     def <<(access_log)
-      Log.log.debug{"webrick log #{access_log.chomp}"}
+      Log.log.debug { "webrick log #{access_log.chomp}" }
     end
   end
 end