aspera-cli 4.25.6 → 4.26.0

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

@@ -56,7 +56,7 @@ module Aspera
           commands = %i[create list show modify delete node cluster entitlement]
           command = options.get_next_command(commands)
           # those do not require access key id
-          access_key_id = instance_identifier unless %i[create list].include?(command)
+          access_key_id = options.instance_identifier unless %i[create list].include?(command)
           case command
           when :create
             params = value_create_modify(command: command, default: {})
@@ -151,7 +151,7 @@ module Aspera
             if options.get_option(:cloud) || options.get_option(:region)
               server_data = server_by_cloud_region
             else
-              server_id = instance_identifier
+              server_id = options.instance_identifier
               server_data = @ats_api_open.all_servers.find{ |i| i['id'].eql?(server_id)}
               raise BadIdentifier.new('server', server_id) if server_data.nil?
             end
@@ -179,7 +179,7 @@ module Aspera
 
         def execute_action_api_key
           command = options.get_next_command(%i[instances create list show delete])
-          concerned_id = instance_identifier if %i[show delete].include?(command)
+          concerned_id = options.instance_identifier if %i[show delete].include?(command)
           rest_add_header = {}
           if !command.eql?(:instances)
             instance = options.get_option(:instance)

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

@@ -8,28 +8,22 @@ module Aspera
     module Plugins
       # Base class for command plugins
       class Base
-        # Operations without id (create list)
-        GLOBAL_OPS = %i[create list].freeze
-        # Operations with id (modify delete show)
-        INSTANCE_OPS = %i[modify delete show].freeze
-        # All standard operations (create list modify delete show)
-        ALL_OPS = (GLOBAL_OPS + INSTANCE_OPS).freeze
-
+        module Operations
+          # Operations without id: `create` `list`
+          GLOBAL = %i[create list].freeze
+          # Operations on singleton: `modify` `show`
+          SINGLETON = %i[modify show].freeze
+          # Operations with id: `modify` `show` `delete`
+          INSTANCE = (SINGLETON + %i[delete]).freeze
+          # All standard operations: `create` `list` `modify` `show` `delete`
+          ALL = (GLOBAL + INSTANCE).freeze
+        end
         class << self
           def declare_options(options)
             options.declare(:query, 'Additional filter for for some commands (list/delete)', allowed: [Hash, Array, NilClass])
             options.declare(:bulk, 'Bulk operation (only some)', allowed: Allowed::TYPES_BOOLEAN, default: false)
             options.declare(:bfail, 'Bulk operation error handling', allowed: Allowed::TYPES_BOOLEAN, default: true)
           end
-
-          # @return [Hash,NilClass] `{field:,value:}` if identifier is a percent selector, else `nil`
-          def percent_selector(identifier)
-            Aspera.assert_type(identifier, String)
-            if (m = identifier.match(REGEX_LOOKUP_ID_BY_FIELD))
-              return {field: m[1], value: ExtendedValue.instance.evaluate(m[2], context: "percent selector: #{m[1]}")}
-            end
-            return
-          end
         end
 
         def initialize(context:)
@@ -62,34 +56,19 @@ module Aspera
           options.parser.separator('OPTIONS:') if has_options
         end
 
-        # Resource identifier as positional parameter
-        #
-        # @param description [String] description of the identifier
-        # @param &block      [Proc] block to search for identifier based on attribute value
-        # @return   [String, Array] identifier or list of ids
-        def instance_identifier(description: 'identifier')
-          res_id = options.get_next_argument(description, multiple: options.get_option(:bulk)) if res_id.nil?
-          # Can be an Array
-          if res_id.is_a?(String) && (m = Base.percent_selector(res_id))
-            Aspera.assert(block_given?, type: Cli::BadArgument){"Percent syntax for #{description} not supported in this context"}
-            res_id = yield(m[:field], m[:value])
-          end
-          return res_id
-        end
-
         # For create and delete operations: execute one action or multiple if bulk is yes
         # @param command   [Symbol] Operation: :create, :delete, ...
         # @param descr     [String] Description of the value
         # @param values    [Object] Value(s), or type of value to get from user
         # @param id_result [String] Key in result hash to use as identifier
         # @param fields    [Array]  Fields to display
