Class: Aspera::Api::Node

Inherits:
Rest
  • Object
show all
Defined in:
lib/aspera/api/node.rb

Overview

Provides additional functions using node API with gen4 extensions (access keys)

Direct Known Subclasses

CosNode

Constant Summary collapse

ACCESS_LEVELS =

node api permissions

%w[delete list mkdir preview read rename write].freeze
HEADER_X_ASPERA_ACCESS_KEY = 
'X-Aspera-AccessKey'
HEADER_X_TOTAL_COUNT = 
'X-Total-Count'
SCOPE_USER = 
'user:all'
SCOPE_ADMIN = 
'admin:all'
PATH_SEPARATOR = 
'/'

Constants inherited from Rest

Rest::ENTITY_NOT_FOUND, Rest::JSON_DECODE

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from Rest

#auth_params, #base_url

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rest

array_params, array_params?, basic_token, build_uri, #call, #cancel, #create, decode_query, #delete, io_http_session, #lookup_by_name, #oauth, #params, parse_header, #read, remote_certificate_chain, set_parameters, start_http_session, #update, user_agent

Constructor Details

#initialize(app_info: nil, add_tspec: nil, **rest_args) ⇒ Node

Returns a new instance of Node.

Parameters:

  • app_info (Hash, NilClass) (defaults to: nil) —

    Special processing for AoC

  • add_tspec (Hash, NilClass) (defaults to: nil) —

    Additional transfer spec

  • base_url (String) —

    Rest parameters

  • auth (String, NilClass) —

    Rest parameters

  • headers (String, NilClass) —

    Rest parameters



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/aspera/api/node.rb', line 132

def initialize(app_info: nil, add_tspec: nil, **rest_args)
  # init Rest
  super(**rest_args)
  @app_info = app_info
  # this is added to transfer spec, for instance to add tags (COS)
  @add_tspec = add_tspec
  @std_t_spec_cache = nil
  if !@app_info.nil?
    REQUIRED_APP_INFO_FIELDS.each do |field|
      Aspera.assert(@app_info.key?(field)){"app_info lacks field #{field}"}
    end
    REQUIRED_APP_API_METHODS.each do |method|
      Aspera.assert(@app_info[:api].respond_to?(method)){"#{@app_info[:api].class} lacks method #{method}"}
    end
  end
end

Class Attribute Details

.use_standard_ports ⇒ Object

Returns the value of attribute use_standard_ports.



47
48
49
 
# File 'lib/aspera/api/node.rb', line 47

def use_standard_ports
  @use_standard_ports
end

Instance Attribute Details

#app_info ⇒ Object (readonly)

Returns the value of attribute app_info.



125
126
127
 
# File 'lib/aspera/api/node.rb', line 125

def app_info
  @app_info
end

Class Method Details

.bearer_headers(bearer_auth, access_key: nil) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/aspera/api/node.rb', line 112

def bearer_headers(bearer_auth, access_key: nil)
  # if username is not provided, use the access key from the token
  if access_key.nil?
    access_key = Node.decode_scope(Node.decode_bearer_token(OAuth::Factory.bearer_extract(bearer_auth))['scope'])[:access_key]
    Aspera.assert(!access_key.nil?)
  end
  return {
    Node::HEADER_X_ASPERA_ACCESS_KEY => access_key,
    'Authorization'                  => bearer_auth
  }
end

.bearer_token(access_key:, payload:, private_key:) ⇒ Object

Create an Aspera Node bearer token

Parameters:

  • payload (String) —

    JSON payload to be included in the token

  • private_key (OpenSSL::PKey::RSA) —

    Private key to sign the token



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aspera/api/node.rb', line 85

