aspera-cli 4.26.0 → 4.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dcaa66a7401bb325ae68b4f51ef44e7820332159203a7a5247fc3c2d447d9e5
-  data.tar.gz: cf0a6734797c0803d77daa01b547daccf4dc4af0c17ff7872d186ad3fbffe62f
+  metadata.gz: bffa626f5f4970bf91f90b15e594315d3c81a1ed92c8eff2f9533f7faef71aab
+  data.tar.gz: 552c9b1d9225d3c1360f83d920bface08022314c7227bf36e7af439310e51c75
 SHA512:
-  metadata.gz: e3c8fb9d31eca016b0c88ef324aa307e73535b34672cd2f42d54c4695b7d12fa8d18e98cdbff7115a65856d161ba5869fb3e3e83eef97293411189d7c8f5a454
-  data.tar.gz: bfee651a574ceaa6c6e10ea54b51d50e3d58cf33e0e89b909ad71bff7969dcb01c45707b3ae2cc4bccd553bb69c42ab0f288a043943df01fd9ca9379d6650872
+  metadata.gz: 2b655e7eaeee027e393fc7136c3f3b1a8d679a0825fb7d92baa6fa854d5cd68b11c01ecbeb9c32c457044f6eef3ae2bdbf22afa324b3d79643ec169aaad8f632
+  data.tar.gz: eeb29fc5c14cbe809e31ee229b79cd650632987d93af8a892001e49aea06aa68ace8f7f660345dc27edf0a1ad6350a85e285ba449d8cc39774f9f4c1d4832a8a

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 <!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
 
+## 4.26.1
+
+Released: 2026-06-11
+
+### New Features
+
+* `aoc`: Added new command `admin workspace shared_folder <workspace ID> node <shared folder ID>` to provide direct access to node operations from shared folders.
+* **global**: Schema for Extended Value for option or command argument can now be retrieved using the special value `help` (e.g., `--ts=help` or `package send help`). Those are generated from JSON schema descriptions.
+* **doc**: Some tables in documentation are now generated from JSON schema descriptions.
+
+### Issues Fixed
+
+* **global**: Resolved issue where supported enumerated values were not properly listed when no value was provided (e.g., for command parameters).
+
 ## 4.26.0
 
 Released: 2026-05-28
@@ -17,7 +31,7 @@ Released: 2026-05-28
 * `aoc`: Support selection of workspace using percent selectors: `%name:` and `%id:`.
 * **global**: Added download URLs for `transferd` 1.1.8.
 * **global**: New Extended Value modifier: `s` converts to `String`.
-* **global**: Parameter `str_lst_sep` or option `table_style` allows setting separator for list of strings.
+* **global**: Parameter `str_lst_sep` of option `table_style` allows setting separator for list of strings.
 
 ### Issues Fixed
 
@@ -57,7 +71,7 @@ Released: 2026-03-04
 
 ### New Features
 
-* **general**: If `@:` is used, then marker `END` optionally marks the end of collected arguments.
+* **global**: If `@:` is used, then marker `END` optionally marks the end of collected arguments.
 * `format`: `display` defaults to `info` only if `format` is set to `table`, else defaults to `data`.
 * `node`: Parameter `accept_v4` of option `node_api` (boolean, defaults to `true`) allows using gen4 browsing with `Accept-Version: 4.0` for best performance when there are thousands of files.
 
@@ -440,7 +454,7 @@ Released: 2024-07-13
 
 ### Breaking Changes
 
-* `config`: Command `remote_certificate` now takes a sub-command.
+* `config`: Command `remote_certificate` now takes a command.
 * **global**: Moved a few internal classes in new/renamed modules.
 * **global**: Deprecated pseudo transfer specification parameters starting with `EX_`:
   * `EX_ssh_key_paths`: Use spec `ssh_private_key` or option `transfer_info={"ascp_args":["-i","..."]}`

data/lib/aspera/api/aoc.rb

@@ -362,6 +362,7 @@ module Aspera
         end
       end
 
+      # @param expected [Array<String>] Link types
       def assert_public_link_types(expected)
         Aspera.assert_values(public_link['purpose'], expected){'public link type'}
       end
