aspera-cli 4.16.0 → 4.17.0

data/lib/aspera/{fasp → transfer}/sync.rb

@@ -3,7 +3,7 @@
 # cspell:words logdir bidi watchd cooloff asyncadmin
 
 require 'aspera/command_line_builder'
-require 'aspera/fasp/installation'
+require 'aspera/ascp/installation'
 require 'aspera/log'
 require 'aspera/assert'
 require 'json'
@@ -12,7 +12,7 @@ require 'open3'
 require 'English'
 
 module Aspera
-  module Fasp
+  module Transfer
     # builds command line arg for async
     module Sync
       # sync direction, default is push
@@ -40,7 +40,7 @@ module Aspera
           'private_key_paths'          => { cli: { type: :opt_with_arg, switch: '--private-key-path'}, accepted_types: :array},
           'direction'                  => { cli: { type: :opt_with_arg}, accepted_types: :string},
           'checksum'                   => { cli: { type: :opt_with_arg}, accepted_types: :string},
-          'tags'                       => { cli: { type: :opt_with_arg, switch: '--tags64', convert: 'Aspera::Fasp::Parameters.convert_json64'},
+          'tags'                       => { cli: { type: :opt_with_arg, switch: '--tags64', convert: 'Aspera::Transfer::Parameters.convert_json64'},
                                             accepted_types: :hash, ts: true},
           'tcp_port'                   => { cli: { type: :opt_with_arg}, accepted_types: :int, ts: :ssh_port},
           'rate_policy'                => { cli: { type: :opt_with_arg}, accepted_types: :string},
@@ -48,7 +48,7 @@ module Aspera
           'cooloff'                    => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'pending_max'                => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'scan_intensity'             => { cli: { type: :opt_with_arg}, accepted_types: :string},
-          'cipher'                     => { cli: { type: :opt_with_arg, convert: 'Aspera::Fasp::Parameters.convert_remove_hyphen'}, accepted_types: :string, ts: true},
+          'cipher'                     => { cli: { type: :opt_with_arg, convert: 'Aspera::Transfer::Parameters.convert_remove_hyphen'}, accepted_types: :string, ts: true},
           'transfer_threads'           => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'preserve_time'              => { cli: { type: :opt_without_arg}, ts: :preserve_times},
           'preserve_access_time'       => { cli: { type: :opt_without_arg}, ts: nil},
@@ -64,8 +64,8 @@ module Aspera
           'license'                    => { cli: { type: :envvar, variable: 'ASPERA_SCP_LICENSE'}}
         }.freeze
 
-      Aspera::CommandLineBuilder.normalize_description(PARAMS_VX_INSTANCE)
-      Aspera::CommandLineBuilder.normalize_description(PARAMS_VX_SESSION)
+      CommandLineBuilder.normalize_description(PARAMS_VX_INSTANCE)
+      CommandLineBuilder.normalize_description(PARAMS_VX_SESSION)
 
       PARAMS_VX_KEYS = %w[instance sessions].freeze
 
@@ -112,12 +112,12 @@ module Aspera
             remote.delete('port')
             remote.delete('fingerprint')
             # ignore cert for wss ?
-            if false # @options[:check_ignore]&.call(remote['host'], remote['ws_port'])
-              wss_cert_file = TempFileManager.instance.new_file_path_global('wss_cert')
-              wss_url = "https://#{remote['host']}:#{remote['ws_port']}"
-              File.write(wss_cert_file, Rest.remote_certificates(wss_url))
-              certificates_to_use.push(wss_cert_file)
-            end
+            # if @options[:check_ignore_cb]&.call(remote['host'], remote['ws_port'])
+            #   wss_cert_file = TempFileManager.instance.new_file_path_global('wss_cert')
+            #   wss_url = "https://#{remote['host']}:#{remote['ws_port']}"
+            #   File.write(wss_cert_file, Rest.remote_certificate_chain(wss_url))
+            #   certificates_to_use.push(wss_cert_file)
+            # end
             # set location for CA bundle to be the one of Ruby, see env var SSL_CERT_FILE / SSL_CERT_DIR
             # certificates_to_use.concat(@options[:trusted_certs]) if @options[:trusted_certs]
           else
@@ -125,7 +125,7 @@ module Aspera
             remote.delete('ws_port')
             # add SSH bypass keys when authentication is token and no auth is provided
             if remote.key?('token') && !remote.key?('pass')
-              certificates_to_use.concat(Installation.instance.aspera_token_ssh_key_paths)
+              certificates_to_use.concat(Ascp::Installation.instance.aspera_token_ssh_key_paths)
             end
           end
           return certificates_to_use
