aspera-cli 4.26.1 → 4.27.0

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
 
@@ -34,7 +34,7 @@ module Aspera
       #
       # @yieldreturn [void] Executes the transfer operation
       def execute_with_resume
-        Aspera.assert(block_given?)
+        Aspera.assert(block_given?, 'block required for execute_with_resume')
         # maximum of retry
         remaining_resumes = @iter_max
         sleep_seconds = @sleep_initial
@@ -53,7 +53,7 @@ module Aspera
             # 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

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.
@@ -706,7 +707,17 @@ properties:
       - transferd
     x-cli-option: -i
   symlink_policy:
-    description: Handle source side symbolic links.
+    description: >-
+      Handle source side symbolic links.
+      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:
       - follow
@@ -719,15 +730,13 @@ properties:
     description: >-
       Metadata for transfer as JSON.
       Key `aspera` is reserved.
-      Key `aspera.xfer_retry` specifies a retry timeout for node API initiated transfers.
+      Key `aspera.xfer_retry` specifies a "retry timeout" but is not actually used for node API initiated transfers.
     type: object
     x-cli-option: --tags64
     x-cli-convert: json64
   tags64:
     description: >-
-      Metadata for transfer as JSON.
-      Key `aspera` is reserved.
-      Key `aspera.xfer_retry` specifies a retry timeout for node API initiated transfers.
+      Base64 string for `tags`.
     type: string
     x-agents:
       - direct
@@ -745,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
@@ -753,11 +770,12 @@ properties:
       - connect
       - transferd
   token:
-    description: "Authorization token. Type: Bearer, Basic or ATM. (Also arg -W)"
+    $comment: Also arg -W
+    description: Authorization token. Type is Bearer, Basic or ATM.
     type: string
     x-cli-envvar: ASPERA_SCP_TOKEN
   use_ascp4:
-    description: Specify version of protocol. Do not use `ascp4`.
+    description: Specify version of protocol. `ascp4` will be deprecated.
     type: boolean
     default: false
     x-agents:
@@ -881,7 +899,7 @@ properties:
   xfer_max_retries:
     description: >-
       Maximum number of retries, for node API initiated transfers.
-      Shall not exceed `aspera.conf` parameter `transfer_manager_max_retries` (default 5).
+      Shall not exceed `aspera.conf` parameter `transfer_manager_max_retries` (default 3).
     type: integer
     x-agents:
       - node

data/lib/aspera/transfer/uri.rb

@@ -13,7 +13,7 @@ module Aspera
       SCHEME = 'faspe'
       def initialize(fasp_link)
         @fasp_uri = URI.parse(fasp_link.gsub(' ', '%20'))
-        Aspera.assert(@fasp_uri.scheme == SCHEME, "Invalid scheme: #{@fasp_uri.scheme}")
+        Aspera.assert_values(@fasp_uri.scheme, [SCHEME]){"Invalid scheme: #{@fasp_uri.scheme}"}
       end
 
       # Generate transfer spec from provided faspe: URL

data/lib/aspera/uri_reader.rb

@@ -45,14 +45,14 @@ module Aspera
           end
         when SCHEME_FILE, 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}]"}
         end
       end
 
-      # @return Path to file with content at URL
+      # @return [String] path to file with content at URL
       def read_as_file(url)
         if url.start_with?(SCHEME_FILE_PFX1)
           # for file scheme, return directly the path

data/lib/aspera/web_auth.rb

@@ -6,8 +6,8 @@ require 'aspera/assert'
 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)

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
@@ -42,7 +40,7 @@ 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)}
       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,7 +93,7 @@ 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

data/lib/aspera/yaml.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'aspera/assert'
 require 'yaml'
 
 module Aspera
@@ -42,7 +43,7 @@ module Aspera
     # @raise [RuntimeError] If duplicate keys are found
     def safe_load(yaml)
       duplicate_keys = find_duplicate_keys(Psych.parse_stream(yaml))
-      raise "Duplicate keys: #{duplicate_keys.join('; ')}" unless duplicate_keys.empty?
+      Aspera.assert(duplicate_keys.empty?){"Duplicate keys: #{duplicate_keys.join('; ')}"}
       YAML.safe_load(yaml, permitted_classes: [Time, Date, Symbol])
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.26.1
+  version: 4.27.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -11,8 +11,8 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIEzDCCAzSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBeMR4wHAYDVQQDDBVsYXVy
   ZW50Lm1hcnRpbi5hc3BlcmExEjAQBgoJkiaJk/IsZAEZFgJmcjETMBEGCgmSJomT