-        # @param &block    [Proc]   Block to execute for each value
-        def do_bulk_operation(command:, descr: nil, values: Hash, id_result: 'id', fields: :default)
+        # @param block     [Proc]   Block to execute for each value
+        def do_bulk_operation(command:, descr: nil, values: Hash, id_result: 'id', fields: :default, &block)
           Aspera.assert(block_given?){'missing block'}
           is_bulk = options.get_option(:bulk)
           case values
           when :identifier
-            values = instance_identifier(description: descr)
+            values = options.instance_identifier(description: descr)
           when Class
             values = value_create_modify(command: command, description: descr, type: values, bulk: is_bulk)
           end
@@ -134,7 +113,7 @@ module Aspera
         # @param delete_style   [String]  If set, the delete operation by array in payload
         # @param id_as_arg      [String]  If set, the id is provided as url argument ?<id_as_arg>=<id>
         # @param is_singleton   [Boolean] If `true`, entity is the full path to the resource
-        # @param block          [Proc]    Block to search for identifier based on attribute value
+        # @param &block         [Proc]    Block to search for identifier based on attribute value
         # @return [Hash] Result suitable for CLI result
         def entity_execute(
           api:,
@@ -148,11 +127,11 @@ module Aspera
           list_query: nil,
           &block
         )
-          command = options.get_next_command(ALL_OPS) if command.nil?
+          command = options.get_next_command(Operations::ALL) if command.nil?
           if is_singleton
             one_res_path = entity
-          elsif INSTANCE_OPS.include?(command)
-            one_res_id = instance_identifier(&block)
+          elsif Operations::INSTANCE.include?(command)
+            one_res_id = options.instance_identifier(&block)
             one_res_path = "#{entity}/#{one_res_id}"
             one_res_path = "#{entity}?#{id_as_arg}=#{one_res_id}" if id_as_arg
           end
@@ -248,10 +227,6 @@ module Aspera
           end
           return value
         end
-
-        # Percent selector: select by this field for this value
-        REGEX_LOOKUP_ID_BY_FIELD = /^%([^:]+):(.*)$/
-        private_constant :REGEX_LOOKUP_ID_BY_FIELD
       end
     end
   end

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

@@ -568,7 +568,9 @@ module Aspera
 
         def install_transfer_sdk
           asked_version = options.get_next_argument('transferd version', mandatory: false)
-          name, version, folder = Ascp::Installation.instance.install_sdk(url: options.get_option(:sdk_url, mandatory: true), version: asked_version)
+          sdk_url = options.get_option(:sdk_url, mandatory: true)
+          sdk_url = nil if sdk_url.eql?(SpecialValues::DEF)
+          name, version, folder = Ascp::Installation.instance.retrieve_sdk(url: sdk_url, version: asked_version)
           return Main.result_status("Installed #{name} version #{version} in #{folder}")
         end
 
@@ -641,7 +643,7 @@ module Aspera
 
         def execute_preset(action: nil, name: nil)
           action = options.get_next_command(PRESET_ALL_ACTIONS) if action.nil?
-          name = instance_identifier if name.nil? && PRESET_INSTANCE_ACTIONS.include?(action)
+          name = options.instance_identifier if name.nil? && PRESET_INSTANCE_ACTIONS.include?(action)
           name = global_default_preset if name.eql?(GLOBAL_DEFAULT_KEYWORD)
           # Those operations require existing option
           raise "no such preset: #{name}" if PRESET_EXIST_ACTIONS.include?(action) && !@config_presets.key?(name)
@@ -820,7 +822,7 @@ module Aspera
             when :list
               return Main.result_object_list(OAuth::Factory.instance.persisted_tokens)
             when :show
