aspera-cli 4.27.2 → 4.27.4

data/lib/aspera/cli/formatter.rb

@@ -18,6 +18,8 @@ require 'yaml'
 require 'pp'
 require 'csv'
 require 'word_wrap'
+require 'aspera/rainbow'
+using Rainbow
 
 module Aspera
   module Cli
@@ -25,7 +27,7 @@ module Aspera
     class Formatter
       extend OptionDeclarator
 
-      # remove a fields from the list
+      # `-` remove a fields from the list
       FIELDS_LESS = '-'
       # supported output formats
       DISPLAY_FORMATS = %i[text nagios ruby json jsonpp yaml table csv image].freeze
@@ -38,17 +40,19 @@ module Aspera
 
       private_constant :FIELDS_LESS, :DISPLAY_FORMATS, :DISPLAY_LEVELS, :SINGLE_OBJECT_COLUMN_NAMES, :STR_LST_SEP_VERT
 
-      option :out,          description: 'Output rendering options (dot-notation: format, level, file, fields, select, table[.pivot], flat, secrets, img)', schema: Schema::Registry::OUT_OPTIONS
-      option :display,      description: 'Output only some information', allowed: DISPLAY_LEVELS, default: :data, deprecation: 'use --out.level'
+      option :out,          description: 'Output rendering options (dot-notation: format, level, file, fields, select, table[.pivot], flat, secrets, colors, utf8, img)', schema: Schema::Registry::OUT_OPTIONS
+      option :display,      description: 'Output only some information', allowed: DISPLAY_LEVELS, default: :data, deprecation: {last: '4.27.0', message: 'use --out.level'}
       option :format,       description: 'Output format (also: --out.format)', allowed: DISPLAY_FORMATS, default: :table
-      option :output,       description: 'Destination for results', deprecation: 'use --out.file'
+      option :output,       description: 'Destination for results', deprecation: {last: '4.27.0', message: 'use --out.file'}
       option :fields,       description: "Comma separated list of: fields, or #{SpecialValues::ALL}, or #{SpecialValues::DEF} (also: --out.fields)", allowed: [String, Array, Regexp, Proc], default: SpecialValues::DEF
       option :select,       description: 'Select only some items in lists: column, value (also: --out.select)', allowed: [Hash, Proc]
-      option :table_style,  description: '(Table) Display style',                                                                             allowed: [Hash], deprecation: 'use --out.table'
-      option :flat_hash,    description: '(Table) Display deep values as additional keys',                                                    allowed: Type::BOOLEAN, default: true,                    deprecation: 'use --out.flat'
-      option :multi_single, description: '(Table) Control how object list is displayed as single table, or multiple objects',                 allowed: %i[no yes single], default: :no,                 deprecation: 'use --out.table.pivot'
-      option :show_secrets, description: 'Show secrets on command output',                                                                    allowed: Type::BOOLEAN, default: false,                   deprecation: 'use --out.secrets'
-      option :image,        schema: Schema::Registry::IMAGE_OPTIONS, deprecation: 'use --out.img'
+      option :table_style,  description: '(Table) Display style',                                                                             allowed: [Hash], deprecation: {last: '4.27.0', message: 'use --out.table'}
+      option :flat_hash,    description: '(Table) Display deep values as additional keys',                                                    allowed: Type::BOOLEAN, default: true,                    deprecation: {last: '4.27.0', message: 'use --out.flat'}
+      option :multi_single, description: '(Table) Control how object list is displayed as single table, or multiple objects',                 allowed: %i[no yes single], default: :no,                 deprecation: {last: '4.27.0', message: 'use --out.table.pivot'}
+      option :show_secrets, description: 'Show secrets on command output',                                                                    allowed: Type::BOOLEAN, default: false,                   deprecation: {last: '4.27.0', message: 'use --out.secrets'}
+      option :image,        schema: Schema::Registry::IMAGE_OPTIONS, deprecation: {last: '4.27.0', message: 'use --out.img'}
+      # All formatter options are handled by `option_handler`, executed on the formatter instance
+      option_specs.each_value { |spec| spec.on_set = ->(value) { option_handler(spec.name, value) } }
 
       class << self
         # Replace special values with a readable version on terminal