@@ -134,7 +134,7 @@ module Aspera
         # @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, &block)
-          assert_type(sync_params, Hash)
+          Aspera.assert_type(sync_params, Hash)
           env_args = {
             args: [],
             env:  {}
@@ -142,12 +142,12 @@ module Aspera
           if sync_params.key?('local')
             remote = sync_params['remote']
             # async native JSON format (v2)
-            assert_type(remote, Hash)
+            Aspera.assert_type(remote, Hash)
             # get transfer spec if possible, and feed back to new structure
             if block
               transfer_spec = yield((sync_params['direction'] || 'push').to_sym, sync_params['local']['path'], remote['path'])
               # async native JSON format
-              assert_type(sync_params['local'], Hash)
+              Aspera.assert_type(sync_params['local'], Hash)
               # translate transfer spec to async parameters
               TS_TO_PARAMS_V2.each do |ts_param, sy_path|
                 next unless transfer_spec.key?(ts_param)
@@ -165,7 +165,7 @@ module Aspera
               remote['private_key_paths'] ||= []
               remote['private_key_paths'].concat(add_certificates)
             end
-            assert_type(sync_params, Hash)
+            Aspera.assert_type(sync_params, Hash)
             env_args[:args] = ["--conf64=#{Base64.strict_encode64(JSON.generate(sync_params))}"]
           elsif sync_params.key?('sessions')
             # ascli JSON format (v1)
@@ -178,25 +178,25 @@ module Aspera
                     session[async_param] ||= transfer_spec[tspec_param] if transfer_spec.key?(tspec_param)
                   end
                 end
-                session['private_key_paths'] = Fasp::Installation.instance.aspera_token_ssh_key_paths if transfer_spec.key?('token')
+                session['private_key_paths'] = Ascp::Installation.instance.aspera_token_ssh_key_paths if transfer_spec.key?('token')
                 update_remote_dir(session, 'remote_dir', transfer_spec)
               end
             end
             raise StandardError, "Only 'sessions', and optionally 'instance' keys are allowed" unless
               sync_params.keys.push('instance').uniq.sort.eql?(PARAMS_VX_KEYS)
-            assert_type(sync_params['sessions'], Array)
-            assert_type(sync_params['sessions'].first, Hash)
+            Aspera.assert_type(sync_params['sessions'], Array)
+            Aspera.assert_type(sync_params['sessions'].first, Hash)
             if sync_params.key?('instance')
-              assert_type(sync_params['instance'], Hash)
-              instance_builder = Aspera::CommandLineBuilder.new(sync_params['instance'], PARAMS_VX_INSTANCE)
+              Aspera.assert_type(sync_params['instance'], Hash)
+              instance_builder = CommandLineBuilder.new(sync_params['instance'], PARAMS_VX_INSTANCE)
               instance_builder.process_params
               instance_builder.add_env_args(env_args)
             end
 
             sync_params['sessions'].each do |session_params|
-              assert_type(session_params, Hash)
-              assert(session_params.key?('name')){'session must contain at least name'}
-              session_builder = Aspera::CommandLineBuilder.new(session_params, PARAMS_VX_SESSION)
+              Aspera.assert_type(session_params, Hash)
+              Aspera.assert(session_params.key?('name')){'session must contain at least name'}
+              session_builder = CommandLineBuilder.new(session_params, PARAMS_VX_SESSION)
               session_builder.process_params
               session_builder.add_env_args(env_args)
             end
@@ -211,7 +211,7 @@ module Aspera
           when true then return nil
           when false then raise "failed: #{$CHILD_STATUS}"
           when nil then raise "not started: #{$CHILD_STATUS}"
-          else error_unexpected_value(res)
+          else Aspera.error_unexpected_value(res)
           end
         end
 
@@ -235,8 +235,8 @@ module Aspera
         def admin_status(sync_params, session_name)
           command_line = [ASYNC_ADMIN_EXECUTABLE, '--quiet']
           if sync_params.key?('local')
-            assert(!sync_params['name'].nil?){'Missing session name'}
-            assert(session_name.nil? || session_name.eql?(sync_params['name'])){'Session not found'}
+            Aspera.assert(!sync_params['name'].nil?){'Missing session name'}
+            Aspera.assert(session_name.nil? || session_name.eql?(sync_params['name'])){'Session not found'}
             command_line.push("--name=#{sync_params['name']}")
             if sync_params.key?('local_db_dir')
               command_line.push("--local-db-dir=#{sync_params['local_db_dir']}")
@@ -267,7 +267,7 @@ module Aspera
           raise "Sync failed: #{status.exitstatus} : #{stderr}" unless status.success?
           return parse_status(stdout)
         end
-      end # end self
-    end # end Sync
-  end # end Fasp
-end # end Aspera
+      end
+    end
+  end
+end

data/lib/aspera/{fasp → transfer}/uri.rb

@@ -7,22 +7,23 @@ require 'aspera/rest'
 require 'aspera/command_line_builder'
 
 module Aspera
-  module Fasp
+  module Transfer
     # translates a "faspe:" URI (used in Faspex 4) into transfer spec (Hash)
     class Uri
       SCHEME = 'faspe'
       def initialize(fasp_link)
         @fasp_uri = URI.parse(fasp_link.gsub(' ', '%20'))
-        # TODO: check scheme is 'faspe'
+        Aspera.assert(@fasp_uri.scheme == SCHEME, "Invalid scheme: #{@fasp_uri.scheme}")
       end
 
+      # Generate transfer spec from provided faspe: URL
       def transfer_spec
         result_ts = {}
         result_ts['remote_host'] = @fasp_uri.host
         result_ts['remote_user'] = @fasp_uri.user
         result_ts['ssh_port'] = @fasp_uri.port
         result_ts['paths'] = [{'source' => URI.decode_www_form_component(@fasp_uri.path)}]
-        # faspex does not encode trailing base64 padding, fix that to be able to decode properly
+        # faspex 4 does not encode trailing base64 padding, fix that to be able to decode properly
         fixed_query = @fasp_uri.query.gsub(/(=+)$/){|x|'%3D' * x.length}
 
         Rest.decode_query(fixed_query).each do |name, value|
@@ -36,20 +37,20 @@ module Aspera
           when 'minrate'     then result_ts['min_rate_kbps'] = value.to_i
           when 'port'        then result_ts['fasp_port'] = value.to_i
           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 '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'] = CommandLineBuilder.yes_to_true(value)
           when 'fallback'    then result_ts['http_fallback'] = CommandLineBuilder.yes_to_true(value)
           when 'lockpolicy'  then result_ts['lock_rate_policy'] = CommandLineBuilder.yes_to_true(value)
           when 'lockminrate' then result_ts['lock_min_rate'] = CommandLineBuilder.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 (2)
