aspera-cli 4.22.0 → 4.24.0

data/lib/aspera/transfer/spec_doc.rb

@@ -12,51 +12,69 @@ module Aspera
           agent_sym.to_sym.eql?(:direct) ? :a : agent_sym.to_s[0].to_sym
         end
 
-        # @columns formatter [Cli::Formatter] formatter to use, methods: special_format, check_row
-        # @columns &block modify parameter info if needed
-        # @return a table suitable to display in manual
-        def man_table(formatter, cli: true)
+        # @param formatter      [Cli::Formatter] Formatter to use, methods: special_format, check_row
+        # @param include_option [Boolean] true : include CLI options
+        # @return [Array] a table suitable to display in manual
+        def man_table(formatter, include_option: false, agent_columns: true)
           col_local = agent_to_short(:direct)
-          Spec::SCHEMA['properties'].filter_map do |name, properties|
+          cols = agent_columns ? %i[name type] + AGENT_LIST.map(&:last) + %i[description] : %i[name type description]
+          rows = Spec::SCHEMA['properties'].filter_map do |name, properties|
             # manual table
             columns = {
               name:        name,
               type:        properties['type'],
               description: []
             }
-            # replace "back solidus" HTML entity with its text value and split lines
-            columns[:description].concat(properties['description'].gsub('\', '\\').split("\n")) if properties.key?('description')
+            # replace "back solidus" HTML entity with its text value
+            #
+            # split lines
+            columns[:description] =
+              properties['description']
+                .gsub('\', '\\')
+                .gsub(/`([a-z0-9_.+-]+)`/){formatter.keyword_highlight(Regexp.last_match(1))}
+                .split("\n") if properties.key?('description')
             columns[:description].unshift("DEPRECATED: #{properties['x-deprecation']}") if properties.key?('x-deprecation')
             # add flags for supported agents in doc
+            agents = []
             AGENT_LIST.each do |agent_info|
-              columns[agent_info.last] = Cli::Formatter.tick(properties['x-agents'].nil? || properties['x-agents'].include?(agent_info.first.to_s))
+              agents.push(agent_info.last) if properties['x-agents'].nil? || properties['x-agents'].include?(agent_info.first.to_s)
+            end
+            agents.push(col_local) if properties['x-cli-option'] && !agents.include?(col_local)
+            if agent_columns
+              AGENT_LIST.each do |agent_info|
+                columns[agent_info.last] = formatter.tick(agents.include?(agent_info.last))
+              end
+            else
+              columns[:description].push("(#{agents.map(&:upcase).join(', ')})") unless agents.length.eql?(AGENT_LIST.length)
             end
-            columns[col_local] = Cli::Formatter.tick(true) if properties['x-cli-option']
             # only keep lines that are usable in supported agents
-            next false if AGENT_LIST.map(&:last).inject(true){ |memory, agent_short_sym| memory && columns[agent_short_sym].empty?}
-            columns[:description].push("Allowed values: #{properties['enum'].join(', ')}") if properties.key?('enum')
+            next false if agents.empty?
+            columns[:description].push("Allowed values: #{properties['enum'].map{ |v| formatter.keyword_highlight(v)}.join(', ')}") if properties.key?('enum')
+            envvar = ''
             cli_option =
-              if properties['x-cli-switch']
+              if properties.key?('x-cli-envvar')
+                envvar = 'env:'
+                properties['x-cli-envvar']
+              elsif properties['x-cli-switch']
                 properties['x-cli-option']
               elsif properties['x-cli-special']
-                formatter.special_format('special')
+                ''
               elsif properties['x-cli-option']
                 arg_type = properties.key?('enum') ? '{enum}' : "{#{[properties['type']].flatten.join('|')}}"
                 conversion_tag = properties.key?('x-cli-convert') ? '(conversion)' : ''
                 sep = properties['x-cli-option'].start_with?('--') ? '=' : ' '
                 "#{properties['x-cli-option']}#{sep}#{conversion_tag}#{arg_type}"
               end
-            cli_option = 'env:' + properties['x-cli-envvar'] if properties.key?('x-cli-envvar')
-            columns[:description].push("(#{cli_option})") if cli && !cli_option.to_s.empty?
+            columns[:description].push("(#{envvar}#{formatter.keyword_highlight(cli_option)})") if include_option && !cli_option.to_s.empty?
             formatter.check_row(columns)
           end.sort_by{ |i| i[:name]}
+          [cols, rows]
         end
       end
       # Agents shown in manual for parameters (sub list)
       AGENT_LIST = Agent::Base.agent_list.map do |agent_sym|
         [agent_sym, agent_sym.to_s.capitalize, agent_to_short(agent_sym)]
       end.sort_by(&:last).freeze
-      TABLE_COLUMNS = (%i[name type] + AGENT_LIST.map(&:last) + %i[description]).freeze
     end
   end
 end

data/lib/aspera/transfer/uri.rb

@@ -4,7 +4,7 @@
 
 require 'aspera/log'
 require 'aspera/rest'
-require 'aspera/transfer/convert'
+require 'aspera/command_line_converter'
 
 module Aspera
   module Transfer
@@ -39,10 +39,10 @@ module Aspera
           when 'bwcap'       then result_ts['target_rate_cap_kbps'] = value.to_i
           when 'enc'         then result_ts['cipher'] = value.gsub(/^aes/, 'aes-').gsub(/cfb$/, '-cfb').gsub(/gcm$/, '-gcm').gsub('--', '-')
           when 'tags64'      then result_ts['tags'] = JSON.parse(Base64.strict_decode64(value))
-          when 'createpath'  then result_ts['create_dir'] = Convert.yes_to_true(value)
-          when 'fallback'    then result_ts['http_fallback'] = Convert.yes_to_true(value)
-          when 'lockpolicy'  then result_ts['lock_rate_policy'] = Convert.yes_to_true(value)
-          when 'lockminrate' then result_ts['lock_min_rate'] = Convert.yes_to_true(value)
+          when 'createpath'  then result_ts['create_dir'] = CommandLineConverter.yes_to_true(value)
+          when 'fallback'    then result_ts['http_fallback'] = CommandLineConverter.yes_to_true(value)
+          when 'lockpolicy'  then result_ts['lock_rate_policy'] = CommandLineConverter.yes_to_true(value)
+          when 'lockminrate' then result_ts['lock_min_rate'] = CommandLineConverter.yes_to_true(value)
           when 'auth'        then Log.log.debug{"ignoring #{name}=#{value}"} # Not used (yes/no)
           when 'v'           then Log.log.debug{"ignoring #{name}=#{value}"} # rubocop:disable Lint/DuplicateBranch -- Not used (shall be 2)
           when 'protect'     then Log.log.debug{"ignoring #{name}=#{value}"} # rubocop:disable Lint/DuplicateBranch -- TODO: what is this ?

data/lib/aspera/uri_reader.rb

@@ -6,33 +6,37 @@ require 'aspera/rest'
 require 'aspera/temp_file_manager'
 
 module Aspera
-  # read some content from some URI, support file: , http: and https: schemes
+  # Read some content from some URI, support file: , http: and https: schemes
   module UriReader
-    FILE_SCHEME_PREFIX = 'file:///'
-    private_constant :FILE_SCHEME_PREFIX
+    SCHEME_FILE = 'file'
+    SCHEME_FILE_PFX1 = "#{SCHEME_FILE}:"
+    SCHEME_FILE_PFX2 = "#{SCHEME_FILE_PFX1}///"
+    private_constant :SCHEME_FILE, :SCHEME_FILE_PFX1, :SCHEME_FILE_PFX2
     class << self
-      # read some content from some URI, support file: , http: and https: schemes
+      # Read some content from some URI, support file: , http: and https: schemes
       def read(uri_to_read)
         uri = URI.parse(uri_to_read)
         case uri.scheme
         when 'http', 'https'
           return Rest.new(base_url: uri_to_read, redirect_max: 5).call(operation: 'GET', headers: {'Accept' => '*/*'})[:data]
-        when 'file', NilClass
+        when SCHEME_FILE, NilClass
           local_file_path = uri.path
-          raise 'URL shall have a path, check syntax' if local_file_path.nil?
+          raise Error, 'URL shall have a path, check syntax' if local_file_path.nil?
           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 Path to file with content at URL
       def read_as_file(url)
-        if url.start_with?('file:')
+        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
-          raise "use format: #{FILE_SCHEME_PREFIX}<path>" unless url.start_with?(FILE_SCHEME_PREFIX)
-          return File.expand_path(url[FILE_SCHEME_PREFIX.length..-1])
+          raise "use format: #{SCHEME_FILE_PFX2}<path>" unless url.start_with?(SCHEME_FILE_PFX2)
+          return File.expand_path(url[SCHEME_FILE_PFX2.length..-1])
         else
+          # download to temp file
           # autodelete on exit
           sdk_archive_path = 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: sdk_archive_path)

data/lib/aspera/web_auth.rb

@@ -16,7 +16,7 @@ module Aspera
 
     def service(request, response)
       Log.log.debug{"received request from browser #{request.request_method} #{request.path}"}
-      Aspera.assert_values(request.request_method, ['GET'], exception_class: WEBrick::HTTPStatus::MethodNotAllowed){'HTTP verb'}
+      Aspera.assert_values(request.request_method, ['GET'], type: WEBrick::HTTPStatus::MethodNotAllowed){'HTTP verb'}
       additionnal_info = @web_auth.signal_request(request)
       response.status = 200
       response.content_type = 'text/html'
@@ -161,7 +161,7 @@ module Aspera
         </html>
       HTML
 
-      return nil
+      return
     end
   end
 

data/lib/aspera/web_server_simple.rb

@@ -72,7 +72,7 @@ module Aspera
         elsif cert && PKCS12_EXT.include?(File.extname(cert).downcase)
           # PKCS12
           Log.log.debug('Using PKCS12 certificate')
-          raise 'PKCS12 requires a key (password)' if key.nil?
+          raise Error, 'PKCS12 requires a key (password)' if key.nil?
           pkcs12 = OpenSSL::PKCS12.new(File.read(cert), key)
           webrick_options[:SSLCertificate] = pkcs12.certificate
           webrick_options[:SSLPrivateKey] = pkcs12.key
@@ -90,7 +90,7 @@ module Aspera
             OpenSSL::X509::Certificate.new(File.read(cert))
           end
           webrick_options[:SSLExtraChainCert] = read_chain_file(chain) unless chain.nil?
-          raise 'key and cert do not match' unless webrick_options[:SSLCertificate].public_key.to_der == webrick_options[:SSLPrivateKey].public_key.to_der
+          raise Error, 'key and cert do not match' unless webrick_options[:SSLCertificate].public_key.to_der == webrick_options[:SSLPrivateKey].public_key.to_der
         end
       end
       # call constructor of parent class, but capture STDERR

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.24.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -37,7 +37,7 @@ cert_chain:
   eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
   Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
   -----END CERTIFICATE-----
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blankslate
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -157,28 +157,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -278,9 +278,6 @@ files:
 - README.md
 - bin/ascli
 - bin/asession
-- examples/dascli
-- examples/get_proto_file.rb
-- examples/proxy.pac
 - lib/aspera/agent/base.rb
 - lib/aspera/agent/connect.rb
 - lib/aspera/agent/desktop.rb
@@ -328,8 +325,10 @@ files:
 - lib/aspera/cli/transfer_agent.rb
 - lib/aspera/cli/transfer_progress.rb
 - lib/aspera/cli/version.rb
+- lib/aspera/cli/wizard.rb
 - lib/aspera/colors.rb
 - lib/aspera/command_line_builder.rb
+- lib/aspera/command_line_converter.rb
 - lib/aspera/coverage.rb
 - lib/aspera/data/1
 - lib/aspera/data/2
@@ -344,6 +343,7 @@ files:
 - lib/aspera/hash_ext.rb
 - lib/aspera/id_generator.rb
 - lib/aspera/json_rpc.rb
+- lib/aspera/keychain/base.rb
 - lib/aspera/keychain/encrypted_hash.rb
 - lib/aspera/keychain/factory.rb
 - lib/aspera/keychain/hashicorp_vault.rb
@@ -381,9 +381,12 @@ files:
 - lib/aspera/resumer.rb
 - lib/aspera/secret_hider.rb
 - lib/aspera/ssh.rb
+- lib/aspera/sync/args.schema.yaml
+- lib/aspera/sync/conf.schema.yaml
+- lib/aspera/sync/database.rb
+- lib/aspera/sync/operations.rb
 - lib/aspera/temp_file_manager.rb
 - lib/aspera/timer_limiter.rb
-- lib/aspera/transfer/convert.rb
 - lib/aspera/transfer/error.rb
 - lib/aspera/transfer/error_info.rb
 - lib/aspera/transfer/faux_file.rb
@@ -391,9 +394,6 @@ files:
 - lib/aspera/transfer/spec.rb
 - lib/aspera/transfer/spec.schema.yaml
 - lib/aspera/transfer/spec_doc.rb
-- lib/aspera/transfer/sync.rb
-- lib/aspera/transfer/sync_instance.schema.yaml
-- lib/aspera/transfer/sync_session.schema.yaml
 - lib/aspera/transfer/uri.rb
 - lib/aspera/uri_reader.rb
 - lib/aspera/web_auth.rb

data/examples/dascli

@@ -1,30 +0,0 @@
-#!/usr/bin/env bash
-# set env var image to specify another docker image
-: "${image:=docker.io/martinlaurent/ascli}"
-# set env var version to specify another image version (default: latest version)
-: "${version:=latest}"
-# set env var imgtag to specify a specific image/version
-: "${imgtag=$image:$version}"
-# set env var `docker` to podman, to use podman
-: "${docker:=docker}"
-# set env var `docker_args` to add options to docker run (then, transform this var into array) # spellcheck disable=SC2086
-read -a add_dock_args <<< $docker_args
-# set env var ASCLI_HOME to set the config folder on host
-: "${ASCLI_HOME:=$HOME/.aspera/ascli}"
-# main config folder for ascli in container (same value as in `Dockerfile`)
-ascli_home_container=/home/cliuser/.aspera/ascli
-if test ! -d "$ASCLI_HOME";then
-	echo "creating folder: $ASCLI_HOME"
-	# create it if necessary to allow mounting the volume in container
-	mkdir -p "$ASCLI_HOME"
-fi
-exec $docker run \
---rm \
---tty \
---interactive \
---user root \
---env ASCLI_HOME="$ascli_home_container" \
---volume "$ASCLI_HOME:$ascli_home_container:z" \
-"${add_dock_args[@]}" \
-"$imgtag" \
-"$@"

data/examples/get_proto_file.rb

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'aspera/ascp/installation'
-require 'aspera/cli/transfer_progress'
-Aspera::RestParameters.instance.progress_bar = Aspera::Cli::TransferProgress.new
-# Retrieve `transfer.proto` from the web
-Aspera::Ascp::Installation.instance.install_sdk(folder: ARGV.first, backup: false, with_exe: false){ |name| name.end_with?('.proto') ? '/' : nil}

data/examples/proxy.pac

@@ -1,60 +0,0 @@
-/* demo proxy pac for `ascli` */
-function FindProxyForURL(url, host) {
-	/* Normalize the URL for pattern matching */
-	url = url.toLowerCase();
-	host = host.toLowerCase();
-
-	/* Don't proxy local host names */
-	if (isPlainHostName(host)) {
-		return 'DIRECT';
-	}
-
-	/* Don't proxy local domains */
-	if (dnsDomainIs(host, ".example1.com") || (host == "example1.com")
-		|| dnsDomainIs(host, ".example2.com") || (host == "example2.com")
-		|| dnsDomainIs(host, ".example3.com") || (host == "example3.com")) {
-		return 'DIRECT';
-	}
-
-	/* Don't proxy Windows Update */
-	if ((host == "download.microsoft.com")
-		|| (host == "ntservicepack.microsoft.com")
-		|| (host == "cdm.microsoft.com") || (host == "wustat.windows.com")
-		|| (host == "windowsupdate.microsoft.com")
-		|| (dnsDomainIs(host, ".windowsupdate.microsoft.com"))
-		|| (host == "update.microsoft.com")
-		|| (dnsDomainIs(host, ".update.microsoft.com"))
-		|| (dnsDomainIs(host, ".windowsupdate.com"))) {
-		return 'DIRECT';
-	}
-
-	if (isResolvable(host)) {
-		var hostIP = dnsResolve(host);
-
-		/* Don't proxy private addresses (RFC 3330) */
-		if (isInNet(hostIP, '0.0.0.0', '255.0.0.0')
-			|| isInNet(hostIP, '10.0.0.0', '255.0.0.0')
-			|| isInNet(hostIP, '127.0.0.0', '255.0.0.0')
-			|| isInNet(hostIP, '169.254.0.0', '255.255.0.0')
-			|| isInNet(hostIP, '172.16.0.0', '255.240.0.0')
-			|| isInNet(hostIP, '192.0.2.0', '255.255.255.0')
-			|| isInNet(hostIP, '192.88.99.0', '255.255.255.0')
-			|| isInNet(hostIP, '192.168.0.0', '255.255.0.0')
-			|| isInNet(hostIP, '198.18.0.0', '255.254.0.0')
-			|| isInNet(hostIP, '224.0.0.0', '240.0.0.0')
-			|| isInNet(hostIP, '240.0.0.0', '240.0.0.0')) {
-			return 'DIRECT';
-		}
-	}
-
-	if (url.substring(0, 5) == 'http:' || url.substring(0, 6) == 'https:'
-		|| url.substring(0, 4) == 'ftp:') {
-		return 'PROXY proxy.example.com:8080';
-	}
-
-	if (url.substring(0, 4) == 'ssh:') {
-		return 'PROXY proxy.aspera.com:9092';
-	}
-
-	return 'DIRECT';
-}

data/lib/aspera/transfer/convert.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/assert'
-module Aspera
-  module Transfer
-    # concertion class for transfert spec values to CLI values (ascp)
-    class Convert
-      class << self
-        # special encoding methods used in YAML (key: convert)
-        def remove_hyphen(value); value.tr('-', ''); end
-
-        # special encoding methods used in YAML (key: convert)
-        def json64(value); Base64.strict_encode64(JSON.generate(value)); end
-
-        # special encoding methods used in YAML (key: convert)
-        def base64(value); Base64.strict_encode64(value); end
-
-        # transform yes/no to true/false
-        def yes_to_true(value)
-          case value
-          when 'yes' then return true
-          when 'no' then return false
-          else Aspera.error_unexpected_value(value){'only: yes or no: '}
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-title: SyncInstanceSpec
-type: object
-properties:
-  alt_logdir:
-    type: string
-  watchd:
-    type: string
-  apply_local_docroot:
-    x-cli-switch: true
-  quiet:
-    x-cli-switch: true
-  ws_connect:
-    x-cli-switch: true

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

@@ -1,79 +0,0 @@
-title: SyncSessionSpec
-type: object
-properties:
-  name:
-    type: string
-  local_dir:
-    type: string
-  remote_dir:
-    type: string
-  local_db_dir:
-    type: string
-  remote_db_dir:
-    type: string
-  host:
-    type: string
-    x-tspec: remote_host
-  user:
-    type: string
-    x-tspec: remote_user
-  private_key_paths:
-    type: array
-    x-cli-option: "--private-key-path"
-  direction:
-    type: string
-  checksum:
-    type: string
-  tags:
-    type: object
-    x-cli-option: "--tags64"
-    x-cli-convert: json64
-    x-tspec: true
-  tcp_port:
-    type: integer
-    x-tspec: ssh_port
-  rate_policy:
-    type: string
-  target_rate:
-    type: string
-  cooloff:
-    type: integer
-  pending_max:
-    type: integer
-  scan_intensity:
-    type: string
-  cipher:
-    type: string
-    x-cli-convert: remove_hyphen
-    x-tspec: true
-  transfer_threads:
-    type: integer
-  preserve_time:
-    x-cli-switch: true
-    x-tspec: preserve_times
-  preserve_access_time:
-    x-cli-switch: true
-  preserve_modification_time:
-    x-cli-switch: true
-  preserve_uid:
-    x-cli-switch: true
-    x-tspec: preserve_file_owner_uid
-  preserve_gid:
-    x-cli-switch: true
-    x-tspec: preserve_file_owner_gid
-  create_dir:
-    x-cli-switch: true
-    x-tspec: true
-  reset:
-    x-cli-switch: true
-  remote_password:
-    x-cli-envvar: ASPERA_SCP_PASS
-    x-tspec: true
-  cookie:
-    x-cli-envvar: ASPERA_SCP_COOKIE
-    x-tspec: true
-  token:
-    x-cli-envvar: ASPERA_SCP_TOKEN
-    x-tspec: true
-  license:
-    x-cli-envvar: ASPERA_SCP_LICENSE