aspera-cli 4.13.0 → 4.15.0

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# cspell:ignore trustpolicy
+
 require 'aspera/cli/plugins/node'
 require 'aspera/ats_api'
 
@@ -7,25 +9,25 @@ module Aspera
   module Cli
     module Plugins
       # Access Aspera Transfer Service
-      # https://52.44.83.163/docs/
       # https://developer.ibm.com/aspera/docs/ats-api-reference/creating-ats-api-keys/
       class Ats < Aspera::Cli::Plugin
+        CLOUD_TABLE = %w[id name].freeze
         def initialize(env)
           super(env)
-          options.add_opt_simple(:ibm_api_key, 'IBM API key, see https://cloud.ibm.com/iam/apikeys')
-          options.add_opt_simple(:instance, 'ATS instance in ibm cloud')
-          options.add_opt_simple(:ats_key, 'ATS key identifier (ats_xxx)')
-          options.add_opt_simple(:ats_secret, 'ATS key secret')
-          options.add_opt_simple(:params, 'Parameters access key creation (@json:)')
-          options.add_opt_simple(:cloud, 'Cloud provider')
-          options.add_opt_simple(:region, 'Cloud region')
+          options.declare(:ibm_api_key, 'IBM API key, see https://cloud.ibm.com/iam/apikeys')
+          options.declare(:instance, 'ATS instance in ibm cloud')
+          options.declare(:ats_key, 'ATS key identifier (ats_xxx)')
+          options.declare(:ats_secret, 'ATS key secret')
+          options.declare(:params, 'Parameters access key creation (@json:)')
+          options.declare(:cloud, 'Cloud provider')
+          options.declare(:region, 'Cloud region')
           options.parse_options!
         end
 
         def server_by_cloud_region
           # TODO: provide list ?
-          cloud = options.get_option(:cloud, is_type: :mandatory).upcase
-          region = options.get_option(:region, is_type: :mandatory)
+          cloud = options.get_option(:cloud, mandatory: true).upcase
+          region = options.get_option(:region, mandatory: true)
           return @ats_api_pub.read("servers/#{cloud}/#{region}")[:data]
         end
 
@@ -36,8 +38,8 @@ module Aspera
             base_url: AtsApi.base_url + '/pub/v1',
             auth:     {
               type:     :basic,
-              username: options.get_option(:ats_key, is_type: :mandatory),
-              password: options.get_option(:ats_secret, is_type: :mandatory)}
+              username: options.get_option(:ats_key, mandatory: true),
+              password: options.get_option(:ats_secret, mandatory: true)}
           })
         end
 
@@ -90,7 +92,7 @@ module Aspera
             res = ats_api_pub_v1.read("access_keys/#{access_key_id}")
             return {type: :single_object, data: res[:data]}
           when :modify
-            params = options.get_option(:value, is_type: :mandatory)
+            params = value_create_modify(command: command)
             params['id'] = access_key_id
             ats_api_pub_v1.update("access_keys/#{access_key_id}", params)
             return Main.result_status('modified')
@@ -104,7 +106,7 @@ module Aspera
           when :node
             ak_data = ats_api_pub_v1.read("access_keys/#{access_key_id}")[:data]
             server_data = @ats_api_pub.all_servers.find {|i| i['id'].start_with?(ak_data['transfer_server_id'])}
-            raise CliError, 'no such server found' if server_data.nil?
+            raise Cli::Error, 'no such server found' if server_data.nil?
             node_url = server_data['transfer_setup_url']
             api_node = Aspera::Node.new(params: {
               base_url: node_url,
@@ -114,7 +116,7 @@ module Aspera
                 password: @agents[:config].lookup_secret(url: node_url, username: access_key_id)
               }})
             command = options.get_next_command(Node::COMMANDS_GEN4)