@@ -85,14 +89,21 @@ module Aspera
           end
         end
 
-        def all_but(list)
-          Array(list).map { |i| "#{FIELDS_LESS}#{i}" }.unshift(SpecialValues::ALL)
+        # @param fields [Array<String>] List of fields to not display
+        # @return [Array<String>] List of fields to display, including special values (`ALL`) and tagged (`-`) fields
+        def all_but(*fields)
+          Aspera.assert_array_all(fields, String)
+          fields.map { |i| "#{FIELDS_LESS}#{i}" }.unshift(SpecialValues::ALL)
         end
       end
 
       # initialize the formatter
       def initialize
         @options = {}
+        # Last value of option `out`
+        @out_dispatched = {}
+        # Colors auto-detected by Rainbow at load time, restored when `--out.colors` is reset
+        @colors_detected = Rainbow.enabled
         @spinner = nil
       end
 
@@ -103,7 +114,7 @@ module Aspera
         total = total.to_i
         return if total.eql?(0) && count.eql?(0)
         count_msg = "Items: #{count}/#{total}"
-        count_msg = count_msg.bg_red unless count.eql?(total)
+        count_msg = count_msg.bg(:red) unless count.eql?(total)
         display_status(count_msg)
       end
 
@@ -137,72 +148,68 @@ module Aspera
         end
       end
 
-      # Bind all formatter options to this instance using set_handler.
+      # Declare formatter options on the parser, with `on_set` callbacks executed on this instance.
       # Called from Runner after Formatter.new.
-      # @param options [Aspera::Cli::Parser]
+      # @param parser [Aspera::Cli::Parser]
       # @return [nil]
-      def bind_options(options)
-        @parser = options
-        %i[out display format output fields select table_style flat_hash multi_single show_secrets image].each do |opt|
-          options.set_handler(opt, object: self, method: :option_handler)
-        end
+      def declare_options(parser)
+        # Used by `option_handler` to dispatch `--out` sub-options
+        @parser = parser
+        self.class.declare_options(parser, target: self)
         nil
       end
 
-      # Getter/setter handler called by the option manager for all formatter options
-      # @param option_symbol [Symbol]       Option name (one of :out, :format, :output, :display, :fields, :select, :table_style, :flat_hash, :multi_single, :show_secrets, :image)
-      # @param operation     [Symbol]       :get or :set
-      # @param value         [Object, nil]  Value to set (only used when operation is :set)
-      # @return [Object, nil] Current option value when operation is :get; nil otherwise
-      def option_handler(option_symbol, operation, value = nil)
-        Aspera.assert_values(operation, %i[set get])
-        case operation
-        when :set
-          # --out is a composite hash: dispatch each sub-key through the parser (validation included)
-          if option_symbol.eql?(:out)
-            Aspera.assert_type(value, Hash)
-            value.each do |k, v|
-              case k.to_sym
-              when :format   then @parser.set_option(:format,       v, warn_deprecation: false)
-              when :level    then @parser.set_option(:display,      v, warn_deprecation: false)
-              when :file     then @parser.set_option(:output,       v, warn_deprecation: false)
-              when :fields   then @parser.set_option(:fields,       v, warn_deprecation: false)
-              when :select   then @parser.set_option(:select,       v, warn_deprecation: false)
-              when :table
-                Aspera.assert_type(v, Hash)
-                table_hash = v.transform_keys(&:to_sym)
-                @parser.set_option(:multi_single, table_hash.delete(:pivot).to_s, warn_deprecation: false) if table_hash.key?(:pivot)
-                @parser.set_option(:table_style,  table_hash, warn_deprecation: false) unless table_hash.empty?
-              when :flat     then @parser.set_option(:flat_hash,    v, warn_deprecation: false)
-              when :secrets  then @parser.set_option(:show_secrets, v, warn_deprecation: false)
-              when :img      then @parser.set_option(:image,        v, warn_deprecation: false)
-              else Aspera.error_unexpected_value(k) { 'out sub-option (format, level, file, fields, select, table[.pivot], flat, secrets, img)' }
-              end
+      # `on_set` callback called by the option manager for all formatter options
+      # @param option_symbol [Symbol]      Option name (one of :out, :format, :output, :display, :fields, :select, :table_style, :flat_hash, :multi_single, :show_secrets, :image)
+      # @param value         [Object, nil] New value
+      # @return [nil]
+      def option_handler(option_symbol, value)
+        # --out is a composite hash: dispatch each sub-key through the parser (validation included)
+        if option_symbol.eql?(:out)
+          Aspera.assert_type(value, Hash)
+          # Value is merged with previous values: dispatch only changes
+          changed = value.reject { |k, v| @out_dispatched[k].eql?(v) }
+          @out_dispatched = value
+          changed.each do |k, v|
+            case k.to_sym
+            when :format   then @parser.set_option(:format,       v, warn_deprecation: false)
+            when :level    then @parser.set_option(:display,      v, warn_deprecation: false)
+            when :file     then @parser.set_option(:output,       v, warn_deprecation: false)
+            when :fields   then @parser.set_option(:fields,       v, warn_deprecation: false)
+            when :select   then @parser.set_option(:select,       v, warn_deprecation: false)
+            when :table
+              Aspera.assert_type(v, Hash)
+              table_hash = v.transform_keys(&:to_sym)
+              @parser.set_option(:multi_single, table_hash.delete(:pivot), warn_deprecation: false) if table_hash.key?(:pivot)
+              @parser.set_option(:table_style,  table_hash, warn_deprecation: false) unless table_hash.empty?
+            when :flat     then @parser.set_option(:flat_hash,    v, warn_deprecation: false)
+            when :secrets  then @parser.set_option(:show_secrets, v, warn_deprecation: false)
+            when :img      then @parser.set_option(:image,        v, warn_deprecation: false)
+            when :colors   then Rainbow.enabled = v.nil? ? @colors_detected : v
+            when :utf8     then Environment.unicode = v
+            else Aspera.error_unexpected_value(k) { 'out sub-option (format, level, file, fields, select, table[.pivot], flat, secrets, colors, utf8, img)' }
             end
