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

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

Overview

list and download connect client versions 52.44.83.163/docs/ developer.ibm.com/aspera/docs/ats-api-reference/creating-ats-api-keys/

Constant Summary collapse

ACTIONS = 
[ :cluster, :access_key ,:api_key, :aws_trust_policy]

Constants inherited from Aspera::Cli::Plugin

Aspera::Cli::Plugin::ALL_OPS, Aspera::Cli::Plugin::GLOBAL_OPS, Aspera::Cli::Plugin::INSTANCE_OPS

Instance Method Summary collapse

Methods inherited from Aspera::Cli::Plugin

#config, #entity_action, #entity_command, #format, #options, #transfer

Constructor Details

#initialize(env) ⇒ Ats

Returns a new instance of Ats.



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/aspera/cli/plugins/ats.rb', line 11

def initialize(env)
  super(env)
  self.options.add_opt_simple(:ibm_api_key,"IBM API key, see https://cloud.ibm.com/iam/apikeys")
  self.options.add_opt_simple(:instance,"ATS instance in ibm cloud")
  self.options.add_opt_simple(:ats_key,"ATS key identifier (ats_xxx)")
  self.options.add_opt_simple(:ats_secret,"ATS key secret")
  self.options.add_opt_simple(:params,"Parameters access key creation (@json:)")
  self.options.add_opt_simple(:cloud,"Cloud provider")
  self.options.add_opt_simple(:region,"Cloud region")
  self.options.parse_options!
end

Instance Method Details

#ats_api_pub_v1 ⇒ Object

require api key only if needed



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

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 => AtsApi.base_url+'/pub/v1',
    :auth     => {
    :type     => :basic,
    :username => self.options.get_option(:ats_key,:mandatory),
    :password => self.options.get_option(:ats_secret,:mandatory)}
  })
end

#ats_api_v2_auth_ibm(rest_add_headers = {}) ⇒ Object 



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

def ats_api_v2_auth_ibm(rest_add_headers={})
  return Rest.new({
    :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',
    :grant      => :ibm_apikey,
    :api_key    => self.options.get_option(:ibm_api_key,:mandatory)
    }
  })
end

#execute_action ⇒ Object

called for legacy ATS only



225
226
227
 
# File 'lib/aspera/cli/plugins/ats.rb', line 225

def execute_action
  execute_action_gen(nil)
end

#execute_action_access_key ⇒ Object 



43
44
45
46
47
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
 
# File 'lib/aspera/cli/plugins/ats.rb', line 43

def execute_action_access_key
  commands=[:create,:list,:show,:modify,:delete,:node,:cluster,:entitlement]
  command=self.options.get_next_command(commands)
  # those dont require access key id
  unless [:create,:list].include?(command)
    access_key_id=self.options.get_option(:id,:mandatory)
  end
  case command
  when :create
    params=self.options.get_option(:params,:optional) || {}
    server_data=nil
    # if transfer_server_id not provided, get it from command line options
    if !params.has_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')
      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.select{|s|s['id'].eql?(params['transfer_server_id'])}.first
          raise "no such transfer server id: #{params['transfer_server_id']}" if server_data2.nil?
        else
          server_data2=@ats_api_pub.all_servers.select{|s|s['cloud'].eql?(server_data['cloud']) and s['region'].eql?(server_data['region']) and s.has_key?('s3_authentication_endpoint')}.first
          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')
          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=self.options.get_option(:params,:optional) || {'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=self.options.get_option(:value,:mandatory)
    params["id"]=access_key_id
    res=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'])
    return {:type=>:single_object, :data=>api_bss.read('entitlement')[:data]}
  when :delete
    res=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.select {|i| i['id'].start_with?(ak_data['transfer_server_id'])}.first
    raise CliError,"no such server found" if server_data.nil?
    api_node=Rest.new({
      :base_url => server_data['transfer_setup_url'],
      :auth     => {
      :type     => :basic,
      :username => access_key_id,
      :password => self.config.get_secret(access_key_id)}})
    command=self.options.get_next_command(Node::COMMON_ACTIONS)
    return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_node)).execute_action(command)
  when :cluster
    rest_params={
      :base_url => ats_api_pub_v1.params[:base_url],
      :auth     => {
      :type     => :basic,
      :username => access_key_id,
      :password => self.config.get_secret(access_key_id)
      }}
    api_ak_auth=Rest.new(rest_params)
    return {:type=>:single_object, :data=>api_ak_auth.read("servers")[:data]}
  else raise "INTERNAL ERROR"
  end
end

#execute_action_api_key ⇒ Object 



160
161
162
163
164
165
166
167
168
169
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
 
# File 'lib/aspera/cli/plugins/ats.rb', line 160

def execute_action_api_key
  command=self.options.get_next_command([:instances, :create, :list, :show, :delete])
  if [:show,:delete].include?(command)
    concerned_id=self.options.get_option(:id,:mandatory)
  end
  rest_add_header={}
  if !command.eql?(:instances)
    instance=self.options.get_option(:instance,:optional)
    #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}")
    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)
    return {:type=>:value_list, :data=>instances['data'], :name=>'instance'}
  when :create
    create_value=self.options.get_option(:value,:optional)||{}
    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})
    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 #
    res=ats_ibm_api.delete("api_keys/#{concerned_id}")
    return Main.result_status("deleted #{concerned_id}")
  else raise "INTERNAL ERROR"
  end
end

#execute_action_cluster_pub ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/aspera/cli/plugins/ats.rb', line 127

def execute_action_cluster_pub
  command=self.options.get_next_command([ :clouds, :list, :show])
  case command
  when :clouds
    return {:type=>:single_object, :data=>@ats_api_pub.cloud_names, :columns=>['id','name']}
  when :list
    return {:type=>:object_list, :data=>@ats_api_pub.all_servers, :fields=>['id','cloud','region']}
  when :show
    server_id=self.options.get_option(:id,:optional)
    if server_id.nil?
      server_data=server_by_cloud_region
    else
      server_data=@ats_api_pub.all_servers.select {|i| i['id'].eql?(server_id)}.first
      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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/aspera/cli/plugins/ats.rb', line 203

def execute_action_gen(ats_api_arg)
  actions=ACTIONS
  actions.delete(:api_key) unless ats_api_arg.nil?
  command=self.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 = AtsApi.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=>self.options.get_option(:region,:mandatory)})[:data]
    return {:type=>:single_object, :data=>res}
  else raise "ERROR"
  end
end

#server_by_cloud_region ⇒ Object 



24
25
26
27
28
29
 
# File 'lib/aspera/cli/plugins/ats.rb', line 24

def server_by_cloud_region
  # todo: provide list ?
  cloud=self.options.get_option(:cloud,:mandatory).upcase
  region=self.options.get_option(:region,:mandatory)
  return @ats_api_pub.read("servers/#{cloud}/#{region}")[:data]
end