aspera-cli 4.13.0 → 4.15.0

data/lib/aspera/fasp/parameters.yaml

@@ -2,12 +2,13 @@
 # accepted_types : accepted types for non-enum
 # default        : default value if not specified
 # enum           : set with list of values for enum types accepted in transfer spec
-# agents         : supported agents (for doc only)
+# agents         : supported agents (for doc only), if not specified: all
 # required       : optional, default: false
 # cli.type       : ascp: type of parameter, one of CLI_OPTION_TYPES
 # cli.switch     : ascp: switch for ascp command line
 # cli.convert    : ascp: transform value: either a Hash with conversion values, or name of class
 # cli.variable   : ascp: name of env var
+# cspell:words dgram dnat dnats faspmgr asperanoded xattrs keepalive datagram
 ---
 cipher:
   :desc: "In transit encryption type."
@@ -78,7 +79,11 @@ destination_root:
   :cli:
     :type: :special
 destination_root_id:
-  :desc: The file ID of the destination root directory. Required when using Bearer token auth for the destination node.
+  :desc: |-
+    The file ID of the destination root directory.
+    Required when using Bearer token auth for the destination node.
+
+
   :accepted_types: :string
   :agents:
   - :sdk
@@ -176,7 +181,7 @@ multi_session:
 
   :accepted_types: :int
   :cli:
-    :type: :ignore
+    :type: :special
     :switch: "-C"
 multi_session_threshold:
   :desc: |-
@@ -226,15 +231,37 @@ precalculate_job_size:
   :cli:
     :type: :opt_without_arg
 preserve_access_time:
+  :desc: |-
+    Preserve the source-file access timestamps at the destination.
+    Because source access times are updated by the transfer operation,
+    the timestamp that is preserved is the one just before to the transfer.
+
+
   :cli:
     :type: :opt_without_arg
 preserve_creation_time:
+  :desc: |-
+    (Windows only) Preserve source-file creation timestamps at the destination.
+    Only Windows systems retain information about creation time.
+    If the destination is not a Windows computer, this option is ignored.
+
+
   :cli:
     :type: :opt_without_arg
 preserve_modification_time:
+  :desc: |-
+    Set the modification time, the last time a file or directory was modified (written), of a transferred file
+    to the modification of the source file or directory.
+    Preserve source-file modification timestamps at the destination.
+
+
   :cli:
     :type: :opt_without_arg
 preserve_times:
+  :desc: Preserve file timestamps. 
+  :agents:
+  - :sdk
+  - :node
   :cli:
     :type: :opt_without_arg
 rate_policy:
@@ -436,6 +463,7 @@ use_ascp4:
   :cli:
     :type: :special
 use_system_ssh:
+  :desc: TODO, comment...
   :accepted_types: :string
   :agents:
   - :sdk
@@ -453,22 +481,46 @@ source_root:
     :switch: "--source-prefix64"
     :convert: Aspera::Fasp::Parameters.convert_base64
 min_rate_cap_kbps:
+  :desc: |-
+    The highest minimum rate that an incoming transfer can request, in kilobits per second.
+    Client minimum rate requests that exceed the minimum rate cap are ignored.
+    The default value of unlimited applies no cap to the minimum rate. (Default: 0)
+
+
   :accepted_types: :int
   :cli:
     :type: :ignore
 lock_rate_policy:
+  :desc: If true, lock the rate policy to the default value.
   :accepted_types: :bool
+  :agents:
+  - :sdk
+  - :connect
   :cli:
     :type: :ignore
 lock_target_rate_kbps:
+  :desc: |-
+    If true, lock the target transfer rate to the default value set for target_rate_kbps.
+    If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
+
+
   :accepted_types: :bool
   :cli:
     :type: :ignore
 lock_min_rate_kbps:
+  :desc: |-
+    If true, lock the minimum transfer rate to the value set for min_rate_kbps.
+    If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
+
+
   :accepted_types: :bool
+  :agents:
+  - :sdk
+  - :connect
   :cli:
     :type: :ignore
 apply_local_docroot:
+  :desc: Apply local docroot to source paths.
   :agents:
   - :direct
   - :sdk
@@ -560,7 +612,7 @@ remove_empty_source_directory:
     :type: :opt_without_arg
 EX_at_rest_password:
   :desc: Content protection password