@@ -557,7 +558,7 @@ module Aspera
               full_recipient_info = lookup_with_q(entity_type, value: short_recipient_info, query: {'workspace_id' => ws_id})
             rescue EntityNotFound
               # dropboxes cannot be created on the fly
-              Aspera.assert_values(entity_type, 'contacts', type: Error){"No such shared inbox in workspace #{ws_id}"}
+              Aspera.assert_values(entity_type, %w[contacts], type: Error){"No such shared inbox in workspace #{ws_id}"}
               # unknown user: create it as external user
               full_recipient_info = create('contacts', {
                 'current_workspace_id' => ws_id,

data/lib/aspera/api/node.rb

@@ -165,7 +165,7 @@ module Aspera
           items = scope.split(Scope::SEPARATOR, 2)
           Aspera.assert(items.length.eql?(2)){"invalid scope: #{scope}"}
           Aspera.assert(items[0].start_with?(Scope::NODE_PREFIX)){"invalid scope: #{scope}"}
-          return {access_key: items[0][Scope::NODE_PREFIX.length..-1], scope: items[1]}
+          return {access_key: items[0].delete_prefix(Scope::NODE_PREFIX), scope: items[1]}
         end
 
         # Create an Aspera Node bearer token
@@ -540,7 +540,7 @@ module Aspera
         else
           transfer_spec.merge!(transport_params)
         end
-        Aspera.assert_values(transfer_spec['remote_user'], Transfer::Spec::ACCESS_KEY_TRANSFER_USER, type: :warn){'transfer user'}
+        Aspera.assert_values(transfer_spec['remote_user'], [Transfer::Spec::ACCESS_KEY_TRANSFER_USER], type: :warn){'transfer user'}
         return transfer_spec
       end
 

data/lib/aspera/ascp/installation.rb

@@ -60,7 +60,7 @@ module Aspera
         Aspera.assert(!ascp_location.empty?){'ascp location cannot be empty: check your config file'}
         folder =
           if ascp_location.start_with?(USE_PRODUCT_PREFIX)
-            product_name = ascp_location[USE_PRODUCT_PREFIX.length..-1]
+            product_name = ascp_location.delete_prefix(USE_PRODUCT_PREFIX)
             if product_name.eql?(FIRST_FOUND)
               pl = installed_products.first
               raise "No Aspera transfer module or SDK found.\nRefer to the manual or install SDK with command:\nascli conf transferd install" if pl.nil?
@@ -113,7 +113,7 @@ module Aspera
           file = File.join(File.dirname(file), Environment.instance.exe_file(k.to_s)) unless k.eql?(:transferd)
         when :ssh_private_dsa, :ssh_private_rsa
           # assume last 3 letters are type
-          type = k.to_s[-3..-1].to_sym
+          type = k.to_s[-3..].to_sym
           file = check_or_create_sdk_file("aspera_bypass_#{type}.pem"){DataRepository.instance.item(type)}
         when :aspera_license
           file = check_or_create_sdk_file('aspera-license'){DataRepository.instance.item(:license)}
@@ -243,7 +243,9 @@ module Aspera
       end
 
       # @param sdk_archive_path [String] path to SDK archive
-      # @param &block called with: file path, data stream, link target if link?
+      # @yieldparam entry_name [String] File path in archive
+      # @yieldparam entry_stream [IO, Gem::Package::TarReader::Entry] Data stream
+      # @yieldparam link_target [String, nil] Link target if symlink, nil otherwise
       def extract_archive_files(sdk_archive_path)
         Aspera.assert(block_given?){'missing block'}
         case sdk_archive_path
@@ -281,7 +283,8 @@ module Aspera
       # @param url     [nil, String] URL to SDK archive, if nil: default url for version
       # @param version [nil, String] Specific version, if nil: latest version
       # @param backup  [Boolean]     If destination folder exists, then rename
-      # @param &block  [nil, Proc]   A lambda that receives a file path from archive and tells destination sub folder(end with /) or file, or nil to not extract
+      # @yieldparam entry_name [String] File path from archive
+      # @yieldreturn [String, nil] Destination sub folder (end with /) or file, or nil to not extract
       # @return [Array] name, ascp version (from execution), folder
       def install_sdk(folder:, url: nil, version: nil, backup: true)
         url ||= sdk_url_for_platform(version: version)

data/lib/aspera/assert.rb

@@ -20,21 +20,24 @@ module Aspera
   class << self
     # Replaces `raise` in assertion
     # Allows sending exception, or just error log, when type is `:error`
-    # @param type [Exception,Symbol] Send to log if symbol, else raise exception
+    # @param type [Exception, Symbol] Send to log if symbol, else raise exception
     # @param message [String] Message for error.
+    # @raise [Exception]
+    # @return [nil]
     def report_error(type, message)
       if type.is_a?(Symbol)
         Log.log.send(type, message)
       else
         raise type, message
       end
+      nil
     end
 
     # Assert that a condition is true, else raise exception
     # @param assertion [TrueClass, FalseClass]       Must be true
-    # @param info      [String,nil] Fixed message in case assert fails, else use `block`
+    # @param info      [String,nil] Fixed message in case assert fails, else use block
     # @param type      [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block     [Proc]       Produces a string that describes the problem for complex messages
+    # @yieldreturn [String] A string that describes the problem for complex messages
     # The block is executed in the context of the Aspera module
     def assert(assertion, info = nil, type: AssertError)
       raise InternalError, 'bad assert: both info and block given' unless info.nil? || !block_given?
@@ -50,18 +53,18 @@ module Aspera
     # @param value   [Object]           The value to check
     # @param classes [Class, Array]     The expected type(s)
     # @param type    [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block   [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_type(value, *classes, type: AssertError)
-      assert(classes.any?{ |k| value.is_a?(k)}, type: type){"#{"#{yield}: " if block_given?}expecting #{classes.join(', ')}, but have (#{value.class})#{value.inspect}"}
+      assert(classes.any?{ |k| value.is_a?(k)}, type: type){"#{"#{yield}: " if block_given?}expecting type #{classes.join(', ')}, but have (#{value.class})#{value.inspect}"}
     end
 
     # Assert that all value of array are of the same specified type.
     # @param array   [Array]            The array to check
     # @param klass   [Class]            The expected type of elements
     # @param type    [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block   [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_array_all(array, klass, type: AssertError)
-      assert_type(array, Array, type: type)
+      assert_type(array, Array, type: AssertError){'array'}
       assert(array.all?(klass), type: type){"#{"#{yield}: " if block_given?}expecting all as #{klass}, but have #{array.map(&:class).uniq}"}
     end
 
@@ -70,19 +73,20 @@ module Aspera
     # @param key_class   [Class]            The expected type of keys (or nil)
     # @param value_class [Class]            The expected type of values (or nil)
     # @param type        [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block       [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_hash_all(hash, key_class, value_class, type: AssertError)
-      assert_type(hash, Hash, type: type)
-      assert_array_all(hash.keys, key_class, type: AssertError){"#{"#{yield}: " if block_given?}keys"} unless key_class.nil?
-      assert_array_all(hash.values, value_class, type: AssertError){"#{"#{yield}: " if block_given?}values"} unless value_class.nil?
+      assert_type(hash, Hash, type: AssertError){'hash'}
+      assert_array_all(hash.keys, key_class, type: type){"#{"#{yield}: " if block_given?}keys"} unless key_class.nil?
+      assert_array_all(hash.values, value_class, type: type){"#{"#{yield}: " if block_given?}values"} unless value_class.nil?
     end
 
     # Assert that value is one of the given values
     # @param value  [Object]           Value to check
     # @param values [Array]            Accepted values
     # @param type   [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param block  [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def assert_values(value, values, type: AssertError)
+      assert_type(values, Array, type: AssertError){'values'}
       assert(values.include?(value), type: type) do
         val_list = values.inspect
         val_list = "one of #{val_list}" if values.is_a?(Array)
@@ -93,7 +97,7 @@ module Aspera
     # The value is not one of the expected values
     # @param value  [Object]           The wrong value
     # @param type   [Exception,Symbol] Exception to raise, or Symbol for Log.log
-    # @param &block [Proc]             Additional description in front of message
+    # @yieldreturn [String] Additional description to prepend to the error message
     def error_unexpected_value(value, type: InternalError)
       report_error(type, "#{"#{yield}: " if block_given?}unexpected value: #{value.inspect}")
     end

data/lib/aspera/cli/extended_value.rb

@@ -15,6 +15,10 @@ require 'singleton'
 module Aspera
   module Cli
     # Command line extended values
+    #
+    # @!method self.instance
+    #   Returns the singleton instance of ExtendedValue
+    #   @return [ExtendedValue] the singleton instance
     class ExtendedValue
       include Singleton
 
@@ -91,7 +95,7 @@ module Aspera
           uri:    lambda{ |i| UriReader.read(i)},
           json:   lambda{ |i| ExtendedValue.JSON_parse(i)},
           lines:  lambda{ |i| i.split("\n")},
-          list:   lambda{ |i| i[1..-1].split(i[0])},
+          list:   lambda{ |i| i[1..].split(i[0])},
           none:   lambda{ |i| ExtendedValue.assert_no_value(i, :none); nil}, # rubocop:disable Style/Semicolon
           path:   lambda{ |i| File.expand_path(i)},
           re:     lambda{ |i| Regexp.new(i, Regexp::MULTILINE)},
@@ -145,7 +149,7 @@ module Aspera
       # @param value   [String] the value to parse
       # @param context [String] Context in which evaluation is done
       # @param allowed [Array<Class>,NilClass] Expected types
-      # @return [Object] Evaluated value
+      # @return [String, Integer, Array, Hash, Boolean] Evaluated value
       def evaluate(value, context:, allowed: nil)
         return value unless value.is_a?(String)
         Aspera.assert_array_all(allowed, Class) unless allowed.nil?

data/lib/aspera/cli/formatter.rb

@@ -9,6 +9,7 @@ require 'aspera/log'
 require 'aspera/assert'
 require 'aspera/markdown'
 require 'aspera/dot_container'
+require 'aspera/formatter_interface'
 require 'terminal-table'
 require 'tty-spinner'
 require 'yaml'
@@ -18,6 +19,60 @@ require 'word_wrap'
 
 module Aspera
   module Cli
+    # Terminal formatter with ANSI colors and Unicode support
+    # @see FormatterInterface
+    # @see MarkdownFormatter (in build/lib/doc_helper.rb)
+    module TerminalFormatter
+      include FormatterInterface
+
+      # Format boolean with colored symbol (✓/✗ or Y/ )
+      def tick(yes)
+        result =
+          if Environment.terminal_supports_unicode?
+            yes ? "\u2713" : "\u2717"
+          else
+            yes ? 'Y' : ' '
+          end
+        return result.green if yes
+        return result.red
+      end
+
+      # Format special values with colors (dim for empty, reverse for others)
+      def special_format(what)
+        result = "<#{what}>"
+        return %w[null empty].any?{ |s| what.include?(s)} ? result.dim : result.reverse_color
+      end
+
+      # Prepare table row for terminal display (word wrap arrays)
+      def check_row(row)
+        row.each_key do |k|
+          row[k] = row[k].map{ |i| WordWrap.ww(i.to_s, 120).chomp}.join("\n") if row[k].is_a?(Array)
+        end
+      end
+
+      # Convert Markdown to terminal format (**bold** -> blue, `code` -> bold)
+      # @param match [MatchData, String]
+      def markdown_text(match)
+        if match.is_a?(String)
+          match = Markdown::FORMATS.match(match)
+          Aspera.assert(match)
+        end
+        Aspera.assert_type(match, MatchData)
+        if match[:entity]
+          Aspera.assert_values(match[:entity], %w[bsol])
+          '\\'
+        elsif match[:bold]
+          match[:bold].to_s.blue
+        elsif match[:code]
+          match[:code].to_s.bold
+        else
+          Aspera.error_unexpected_value(match.to_s)
+        end
+      end
+
+      module_function :tick, :special_format, :check_row, :markdown_text
+    end
+
     # Take care of CLI output on terminal
     class Formatter
       # remove a fields from the list
@@ -34,56 +89,6 @@ module Aspera
       private_constant :FIELDS_LESS, :DISPLAY_FORMATS, :DISPLAY_LEVELS, :SINGLE_OBJECT_COLUMN_NAMES, :STR_LST_SEP_VERT
 
       class << self
-        # nicer display for boolean
-        # used by `spec_doc`
-        def tick(yes)
-          result =
-            if Environment.terminal_supports_unicode?
-              yes ? "\u2713" : "\u2717"
-            else
-              yes ? 'Y' : ' '
-            end
-          return result.green if yes
-          return result.red
-        end
-
-        # Highlight special values on terminal
-        # empty values are dim
-        # used by `spec_doc`
-        def special_format(what)
-          result = "<#{what}>"
-          return %w[null empty].any?{ |s| what.include?(s)} ? result.dim : result.reverse_color
-        end
-
-        # For transfer spec table, build line for display in terminal
-        # used by `spec_doc`
-        def check_row(row)
-          row.each_key do |k|
-            row[k] = row[k].map{ |i| WordWrap.ww(i.to_s, 120).chomp}.join("\n") if row[k].is_a?(Array)
-          end
-        end
-
-        # Give Markdown String, or matched data, return formatted string for terminal
-        # used by `spec_doc`
-        # @param match [MatchData,String]
-        def markdown_text(match)
-          if match.is_a?(String)
-            match = Markdown::FORMATS.match(match)
-            Aspera.assert(match)
-          end
-          Aspera.assert_type(match, MatchData)
-          if match[:entity]
-            Aspera.assert_values(match[:entity], 'bsol')
-            '\\'
-          elsif match[:bold]
-            match[:bold].to_s.blue
-          elsif match[:code]
-            match[:code].to_s.bold
-          else
-            Aspera.error_unexpected_value(match.to_s)
-          end
-        end
-
         # Replace special values with a readable version on terminal
         def replace_specific_for_terminal(input_hash, string_list_separator)
           hash_to_process = [input_hash]
@@ -92,14 +97,14 @@ module Aspera
             current.each do |key, value|
               case value
               when NilClass
-                current[key] = special_format('null')
+                current[key] = TerminalFormatter.special_format('null')
               when String
-                current[key] = special_format('empty string') if value.empty?
+                current[key] = TerminalFormatter.special_format('empty string') if value.empty?
               when Proc
-                current[key] = special_format('lambda')
+                current[key] = TerminalFormatter.special_format('lambda')
               when Array
                 if value.empty?
-                  current[key] = special_format('empty list')
+                  current[key] = TerminalFormatter.special_format('empty list')
                 elsif value.all?(String)
                   current[key] = value.join(string_list_separator)
                 else
@@ -109,7 +114,7 @@ module Aspera
                 end
               when Hash
                 if value.empty?
-                  current[key] = special_format('empty dict')
+                  current[key] = TerminalFormatter.special_format('empty dict')
                 else
                   hash_to_process.push(value)
                 end
@@ -240,7 +245,7 @@ module Aspera
         !@options[:show_secrets] && !@options[:display].eql?(:data)
       end
 
-      # hides secrets in Hash or Array
+      # Hides secrets in Hash or Array
       def hide_secrets(data)
         SecretHider.instance.deep_remove_secret(data) if hide_secrets?
       end
@@ -316,7 +321,7 @@ module Aspera
             # :single_object is a Hash, where key=column name
             Aspera.assert_type(data, Hash){'result'}
             if data.empty?
-              display_message(:data, self.class.special_format('empty dict'))
+              display_message(:data, TerminalFormatter.special_format('empty dict'))
             else
               data = DotContainer.new(data).to_dotted if @options[:flat_hash]
               display_table([data], compute_fields([data], fields), single: true)
@@ -334,7 +339,7 @@ module Aspera
               Log.log.debug('no result expected')
               return
             end
-            display_message(:info, self.class.special_format(data.to_s))
+            display_message(:info, TerminalFormatter.special_format(data.to_s))
             return
           when :status # no table
             # :status displays a simple message
@@ -379,7 +384,7 @@ module Aspera
           removal = false
           if item[0].eql?(FIELDS_LESS)
             removal = true
-            item = item[1..-1]
+            item = item.delete_prefix(FIELDS_LESS)
           end
           case item
           when SpecialValues::ALL
@@ -439,7 +444,7 @@ module Aspera
         Aspera.assert_array_all(fields, String)
         if object_array.empty?
           # no  display for csv
-          display_message(:info, self.class.special_format('empty')) if @options[:format].eql?(:table)
+          display_message(:info, TerminalFormatter.special_format('empty')) if @options[:format].eql?(:table)
           return
         end
         filter_columns_on_select(object_array)