-              data = OAuth::Factory.instance.get_token_info(instance_identifier)
+              data = OAuth::Factory.instance.get_token_info(options.instance_identifier)
               raise Cli::Error, 'Unknown identifier' if data.nil?
               return Main.result_single_object(data)
             end

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

@@ -130,15 +130,15 @@ module Aspera
                   fields: %w[id contact name status]
                 )
               when :show
-                transfer_id = instance_identifier(description: 'transfer ID')
+                transfer_id = options.instance_identifier(description: 'transfer ID')
                 return Main.result_single_object(api_console.read("transfers/#{transfer_id}"))
               when :files
-                transfer_id = instance_identifier(description: 'transfer ID')
+                transfer_id = options.instance_identifier(description: 'transfer ID')
                 query = query_read_delete(default: {})
                 query['limit'] ||= 100
                 return Main.result_object_list(api_console.read("transfers/#{transfer_id}/files", query))
               when :start, :pause, :cancel, :resume, :rerun, :change_rate, :change_policy, :move_forwards, :move_back
-                transfer_id = instance_identifier(description: 'transfer ID')
+                transfer_id = options.instance_identifier(description: 'transfer ID')
                 return Main.result_single_object(api_console.update("transfers/#{transfer_id}/#{command}", query_read_delete))
               end
             end

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

@@ -291,7 +291,7 @@ module Aspera
             command_pkg = options.get_next_command(%i[send receive list show], aliases: {recv: :receive})
             case command_pkg
             when :show
-              delivery_id = instance_identifier
+              delivery_id = options.instance_identifier
               return Main.result_single_object(mailbox_filtered_entries(stop_at_id: delivery_id).find{ |p| p[PACKAGE_MATCH_FIELD].eql?(delivery_id)})
             when :list
               return Main.result_object_list(mailbox_filtered_entries, fields: [PACKAGE_MATCH_FIELD, 'title', 'items'])
@@ -307,7 +307,7 @@ module Aspera
                 first_source = delivery_info['sources'].first
                 first_source['paths'].concat(transfer.source_list)
                 source_id = options.get_option(:remote_source)
-                if source_id && (m = Base.percent_selector(source_id))
+                if source_id && (m = Manager.percent_selector(source_id))
                   Aspera.assert(m[:field].eql?('name'), type: Cli::BadArgument){'only name as selector, or give id'}
                   source_list = api_v3.read('source_shares')['items']
                   source_id = self.class.get_source_id_by_name(m[:value], source_list)
@@ -348,7 +348,7 @@ module Aspera
                   )
                 end
                 # get command line parameters
-                delivery_id = instance_identifier
+                delivery_id = options.instance_identifier
                 Aspera.assert(!delivery_id.empty?){'empty id'}
                 recipient = options.get_option(:recipient)
                 if delivery_id.eql?(SpecialValues::ALL)
@@ -441,7 +441,7 @@ module Aspera
             when :list
               return Main.result_object_list(source_list)
             else # :info :node
-              source_id = instance_identifier do |field, value|
+              source_id = options.instance_identifier do |field, value|
                 Aspera.assert(field.eql?('name'), type: Cli::BadArgument){'only name as selector, or give id'}
                 self.class.get_source_id_by_name(value, source_list)
               end.to_i
@@ -506,7 +506,7 @@ module Aspera
               return entity_execute(api: api_v4, entity: 'metadata_profiles')
             when :package
               pkg_box_type = options.get_next_command([:users])
-              pkg_box_id = instance_identifier
+              pkg_box_id = options.instance_identifier
               return entity_execute(api: api_v4, entity: "#{pkg_box_type}/#{pkg_box_id}/packages")
             end
           when :address_book

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

@@ -98,6 +98,8 @@ module Aspera
           options.declare(:shared_folder, 'Send package with files from shared folder')
           options.declare(:group_type, 'Type of shared box', allowed: %i[shared_inboxes workgroups], default: :shared_inboxes)
           options.parse_options!