-            return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_node)).execute_command_gen4(command, ak_data['root_file_id'])
+            return Node.new(@agents, api: api_node).execute_command_gen4(command, ak_data['root_file_id'])
           when :cluster
             ats_url = ats_api_pub_v1.params[:base_url]
             rest_params = {
@@ -134,11 +136,11 @@ module Aspera
           command = options.get_next_command(%i[clouds list show])
           case command
           when :clouds
-            return {type: :single_object, data: @ats_api_pub.cloud_names, columns: %w[id name]}
+            return {type: :object_list, data: @ats_api_pub.cloud_names.map { |k, v| CLOUD_TABLE.zip([k, v]).to_h }}
           when :list
             return {type: :object_list, data: @ats_api_pub.all_servers, fields: %w[id cloud region]}
           when :show
-            if options.get_option(:cloud) || options.get_option(:region, is_type: :optional)
+            if options.get_option(:cloud) || options.get_option(:region)
               server_data = server_by_cloud_region
             else
               server_id = instance_identifier
@@ -161,7 +163,7 @@ module Aspera
               generic:      {
                 grant_type:    'urn:ibm:params:oauth:grant-type:apikey',
                 response_type: 'cloud_iam',
-                apikey:        options.get_option(:ibm_api_key, is_type: :mandatory)
+                apikey:        options.get_option(:ibm_api_key, mandatory: true)
               }}})
         end
 
@@ -187,8 +189,7 @@ module Aspera
             Log.log.warn{"more instances remaining: #{instances['remaining']}"} unless instances['remaining'].to_i.eql?(0)
             return {type: :value_list, data: instances['data'], name: 'instance'}
           when :create
-            create_value = options.get_option(:value) || {}
-            created_key = ats_ibm_api.create('api_keys', create_value)[:data]
+            created_key = ats_ibm_api.create('api_keys', value_create_modify(command: command, default: {}))[:data]
             return {type: :single_object, data: created_key}
           when :list # list known api keys in ATS (this require an api_key ...)
             res = ats_ibm_api.read('api_keys', {'offset' => 0, 'max_results' => 1000})
@@ -221,7 +222,7 @@ module Aspera
           when :api_key # manage credential to access ATS API
             return execute_action_api_key
           when :aws_trust_policy
-            res = ats_api_pub_v1.read('aws/trustpolicy', {region: options.get_option(:region, is_type: :mandatory)})[:data]
+            res = ats_api_pub_v1.read('aws/trustpolicy', {region: options.get_option(:region, mandatory: true)})[:data]
             return {type: :single_object, data: res}
           else raise 'ERROR'
           end

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

@@ -23,7 +23,7 @@ module Aspera
 
         def execute_action
           if @api_bss.nil?
-            key = options.get_option(:password, is_type: :mandatory)
+            key = options.get_option(:password, mandatory: true)
             @api_bss = Rest.new(
               base_url: 'https://dashboard.bss.asperasoft.com/platform',
               headers: {cookie: "_dashboard_key=#{key}"})
@@ -35,8 +35,8 @@ module Aspera
             object = 'bssSubscriptions'
             case command
             when :find
-              query = options.get_option(:query, is_type: :mandatory) # AOC_ORGANIZATION_QUERY AOC_USER_EMAIL
-              value = options.get_option(:value, is_type: :mandatory)
+              query = options.get_option(:query, mandatory: true) # AOC_ORGANIZATION_QUERY AOC_USER_EMAIL
+              value = value_create_modify(command: command)
               request = {
                 'variables' => {'filter' => {'key' => query, 'value' => value}},
                 'query'     => "query($filter: BssSubscriptionFilter!) {#{object}(filter: $filter) { #{all_fields('bssSubscriptions')} } }"
@@ -48,8 +48,8 @@ module Aspera
               id = instance_identifier
               request = {
                 'variables' => {'id' => id},
-                'query'     => "query($id: ID!) {#{object}(id: $id) { #{all_fields('bssSubscriptions')} roleAssignments(uniqueSubjectId: true) { id subjectId } "\
-                  'instances { id state planId serviceId ssmSubscriptionId entitlement { id } aocOrganization { id subdomainName name status tier urlId trialExpiresAt '\
+                'query'     => "query($id: ID!) {#{object}(id: $id) { #{all_fields('bssSubscriptions')} roleAssignments(uniqueSubjectId: true) { id subjectId } " \
+                  'instances { id state planId serviceId ssmSubscriptionId entitlement { id } aocOrganization { id subdomainName name status tier urlId trialExpiresAt ' \
                   'users(organizationAdmin: true) { id name email atsAdmin subscriptionAdmin } } } } }'
               }
               result = @api_bss.create('graphql', request)[:data]['data'][object].first