aspera-cli 4.19.0 → 4.21.1

data/lib/aspera/cli/plugin.rb

@@ -24,10 +24,7 @@ module Aspera
 
       class << self
         def declare_generic_options(options)
-          options.declare(:query, 'Additional filter for for some commands (list/delete)', types: Hash)
-          options.declare(
-            :value, 'Value for create, update, list filter', types: Hash,
-            deprecation: '(4.14) Use positional value for create/modify or option: query for list/delete')
+          options.declare(:query, 'Additional filter for for some commands (list/delete)', types: [Hash, Array])
           options.declare(:property, 'Name of property to set (modify operation)')
           options.declare(:bulk, 'Bulk operation (only some)', values: :bool, default: :no)
           options.declare(:bfail, 'Bulk operation error handling', values: :bool, default: :yes)
@@ -36,21 +33,25 @@ module Aspera
 
       attr_accessor(*INIT_PARAMS)
 
-      def initialize(options:, transfer:, config:, formatter:, persistency:, only_manual:)
+      def initialize(options:, transfer:, config:, formatter:, persistency:, only_manual:, man_header: true)
+        # check presence in descendant of mandatory method and constant
+        Aspera.assert(respond_to?(:execute_action)){"Missing method 'execute_action' in #{self.class}"}
+        Aspera.assert(self.class.constants.include?(:ACTIONS)){"Missing constant 'ACTIONS' in #{self.class}"}
         @options = options
         @transfer = transfer
         @config = config
         @formatter = formatter
         @persistency = persistency
         @only_manual = only_manual
-        # check presence in descendant of mandatory method and constant
-        Aspera.assert(respond_to?(:execute_action)){"Missing method 'execute_action' in #{self.class}"}
-        Aspera.assert(self.class.constants.include?(:ACTIONS)){'ACTIONS shall be redefined by subclass'}
+        add_manual_header if man_header
+      end
+
+      def add_manual_header(has_options = true)
         # manual header for all plugins
         options.parser.separator('')
         options.parser.separator("COMMAND: #{self.class.name.split('::').last.downcase}")
         options.parser.separator("SUBCOMMANDS: #{self.class.const_get(:ACTIONS).map(&:to_s).sort.join(' ')}")
-        options.parser.separator('OPTIONS:')
+        options.parser.separator('OPTIONS:') if has_options
       end
 
       # @return a hash of instance variables
@@ -156,7 +157,7 @@ module Aspera
         when :create
           raise 'cannot create singleton' if is_singleton
           return do_bulk_operation(command: command, descr: 'data', fields: display_fields) do |params|
-            rest_api.create(res_class_path, params)[:data]
+            rest_api.create(res_class_path, params)
           end
         when :delete
           raise 'cannot delete singleton' if is_singleton
@@ -171,9 +172,9 @@ module Aspera
             {'id' => one_id}
           end
         when :show
-          return {type: :single_object, data: rest_api.read(one_res_path)[:data], fields: display_fields}
+          return {type: :single_object, data: rest_api.read(one_res_path), fields: display_fields}
         when :list
-          resp = rest_api.read(res_class_path, query_read_delete)
+          resp = rest_api.call(operation: 'GET', subpath: res_class_path, headers: {'Accept' => 'application/json'}, query: query_read_delete)
           return Main.result_empty if resp[:http].code == '204'
           data = resp[:data]
           # TODO: not generic : which application is this for ?
@@ -214,45 +215,30 @@ module Aspera
         return entity_command(command, rest_api, res_class_path, **opts, &block)
       end
 
-      # query parameters in URL suitable for REST list/GET and delete/DELETE
+      # query parameters in URL suitable for REST: list/GET and delete/DELETE
       def query_read_delete(default: nil)
         query = options.get_option(:query)
         # dup default, as it could be frozen
         query = default.dup if query.nil?
-        Log.log.debug{"Query=#{query}".bg_red}
+        Log.log.debug{"query_read_delete=#{query}".bg_red}
         begin
           # check it is suitable
           URI.encode_www_form(query) unless query.nil?
         rescue StandardError => e
-          raise Cli::BadArgument, "Query must be an extended value which can be encoded with URI.encode_www_form. Refer to manual. (#{e.message})"
+          raise Cli::BadArgument, "Query must be an extended value (Hash, Array) which can be encoded with URI.encode_www_form. Refer to manual. (#{e.message})"
         end
         return query
       end
 
-      # TODO: when deprecation of `value` is completed: remove this method, replace with options.get_option(:query)
-      # deprecation: 4.14
-      def query_option(mandatory: false, default: nil)
-        option = :value
-        value = options.get_option(option, mandatory: false)
-        if value.nil?
-          option = :query
-          value = options.get_option(option, mandatory: mandatory, default: default)
-        end
-        return value
-      end
-
       # Retrieves an extended value from command line, used for creation or modification of entities
       # @param command [Symbol] command name for error message
       # @param type [Class] expected type of value, either a Class, an Array of Class
       # @param bulk [Boolean] if true, value must be an Array of <type>
       # @param default [Object] default value if not provided
-      # TODO: when deprecation of `value` is completed: remove line with :value
       def value_create_modify(command:, description: nil, type: Hash, bulk: false, default: nil)
-        value = options.get_option(:value)
-        Log.log.warn("option `value` is deprecated. Use positional parameter for #{command}") unless value.nil?
         value = options.get_next_argument(
           "parameters for #{command}#{description.nil? ? '' : " (#{description})"}", mandatory: default.nil?,
-          validation: bulk ? Array : type) if value.nil?
+          validation: bulk ? Array : type)
         value = default if value.nil?
         unless type.nil?
           type = [type] unless type.is_a?(Array)

data/lib/aspera/cli/plugins/alee.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'aspera/api/aoc'
+require 'aspera/api/alee'
 require 'aspera/nagios'
 
 module Aspera
@@ -16,7 +16,7 @@ module Aspera
             nagios = Nagios.new
             begin
               api = Api::Alee.new(nil, nil, version: 'ping')
-              result = api.call(operation: 'GET', subpath: '')
+              result = api.call(operation: 'GET')
               raise "unexpected response: #{result[:http].body}" unless result[:http].body.eql?('pong')
               nagios.add_ok('api', 'answered ok')
             rescue StandardError => e
@@ -27,7 +27,7 @@ module Aspera
             entitlement_id = options.get_option(:username, mandatory: true)
             customer_id = options.get_option(:password, mandatory: true)
             api_metering = Api::Alee.new(entitlement_id, customer_id)
-            return {type: :single_object, data: api_metering.read('entitlement')[:data]}
+            return {type: :single_object, data: api_metering.read('entitlement')}
           end
         end
       end