Class: Aspera::Cli::Plugins::Ats

Inherits:
Aspera::Cli::Plugin show all
Defined in:
lib/aspera/cli/plugins/ats.rb

Overview

Access Aspera Transfer Service developer.ibm.com/aspera/docs/ats-api-reference/creating-ats-api-keys/

Constant Summary collapse

CLOUD_TABLE = 
%w[id name].freeze
ACTIONS = 
%i[cluster access_key api_key aws_trust_policy].freeze

Constants inherited from Aspera::Cli::Plugin

Aspera::Cli::Plugin::ALL_OPS, Aspera::Cli::Plugin::GLOBAL_OPS, Aspera::Cli::Plugin::INIT_PARAMS, Aspera::Cli::Plugin::INSTANCE_OPS, Aspera::Cli::Plugin::MAX_ITEMS, Aspera::Cli::Plugin::MAX_PAGES, Aspera::Cli::Plugin::REGEX_LOOKUP_ID_BY_FIELD

Instance Method Summary collapse

Methods inherited from Aspera::Cli::Plugin

declare_generic_options, #do_bulk_operation, #entity_action, #entity_command, #init_params, #instance_identifier, #old_query_read_delete, #query_option, #query_read_delete, #value_create_modify

Constructor Details

#initialize(**env) ⇒ Ats

Returns a new instance of Ats.



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/aspera/cli/plugins/ats.rb', line 17

def initialize(**env)
  super
  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

Instance Method Details

#ats_api_pub_v1 ⇒ Object

require api key only if needed



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/aspera/cli/plugins/ats.rb', line 37

def ats_api_pub_v1
  return @ats_api_pub_v1_cache unless @ats_api_pub_v1_cache.nil?
  @ats_api_pub_v1_cache = Rest.new(
    base_url: "#{Api::Ats::SERVICE_BASE_URL}/pub/v1",
    auth:     {
      type:     :basic,
      username: options.get_option(:ats_key, mandatory: true),
      password: options.get_option(:ats_secret, mandatory: true)}
  )
end

#ats_api_v2_auth_ibm(rest_add_headers = {}) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/aspera/cli/plugins/ats.rb', line 155

def ats_api_v2_auth_ibm(rest_add_headers={})
  return Rest.new(
    base_url: "#{Api::Ats::SERVICE_BASE_URL}/v2",
    headers:  rest_add_headers,
    auth:     {
      type:          :oauth2,
      grant_method:  :generic,
      base_url:      'https://iam.bluemix.net/identity',
      # does not work:  base_url:    'https://iam.cloud.ibm.com/identity',
      grant_type:    'urn:ibm:params:oauth:grant-type:apikey',
      response_type: 'cloud_iam',
      apikey:        options.get_option(:ibm_api_key, mandatory: true)
    })
end

#execute_action ⇒ Object

called for legacy ATS only



232
233
234
 
# File 'lib/aspera/cli/plugins/ats.rb', line 232

def execute_action
  execute_action_gen(nil)
end

#execute_action_access_key ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/aspera/cli/plugins/ats.rb', line 48

def execute_action_access_key
  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)
  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.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.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'
        server_data2 = nil
        if server_data.nil?
          server_data2 = @ats_api_pub.all_servers.find{|s|s['id'].eql?(params['transfer_server_id'])}
          raise "no such transfer server id: #{params['transfer_server_id']}" if server_data2.nil?
        else
          server_data2 = @ats_api_pub.all_servers.find do |s|
            s['cloud'].eql?(server_data['cloud']) &&
              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'].key?('authentication_endpoint')
          params['storage']['endpoint'] = server_data2['s3_authentication_endpoint']
        end
      end
    end
    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']}
  when :show
    res = ats_api_pub_v1.read("access_keys/#{access_key_id}")
    return {type: :single_object, data: res[:data]}
  when :modify
    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')
  when :entitlement
    ak = ats_api_pub_v1.read("access_keys/#{access_key_id}")[:data]
    api_bss = Api::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}")
    return Main.result_status("deleted #{access_key_id}")
  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 Cli::Error, 'no such server found' if server_data.nil?
    node_url = server_data['transfer_setup_url']
    api_node = Api::Node.new(
      base_url: node_url,
      auth:     {
        type:     :basic,
        username: access_key_id,
        password: config.lookup_secret(url: node_url, username: access_key_id)
      })
    command = options.get_next_command(Node::COMMANDS_GEN4)
    return Node.new(**init_params, api: api_node).execute_command_gen4(command, ak_data['root_file_id'])
  when :cluster
    ats_url = ats_api_pub_v1.base_url
    api_ak_auth = Rest.new(
      base_url: ats_url,
      auth:     {
        type:     :basic,
        username: access_key_id,
        password: config.lookup_secret(url: ats_url, username: access_key_id)
      })
    return {type: :single_object, data: api_ak_auth.read('servers')[:data]}
  else Aspera.error_unexpected_value(command)
  end
end

#execute_action_api_key ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/aspera/cli/plugins/ats.rb', line 170

def execute_action_api_key
  command = options.get_next_command(%i[instances create list show delete])
  if %i[show delete].include?(command)
    concerned_id = instance_identifier
  end
  rest_add_header = {}
  if !command.eql?(:instances)
    instance = options.get_option(:instance)
    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
      formatter.display_status("using first instance: #{instance}")
    end
    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)
    return {type: :value_list, data: instances['data'], name: 'instance'}
  when :create
    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})
    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}")
    return {type: :single_object, data: res[:data]}
  when :delete
    ats_ibm_api.delete("api_keys/#{concerned_id}")
    return Main.result_status("deleted #{concerned_id}")
  else Aspera.error_unexpected_value(command)
  end
end

#execute_action_cluster_pub ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/aspera/cli/plugins/ats.rb', line 136

def execute_action_cluster_pub
  command = options.get_next_command(%i[clouds list show])
  case command
  when :clouds
    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)
      server_data = server_by_cloud_region
    else
      server_id = instance_identifier
      server_data = @ats_api_pub.all_servers.find {|i| i['id'].eql?(server_id)}
      raise 'no such server id' if server_data.nil?
    end
    return {type: :single_object, data: server_data}
  end
end

#execute_action_gen(ats_api_arg) ⇒ Object

called for legacy and AoC



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/aspera/cli/plugins/ats.rb', line 210

def execute_action_gen(ats_api_arg)
  actions = ACTIONS.dup
  actions.delete(:api_key) unless ats_api_arg.nil?
  command = options.get_next_command(actions)
  @ats_api_pub_v1_cache = ats_api_arg
  # keep as member variable as we may want to use the api in AoC name space
  @ats_api_pub = Api::Ats.new
  case command
  when :cluster # display general ATS cluster information, this uses public API, no auth
    return execute_action_cluster_pub
  when :access_key
    return execute_action_access_key
  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, mandatory: true)})[:data]
    return {type: :single_object, data: res}
  else Aspera.error_unexpected_value(command)
  end
end

#server_by_cloud_region ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/aspera/cli/plugins/ats.rb', line 29

def server_by_cloud_region
  # TODO: provide list ?
  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