+          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 ?
           else                    Log.log.warn{"URI parameter ignored: #{name} = #{value}"}
           end
         end
         return result_ts
       end
-    end # Uri
-  end # Fasp
-end # Aspera
+    end
+  end
+end

data/lib/aspera/web_server_simple.rb

@@ -38,6 +38,7 @@ module Aspera
 
     # @param uri [URI]
     def initialize(uri, certificate: nil)
+      @url = uri
       # see https://www.rubydoc.info/stdlib/webrick/WEBrick/Config
       webrick_options = {
         BindAddress: uri.host,
@@ -53,7 +54,7 @@ module Aspera
         if certificate.nil?
           webrick_options[:SSLCertName] = [['CN', WEBrick::Utils.getservername]]
         else
-          assert_type(certificate, Hash)
+          Aspera.assert_type(certificate, Hash)
           certificate = certificate.symbolize_keys
           raise "unexpected key in certificate config: only: #{CERT_PARAMETERS.join(', ')}" if certificate.keys.any?{|k|!CERT_PARAMETERS.include?(k)}
           webrick_options[:SSLPrivateKey] = if certificate.key?(:key)
@@ -72,10 +73,17 @@ module Aspera
           end
         end
       end
+      # call constructor of parent class, but capture STDERR
       # self signed certificate generates characters on STDERR, see create_self_signed_cert in webrick/ssl.rb
       Log.capture_stderr { super(webrick_options) }
-      # kill -USR1 for graceful shutdown
-      Kernel.trap('USR1') { shutdown }
+    end
+
+    # blocking
+    def start
+      Log.log.info{"Listening on #{@url}"}
+      # kill -HUP for graceful shutdown
+      Kernel.trap('HUP') { shutdown }
+      super
     end
 
     # log web server access ( option AccessLog )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -37,42 +37,8 @@ cert_chain:
   eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
   Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
   -----END CERTIFICATE-----
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: base64
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.6
 - !ruby/object:Gem::Dependency
   name: blankslate
   requirement: !ruby/object:Gem::Requirement
@@ -219,14 +185,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -401,14 +367,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.48'
 description: Command line interface for IBM Aspera products
 email:
 - laurent.martin.aspera@fr.ibm.com
@@ -427,10 +393,22 @@ files:
 - examples/dascli
 - examples/proxy.pac
 - examples/rubyc
-- lib/aspera/aoc.rb
+- lib/aspera/agent/alpha.rb
+- lib/aspera/agent/base.rb
+- lib/aspera/agent/connect.rb
+- lib/aspera/agent/direct.rb
+- lib/aspera/agent/httpgw.rb
+- lib/aspera/agent/node.rb
+- lib/aspera/agent/trsdk.rb
+- lib/aspera/api/aoc.rb
+- lib/aspera/api/ats.rb
+- lib/aspera/api/cos_node.rb
+- lib/aspera/api/node.rb
 - lib/aspera/ascmd.rb
+- lib/aspera/ascp/installation.rb
+- lib/aspera/ascp/management.rb
+- lib/aspera/ascp/products.rb
 - lib/aspera/assert.rb
-- lib/aspera/ats_api.rb
 - lib/aspera/cli/basic_auth_plugin.rb
 - lib/aspera/cli/error.rb
 - lib/aspera/cli/extended_value.rb
@@ -440,6 +418,7 @@ files:
 - lib/aspera/cli/main.rb
 - lib/aspera/cli/manager.rb
 - lib/aspera/cli/plugin.rb
+- lib/aspera/cli/plugin_factory.rb
 - lib/aspera/cli/plugins/alee.rb
 - lib/aspera/cli/plugins/aoc.rb
 - lib/aspera/cli/plugins/ats.rb
@@ -460,7 +439,6 @@ files:
 - lib/aspera/cli/version.rb
 - lib/aspera/colors.rb
 - lib/aspera/command_line_builder.rb
-- lib/aspera/cos_node.rb
 - lib/aspera/coverage.rb
 - lib/aspera/data/1
 - lib/aspera/data/2
@@ -470,25 +448,6 @@ files:
 - lib/aspera/data/6
 - lib/aspera/data_repository.rb
 - lib/aspera/environment.rb
-- lib/aspera/fasp/agent_alpha.rb
-- lib/aspera/fasp/agent_base.rb
-- lib/aspera/fasp/agent_connect.rb
-- lib/aspera/fasp/agent_direct.rb
-- lib/aspera/fasp/agent_httpgw.rb
-- lib/aspera/fasp/agent_node.rb
-- lib/aspera/fasp/agent_trsdk.rb
-- lib/aspera/fasp/error.rb
-- lib/aspera/fasp/error_info.rb
-- lib/aspera/fasp/faux_file.rb
-- lib/aspera/fasp/installation.rb
-- lib/aspera/fasp/management.rb
-- lib/aspera/fasp/parameters.rb
-- lib/aspera/fasp/parameters.yaml
-- lib/aspera/fasp/products.rb
-- lib/aspera/fasp/resume_policy.rb
-- lib/aspera/fasp/sync.rb
-- lib/aspera/fasp/transfer_spec.rb
-- lib/aspera/fasp/uri.rb
 - lib/aspera/faspex_gw.rb
 - lib/aspera/faspex_postproc.rb
 - lib/aspera/hash_ext.rb
@@ -499,9 +458,14 @@ files:
 - lib/aspera/line_logger.rb
 - lib/aspera/log.rb
 - lib/aspera/nagios.rb
-- lib/aspera/node.rb
 - lib/aspera/node_simulator.rb
 - lib/aspera/oauth.rb
+- lib/aspera/oauth/base.rb
+- lib/aspera/oauth/factory.rb
+- lib/aspera/oauth/generic.rb
+- lib/aspera/oauth/jwt.rb
+- lib/aspera/oauth/url_json.rb
+- lib/aspera/oauth/web.rb
 - lib/aspera/open_application.rb
 - lib/aspera/persistency_action_once.rb
 - lib/aspera/persistency_folder.rb
@@ -518,10 +482,19 @@ files:
 - lib/aspera/rest_call_error.rb
 - lib/aspera/rest_error_analyzer.rb
 - lib/aspera/rest_errors_aspera.rb
+- lib/aspera/resumer.rb
 - lib/aspera/secret_hider.rb
 - lib/aspera/ssh.rb
 - lib/aspera/temp_file_manager.rb
 - lib/aspera/timer_limiter.rb
+- lib/aspera/transfer/error.rb
+- lib/aspera/transfer/error_info.rb
+- lib/aspera/transfer/faux_file.rb
+- lib/aspera/transfer/parameters.rb
+- lib/aspera/transfer/spec.rb
+- lib/aspera/transfer/spec.yaml
+- lib/aspera/transfer/sync.rb
+- lib/aspera/transfer/uri.rb
 - lib/aspera/uri_reader.rb
 - lib/aspera/web_auth.rb
 - lib/aspera/web_server_simple.rb