aspera-cli 4.10.0 → 4.12.0

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

@@ -6,26 +6,26 @@ require 'aspera/ats_api'
 module Aspera
   module Cli
     module Plugins
-      # list and download connect client versions
+      # 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 < Plugin
+      class Ats < Aspera::Cli::Plugin
         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.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.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)
+          # TODO: provide list ?
+          cloud = options.get_option(:cloud, is_type: :mandatory).upcase
+          region = options.get_option(:region, is_type: :mandatory)
           return @ats_api_pub.read("servers/#{cloud}/#{region}")[:data]
         end
 
@@ -36,27 +36,27 @@ 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, is_type: :mandatory),
+              password: options.get_option(:ats_secret, is_type: :mandatory)}
           })
         end
 
         def execute_action_access_key
           commands = %i[create list show modify delete node cluster entitlement]
           command = options.get_next_command(commands)
-          # those dont require access key id
+          # those do not require access key id
           access_key_id = instance_identifier unless %i[create list].include?(command)
           case command
           when :create
             params = options.get_option(:params) || {}
             server_data = nil
             # if transfer_server_id not provided, get it from command line options
-            if !params.has_key?('transfer_server_id')
+            if !params.key?('transfer_server_id')
               server_data = server_by_cloud_region
               params['transfer_server_id'] = server_data['id']
             end
-            Log.log.debug("using params: #{params}".bg_red.gray)
-            if params.has_key?('storage')
+            Log.log.debug{"using params: #{params}".bg_red.gray}
+            if params.key?('storage')
               case params['storage']['type']
               # here we need somehow to map storage type to field to get for auth end point
               when 'ibm-s3'
@@ -67,36 +67,36 @@ module Aspera
                 else
                   server_data2 = @ats_api_pub.all_servers.find do |s|
                     s['cloud'].eql?(server_data['cloud']) &&
-                    s['region'].eql?(server_data['region']) &&
-                    s.has_key?('s3_authentication_endpoint')
+                      s['region'].eql?(server_data['region']) &&
+                      s.key?('s3_authentication_endpoint')
                   end
                   raise "no such transfer server id: #{params['transfer_server_id']}" if server_data2.nil?
                   # specific one do not have s3 end point in id
                   params['transfer_server_id'] = server_data2['id']
                 end
-                if !params['storage'].has_key?('authentication_endpoint')
+                if !params['storage'].key?('authentication_endpoint')
                   params['storage']['endpoint'] = server_data2['s3_authentication_endpoint']
                 end
               end
             end
-            res = ats_api_pub_v1.create('access_keys',params)
+            res = ats_api_pub_v1.create('access_keys', params)
             return {type: :single_object, data: res[:data]}
             # TODO : action : modify, with "PUT"
           when :list
-            params = options.get_option(:params) || {'offset' => 0,'max_results' => 1000}
-            res = ats_api_pub_v1.read('access_keys',params)
-            return {type: :object_list, data: res[:data]['data'], fields: ['name','id','created.at','modified.at']}
+            params = options.get_option(:params) || {'offset' => 0, 'max_results' => 1000}
+            res = ats_api_pub_v1.read('access_keys', params)
+            return {type: :object_list, data: res[:data]['data'], fields: ['name', 'id', 'created.at', 'modified.at']}
           when :show
             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 = options.get_option(:value, is_type: :mandatory)
             params['id'] = access_key_id
-            ats_api_pub_v1.update("access_keys/#{access_key_id}",params)
+            ats_api_pub_v1.update("access_keys/#{access_key_id}", params)
             return Main.result_status('modified')
           when :entitlement
             ak = ats_api_pub_v1.read("access_keys/#{access_key_id}")[:data]
-            api_bss = AoC.metering_api(ak['license']['entitlement_id'],ak['license']['customer_id'])
+            api_bss = AoC.metering_api(ak['license']['entitlement_id'], ak['license']['customer_id'])
             return {type: :single_object, data: api_bss.read('entitlement')[:data]}
           when :delete
             ats_api_pub_v1.delete("access_keys/#{access_key_id}")
@@ -104,25 +104,25 @@ 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?
-            base_url = server_data['transfer_setup_url']
-            api_node = Rest.new({
-              base_url: base_url,
+            raise CliError, '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,
               auth:     {
                 type:     :basic,
                 username: access_key_id,
-                password: @agents[:config].get_secret(url: base_url,username: access_key_id)
+                password: @agents[:config].lookup_secret(url: node_url, username: access_key_id)
               }})
-            command = options.get_next_command(Node::COMMON_ACTIONS)
-            return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_node)).execute_action(command)
+            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'])
           when :cluster
-            base_url = ats_api_pub_v1.params[:base_url]
+            ats_url = ats_api_pub_v1.params[:base_url]
             rest_params = {
-              base_url: base_url,
+              base_url: ats_url,
               auth:     {
                 type:     :basic,
                 username: access_key_id,
-                password: @agents[:config].get_secret(url: base_url, username: access_key_id)
+                password: @agents[:config].lookup_secret(url: ats_url, username: access_key_id)
               }}
             api_ak_auth = Rest.new(rest_params)
             return {type: :single_object, data: api_ak_auth.read('servers')[:data]}