-  :deprecation: "Use standard spec parameter: content_protection_password"
+  :deprecation: "(4.13) Use standard spec parameter: content_protection_password"
   :agents:
   - :direct
   :cli:
@@ -569,9 +621,10 @@ EX_at_rest_password:
 EX_proxy_password:
   :desc: |-
     Password used for Aspera proxy server authentication.
-    May be overridden by password in URL EX_fasp_proxy_url.
+    May be overridden by password in URL provided in parameter: proxy.
 
 
+  :deprecation: (4.14) Use env var ASPERA_PROXY_PASS
   :agents:
   - :direct
   :cli:
@@ -579,14 +632,17 @@ EX_proxy_password:
     :variable: ASPERA_PROXY_PASS
 EX_license_text:
   :desc: "License file text override.\nBy default ascp looks for license file near executable."
+  :deprecation: (4.14) Use env var ASPERA_SCP_LICENSE
   :agents:
   - :direct
   :cli:
     :type: :envvar
     :variable: ASPERA_SCP_LICENSE
 keepalive:
+  :desc: The session is running in persistent session mode.
   :agents:
-  - :none
+  - :sdk
+  - :direct
   :cli:
     :type: :opt_without_arg
 dgram_size:
@@ -609,6 +665,7 @@ sshfp:
     :switch: "--check-sshfp"
 EX_http_proxy_url:
   :desc: Specify the proxy server address used by HTTP Fallback
+  :deprecation: (4.14) TODO, use proxy option ?
   :agents:
   - :direct
   :cli:
@@ -616,6 +673,7 @@ EX_http_proxy_url:
     :switch: "-x"
 EX_ssh_key_paths:
   :desc: Use public key authentication for SSH and specify the private key file paths
+  :deprecation: (4.14) Use option transfer_info.ascp_args
   :accepted_types: :array
   :agents:
   - :direct
@@ -624,6 +682,7 @@ EX_ssh_key_paths:
     :switch: "-i"
 EX_http_transfer_jpeg:
   :desc: HTTP transfers as JPEG file
+  :deprecation: (4.14) Use option transfer_info.ascp_args
   :accepted_types: :int
   :default: '0'
   :agents:
@@ -633,6 +692,7 @@ EX_http_transfer_jpeg:
     :switch: "-j"
 EX_no_read:
   :desc: no read source
+  :deprecation: (4.14) Use option transfer_info.ascp_args
   :agents:
   - :direct
   :cli:
@@ -640,12 +700,14 @@ EX_no_read:
     :switch: "--no-read"
 EX_no_write:
   :desc: no write on destination
+  :deprecation: (4.14) Use option transfer_info.ascp_args
   :agents:
   - :direct
   :cli:
     :type: :opt_without_arg
     :switch: "--no-write"
 target_rate_percentage:
+  :desc: "TODO: remove ?"
   :cli:
     :type: :ignore
 rate_policy_allowed:
@@ -660,15 +722,18 @@ rate_policy_allowed:
   :cli:
     :type: :ignore
 fasp_url:
+  :desc: Only used in Faspex.
   :agents:
   - :unknown
   :cli:
     :type: :ignore
 lock_min_rate:
+  :desc: "TODO: remove ?"
   :accepted_types: :bool
   :cli:
     :type: :ignore
 lock_target_rate:
+  :desc: "TODO: remove ?"
   :accepted_types: :bool
   :cli:
     :type: :ignore
@@ -683,13 +748,15 @@ cipher_allowed:
   :cli:
     :type: :ignore
 obfuscate_file_names:
+  :desc: HTTP Gateway obfuscates file names when set to true.
   :accepted_types: :bool
   :agents:
-  - :unknown
+  - :httpgw
   :cli:
     :type: :ignore
 EX_file_list:
   :desc: source file list
+  :deprecation: (4.14) Use command line file list, or option transfer_info.ascp_args
   :agents:
   - :direct
   :cli:
@@ -697,6 +764,7 @@ EX_file_list:
     :switch: "--file-list"
 EX_file_pair_list:
   :desc: source file pair list
+  :deprecation: (4.14) Use command line file pair list, or option transfer_info.ascp_args
   :agents:
   - :direct
   :cli:
@@ -704,7 +772,7 @@ EX_file_pair_list:
     :switch: "--file-pair-list"
 EX_ascp_args:
   :desc: Add native command line arguments to ascp
