aspera-cli 4.21.2 → 4.22.0

data/lib/aspera/transfer/parameters.rb

@@ -6,9 +6,9 @@ require 'aspera/command_line_builder'
 require 'aspera/temp_file_manager'
 require 'aspera/transfer/error'
 require 'aspera/transfer/spec'
+require 'aspera/transfer/convert'
 require 'aspera/ascp/installation'
 require 'aspera/cli/formatter'
-require 'aspera/agent/base'
 require 'aspera/rest'
 require 'securerandom'
 require 'base64'
@@ -20,15 +20,10 @@ module Aspera
   module Transfer
     # translate transfer specification to ascp parameter list
     class Parameters
-      # Agents shown in manual for parameters (sub list)
-      SUPPORTED_AGENTS = Agent::Base.agent_list.freeze
       FILE_LIST_OPTIONS = ['--file-list', '--file-pair-list'].freeze
-      # Short names of columns in manual
-      SUPPORTED_AGENTS_SHORT = SUPPORTED_AGENTS.map{|agent_sym|agent_sym.to_s[0].to_sym}
+      private_constant :FILE_LIST_OPTIONS
       HTTP_FALLBACK_ACTIVATION_VALUES = ['1', 1, true, 'force'].freeze
 
-      private_constant :SUPPORTED_AGENTS, :FILE_LIST_OPTIONS
-
       class << self
         # temp file list files are created here
         def file_list_folder=(value)
@@ -46,64 +41,14 @@ module Aspera
           @file_list_folder ||= TempFileManager.instance.new_file_path_global('asession_filelists')
         end
 
-        # @param formatter [Cli::Formatter] formatter to use
-        # @return a table suitable to display in manual
-        def man_table(formatter)
-          result = []
-          Spec::DESCRIPTION.each do |name, options|
-            param = {name: name, type: [options[:accepted_types]].flatten.join(','), description: options[:desc]}
-            # add flags for supported agents in doc
-            SUPPORTED_AGENTS.each do |agent_sym|
-              param[agent_sym.to_s[0].to_sym] = Cli::Formatter.tick(options[:agents].nil? || options[:agents].include?(agent_sym))
-            end
-            # only keep lines that are usable in supported agents
-            next if SUPPORTED_AGENTS_SHORT.inject(true){|memory, agent_short_sym|memory && param[agent_short_sym].empty?}
-            param[:cli] =
-              case options[:cli][:type]
-              when :envvar then 'env:' + options[:cli][:variable]
-              when :opt_without_arg then options[:cli][:switch]
-              when :opt_with_arg
-                values = if options.key?(:enum)
-                  ['enum']
-                elsif options[:accepted_types].is_a?(Array)
-                  options[:accepted_types]
-                elsif !options[:accepted_types].nil?
-                  [options[:accepted_types]]
-                else
-                  raise "error: #{param}"
-                end.map{|n|"{#{n}}"}.join('|')
-                conversion_tag = options[:cli].key?(:convert) ? '(conversion)' : ''
-                "#{options[:cli][:switch]} #{conversion_tag}#{values}"
-              when :special then formatter.special_format('special')
-              when :ignore then formatter.special_format('ignored')
-              else
-                param[:d].eql?(tick_yes) ? '' : 'n/a'
-              end
-            param[:description] += "\nAllowed values: #{options[:enum].join(', ')}" if options.key?(:enum)
-            # replace "solidus" HTML entity with its text value
-            param[:description] = param[:description].gsub('&sol;', '\\')
-            result.push(param)
-          end
-          return result.sort_by { |parameter_info| parameter_info[:name] }
-        end
-
-        # special encoding methods used in YAML (key: :convert)
-        def convert_remove_hyphen(value); value.tr('-', ''); end
-
-        # special encoding methods used in YAML (key: :convert)
-        def convert_json64(value); Base64.strict_encode64(JSON.generate(value)); end
-
-        # special encoding methods used in YAML (key: :convert)
-        def convert_base64(value); Base64.strict_encode64(value); end
-
         # file list is provided directly with ascp arguments
-        # @param ascp_args [Array,NilClass] ascp arguments
+        # @columns ascp_args [Array,NilClass] ascp arguments
         def ascp_args_file_list?(ascp_args)
-          ascp_args&.any?{|i|FILE_LIST_OPTIONS.include?(i)}
+          ascp_args&.any?{ |i| FILE_LIST_OPTIONS.include?(i)}
         end
       end
 