@@ -138,7 +138,7 @@ module Aspera
           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, is_type: :optional)
               server_data = server_by_cloud_region
             else
               server_id = instance_identifier
@@ -154,14 +154,14 @@ module Aspera
             base_url: AtsApi.base_url + '/v2',
             headers:  rest_add_headers,
             auth:     {
-              type:     :oauth2,
-              base_url: 'https://iam.bluemix.net/identity',
-              #does not work:  base_url:    'https://iam.cloud.ibm.com/identity',
-              crtype:   :generic,
-              generic:  {
+              type:         :oauth2,
+              base_url:     'https://iam.bluemix.net/identity',
+              # does not work:  base_url:    'https://iam.cloud.ibm.com/identity',
+              grant_method: :generic,
+              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, is_type: :mandatory)
               }}})
         end
 
@@ -173,27 +173,25 @@ module Aspera
           rest_add_header = {}
           if !command.eql?(:instances)
             instance = options.get_option(:instance)
-            #Log.log.error("1>>#{instance}".red)
             if instance.nil?
               # Take the first Aspera on Cloud transfer service instance ID if not provided by user
               instance = ats_api_v2_auth_ibm.read('instances')[:data]['data'].first
-              self.format.display_status("using first instance: #{instance}")
+              formatter.display_status("using first instance: #{instance}")
             end
-            #Log.log.error("2>>#{instance}".red)
             rest_add_header = {'X-ATS-Service-Instance-Id' => instance}
           end
           ats_ibm_api = ats_api_v2_auth_ibm(rest_add_header)
           case command
           when :instances
             instances = ats_ibm_api.read('instances')[:data]
-            Log.log.warn("more instances remaining: #{instances['remaining']}") unless instances['remaining'].to_i.eql?(0)
+            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', create_value)[: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})
+            res = ats_ibm_api.read('api_keys', {'offset' => 0, 'max_results' => 1000})
             return {type: :value_list, data: res[:data]['data'], name: 'ats_id'}
           when :show # show one of api_key in ATS
             res = ats_ibm_api.read("api_keys/#{concerned_id}")
@@ -223,7 +221,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, is_type: :mandatory)})[:data]
             return {type: :single_object, data: res}
           else raise 'ERROR'
           end

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

@@ -5,7 +5,7 @@ require 'aspera/rest'
 module Aspera
   module Cli
     module Plugins
-      class Bss < BasicAuthPlugin
+      class Bss < Aspera::Cli::BasicAuthPlugin
         ACTIONS = %i[subscription].freeze
 
         FIELDS = {
@@ -14,7 +14,7 @@ module Aspera
 
         def initialize(env)
           super(env)
-          @api_bss = env[:bss_api] if env.has_key?(:bss_api)
+          @api_bss = env[:bss_api] if env.key?(:bss_api)
         end
 
         def all_fields(name)
@@ -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, is_type: :mandatory)
             @api_bss = Rest.new(
               base_url: 'https://dashboard.bss.asperasoft.com/platform',
               headers: {cookie: "_dashboard_key=#{key}"})
@@ -35,15 +35,15 @@ 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, is_type: :mandatory) # AOC_ORGANIZATION_QUERY AOC_USER_EMAIL
+              value = options.get_option(:value, is_type: :mandatory)
               request = {
-                'variables' => {'filter' => {'key' => query,'value' => value}},
+                'variables' => {'filter' => {'key' => query, 'value' => value}},
                 'query'     => "query($filter: BssSubscriptionFilter!) {#{object}(filter: $filter) { #{all_fields('bssSubscriptions')} } }"
               }
-              result = @api_bss.create('graphql',request)[:data]
+              result = @api_bss.create('graphql', request)[:data]
               # give fields to keep order
-              return {type: :object_list, data: result['data'][object],fields: FIELDS['bssSubscriptions']}
+              return {type: :object_list, data: result['data'][object], fields: FIELDS['bssSubscriptions']}
             when :show
               id = instance_identifier
               request = {
@@ -52,7 +52,7 @@ module Aspera
                   '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
+              result = @api_bss.create('graphql', request)[:data]['data'][object].first
               result.delete('instances')
               return {type: :single_object, data: result}
             when :instances
@@ -61,7 +61,7 @@ module Aspera
                 'variables' => {'id' => id},
                 'query'     => "query($id: ID!) {#{object}(id: $id) { aocOrganization { id subdomainName name status tier urlId trialExpiresAt } } } }"
               }
-              result = @api_bss.create('graphql',request)[:data]['data'][object].first
+              result = @api_bss.create('graphql', request)[:data]['data'][object].first
               return {type: :object_list, data: result['instances']}
             end
           end