-            return
           end
-          @options[option_symbol] = value
-          # special handling of some options
-          case option_symbol
-          when :format
-            @options[:display] = value.eql?(:table) ? :info : :data
-          when :output
-            $stdout = if value.eql?('-')
-              STDOUT # rubocop:disable Style/GlobalStdStream
-            else
-              File.open(value, 'w')
-            end
-          when :image
-            # get list if key arguments of method
-            allowed_options = Preview::Terminal.method(:build).parameters.select { |i| i[0].eql?(:key) }.map { |i| i[1] }
-            # check that only supported options are given
-            unknown_options = value.keys.map(&:to_sym) - allowed_options
-            Aspera.assert(unknown_options.empty?) { "Invalid parameter(s) for option image: #{unknown_options.join(', ')}, use #{allowed_options.join(', ')}" }
+          return
+        end
+        @options[option_symbol] = value
+        # special handling of some options
+        case option_symbol
+        when :format
+          # The default output level depends on the format, unless the level is set explicitly (e.g. `--out.level`)
+          @options[:display] = value.eql?(:table) ? :info : :data if @parser.nil? || @parser.option_def(:display).source.eql?(:default)
+        when :output
+          $stdout = if value.eql?('-')
+            STDOUT # rubocop:disable Style/GlobalStdStream
+          else
+            File.open(value, 'w')
           end
-        when :get
-          return if option_symbol.eql?(:out)
-          return @options[option_symbol]
-        else Aspera.error_unreachable_line
+        when :image
+          # get list if key arguments of method
+          allowed_options = Preview::Terminal.method(:build).parameters.select { |i| i[0].eql?(:key) }.map { |i| i[1] }
+          # check that only supported options are given
+          unknown_options = value.keys.map(&:to_sym) - allowed_options
+          Aspera.assert(unknown_options.empty?) { "Invalid parameter(s) for option image: #{unknown_options.join(', ')}, use #{allowed_options.join(', ')}" }
         end
         nil
       end
@@ -214,9 +221,9 @@ module Aspera
       # @param hide_secrets [Boolean] Whether to hide secrets in the message (default: true)
       # @return [nil]
       # @note Message display behavior depends on the message_level:
