aspera-cli 4.22.0 → 4.23.0

data/lib/aspera/transfer/sync.rb

@@ -17,8 +17,10 @@ module Aspera
   module Transfer
     # builds command line arg for async and execute it
     module Sync
-      # sync direction, default is push
+      # sync direction
       DIRECTIONS = %i[push pull bidi].freeze
+      # default direction for sync
+      DEFAULT_DIRECTION = :push
       # JSON for async instance command line options
       INSTANCE_SCHEMA = CommandLineBuilder.read_schema(__FILE__, 'instance')
       SESSION_SCHEMA = CommandLineBuilder.read_schema(__FILE__, 'session')
@@ -26,6 +28,7 @@ module Aspera
       CMDLINE_PARAMS_KEYS = %w[instance sessions].freeze
 
       # Translation of transfer spec parameters to async v2 API (asyncs)
+      # TODO: complete this list with all transfer spec parameters or include in async json schema with x- parameters
       TSPEC_TO_ASYNC_CONF = {
         'remote_host'     => 'remote.host',
         'remote_user'     => 'remote.user',
@@ -87,6 +90,13 @@ module Aspera
           return certificates_to_use
         end
 
+        # Get symbol of sync direction, defaulting to :push
+        # @param params [Hash] sync parameters, old or new format
+        # @return [Symbol] direction symbol, one of :push, :pull, :bidi
+        def direction_sym(params)
+          (params['direction'] || DEFAULT_DIRECTION).to_sym
+        end
+
         # @param sync_params [Hash] sync parameters, old or new format
         # @param &block [nil, Proc] block to generate transfer spec, takes: direction (one of DIRECTIONS), local_dir, remote_dir
         def start(sync_params)
@@ -105,7 +115,7 @@ module Aspera
             Aspera.assert_type(remote['path'], String){'remote path'}
             # get transfer spec if possible, and feed back to new structure
             if block_given?
-              transfer_spec = yield((sync_params['direction'] || 'push').to_sym, sync_params['local']['path'], remote['path'])
+              transfer_spec = yield(direction_sym(sync_params), sync_params['local']['path'], remote['path'])
               # translate transfer spec to async parameters
               TSPEC_TO_ASYNC_CONF.each do |ts_param, sy_path|
                 next unless transfer_spec.key?(ts_param)
@@ -139,7 +149,7 @@ module Aspera
               sync_params['sessions'].each do |session|
                 Aspera.assert_type(session['local_dir'], String){'local_dir'}
                 Aspera.assert_type(session['remote_dir'], String){'remote_dir'}
-                transfer_spec = yield((session['direction'] || 'push').to_sym, session['local_dir'], session['remote_dir'])
+                transfer_spec = yield(direction_sym(session), session['local_dir'], session['remote_dir'])
                 SESSION_SCHEMA['properties'].each do |name, properties|
                   if properties.key?('x-tspec')
                     tspec_param = properties['x-tspec'].is_a?(TrueClass) ? name : properties['x-tspec'].to_s
@@ -158,7 +168,7 @@ module Aspera
             end
             sync_params['sessions'].each do |session_params|
               Aspera.assert_type(session_params, Hash)
-              Aspera.assert(session_params.key?('name')){'session must contain at least name'}
+              Aspera.assert(session_params.key?('name')){'session must contain at least: name'}
               session_builder = CommandLineBuilder.new(session_params, SESSION_SCHEMA, Convert)
               session_builder.process_params
               session_builder.add_env_args(env_args)

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

@@ -1,4 +1,11 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: https://github.com/IBM/aspera-cli/tree/main/lib/aspera/transfer/sync_instance.schema.yaml
+$comment: >-
+  `x-` fields documented in command_line_builder.rb
+  This spec is specific to ascli.
+  The native async conf format is now preferred.
 title: SyncInstanceSpec
+description: Global parameters for async.
 type: object
 properties:
   alt_logdir:

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

@@ -1,4 +1,11 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: https://github.com/IBM/aspera-cli/tree/main/lib/aspera/transfer/sync_instance.schema.yaml
+$comment: >-
+  `x-` fields documented in command_line_builder.rb
+  This spec is specific to ascli.
+  The native async conf format is now preferred.
 title: SyncSessionSpec
+description: Sync session parameters for async.
 type: object
 properties:
   name:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.23.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-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blankslate
@@ -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
@@ -383,6 +380,7 @@ files:
 - lib/aspera/ssh.rb
 - lib/aspera/temp_file_manager.rb
 - lib/aspera/timer_limiter.rb
+- lib/aspera/transfer/async_conf.schema.yaml
 - lib/aspera/transfer/convert.rb
 - lib/aspera/transfer/error.rb
 - lib/aspera/transfer/error_info.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';
-}