-      # @param options [Hash] key: :wss: bool, :ascp_args: array of strings
+      # @columns options [Hash] key: :wss: bool, :ascp_args: array of strings
       def initialize(
         job_spec,
         ascp_args:       nil,
@@ -125,7 +70,7 @@ module Aspera
         Aspera.assert(@ascp_args.all?(String)){'all ascp arguments must be String'}
         Aspera.assert_type(@trusted_certs, Array){'trusted_certs'}
         Aspera.assert_values(@client_ssh_key, Ascp::Installation::CLIENT_SSH_KEY_OPTIONS)
-        @builder = CommandLineBuilder.new(@job_spec, Spec::DESCRIPTION)
+        @builder = CommandLineBuilder.new(@job_spec, Spec::SCHEMA, Convert)
       end
 
       # either place source files on command line, or add file list file
@@ -133,29 +78,29 @@ module Aspera
         # is the file list provided through ascp parameters?
         ascp_file_list_provided = self.class.ascp_args_file_list?(@ascp_args)
         # set if paths is mandatory in ts
-        @builder.params_definition['paths'][:mandatory] = !@job_spec.key?('keepalive') && !ascp_file_list_provided # cspell:words keepalive
+        @builder.required('paths', !@job_spec.key?('keepalive') && !ascp_file_list_provided) # cspell:words keepalive
         # get paths in transfer spec (after setting if it is mandatory)
         ts_paths_array = @builder.read_param('paths')
         file_list_option = nil
         # transfer spec contains paths ?
         if !ts_paths_array.nil?
           Aspera.assert(!ascp_file_list_provided){'file list provided both in transfer spec and ascp file list. Remove one of them.'}
-          Aspera.assert(ts_paths_array.all?{|i|i.key?('source')}){"All elements of paths must have a 'source' key"}
-          is_pair_list = ts_paths_array.any?{|i|i.key?('destination')}
-          raise "All elements of paths must be consistent with 'destination' key" if is_pair_list && !ts_paths_array.all?{|i|i.key?('destination')}
+          Aspera.assert(ts_paths_array.all?{ |i| i.key?('source')}){"All elements of paths must have a 'source' key"}
+          is_pair_list = ts_paths_array.any?{ |i| i.key?('destination')}
+          raise "All elements of paths must be consistent with 'destination' key" if is_pair_list && !ts_paths_array.all?{ |i| i.key?('destination')}
           if self.class.file_list_folder.nil?
             Aspera.assert(!is_pair_list){'file pair list is not supported when file list folder is not set'}
             # not safe for special characters ? (maybe not, depends on OS)
             Log.log.debug('placing source file list on command line (no file list file)')
-            @builder.add_command_line_options(ts_paths_array.map{|i|i['source']})
+            @builder.add_command_line_options(ts_paths_array.map{ |i| i['source']})
           else
             # safer option: generate a file list file if there is storage defined for it
             if is_pair_list
               file_list_option = '--file-pair-list'
-              lines = ts_paths_array.each_with_object([]){|e, m|m.push(e['source'], e['destination']) }
+              lines = ts_paths_array.each_with_object([]){ |e, m| m.push(e['source'], e['destination'])}
             else
               file_list_option = '--file-list'
-              lines = ts_paths_array.map{|i|i['source']}
+              lines = ts_paths_array.map{ |i| i['source']}
             end
             file_list_file = TempFileManager.instance.new_file_path_in_folder(self.class.file_list_folder)
             Log.log.debug{Log.dump(:file_list, lines)}

data/lib/aspera/transfer/spec.rb

@@ -2,7 +2,6 @@
 
 require 'aspera/command_line_builder'
 require 'aspera/assert'
-require 'yaml'
 
 module Aspera
   module Transfer
@@ -36,12 +35,12 @@ module Aspera
           XFER_DIR_TO_TYPE.fetch(direction)
         end
       end
-      DESCRIPTION = CommandLineBuilder.normalize_description(YAML.load_file("#{__FILE__[0..-3]}yaml"))
+      SCHEMA = CommandLineBuilder.read_schema(__FILE__)
       # define constants for enums of parameters: <parameter>_<enum>, e.g. CIPHER_AES_128, DIRECTION_SEND, ...
-      DESCRIPTION.each do |name, description|
-        next unless description[:enum].is_a?(Array)
-        const_set(:"#{name.to_s.upcase}_ENUM_VALUES", description[:enum])
-        description[:enum].each do |enum|
+      SCHEMA['properties'].each do |name, description|
+        next unless description['enum'].is_a?(Array)
+        const_set(:"#{name.to_s.upcase}_ENUM_VALUES", description['enum'])
+        description['enum'].each do |enum|
           const_set("#{name.to_s.upcase}_#{enum.upcase.gsub(/[^A-Z0-9]/, '_')}", enum.freeze)
         end
       end