-      #   - +:data+ messages are displayed unless display level is +:error+
-      #   - +:info+ messages are only displayed when display level is +:info+
-      #   - +:error+ messages are always displayed on stderr
+      #   - `:data` messages are displayed unless display level is `:error`
+      #   - `:info` messages are only displayed when display level is `:info`
+      #   - `:error` messages are always displayed on `stderr`
       def display_message(message_level, message, hide_secrets: true)
         message = SecretHider.instance.hide_secrets_in_string(message) if hide_secrets && message.is_a?(String) && hide_secrets?
         case message_level
@@ -291,14 +298,18 @@ module Aspera
         @options[:image].symbolize_keys
       end
 
-      # @return [Array<String>] all fields of all objects in list of objects
+      # Compute the list of all fields for all provided objects
+      # @param data [Array<Hash>] objects
+      # @return [Array<String>] All fields of all objects in list of objects
       def all_fields(data)
-        data.each_with_object({}) { |v, m| v.each_key { |c| m[c] = true } }.keys
+        data.flat_map(&:keys).uniq
       end
 
-      # @return [Array<String>] the list of fields to display
-      # @param data    [Array<Hash>]         data to display
-      # @param default [Array<String>, Proc] list of fields to display by default (may contain special values)
+      # Given the list of objects (with all fields) and a default filter, including `DEF`, `ALL` and `-`,
+      # expand and compute the actual list of fields to display.
+      # @param data [Array<Hash>] Data to display
+      # @param default [Array<String>, Proc] List of fields to display by default (may contain special values)
+      # @return [Array<String>] List of fields to display
       def compute_fields(data, default)
         Log.log.debug { "compute_fields: data:#{data.class} default:#{default.class} #{default}" }
         Log.dump(:compute_fields_default, default, level: :trace1)
@@ -355,8 +366,9 @@ module Aspera
         return data.map { |i| i.slice(*selected_fields) }
       end
 
-      # filter the list of items on the select option
-      # @param data [Array<Hash>] list of items
+      # Filter the list of items on the select option
+      # @param data [Array<Hash>] List of items
+      # @return [nil]
       def filter_columns_on_select(data)
         case @options[:select]
         when Proc
@@ -368,12 +380,14 @@ module Aspera
         when Hash
           @options[:select].each { |k, v| data.select! { |i| i[k].eql?(v) } }
         end
+        nil
       end
 
       # Displays a list of objects
       # @param object_array [Array<Hash>] Array of hash
       # @param fields [Array<String>] List of column names
       # @param single [Boolean] Contains a single object to display
+      # @return [nil]
       def display_table(object_array, fields, single: false)
         Aspera.assert_array_all(object_array, Hash)
         Aspera.assert_array_all(fields, String)

data/lib/aspera/cli/gem_checker.rb

@@ -19,7 +19,7 @@ module Aspera
       def check_gem_version
         latest_version =
           begin
-            Rest.new(base_url: 'https://rubygems.org/api/v1').read("versions/#{Info::GEM_NAME}/latest.json")['version']
+            Rest::Client.new(base_url: 'https://rubygems.org/api/v1').read("versions/#{Info::GEM_NAME}/latest.json")['version']
           rescue StandardError
             Log.log.warn('Could not retrieve latest gem version on rubygems.')
             '0'

data/lib/aspera/cli/hints.rb

@@ -6,6 +6,7 @@ require 'aspera/log'
 require 'aspera/ssh'
 require 'aspera/assert'
 require 'aspera/cli/info'
+require 'aspera/cli/terminal_formatter'
 require 'net/ssh'
 require 'openssl'
 