-  8ixkARkWA2libTETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0yMzA2MjcwODUwMDRa
-  Fw0yNjA3MDEwODUwMDRaMF4xHjAcBgNVBAMMFWxhdXJlbnQubWFydGluLmFzcGVy
+  8ixkARkWA2libTETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0yNjA3MTcxMjE0MzNa
+  Fw0yODA3MTYxMjE0MzNaMF4xHjAcBgNVBAMMFWxhdXJlbnQubWFydGluLmFzcGVy
   YTESMBAGCgmSJomT8ixkARkWAmZyMRMwEQYKCZImiZPyLGQBGRYDaWJtMRMwEQYK
   CZImiZPyLGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA
   1E7e2PvDM1xOXrAQKYzkFG2uZcPC+uAdcq2zqUdfLv2iwAXhGQ/P5f/6uDt/cL5b
@@ -26,15 +26,15 @@ cert_chain:
   AgMBAAGjgZQwgZEwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFPZD
   HBRnWTjzjeZq3Sx/yv7hhY9rMCsGA1UdEQQkMCKBIGxhdXJlbnQubWFydGluLmFz
   cGVyYUBmci5pYm0uY29tMCsGA1UdEgQkMCKBIGxhdXJlbnQubWFydGluLmFzcGVy
-  YUBmci5pYm0uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQCtbncBw6IjRWDjiaeH6gmQ
-  GrfPX53oAJOMnyjhhgKfLd/PPJIckCxz/Tscsuq9+ZUDTubz2E3ltycdxrz0OOul
-  M8cWfkJ4cvdGAGTtqhmv3GGWZwFN8V8WYmmXrgej4o33vx6o8B6uwBn38hvkkAlB
-  ixQDORrk0ck1GVUYYo2UmDOlqArf6paaqd7rziY0dntYl0DfFWe7eJYA467FKjM6
-  /V3L2mTuHg4nCqC2febbAG+W+n158UrEkIKoOpAvQsykuuRtMaTpSTnYd0kLtQIF
-  qNyjadnjZB8iMIedYmEOKApKUJS/9BN1iXHxVbL03AS4o5xMQO3PPjXcwwaybE8G
-  sqAiwQUoawi1m3fZ8u3Xx+GmWE7tE9oxnPA48Y44EkiiWozq263f4S2Xa449ODoh
-  eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
-  Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
+  YUBmci5pYm0uY29tMA0GCSqGSIb3DQEBCwUAA4IBgQDIMFaig1C/3xA+ccAZD89x
+  CF16MUxdTWkmDh1uWrC87tJzdSDwRUnvXvqnGCGU7L0slEfYfP2Aa2n/+3C70Eks
+  rE/SbOWEw1jvAGCZkzQehbg33rEGWymAzFzcBdwoF7AQTyux6ylhcfd0XCO+LQHW
+  CimlmOrKfR72Hahk7rt0fc72XY1M9q4IAc7PE/ldaiHKKzX5RbelvM8nMS8oV6tT
+  dIOyDDZFhBRhOmeAh6Rix57FA65pw7rxxxlMqtNYmM60s8Yzdb6YNW2p+Kk9IWgz
+  PCv9trmuKaozXi9HAQ7285yPMjeccIX28FWZzALu/OZt/98+E+l15rb2qq6AhYvn
+  FOfe1hzTtPWN7gAcyb+9pVICat2KG0WNzmM9wvLMc1IuPgaMGfeMg2moeELGAwqS
+  Mar5Df73cC83QnpW3RalwgGSb5ch8Cz8L9j/DaLIy/RoZ0lpNqGOvm8DUDQ/XoqM
+  IWpYzVavdZxwcrakRXil3x0kelFqCzC57twcNj0b0QI=
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -319,6 +319,8 @@ files:
 - README.md
 - bin/ascli
 - bin/asession
+- docs/README.md
+- docs/test-mcp-with-ai.md
 - lib/aspera/agent/base.rb
 - lib/aspera/agent/connect.rb
 - lib/aspera/agent/desktop.rb
@@ -334,18 +336,29 @@ files:
 - lib/aspera/api/faspex.rb
 - lib/aspera/api/httpgw.rb
 - lib/aspera/api/node.rb
+- lib/aspera/api/queries/bss_subscription_account.graphql
+- lib/aspera/api/queries/bss_subscription_usage.graphql
 - lib/aspera/ascmd.rb
 - lib/aspera/ascp/installation.rb
 - lib/aspera/ascp/management.rb
 - lib/aspera/assert.rb