+          # [Aspera::Api::Faspex]
+          @api_v5 = nil
         end
 
         # if recipient is just an email, then convert to expected API hash : name and type
@@ -114,7 +116,7 @@ module Aspera
           parameters[type].map! do |recipient_data|
             # If just a string, make a general lookup and build expected name/type hash
             if recipient_data.is_a?(String)
-              matched = @api_v5.lookup_by_name('contacts', recipient_data, query: Rest.php_style({context: 'packages', type: recipient_types}))
+              matched = @api_v5.lookup_with_q('contacts', value: recipient_data, query: Rest.php_style({context: 'packages', type: recipient_types}))
               recipient_data = {
                 name:           matched['name'],
                 recipient_type: matched['type']
@@ -297,7 +299,7 @@ module Aspera
             return Main.result_transfer(transfer.start(transfer_spec))
           else
             # send from remote shared folder
-            if (m = Base.percent_selector(shared_folder))
+            if (m = Manager.percent_selector(shared_folder))
               shared_folder = @api_v5.lookup_entity_by_field(
                 entity: 'shared_folders',
                 field: m[:field],
@@ -376,7 +378,7 @@ module Aspera
           command = options.get_next_command(%i[show browse status delete receive send list])
           package_id =
             if %i[receive show browse status delete].include?(command)
-              @api_v5.pub_link_context&.key?('package_id') ? @api_v5.pub_link_context['package_id'] : instance_identifier
+              @api_v5.pub_link_context&.key?('package_id') ? @api_v5.pub_link_context['package_id'] : options.instance_identifier
             end
           case command
           when :show
@@ -419,7 +421,7 @@ module Aspera
             entity: res_sym.to_s
           }
           res_id_query = :default
-          available_commands = ALL_OPS
+          available_commands = Operations::ALL
           case res_sym
           when :metadata_profiles
             exec_args[:entity] = 'configuration/metadata_profiles'
@@ -437,7 +439,7 @@ module Aspera
             available_commands += [:reset_password]
           when :oauth_clients
             exec_args[:display_fields] = Formatter.all_but('public_key')
-            exec_args[:api] = Api::Faspex.new(root: Api::Faspex::PATH_AUTH, **Oauth.args_from_options(options))
+            exec_args[:api] = Api::Faspex.new(root: Api::Faspex::PATH_AUTH, **Oauth.kwargs_from_options(options))
             exec_args[:list_query] = {'expand': true, 'no_api_path': true, 'client_types[]': 'public'}
           when :shared_inboxes, :workgroups
             available_commands += %i[members saml_groups invite_external_collaborator]
@@ -459,13 +461,13 @@ module Aspera
             return Main.result_object_list(data, total: total, fields: exec_args[:display_fields])
           when :shared_folders
             # nodes
-            node_id = instance_identifier do |field, value|
+            node_id = options.instance_identifier do |field, value|
               @api_v5.lookup_entity_by_field(entity: 'nodes', field: field, value: value)['id']
             end
             shfld_entity = "nodes/#{node_id}/shared_folders"
-            sh_command = options.get_next_command(ALL_OPS + [:user])
+            sh_command = options.get_next_command(Operations::ALL + [:user])
             case sh_command
-            when *ALL_OPS
+            when *Operations::ALL
               return entity_execute(
                 api: @api_v5,
                 entity: shfld_entity,
@@ -474,7 +476,7 @@ module Aspera
                        @api_v5.lookup_entity_by_field(entity: shfld_entity, field: field, value: value)['id']
                      end
             when :user
-              sh_id = instance_identifier do |field, value|
+              sh_id = options.instance_identifier do |field, value|
                 @api_v5.lookup_entity_by_field(entity: shfld_entity, field: field, value: value)['id']
               end
               user_path = "#{shfld_entity}/#{sh_id}/custom_access_users"
@@ -485,13 +487,13 @@ module Aspera
             end
           when :browse
             # nodes
-            node_id = instance_identifier do |field, value|
+            node_id = options.instance_identifier do |field, value|
               @api_v5.lookup_entity_by_field(entity: 'nodes', value: value, field: field)['id']
             end
             return browse_folder("nodes/#{node_id}/browse")
           when :invite_external_collaborator
             # :shared_inboxes, :workgroups
-            shared_inbox_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
+            shared_inbox_id = options.instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
             creation_payload = value_create_modify(command: res_command, type: [Hash, String])
             creation_payload = {'email_address' => creation_payload} if creation_payload.is_a?(String)
             result = @api_v5.create("#{res_sym}/#{shared_inbox_id}/external_collaborator", creation_payload)
@@ -505,7 +507,7 @@ module Aspera
             return Main.result_single_object(result)
           when :members, :saml_groups
             # res_command := :shared_inboxes, :workgroups
-            res_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
+            res_id = options.instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: res_sym.to_s, field: field, value: value, query: res_id_query)['id']}
             res_path = "#{res_sym}/#{res_id}/#{res_command}"
             list_key = res_command.to_s
             list_key = 'groups' if res_command.eql?(:saml_groups)