def bearer_token(access_key:, payload:, private_key:)
  Aspera.assert_type(payload, Hash)
  Aspera.assert(payload.key?('user_id'))
  Aspera.assert_type(payload['user_id'], String)
  Aspera.assert(!payload['user_id'].empty?)
  Aspera.assert_type(private_key, OpenSSL::PKey::RSA)
  # manage convenience parameters
  expiration_sec = payload['_validity'] || BEARER_TOKEN_VALIDITY_DEFAULT
  payload.delete('_validity')
  scope = payload['_scope'] || SCOPE_USER
  payload.delete('_scope')
  payload['scope'] ||= token_scope(access_key, scope)
  payload['auth_type'] ||= 'access_key'
  payload['expires_at'] ||= (Time.now + expiration_sec).utc.strftime('%FT%TZ')
  payload_json = JSON.generate(payload)
  return Base64.strict_encode64(Zlib::Deflate.deflate([
    payload_json,
    SIGNATURE_DELIMITER,
    Base64.strict_encode64(private_key.sign(OpenSSL::Digest.new('sha512'), payload_json)).scan(/.{1,60}/).join("\n"),
    ''
  ].join("\n")))
end

.decode_bearer_token(token) ⇒ Object 



108
109
110
 
# File 'lib/aspera/api/node.rb', line 108

def decode_bearer_token(token)
  return JSON.parse(Zlib::Inflate.inflate(Base64.decode64(token)).partition(SIGNATURE_DELIMITER).first)
end

.decode_scope(scope) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/aspera/api/node.rb', line 75

def decode_scope(scope)
  items = scope.split(SCOPE_SEPARATOR, 2)
  Aspera.assert(items.length.eql?(2)){"invalid scope: #{scope}"}
  Aspera.assert(items[0].start_with?(SCOPE_NODE_PREFIX)){"invalid scope: #{scope}"}
  return {access_key: items[0][SCOPE_NODE_PREFIX.length..-1], scope: items[1]}
end

.file_matcher(match_expression) ⇒ Object

For access keys: provide expression to match entry in folder



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/aspera/api/node.rb', line 50

def file_matcher(match_expression)
  case match_expression
  when Proc then return match_expression
  when Regexp then return ->(f){f['name'].match?(match_expression)}
  when String
    if match_expression.start_with?(MATCH_EXEC_PREFIX)
      code = "->(f){#{match_expression[MATCH_EXEC_PREFIX.length..-1]}}"
      Log.log.warn{"Use of prefix #{MATCH_EXEC_PREFIX} is deprecated (4.15), instead use: @ruby:'#{code}'"}
      return Environment.secure_eval(code, __FILE__, __LINE__)
    end
    return lambda{|f|File.fnmatch(match_expression, f['name'], File::FNM_DOTMATCH)}
  when NilClass then return ->(_){true}
  else Aspera.error_unexpected_value(match_expression.class.name, exception_class: Cli::BadArgument)
  end
end

.file_matcher_from_argument(options) ⇒ Object 



66
67
68
 
# File 'lib/aspera/api/node.rb', line 66

def file_matcher_from_argument(options)
  return file_matcher(options.get_next_argument('filter', validation: MATCH_TYPES, mandatory: false))
end

.token_scope(access_key, scope) ⇒ Object

node API scopes



71
72
73
 
# File 'lib/aspera/api/node.rb', line 71

def token_scope(access_key, scope)
  return [SCOPE_NODE_PREFIX, access_key, SCOPE_SEPARATOR, scope].join('')
end

Instance Method Details

#add_tspec_info(tspec) ⇒ Object

update transfer spec with special additional tags



150
151
152
153
 
# File 'lib/aspera/api/node.rb', line 150

def add_tspec_info(tspec)
  tspec.deep_merge!(@add_tspec) unless @add_tspec.nil?
  return tspec
end

#entry_has_link_information(entry) ⇒ Boolean

Check if a link entry in folder has target information

Parameters:

  • entry (Hash) —

    entry in folder

Returns:

  • (Boolean) —

    true if target information is available



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspera/api/node.rb', line 171

def entry_has_link_information(entry)
  # if target information is missing in folder, try to get it on entry
  if entry['target_node_id'].nil? || entry['target_id'].nil?
    link_entry = read("files/#{entry['id']}")[:data]
    entry['target_node_id'] = link_entry['target_node_id']
    entry['target_id'] = link_entry['target_id']
  end
  return true unless entry['target_node_id'].nil? || entry['target_id'].nil?
  Log.log.warn{"Missing target information for link: #{entry['name']}"}
  return false
end