+- lib/aspera/cli/ascp_actions.rb
+- lib/aspera/cli/async_transfer_store.rb
+- lib/aspera/cli/bootstrapper.rb
+- lib/aspera/cli/command_registry.rb
+- lib/aspera/cli/command_spec.rb
+- lib/aspera/cli/context.rb
 - lib/aspera/cli/error.rb
 - lib/aspera/cli/extended_value.rb
 - lib/aspera/cli/formatter.rb
+- lib/aspera/cli/gem_checker.rb
 - lib/aspera/cli/hints.rb
+- lib/aspera/cli/http.rb
 - lib/aspera/cli/info.rb
-- lib/aspera/cli/main.rb
-- lib/aspera/cli/manager.rb
+- lib/aspera/cli/mailer.rb
+- lib/aspera/cli/mcp_tool.rb
 - lib/aspera/cli/options.schema.yaml
+- lib/aspera/cli/parser.rb
 - lib/aspera/cli/plugins/alee.rb
 - lib/aspera/cli/plugins/aoc.rb
 - lib/aspera/cli/plugins/ats.rb
@@ -359,16 +372,25 @@ files:
 - lib/aspera/cli/plugins/faspex5.rb
 - lib/aspera/cli/plugins/faspio.rb
 - lib/aspera/cli/plugins/httpgw.rb
+- lib/aspera/cli/plugins/mcp.rb
 - lib/aspera/cli/plugins/node.rb
 - lib/aspera/cli/plugins/oauth.rb
 - lib/aspera/cli/plugins/orchestrator.rb
 - lib/aspera/cli/plugins/preview.rb
 - lib/aspera/cli/plugins/server.rb
 - lib/aspera/cli/plugins/shares.rb
+- lib/aspera/cli/preset_actions.rb
+- lib/aspera/cli/preset_manager.rb
+- lib/aspera/cli/result.rb
+- lib/aspera/cli/runner.rb
+- lib/aspera/cli/secret_finder.rb
 - lib/aspera/cli/special_values.rb
 - lib/aspera/cli/sync_actions.rb
+- lib/aspera/cli/terminal_formatter.rb
+- lib/aspera/cli/transfer_actions.rb
 - lib/aspera/cli/transfer_agent.rb
 - lib/aspera/cli/transfer_progress.rb
+- lib/aspera/cli/vault_manager.rb
 - lib/aspera/cli/version.rb
 - lib/aspera/cli/wizard.rb
 - lib/aspera/colors.rb
@@ -384,24 +406,29 @@ files:
 - lib/aspera/data_repository.rb
 - lib/aspera/dot_container.rb
 - lib/aspera/environment.rb
+- lib/aspera/exec_spec.rb
 - lib/aspera/faspex_gw.rb
 - lib/aspera/faspex_postproc.rb
 - lib/aspera/formatter_interface.rb
+- lib/aspera/graphql.rb
 - lib/aspera/hash_ext.rb
 - lib/aspera/id_generator.rb
-- lib/aspera/json_rpc.rb
+- lib/aspera/json_rpc/client.rb
+- lib/aspera/json_rpc/version.rb
 - lib/aspera/keychain/base.rb
 - lib/aspera/keychain/encrypted_hash.rb
 - lib/aspera/keychain/factory.rb
 - lib/aspera/keychain/hashicorp_vault.rb
 - lib/aspera/keychain/macos_security.rb
 - lib/aspera/line_logger.rb
+- lib/aspera/link_header.rb
 - lib/aspera/log.rb
 - lib/aspera/markdown.rb
 - lib/aspera/nagios.rb
 - lib/aspera/node_simulator.rb
 - lib/aspera/oauth.rb
 - lib/aspera/oauth/base.rb
+- lib/aspera/oauth/boot.rb
 - lib/aspera/oauth/factory.rb
 - lib/aspera/oauth/generic.rb
 - lib/aspera/oauth/jwt.rb
@@ -429,6 +456,7 @@ files:
 - lib/aspera/rest_list.rb
 - lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml
 - lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml
+- lib/aspera/schema/async_tables.yaml
 - lib/aspera/schema/documentation.rb
 - lib/aspera/schema/reader.rb
 - lib/aspera/schema/registry.rb
@@ -444,6 +472,7 @@ files:
 - lib/aspera/transfer/error.rb
 - lib/aspera/transfer/faux_file.rb
 - lib/aspera/transfer/parameters.rb
+- lib/aspera/transfer/result.rb
 - lib/aspera/transfer/resumer.rb
 - lib/aspera/transfer/spec.rb
 - lib/aspera/transfer/spec.schema.yaml
@@ -479,7 +508,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Read the manual for any requirement
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: 'Execute actions using command line on IBM Aspera Server products: Aspera
   on Cloud, Faspex, Shares, Node, Console, Orchestrator, High Speed Transfer Server'