-  :deprecation: Use parameter ascp_args in option transfer_info
+  :deprecation: (4.13) Use option transfer_info.ascp_args
   :accepted_types: :array
   :agents:
   - :direct

data/lib/aspera/fasp/products.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+# cspell:ignore LOCALAPPDATA
+require 'aspera/environment'
+
+module Aspera
+  module Fasp
+    # find Aspera standard products installation in standard paths
+    class Products
+      # known product names
+      CONNECT = 'IBM Aspera Connect'
+      ASPERA = 'IBM Aspera (Client)'
+      CLI_V1 = 'Aspera CLI (deprecated)'
+      DRIVE = 'Aspera Drive (deprecated)'
+      HSTS = 'IBM Aspera High-Speed Transfer Server'
+      # product information manifest: XML (part of aspera product)
+      INFO_META_FILE = 'product-info.mf'
+      BIN_SUBFOLDER = 'bin'
+      ETC_SUBFOLDER = 'etc'
+      VAR_RUN_SUBFOLDER = File.join('var', 'run')
+
+      @@found_products = nil # rubocop:disable Style/ClassVars
+      class << self
+        # @return product folders depending on OS fields
+        # :expected  M app name is taken from the manifest if present, else defaults to this value
+        # :app_root  M main folder for the application
+        # :log_root  O location of log files (Linux uses syslog)
+        # :run_root  O only for Connect Client, location of http port file
+        # :sub_bin   O subfolder with executables, default : bin
+        def product_locations_on_current_os
+          result =
+            case Aspera::Environment.os
+            when Aspera::Environment::OS_WINDOWS then [{
+              expected: CONNECT,
+              app_root: File.join(ENV.fetch('LOCALAPPDATA', nil), 'Programs', 'Aspera', 'Aspera Connect'),
+              log_root: File.join(ENV.fetch('LOCALAPPDATA', nil), 'Aspera', 'Aspera Connect', 'var', 'log'),
+              run_root: File.join(ENV.fetch('LOCALAPPDATA', nil), 'Aspera', 'Aspera Connect')
+            }, {
+              expected: CLI_V1,
+              app_root: File.join('C:', 'Program Files', 'Aspera', 'cli'),
+              log_root: File.join('C:', 'Program Files', 'Aspera', 'cli', 'var', 'log')
+            }, {
+              expected: HSTS,
+              app_root: File.join('C:', 'Program Files', 'Aspera', 'Enterprise Server'),
+              log_root: File.join('C:', 'Program Files', 'Aspera', 'Enterprise Server', 'var', 'log')
+            }]
+            when Aspera::Environment::OS_X then [{
+              expected: CONNECT,
+              app_root: File.join(Dir.home, 'Applications', 'Aspera Connect.app'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Connect'),
+              run_root: File.join(Dir.home, 'Library', 'Application Support', 'Aspera', 'Aspera Connect'),
+              sub_bin:  File.join('Contents', 'Resources')
+            }, {
+              expected: CONNECT,
+              app_root: File.join('', 'Applications', 'Aspera Connect.app'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Connect'),
+              run_root: File.join(Dir.home, 'Library', 'Application Support', 'Aspera', 'Aspera Connect'),
+              sub_bin:  File.join('Contents', 'Resources')
+            }, {
+              expected: CLI_V1,
+              app_root: File.join(Dir.home, 'Applications', 'Aspera CLI'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera')
+            }, {
+              expected: HSTS,
+              app_root: File.join('', 'Library', 'Aspera'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera')
+            }, {
+              expected: DRIVE,
+              app_root: File.join('', 'Applications', 'Aspera Drive.app'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'Aspera_Drive'),
+              sub_bin:  File.join('Contents', 'Resources')
+            }, {
+              expected: ASPERA,
+              app_root: File.join('', 'Applications', 'IBM Aspera.app'),
+              log_root: File.join(Dir.home, 'Library', 'Logs', 'IBM Aspera'),
+              sub_bin:  File.join('Contents', 'Resources', 'sdk', 'aspera', 'bin')
+            }]
+            else [{ # other: Linux and Unix family
+              expected: CONNECT,
+              app_root: File.join(Dir.home, '.aspera', 'connect'),
+              run_root: File.join(Dir.home, '.aspera', 'connect')
+            }, {
+              expected: CLI_V1,
+              app_root: File.join(Dir.home, '.aspera', 'cli')
+            }, {
+              expected: HSTS,
+              app_root: File.join('', 'opt', 'aspera')
+            }]
+            end
+          result # .each {|item| item.deep_do {|h, _k, _v, _m|h.freeze}}.freeze
+        end
+
+        # @return the list of installed products in format of product_locations_on_current_os
+        def installed_products
+          if @@found_products.nil?
+            scan_locations = product_locations_on_current_os.clone
+            # add SDK as first search path
+            scan_locations.unshift({
+              expected: 'SDK',
+              app_root: Installation.instance.sdk_folder,
+              sub_bin:  ''
+            })
+            # search installed products: with ascp
+            @@found_products = scan_locations.select! do |item| # rubocop:disable Style/ClassVars
+              # skip if not main folder
+              next false unless Dir.exist?(item[:app_root])
+              Log.log.debug{"Found #{item[:app_root]}"}
+              sub_bin = item[:sub_bin] || BIN_SUBFOLDER
+              item[:ascp_path] = File.join(item[:app_root], sub_bin, ascp_filename)
+              # skip if no ascp
+              next false unless File.exist?(item[:ascp_path])
+              # read info from product info file if present
+              product_info_file = "#{item[:app_root]}/#{INFO_META_FILE}"
+              if File.exist?(product_info_file)
+                res_s = XmlSimple.xml_in(File.read(product_info_file), {'ForceArray' => false})
+                item[:name] = res_s['name']
+                item[:version] = res_s['version']
+              else
+                item[:name] = item[:expected]
+              end
+              true # select this version
+            end
+          end
+          return @@found_products
+        end
+
+        # filename for ascp with optional extension (Windows)
+        def ascp_filename
+          return 'ascp' + Environment.exe_extension
+        end
+
+        # @return folder paths for specified applications
+        # @param name Connect or CLI
+        def folders(name)
+          found = Products.installed_products.select{|i|i[:expected].eql?(name) || i[:name].eql?(name)}
+          raise "Product: #{name} not found, please install." if found.empty?
+          return found.first
+        end
+
+        # @return the file path of local connect where API's URI can be read
+        def connect_uri
+          connect = folders(CONNECT)
+          folder = File.join(connect[:run_root], VAR_RUN_SUBFOLDER)
+          ['', 's'].each do |ext|
+            uri_file = File.join(folder, "http#{ext}.uri")
+            Log.log.debug{"checking connect port file: #{uri_file}"}
+            if File.exist?(uri_file)
+              return File.open(uri_file, &:gets).strip
+            end
+          end
+          raise "no connect uri file found in #{folder}"
+        end
+
+        # @ return path to configuration file of aspera CLI
+        # def cli_conf_file
+        #  connect = folders(PRODUCT_CLI_V1)
+        #  return File.join(connect[:app_root], BIN_SUBFOLDER, '.aspera_cli_conf')
+        # end
+      end
+    end
+  end
+end

data/lib/aspera/fasp/resume_policy.rb

@@ -49,11 +49,11 @@ module Aspera
             # failure in ascp
             if e.retryable?
               # exit if we exceed the max number of retry
-              raise Fasp::Error, 'Maximum number of retry reached' if remaining_resumes <= 0
+              raise Fasp::Error, "Maximum number of retry reached (#{@parameters[:iter_max]})" if remaining_resumes <= 0
             else
               # give one chance only to non retryable errors
               unless remaining_resumes.eql?(@parameters[:iter_max])
-                Log.log.error('non-retryable error')
+                Log.log.error('non-retryable error'.red.blink)
                 raise e
               end
             end
@@ -61,7 +61,7 @@ module Aspera
 
           # take this retry in account
           remaining_resumes -= 1
-          Log.log.warn{"resuming in  #{sleep_seconds} seconds (retry left:#{remaining_resumes})"}
+          Log.log.warn{"Resuming in #{sleep_seconds} seconds (retry left:#{remaining_resumes})"}
 
           # wait a bit before retrying, maybe network condition will be better
           sleep(sleep_seconds)

data/lib/aspera/fasp/transfer_spec.rb

@@ -17,11 +17,12 @@ module Aspera
       }.freeze
       # reserved tag for Aspera
       TAG_RESERVED = 'aspera'
-      # define constants for enums of parameters: <parameter>_<enum>, e.g. CIPHER_AES_128
-      Aspera::Fasp::Parameters.description.each do |k, v|
-        next unless v[:enum].is_a?(Array)
-        v[:enum].each do |enum|
-          TransferSpec.const_set("#{k.to_s.upcase}_#{enum.upcase.gsub(/[^A-Z0-9]/, '_')}", enum.freeze)
+      # define constants for enums of parameters: <parameter>_<enum>, e.g. CIPHER_AES_128, DIRECTION_SEND, ...
+      Aspera::Fasp::Parameters.description.each do |name, description|
+        next unless description[:enum].is_a?(Array)
+        TransferSpec.const_set("#{name.to_s.upcase}_ENUM_VALUES", description[:enum])
+        description[:enum].each do |enum|
+          TransferSpec.const_set("#{name.to_s.upcase}_#{enum.upcase.gsub(/[^A-Z0-9]/, '_')}", enum.freeze)
         end
       end
       class << self
@@ -40,7 +41,7 @@ module Aspera
           return case tspec['direction']
                  when DIRECTION_SEND then :upload
                  when DIRECTION_RECEIVE then :download
-                 else raise 'Error: upload or download only'
+                 else raise "Error: upload or download only, not #{tspec['direction']} (#{tspec['direction'].class})"
                  end
         end
       end

data/lib/aspera/fasp/uri.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
+# cspell:words httpport targetrate minrate bwcap createpath lockpolicy lockminrate faspe
+
 require 'aspera/log'
+require 'aspera/rest'
 require 'aspera/command_line_builder'
 
 module Aspera
   module Fasp
     # translates a "faspe:" URI (used in Faspex 4) into transfer spec hash
     class Uri
-      def initialize(fasplink)
-        @fasp_uri = URI.parse(fasplink.gsub(' ', '%20'))
+      SCHEME = 'faspe'
+      def initialize(fasp_link)
+        @fasp_uri = URI.parse(fasp_link.gsub(' ', '%20'))
         # TODO: check scheme is faspe
       end
 
@@ -18,32 +22,30 @@ module Aspera
         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 encoded tags, fix that
+        # faspex does not encode trailing base64 padding, fix that to be able to decode properly
         fixed_query = @fasp_uri.query.gsub(/(=+)$/){|x|'%3D' * x.length}
 
-        URI.decode_www_form(fixed_query).each do |i|
-          name = i[0]
-          value = i[1]
+        Rest.decode_query(fixed_query).each do |name, value|
           case name
-          when 'cookie' then result_ts['cookie'] = value
-          when 'token' then result_ts['token'] = value
-          when 'sshfp' then result_ts['sshfp'] = value
-          when 'policy' then result_ts['rate_policy'] = value
-          when 'httpport' then result_ts['http_fallback_port'] = value.to_i
-          when 'targetrate' then result_ts['target_rate_kbps'] = value.to_i
-          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 '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 'cookie'      then result_ts['cookie'] = value
+          when 'token'       then result_ts['token'] = value
+          when 'sshfp'       then result_ts['sshfp'] = value
+          when 'policy'      then result_ts['rate_policy'] = value
+          when 'httpport'    then result_ts['http_fallback_port'] = value.to_i
+          when 'targetrate'  then result_ts['target_rate_kbps'] = value.to_i
+          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 '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 auth #{name}=#{value}"} # TODO: translate into transfer spec ? yes/no
-          when 'v' then Log.log.debug{"ignoring v #{name}=#{value}"} # TODO: translate into transfer spec ? 2
-          when 'protect' then Log.log.debug{"ignoring protect #{name}=#{value}"} # TODO: translate into transfer spec ?
-          else Log.log.warn{"URI parameter ignored: #{name} = #{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 '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

data/lib/aspera/faspex_gw.rb

@@ -68,9 +68,9 @@ module Aspera
           faspex_pkg_parameters = JSON.parse(request.body)
           Log.log.debug{"faspex pkg create parameters=#{faspex_pkg_parameters}"}
           faspex_package_create_result =
-            if @app_api.is_a?(Aspera::AoC)
+            if @app_api.class.name.eql?('Aspera::AoC')
               faspex4_send_to_aoc(faspex_pkg_parameters)
-            elsif @app_api.is_a?(Aspera::Rest)
+            elsif @app_api.class.name.eql?('Aspera::Rest')
               faspex4_send_to_faspex5(faspex_pkg_parameters)
             else
               raise "No such adapter: #{@app_api.class}"

data/lib/aspera/faspex_postproc.rb

@@ -13,7 +13,7 @@ module Aspera
     def initialize(server, parameters)
       raise 'parameters must be Hash' unless parameters.is_a?(Hash)
       @parameters = parameters.symbolize_keys
-      Log.dump(:postproc_parameters, @parameters)
+      Log.log.debug{Log.dump(:post_proc_parameters, @parameters)}
       raise "unexpected key in parameters config: only: #{ALLOWED_PARAMETERS.join(', ')}" if @parameters.keys.any?{|k|!ALLOWED_PARAMETERS.include?(k)}
       @parameters[:script_folder] ||= '.'
       @parameters[:fail_on_error] ||= false
@@ -44,7 +44,7 @@ module Aspera
         script_path = File.join(@parameters[:script_folder], script_file)
         Log.log.debug{"script=#{script_path}"}
         webhook_parameters = JSON.parse(request.body)
-        Log.dump(:webhook_parameters, webhook_parameters)
+        Log.log.debug{Log.dump(:webhook_parameters, webhook_parameters)}
         # env expects only strings
         environment = webhook_parameters.each_with_object({}) { |(k, v), h| h[k] = v.to_s }
         post_proc_pid = Process.spawn(environment, [script_path, script_path])

data/lib/aspera/hash_ext.rb

@@ -2,11 +2,21 @@
 
 class ::Hash
   def deep_merge(second)
-    merge(second){|_key, v1, v2|Hash === v1 && Hash === v2 ? v1.deep_merge(v2) : v2}
+    merge(second){|_key, v1, v2|v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.deep_merge(v2) : v2}
   end
 
   def deep_merge!(second)
-    merge!(second){|_key, v1, v2|Hash === v1 && Hash === v2 ? v1.deep_merge!(v2) : v2}
+    merge!(second){|_key, v1, v2|v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.deep_merge!(v2) : v2}
+  end
+
+  def deep_do(memory=nil, &block)
+    each do |key, value|
+      if value.is_a?(Hash)
+        value.deep_do(memory, &block)
+      else
+        yield(self, key, value, memory)
+      end
+    end
   end
 end
 
@@ -14,8 +24,8 @@ end
 unless Hash.method_defined?(:transform_keys)
   class Hash
     def transform_keys
-      return each_with_object({}){|(k, v), memo|memo[yield(k)] = v} if block_given?
-      raise 'missing block'
+      raise 'missing block' unless block_given?
+      return each_with_object({}){|(k, v), memo|memo[yield(k)] = v}
     end
   end
 end

data/lib/aspera/json_rpc.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# cspell:ignore blankslate
+
+require 'aspera/rest_error_analyzer'
+require 'blankslate'
+
+Aspera::RestErrorAnalyzer.instance.add_simple_handler(name: 'JSON RPC', path: %w[error message], always: true)
+
+module Aspera
+  # a very simple JSON RPC client
+  class JsonRpcClient < BlankSlate
+    JSON_RPC_VERSION = '2.0'
+    reveal :instance_variable_get
+    reveal :inspect
+    reveal :to_s
+
+    def initialize(api, namespace = nil)
+      super()
+      @api = api
+      @namespace = namespace
+      @request_id = 0
+    end
+
+    def respond_to_missing?(sym, include_private = false)
+      true
+    end
+
+    def method_missing(method, *args, &block)
+      args = args.first if args.size == 1 && args.first.is_a?(Hash)
+      data = @api.create('', {
+        jsonrpc: JSON_RPC_VERSION,
+        method:  "#{@namespace}#{method}",
+        params:  args,
+        id:      @request_id += 1
+      })[:data]
+      raise 'response shall be Hash' unless data.is_a?(Hash)
+      raise 'bad version in response' unless data['jsonrpc'] == JSON_RPC_VERSION
+      raise 'missing id in response' unless data.key?('id')
+      raise 'both error and response' if data.key?('error') && data.key?('result')
+      raise 'bad error response' unless
+        !data.key?('error') ||
+          data['error'].is_a?(Hash) &&
+            data['error']['code'].is_a?(Integer) &&
+            data['error']['message'].is_a?(String)
+      return data['result']
+    end
+  end
+end