@@ -26,7 +27,7 @@ module Aspera
           ]
         },
         {
-          exception:   Aspera::RestCallError,
+          exception:   Aspera::Rest::CallError,
           match:       /Signature has expired/,
           remediation: [
             'There is too much time difference between your computer and the server',
@@ -70,7 +71,7 @@ module Aspera
           ]
         },
         {
-          exception:   Aspera::RestCallError,
+          exception:   Aspera::Rest::CallError,
           match:       /Invalid subject\./,
           remediation: [
             'It seems that this user name is not registered on the server',
@@ -102,7 +103,7 @@ module Aspera
           ]
         },
         {
-          exception:   Aspera::RestCallError,
+          exception:   Aspera::Rest::CallError,
           match:       /Server is not configured for this request/,
           remediation: [
             'Transfer user shall have those parameters in aspera.conf set to: token',
@@ -110,14 +111,14 @@ module Aspera
           ]
         },
         {
-          exception:   Aspera::RestCallError,
+          exception:   Aspera::Rest::CallError,
           match:       /invalid_grant/,
           remediation: [
             'Check your public key in your AoC user profile.'
           ]
         },
         {
-          exception:   Aspera::RestCallError,
+          exception:   Aspera::Rest::CallError,
           match:       /Please configure ACLs for this URI/,
           remediation: [
             'server must have: asnodeadmin -mu <node user> --acl-add=internal --internal'
@@ -145,7 +146,7 @@ module Aspera
               else Aspera.error_unexpected_value(m) { 'hint match' }
               end
               hint[:remediation].each do |r|
-                Log.log.info { "#{'HINT:'.bg_green.gray.blink.freeze} #{r}" }
+                Log.log.info { "#{TerminalFormatter.hint} #{r}" }
               end
             end
           end

data/lib/aspera/cli/http.rb

@@ -26,12 +26,13 @@ module Aspera
 
       private_constant :CERT_EXT, :SELF_SIGNED_CERT
 
-      option :insecure,           description: 'HTTP/S: Do not validate any certificate',                   allowed: Type::BOOLEAN, default: false
-      option :ignore_certificate, description: 'HTTP/S: Do not validate certificate for these URLs',        allowed: [Array, NilClass]
-      option :warn_insecure,      description: 'HTTP/S: Issue a warning if certificate is ignored',         allowed: Type::BOOLEAN, default: true
-      option :cert_stores,        description: 'HTTP/S: List of folder with trusted certificates',          allowed: Type::STRING_ARRAY
-      option :http_options,       schema: Schema::Registry::HTTP_OPTIONS
-      option :http_proxy,         description: 'HTTP/S: URL for proxy with optional credentials'
+      # `on_set` callbacks are methods of the instance given as `target:` to `declare_options`
+      option :insecure,           description: 'HTTP/S: Do not validate any certificate',                   allowed: Type::BOOLEAN, default: false, on_set: :insecure=
+      option :ignore_certificate, description: 'HTTP/S: Do not validate certificate for these URLs',        allowed: [Array, NilClass],             on_set: :ignore_cert_host_port=
+      option :warn_insecure,      description: 'HTTP/S: Issue a warning if certificate is ignored',         allowed: Type::BOOLEAN, default: true,  on_set: :warn_insecure=
+      option :cert_stores,        description: 'HTTP/S: List of folder with trusted certificates',          allowed: Type::STRING_ARRAY,            on_set: :trusted_cert_locations=
+      option :http_options,       schema: Schema::Registry::HTTP_OPTIONS,                                                                           on_set: :http_options=
+      option :http_proxy,         description: 'HTTP/S: URL for proxy with optional credentials',                                                   on_set: :http_proxy=
 
       def initialize
         @insecure              = false
@@ -46,21 +47,8 @@ module Aspera
       attr_accessor :insecure, :warn_insecure
       attr_reader   :ignore_cert_host_port, :http_options
 
-      # Bind all HTTP options to this instance using set_handler.
-      # Called from Config#initialize immediately after Http.new.
-      # @param options [Aspera::Cli::Parser]
-      # @return [nil]
-      def bind_options(options)
-        options.set_handler(:insecure,           object: self, method: :insecure)
-        options.set_handler(:ignore_certificate, object: self, method: :ignore_cert_host_port)
-        options.set_handler(:warn_insecure,      object: self, method: :warn_insecure)
-        options.set_handler(:cert_stores,        object: self, method: :trusted_cert_locations)
-        options.set_handler(:http_options,       object: self, method: :http_options)
-        options.set_handler(:http_proxy,         object: self, method: :http_proxy)
-      end
-
       # Setter for http_options: dispatch each key to its target singleton immediately.
-      # Keys matching RestParameters setters go to RestParameters, 'ssl_options' goes to SSL,
+      # Keys matching Rest::Parameters setters go to Rest::Parameters, 'ssl_options' goes to SSL,
       # keys matching OAuth::Factory.instance.parameters go to OAuth, and the rest are kept
       # in @http_options for Net::HTTP session configuration in update_session.
       # This runs on every assignment (JSON hash, dotted notation, preset merge) so timing
@@ -72,8 +60,8 @@ module Aspera
         kept = {}
         new_options.each do |k, v|
           method = "#{k}=".to_sym
-          if RestParameters.instance.respond_to?(method)
-            RestParameters.instance.send(method, v)
+          if Rest::Parameters.instance.respond_to?(method)
+            Rest::Parameters.instance.send(method, v)
           elsif k.to_s.eql?('ssl_options')
             Aspera::SSL.option_list = v
           elsif OAuth::Factory.instance.parameters.key?(k.to_sym)
@@ -90,10 +78,6 @@ module Aspera
       # Proxy
       # ------------------------------------------------------------------
 
-      def http_proxy
-        ENV['http_proxy']
-      end
-
       def http_proxy=(value)
         URI.parse(value)
         ENV['http_proxy'] = value
@@ -103,11 +87,12 @@ module Aspera
       # Per-URL certificate ignore list
       # ------------------------------------------------------------------
 
+      # @param url_list [Array<String>, nil] URLs for which certificate is not validated
       def ignore_cert_host_port=(url_list)
-        url_list.each do |url|
+        @ignore_cert_host_port = (url_list || []).map do |url|
           uri = URI.parse(url)
           Aspera.assert(uri.scheme.eql?('https')) { "Expecting https scheme: #{url}" }
-          @ignore_cert_host_port.push([uri.host, uri.port].freeze)
+          [uri.host, uri.port].freeze
         end
       end
 
@@ -134,13 +119,16 @@ module Aspera
       # Add files, folders or the default OS locations to the cert store.
       # @param path_list [Array<String>] list of file/folder paths to add to the certificate store
       # @return [nil]
+      # Replace the certificate store with the given locations
+      # @param path_list [Array<String>] files or folders, or `DEF` for system default; empty: system default
       def trusted_cert_locations=(path_list)
         Aspera.assert_type(path_list, Array) { 'cert locations' }
-        if @certificate_store.nil?
-          Log.log.debug('Creating SSL Cert store')
-          @certificate_store = OpenSSL::X509::Store.new
-          @certificate_paths = []
-        end
+        # Empty: lazily initialized with system default
+        @certificate_store = @certificate_paths = nil
+        return if path_list.empty?
+        Log.log.debug('Creating SSL Cert store')
+        @certificate_store = OpenSSL::X509::Store.new
+        @certificate_paths = []
         path_list.each do |path|
           Aspera.assert_type(path, String) { 'Expecting a String for certificate location' }
           paths_to_add = [path]
@@ -148,7 +136,7 @@ module Aspera
           if path.eql?(SpecialValues::DEF)
             @certificate_store.set_default_paths
             paths_to_add = [OpenSSL::X509::DEFAULT_CERT_DIR]
-            paths_to_add.push(OpenSSL::X509::DEFAULT_CERT_FILE) unless defined?(JRUBY_VERSION)
+            paths_to_add.push(ENV.fetch(OpenSSL::X509::DEFAULT_CERT_FILE_ENV, OpenSSL::X509::DEFAULT_CERT_FILE)) unless defined?(JRUBY_VERSION)
             paths_to_add.select! { |f| File.exist?(f) }
           elsif File.file?(path)
             @certificate_store.add_file(path)

data/lib/aspera/cli/info.rb

@@ -17,6 +17,9 @@ module Aspera
       RUBY_FUTURE_MINIMUM_VERSION = '3.2'
       # Version with which this version of CLI was tested
       SDK_VERSION = '1.1.9'
+      # RubyInstaller version packaged in the Windows installer zip (release tag without `RubyInstaller-` prefix)
+      # https://github.com/oneclick/rubyinstaller2/releases
+      WINDOWS_RUBY_INSTALLER_VERSION = '4.0.7-1'
     end
   end
 end