#find_files(top_file_id, test_block) ⇒ Object 



250
251
252
253
254
255
 
# File 'lib/aspera/api/node.rb', line 250

def find_files(top_file_id, test_block)
  Log.log.debug{"find_files: file id=#{top_file_id}"}
  find_state = {found: [], test_block: test_block}
  process_folder_tree(method_sym: :process_find_files, state: find_state, top_file_id: top_file_id)
  return find_state[:found]
end

#node_id_to_node(node_id) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/aspera/api/node.rb', line 156

def node_id_to_node(node_id)
  if !@app_info.nil?
    return self if node_id.eql?(@app_info[:node_info]['id'])
    return @app_info[:api].node_api_from(
      node_id: node_id,
      workspace_id: @app_info[:workspace_id],
      workspace_name: @app_info[:workspace_name])
  end
  Log.log.warn{"Cannot resolve link with node id #{node_id}, no resolver"}
  return nil
end

#process_folder_tree(method_sym:, state:, top_file_id:, top_file_path: '/') ⇒ Object

Recursively browse in a folder (with non-recursive method) sub folders are processed if the processing method returns true links are processed on the respective node

Parameters:

  • state (Object) —

    state object sent to processing method

  • top_file_id (String) —

    file id to start at (default = access key root file id)

  • top_file_path (String) (defaults to: '/') —

    path of top folder (default = /)

  • block (Proc) —

    processing method, arguments: entry, path, state



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/aspera/api/node.rb', line 190

def process_folder_tree(method_sym:, state:, top_file_id:, top_file_path: '/')
  Aspera.assert(!top_file_path.nil?){'top_file_path not set'}
  Log.log.debug{"process_folder_tree: node=#{@app_info ? @app_info[:node_info]['id'] : 'nil'}, file id=#{top_file_id},  path=#{top_file_path}"}
  # start at top folder
  folders_to_explore = [{id: top_file_id, path: top_file_path}]
  Log.log.debug{Log.dump(:folders_to_explore, folders_to_explore)}
  until folders_to_explore.empty?
    # consume first in job list
    current_item = folders_to_explore.shift
    Log.log.debug{"Exploring #{current_item[:path]}".bg_green}
    # get folder content
    folder_contents =
      begin
        read("files/#{current_item[:id]}/files")[:data]
      rescue StandardError => e
        Log.log.warn{"#{current_item[:path]}: #{e.class} #{e.message}"}
        []
      end
    Log.log.debug{Log.dump(:folder_contents, folder_contents)}
    folder_contents.each do |entry|
      relative_path = File.join(current_item[:path], entry['name'])
      Log.log.debug{"process_folder_tree: checking #{relative_path}"}
      # call block, continue only if method returns true
      next unless send(method_sym, entry, relative_path, state)
      # entry type is file, folder or link
      case entry['type']
      when 'folder'
        folders_to_explore.push({id: entry['id'], path: relative_path})
      when 'link'
        if entry_has_link_information(entry)
          node_id_to_node(entry['target_node_id'])&.process_folder_tree(
            method_sym:    method_sym,
            state:         state,
            top_file_id:   entry['target_id'],
            top_file_path: relative_path)
        end
      end
    end
  end
end

#refreshed_transfer_token ⇒ Object 



257
258
259
 
# File 'lib/aspera/api/node.rb', line 257

def refreshed_transfer_token
  return oauth.token(refresh: true)
end

#resolve_api_fid(top_file_id, path) ⇒ Hash

Navigate the path from given file id

Parameters:

  • top_file_id (String) —

    id initial file id

  • path (String) —

    file path

Returns:

  • (Hash) —

    Aspera::Api::Node.api,.api,.file_id



235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/aspera/api/node.rb', line 235