@@ -515,7 +517,7 @@ module Aspera
               users = options.get_next_argument('user id, %name:, or Array')
               users = [users] unless users.is_a?(Array)
               users = users.map do |user|
-                if (m = Base.percent_selector(user))
+                if (m = Manager.percent_selector(user))
                   @api_v5.lookup_entity_by_field(
                     entity: 'accounts',
                     field: m[:field],
@@ -546,7 +548,7 @@ module Aspera
                    end
           when :reset_password
             # :accounts
-            contact_id = instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: 'accounts', field: field, value: value, query: res_id_query)['id']}
+            contact_id = options.instance_identifier{ |field, value| @api_v5.lookup_entity_by_field(entity: 'accounts', field: field, value: value, query: res_id_query)['id']}
             @api_v5.create("accounts/#{contact_id}/reset_password", {})
             return Main.result_status('password reset, user shall check email')
           end
@@ -617,7 +619,7 @@ module Aspera
           command = options.get_next_command(ACTIONS)
           unless %i{postprocessing health}.include?(command)
             # create an API object with the same options, but with a different subpath
-            @api_v5 = Api::Faspex.new(**Oauth.args_from_options(options))
+            @api_v5 = Api::Faspex.new(**Oauth.kwargs_from_options(options))
             # in case user wants to use HTTPGW tell transfer agent how to get address
             transfer.httpgw_url_cb = lambda{@api_v5.read('account')['gateway_url']}
           end
@@ -660,7 +662,7 @@ module Aspera
             when :list
               return Main.result_object_list(all_shared_folders)
             when :browse
-              shared_folder_id = instance_identifier do |field, value|
+              shared_folder_id = options.instance_identifier do |field, value|
                 matches = all_shared_folders.select{ |i| i[field].eql?(value)}
                 raise "no match for #{field} = #{value}" if matches.empty?
                 raise "multiple matches for #{field} = #{value}" if matches.length > 1
@@ -674,7 +676,7 @@ module Aspera
             return execute_admin
           when :invitations
             invitation_endpoint = 'invitations'
-            invitation_command = options.get_next_command(%i[resend].concat(ALL_OPS))
+            invitation_command = options.get_next_command(%i[resend].concat(Operations::ALL))
             case invitation_command
             when :create
               return do_bulk_operation(command: invitation_command, descr: 'data') do |params|
@@ -682,7 +684,7 @@ module Aspera
                 @api_v5.create(invitation_endpoint, params)
               end
             when :resend
-              @api_v5.create("#{invitation_endpoint}/#{instance_identifier}/resend", nil)
+              @api_v5.create("#{invitation_endpoint}/#{options.instance_identifier}/resend", nil)
               return Main.result_status('Invitation resent')
             else
               return entity_execute(