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

Inherits:
Base
  • Object
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

ACTIONS = 
i[cluster access_key api_key aws_trust_policy].freeze

Constants inherited from Base

Base::ALL_OPS, Base::GLOBAL_OPS, Base::INSTANCE_OPS, Base::MAX_ITEMS, Base::MAX_PAGES, Base::REGEX_LOOKUP_ID_BY_FIELD

Instance Attribute Summary

Attributes inherited from Base

#context

Instance Method Summary collapse

Methods inherited from Base

#add_manual_header, #config, declare_options, #do_bulk_operation, #entity_execute, #formatter, #instance_identifier, #list_entities_limit_offset_total_count, #lookup_entity_by_field, #options, #persistency, #query_read_delete, #transfer, #value_create_modify

Constructor Details

#initialize(**_) ⇒ Ats

Returns a new instance of Ats.



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/aspera/cli/plugins/ats.rb', line 21

def initialize(**_)
  super
  @ats_api_pub = nil
  @ats_api_pub_v1_cache = nil
  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(:cloud, 'Cloud provider')
  options.declare(:region, 'Cloud region')
  options.parse_options!
  Node.declare_options(options)
end

Instance Method Details

#ats_api_pub_v1 ⇒ Object

require api key only if needed



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/aspera/cli/plugins/ats.rb', line 43

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 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/aspera/cli/plugins/ats.rb', line 162

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



238
239
240
 
# File 'lib/aspera/cli/plugins/ats.rb', line 238

def execute_action
  execute_action_gen(nil)
end

#execute_action_access_key ⇒ Object 



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
135
136
137
138
139
140
141
 
# File 'lib/aspera/cli/plugins/ats.rb', line 55

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 = value_create_modify(command: command, default: {})
    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
        params['storage']['endpoint'] = server_data2['s3_authentication_endpoint'] if !params['storage'].key?('authentication_endpoint')
      end
    end
    res = ats_api_pub_v1.create('access_keys', params)
    return Main.result_single_object(res)
    # TODO : action : modify, with "PUT"
  when :list
    params = query_read_delete(default: {'offset' => 0, 'max_results' => 1000})
    res = ats_api_pub_v1.read('access_keys', params)
    return Main.result_object_list(res['data'], fields: ['name', 'id', 'created.at', 'modified.at'])
  when :show
    res = ats_api_pub_v1.read("access_keys/#{access_key_id}")
    return Main.result_single_object(res)
  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}")
    api_bss = Api::Alee.new(ak['license']['entitlement_id'], ak['license']['customer_id'])
    return Main.result_single_object(api_bss.read('entitlement'))
  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}")
    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(context: context, 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 Main.result_single_object(api_ak_auth.read('servers'))
  else Aspera.error_unexpected_value(command)
  end
end

#execute_action_api_key ⇒ Object 



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
206
207
208
209
210
211
 
# File 'lib/aspera/cli/plugins/ats.rb', line 178

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)
  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'].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')
    Log.log.warn{"more instances remaining: #{instances['remaining']}"} unless instances['remaining'].to_i.eql?(0)
    return Main.result_value_list(instances['data'], name: 'instance')
  when :create
    created_key = ats_ibm_api.create('api_keys', value_create_modify(command: command, default: {}))
    return Main.result_single_object(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 Main.result_value_list(res['data'], name: 'ats_id')
  when :show # show one of api_key in ATS
    res = ats_ibm_api.read("api_keys/#{concerned_id}")
    return Main.result_single_object(res)
  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 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/aspera/cli/plugins/ats.rb', line 143

def execute_action_cluster_pub
  command = options.get_next_command(i[clouds list show])
  case command
  when :clouds
    return Main.result_object_list(@ats_api_pub.cloud_names.map{ |k, v| CLOUD_TABLE.zip([k, v]).to_h})
  when :list
    return Main.result_object_list(@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 BadIdentifier.new('server', server_id) if server_data.nil?
    end
    return Main.result_single_object(server_data)
  end
end

#execute_action_gen(ats_api_arg) ⇒ Object

called for legacy and AoC



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspera/cli/plugins/ats.rb', line 216

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)})
    return Main.result_single_object(res)
  else Aspera.error_unexpected_value(command)
  end
end

#server_by_cloud_region ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/aspera/cli/plugins/ats.rb', line 35

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}")
end