def resolve_api_fid(top_file_id, path)
  Aspera.assert_type(top_file_id, String)
  Aspera.assert_type(path, String)
  # if last element is a link and followed by "/", we list the content of that folder, else we return the link
  process_last_link = path.end_with?(PATH_SEPARATOR)
  # keep only non-empty elements
  path_elements = path.split(PATH_SEPARATOR).reject(&:empty?)
  return {api: self, file_id: top_file_id} if path_elements.empty?
  resolve_state = {path: path_elements, result: nil, process_last_link: process_last_link}
  process_folder_tree(method_sym: :process_api_fid, state: resolve_state, top_file_id: top_file_id)
  raise "entry not found: #{resolve_state[:path]}" if resolve_state[:result].nil?
  Log.log.debug{"resolve_api_fid: #{path} -> #{resolve_state[:result][:api].base_url} #{resolve_state[:result][:file_id]}"}
  return resolve_state[:result]
end

#transfer_spec_gen4(file_id, direction, ts_merge = nil) ⇒ Object

Create transfer spec for gen4



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aspera/api/node.rb', line 278

def transfer_spec_gen4(file_id, direction, ts_merge=nil)
  ak_name = nil
  ak_token = nil
  case auth_params[:type]
  when :basic
    ak_name = auth_params[:username]
    Aspera.assert(auth_params[:password]){'no secret in node object'}
    ak_token = Rest.basic_token(auth_params[:username], auth_params[:password])
  when :oauth2
    ak_name = params[:headers][HEADER_X_ASPERA_ACCESS_KEY]
    # TODO: token_generation_lambda = lambda{|do_refresh|oauth.token(refresh: do_refresh)}
    # get bearer token, possibly use cache
    ak_token = oauth.token
  else Aspera.error_unexpected_value(auth_params[:type])
  end
  transfer_spec = {
    'direction' => direction,
    'token'     => ak_token,
    'tags'      => {
      Transfer::Spec::TAG_RESERVED => {
        'node' => {
          'access_key' => ak_name,
          'file_id'    => file_id
        } # node
      } # aspera
    } # tags
  }
  # add specials tags (cos)
  add_tspec_info(transfer_spec)
  transfer_spec.deep_merge!(ts_merge) unless ts_merge.nil?
  # add application specific tags (AoC)
  app_info[:api].add_ts_tags(transfer_spec: transfer_spec, app_info: app_info) unless app_info.nil?
  # add remote host info
  if self.class.use_standard_ports
    # get default TCP/UDP ports and transfer user
    transfer_spec.merge!(Transfer::Spec::AK_TSPEC_BASE)
    # by default: same address as node API
    transfer_spec['remote_host'] = URI.parse(base_url).host
    # AoC allows specification of other url
    if !@app_info.nil? && !@app_info[:node_info]['transfer_url'].nil? && !@app_info[:node_info]['transfer_url'].empty?
      transfer_spec['remote_host'] = @app_info[:node_info]['transfer_url']
    end
    info = read('info')[:data]
    # get the transfer user from info on access key
    transfer_spec['remote_user'] = info['transfer_user'] if info['transfer_user']
    # get settings from name.value array to hash key.value
    settings = info['settings']&.each_with_object({}){|i, h|h[i['name']] = i['value']}
    # check WSS ports
    %w[wss_enabled wss_port].each do |i|
      transfer_spec[i] = settings[i] if settings.key?(i)
    end if settings.is_a?(Hash)
  else
    transfer_spec.merge!(transport_params)
  end
  Log.log.warn{"Expected transfer user: #{Transfer::Spec::ACCESS_KEY_TRANSFER_USER}, but have #{transfer_spec['remote_user']}"} \
    unless transfer_spec['remote_user'].eql?(Transfer::Spec::ACCESS_KEY_TRANSFER_USER)
  return transfer_spec
end

#transport_params ⇒ Object

Returns part of transfer spec with transport parameters only.

Returns:

  • part of transfer spec with transport parameters only



262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aspera/api/node.rb', line 262

def transport_params
  if @std_t_spec_cache.nil?
    # retrieve values from API (and keep a copy/cache)
    full_spec = create(
      'files/download_setup',
      {transfer_requests: [{transfer_request: {paths: [{source: '/'}]}}]}
    )[:data]['transfer_specs'].first['transfer_spec']
    # set available fields
    @std_t_spec_cache = Transfer::Spec::TRANSPORT_FIELDS.each_with_object({}) do |i, h|
      h[i] = full_spec[i] if full_spec.key?(i)
    end
  end
  return @std_t_spec_cache
end