Class: Aspera::Rest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspera/rest.rb

Overview

a simple class to make HTTP calls, equivalent to rest-client rest call errors are raised as exception RestCallError and error are analyzed in RestErrorAnalyzer

Constant Summary collapse

ENTITY_NOT_FOUND =

Error message when entity not found (TODO: use specific exception)

'No such'
MIME_JSON = 
'application/json'
MIME_WWW = 
'application/x-www-form-urlencoded'
MIME_TEXT = 
'text/plain'
MAX_ITEMS =

Special query parameter: max number of items for list command

'max'
MAX_PAGES =

Special query parameter: max number of pages for list command

'pmax'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url:, auth: {type: :none}, not_auth_codes: ['401'], redirect_max: 0, headers: {}) ⇒ Rest

Create a REST object for API calls HTTP sessions parameters can be modified using global parameters in RestParameters For example, TLS verification can be skipped.

Parameters:

  • base_url (String) —

    base URL of REST API

  • auth (Hash) (defaults to: {type: :none}) —

    authentication parameters: :type (:none, :basic, :url, :oauth2) :username [:basic] :password [:basic] :url_query [:url] a hash :* [:oauth2] see OAuth::Factory class

  • not_auth_codes (Array) (defaults to: ['401']) —

    codes that trigger a refresh/regeneration of bearer token

  • redirect_max (Integer) (defaults to: 0) —

    max redirection allowed

  • headers (Hash) (defaults to: {}) —

    default headers to include in all calls



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/aspera/rest.rb', line 260

def initialize(
  base_url:,
  auth: {type: :none},
  not_auth_codes: ['401'],
  redirect_max: 0,
  headers: {}
)
  Aspera.assert_type(base_url, String)
  # base url with no trailing slashes (note: string may be frozen)
  @base_url = base_url.chomp('/')
  # remove trailing port if it is 443 and scheme is https
  @base_url = @base_url.gsub(/:443$/, '') if @base_url.start_with?('https://')
  @base_url = @base_url.gsub(/:80$/, '') if @base_url.start_with?('http://')
  Log.log.debug{"Rest.new(#{@base_url})"}
  # default is no auth
  @auth_params = auth
  Aspera.assert_type(@auth_params, Hash)
  Aspera.assert(@auth_params.key?(:type)){'no auth type defined'}
  @not_auth_codes = not_auth_codes
  Aspera.assert_type(@not_auth_codes, Array)
  # persistent session
  @http_session = nil
  @redirect_max = redirect_max
  Aspera.assert_type(@redirect_max, Integer)
  @headers = headers.clone
  Aspera.assert_type(@headers, Hash)
  @headers['User-Agent'] ||= RestParameters.instance.user_agent
  # OAuth object (created on demand)
  @oauth = nil
end

Instance Attribute Details

#auth_params ⇒ Object (readonly)

All original constructor parameters



228
229
230
 
# File 'lib/aspera/rest.rb', line 228

def auth_params
  @auth_params
end

#base_url ⇒ Object (readonly)

The root URL for the API



231
232
233
 
# File 'lib/aspera/rest.rb', line 231

def base_url
  @base_url
end

#headers ⇒ Object (readonly)

Base common headers of API



234
235
236
 
# File 'lib/aspera/rest.rb', line 234

def headers
  @headers
end

Class Method Details

.basic_authorization(user, pass) ⇒ String

Returns Basic auth token.

Returns:

  • (String) —

    Basic auth token



71
 
# File 'lib/aspera/rest.rb', line 71

def basic_authorization(user, pass); return "Basic #{Base64.strict_encode64("#{user}:#{pass}")}"; end

.build_uri(url, query) ⇒ Object

Build URI from URL and parameters and check it is http or https Check iof php style is specified

Parameters:

  • url (String) —

    The URL without query.

  • query (Hash, Array, String) —

    The query.



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

def build_uri(url, query)
  uri = URI.parse(url)
  Aspera.assert_values(uri.scheme, %w[http https]){'URI scheme'}
  return uri if query.nil? || query.respond_to?(:empty?) && query.empty?
  Log.dump(:query, query)
  uri.query =
    case query
    when String
      query
    when Hash
      URI.encode_www_form(h_to_query_array(query))
    when Array
      Aspera.assert(query.all?{ |i| i.is_a?(Array) && i.length.eql?(2)}){'Query must be array of arrays of 2 elements'}
      URI.encode_www_form(query)
    else Aspera.error_unexpected_value(query.class){'query type'}
    end.gsub('%5B%5D=', '[]=')
  # [] is allowed in url parameters
  uri
end

.h_to_query_array(query) ⇒ Object

Parameters:

  • query (Hash) —

    HTTP query as hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspera/rest.rb', line 106

def h_to_query_array(query)
  Aspera.assert_type(query, Hash)
  # Support array for query parameter, there is no standard.
  # Either p[]=1&p[]=2, or p=1&p=2
  suffix = query.delete(:x_array_php_style) ? '[]' : nil
  query.each_with_object([]) do |(k, v), query_array|
    case v
    when Array
      v.each do |e|
        query_array.push(["#{k}#{suffix}", e])
      end
    else
      query_array.push([k, v])
    end
  end
end

.io_http_session(http_session) ⇒ Object

get Net::HTTP underlying socket i/o little hack, handy because HTTP debug, proxy, etc… will be available used implement web sockets after ‘start_http_session`



164
165
166
167
168
169
170
 
# File 'lib/aspera/rest.rb', line 164

def io_http_session(http_session)
  Aspera.assert_type(http_session, Net::HTTP)
  # Net::BufferedIO in net/protocol.rb
  result = http_session.instance_variable_get(:@socket)
  Aspera.assert(!result.nil?){"no socket for #{http_session}"}
  return result
end

.parse_header(header) ⇒ Hash

Parses an HTTP Content-Type header string into its media type and parameters according to RFC 9110 and RFC 6838. TODO: use gem: content_type

Parameters:

  • header (String) —

    The Content-Type header string, e.g., “application/json; charset=utf-8”

Returns:

  • (Hash) —

    A hash with :type and :parameters keys. Example:

    {
  type: "application/json",
  parameters: {
    charset: "utf-8",
    version: "1.0"
  }
}



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/aspera/rest.rb', line 203

def parse_header(header)
  parts = header.split(';').map(&:strip)
  media_type = parts.shift.downcase
  parameters = parts.filter_map do |param|
    key, value = param.split('=', 2)
    next unless key && value
    key = key.strip.downcase.to_sym
    value = value.strip.gsub(/\A"|"\z/, '')
    [key, value]
  end.to_h
  {type: media_type, parameters: parameters}
end

.php_style(query) ⇒ Object

Indicate that the given Hash query uses php style for array parameters a[]=1&a=2



75
76
77
78
79
 
# File 'lib/aspera/rest.rb', line 75

def php_style(query)
  Aspera.assert_type(query, Hash){'query'}
  query[:x_array_php_style] = true
  query
end

.query_to_h(query) ⇒ Hash

Decode query string as Hash if parameter is only once, then it’s a scalar if a parameter is several, then it’s array if parameter has [] then it’s an array, and [] is removed Support arrays in query string, e.g. PHP’s way is p[]=1&p=2

Parameters:

  • query (String) —

    query string as in URI.query

Returns:

  • (Hash) —

    decoded query



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/aspera/rest.rb', line 130

def query_to_h(query)
  URI.decode_www_form(query).each_with_object({}) do |(key, value), h|
    if key.end_with?('[]')
      key = key[..-3]
      h[key] = [] unless h.key?(key)
    end
    if h.key?(key)
      h[key] = [h[key]] if !h[key].is_a?(Array)
      h[key].push(value)
    else
      h[key] = value
    end
  end
end

.remote_certificate_chain(url, as_string: true) ⇒ String

Returns PEM certificates of remote server.

Returns:

  • (String) —

    PEM certificates of remote server



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/aspera/rest.rb', line 173

def remote_certificate_chain(url, as_string: true)
  result = []
  # initiate a session to retrieve remote certificate
  http_session = Rest.start_http_session(url)
  begin
    # retrieve underlying openssl socket
    result = Rest.io_http_session(http_session).io.peer_cert_chain
  rescue
    result = http_session.peer_cert
  ensure
    http_session.finish
  end
  result = result.map(&:to_pem).join("\n") if as_string
  return result
end

.start_http_session(base_url) ⇒ Net::HTTP

Start a HTTP/S session, also used for web sockets

Parameters:

  • base_url (String) —

    base url of HTTP/S session

Returns:

  • (Net::HTTP) —

    a started HTTP session



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/aspera/rest.rb', line 148

def start_http_session(base_url)
  uri = URI.parse(base_url)
  Aspera.assert_values(uri.scheme, %w[http https]){'URI scheme'}
  # This honors http_proxy env var
  http_session = Net::HTTP.new(uri.host, uri.port)
  http_session.use_ssl = uri.scheme.eql?('https')
  # Set http options in callback, such as timeout and cert. verification
  RestParameters.instance.session_cb&.call(http_session)
  # Manually start session for keep alive (if supported by server, else, session is closed every time)
  http_session.start
  return http_session
end

Instance Method Details

#call(operation:, subpath: nil, query: nil, content_type: nil, body: nil, headers: nil, save_to_file: nil, exception: true) ⇒ Object

HTTP/S REST call

Parameters:

  • operation (String) —

    HTTP operation (GET, POST, PUT, DELETE)

  • subpath (String) (defaults to: nil) —

    subpath of REST API

  • query (Hash) (defaults to: nil) —

    URL parameters

  • content_type (String, nil) (defaults to: nil) —

    Type of body parameters (one of MIME_*) and serialization, else use headers

  • body (Hash, String) (defaults to: nil) —

    body parameters

  • headers (Hash) (defaults to: nil) —

    additional headers (override Content-Type)

  • save_to_file (filepath) (defaults to: nil)
  • exception (bool) (defaults to: true) —

    true, error raise exception



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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/aspera/rest.rb', line 311

def call(
  operation:,
  subpath: nil,
  query: nil,
  content_type: nil,
  body: nil,
  headers: nil,
  save_to_file: nil,
  exception: true
)
  subpath = subpath.to_s if subpath.is_a?(Symbol)
  subpath = '' if subpath.nil?
  Log.log.debug{"call #{operation} [#{subpath}]".red.bold.bg_green}
  Log.dump(:body, body, level: :trace1)
  Log.dump(:query, query, level: :trace1)
  Log.dump(:headers, headers, level: :trace1)
  Aspera.assert_type(subpath, String)
  if headers.nil?
    headers = @headers.clone
  else
    h = headers
    headers = @headers.clone
    headers.merge!(h)
  end
  Aspera.assert_type(headers, Hash)
  case @auth_params[:type]
  when :none
    # no auth
  when :basic
    Log.log.debug('using Basic auth')
    # done in build_req
  when :oauth2
    headers['Authorization'] = oauth.authorization unless headers.key?('Authorization')
  when :url
    query ||= {}
    @auth_params[:url_query].each do |key, value|
      query[key] = value
    end
  else Aspera.error_unexpected_value(@auth_params[:type])
  end
  result = {http: nil}
  # start a block to be able to retry the actual HTTP request in case of OAuth token expiration
  begin
    # TODO: shall we percent encode subpath (spaces) test with access key delete with space in id
    # URI.escape()
    separator = ['', '/'].include?(subpath) ? '' : '/'
    uri = self.class.build_uri("#{@base_url}#{separator}#{subpath}", query)
    Log.log.debug{"URI=#{uri}"}
    begin
      # instantiate request object based on string name
      req = Net::HTTP.const_get(operation.capitalize).new(uri)
    rescue NameError
      raise "unsupported operation : #{operation}"
    end
    case content_type
    when nil # ignore
    when MIME_JSON
      req.body = JSON.generate(body) # , ascii_only: true
      req['Content-Type'] = MIME_JSON
    when MIME_WWW
      req.body = URI.encode_www_form(body)
      req['Content-Type'] = MIME_WWW
    when MIME_TEXT
      req.body = body
      req['Content-Type'] = MIME_TEXT
    else Aspera.error_unexpected_value(content_type){'body type'}
    end
    # set headers
    headers.each do |key, value|
      req[key] = value
    end
    # :type = :basic
    req.basic_auth(@auth_params[:username], @auth_params[:password]) if @auth_params[:type].eql?(:basic)
    Log.dump(:req_body, req.body, level: :trace1)
    # we try the call, and will retry on some error types
    error_tries ||= 1 + RestParameters.instance.retry_max
    # initialize with number of initial retries allowed, nil gives zero
    tries_remain_redirect = @redirect_max if tries_remain_redirect.nil?
    Log.log.debug("send request (retries=#{tries_remain_redirect})")
    result_mime = nil
    file_saved = false
    # make http request (pipelined)
    http_session.request(req) do |response|
      result[:http] = response
      result_mime = self.class.parse_header(result[:http]['Content-Type'] || MIME_TEXT)[:type]
      Log.log.debug{"response: code=#{result[:http].code}, mime=#{result_mime}, mime2= #{response['Content-Type']}"}
      # JSON data needs to be parsed, in case it contains an error code
      if !save_to_file.nil? &&
          result[:http].code.to_s.start_with?('2') &&
          !JSON_DECODE.include?(result_mime)
        total_size = result[:http]['Content-Length']&.to_i
        Log.log.debug('before write file')
        target_file = save_to_file
        # override user's path to path in header
        if !response['Content-Disposition'].nil?
          disposition = self.class.parse_header(response['Content-Disposition'])
          target_file = File.join(File.dirname(target_file), disposition[:parameters][:filename]) if disposition[:parameters].key?(:filename) && !disposition[:parameters][:filename].eql?('.')
        end
        # download with temp filename
        target_file_tmp = "#{target_file}#{RestParameters.instance.download_partial_suffix}"
        Log.log.debug{"saving to: #{target_file}"}
        written_size = 0
        session_id = SecureRandom.uuid.freeze
        RestParameters.instance.progress_bar&.event(:session_start, session_id: session_id)
        RestParameters.instance.progress_bar&.event(:session_size, session_id: session_id, info: total_size) if total_size
        FileUtils.mkdir_p(File.dirname(target_file_tmp))
        limiter = TimerLimiter.new(0.5)
        File.open(target_file_tmp, 'wb') do |file|
          result[:http].read_body do |fragment|
            file.write(fragment)
            written_size += fragment.length
            RestParameters.instance.progress_bar&.event(:transfer, session_id: session_id, info: written_size) if limiter.trigger?
          end
        end
        RestParameters.instance.progress_bar&.event(:session_end, session_id: session_id)
        RestParameters.instance.progress_bar&.event(:end)
        # rename at the end
        File.rename(target_file_tmp, target_file)
        file_saved = true
      end
    end
    Log.log.debug{"result: code=#{result[:http].code} mime=#{result_mime}"}
    # sometimes there is a UTF8 char (e.g. (c) ), TODO : related to mime type encoding ?
    # result[:http].body.force_encoding('UTF-8') if result[:http].body.is_a?(String)
    # Log.log.debug{"result: body=#{result[:http].body}"}
    case result_mime
    when *JSON_DECODE
      result[:data] = JSON.parse(result[:http].body) rescue result[:http].body
      Log.dump(:result_data, result[:data])
    else # when MIME_TEXT
      result[:data] = result[:http].body
    end
    RestErrorAnalyzer.instance.raise_on_error(req, result)
    unless file_saved || save_to_file.nil?
      FileUtils.mkdir_p(File.dirname(save_to_file))
      File.write(save_to_file, result[:http].body, binmode: true)
    end
  rescue RestCallError => e
    do_retry = false
    # AoC have some timeout , like Connect to platform.bss.asperasoft.com:443 ...
    do_retry ||= true if e.response.body.include?('failed: connect timed out') && RestParameters.instance.retry_on_timeout
    # AoC sometimes not available
    do_retry ||= true if RestParameters.instance.retry_on_unavailable && UNAVAILABLE_CODES.include?(result[:http].code.to_s)
    # possibility to retry anything if it fails
    do_retry ||= true if RestParameters.instance.retry_on_error
    # not authorized: oauth token expired
    if @not_auth_codes.include?(result[:http].code.to_s) && @auth_params[:type].eql?(:oauth2)
      begin
        # try to use refresh token
        req['Authorization'] = oauth.authorization(refresh: true)
      rescue RestCallError => e_tok
        e = e_tok
        Log.log.error('refresh failed'.bg_red)
        # regenerate a brand new token
        req['Authorization'] = oauth.authorization(cache: false)
      end
      Log.log.debug{"using new token=#{headers['Authorization']}"}
      do_retry ||= true
    end
    if do_retry && (error_tries -= 1).positive?
      sleep(RestParameters.instance.retry_sleep) unless RestParameters.instance.retry_sleep.eql?(0)
      retry
    end
    # redirect ? (any code beginning with 3)
    if e.response.is_a?(Net::HTTPRedirection) && tries_remain_redirect.positive?
      tries_remain_redirect -= 1
      current_uri = URI.parse(@base_url)
      new_url = e.response['Location']
      # special case: relative redirect
      if URI.parse(new_url).host.nil?
        # we don't manage relative redirects with non-absolute path
        Aspera.assert(new_url.start_with?('/')){"redirect location is relative: #{new_url}, but does not start with /."}
        new_url = "#{current_uri.scheme}://#{current_uri.host}#{new_url}"
      end
      # forwards the request to the new location
      return self.class.new(
        base_url: new_url,
        redirect_max: tries_remain_redirect
      ).call(
        operation: operation,
        subpath: new_url.end_with?('/') ? '/' : nil,
        query: query,
        body: body,
        content_type: content_type,
        save_to_file: save_to_file,
        exception: exception,
        headers: headers
      )
    end
    # raise exception if could not retry and not return error in result
    raise e if exception
  end
  Log.log.debug{"result=http:#{result[:http]}, data:#{result[:data].class}"}
  return result
end

#cancel(subpath, **kwargs) ⇒ Object

Cancel: ‘CANCEL`



533
534
535
 
# File 'lib/aspera/rest.rb', line 533

def cancel(subpath, **kwargs)
  return call(operation: 'CANCEL', subpath: subpath, headers: {'Accept' => MIME_JSON}, **kwargs)[:data]
end

#create(subpath, params, **kwargs) ⇒ Object

Create: ‘POST`



513
514
515
 
# File 'lib/aspera/rest.rb', line 513

def create(subpath, params, **kwargs)
  return call(operation: 'POST', subpath: subpath, headers: {'Accept' => MIME_JSON}, body: params, content_type: MIME_JSON, **kwargs)[:data]
end

#delete(subpath, params = nil, **kwargs) ⇒ Object

Delete: ‘DELETE`



528
529
530
 
# File 'lib/aspera/rest.rb', line 528

def delete(subpath, params = nil, **kwargs)
  return call(operation: 'DELETE', subpath: subpath, headers: {'Accept' => MIME_JSON}, query: params, **kwargs)[:data]
end

#lookup_by_name(subpath, search_name, query: nil) ⇒ Object

Query entity by general search (read with parameter ‘q`) TODO: not generic enough ? move somewhere ? inheritance ?

Parameters:

  • subpath (String) —

    Path of entity in API

  • search_name (String) —

    Name of searched entity

  • query (Hash) (defaults to: nil) —

    Additional search query parameters



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/aspera/rest.rb', line 543

def lookup_by_name(subpath, search_name, query: nil)
  query = {} if query.nil?
  # returns entities matching the query (it matches against several fields in case insensitive way)
  matching_items = read(subpath, query.merge({'q' => search_name}))
  # API style: {totalcount:, ...} cspell: disable-line
  matching_items = matching_items[subpath] if matching_items.is_a?(Hash)
  Aspera.assert_type(matching_items, Array)
  case matching_items.length
  when 1 then return matching_items.first
  when 0 then raise %Q{#{ENTITY_NOT_FOUND} #{subpath}: "#{search_name}"}
  else
    # multiple case insensitive partial matches, try case insensitive full match
    # (anyway AoC does not allow creation of 2 entities with same case insensitive name)
    name_matches = matching_items.select{ |i| i['name'].casecmp?(search_name)}
    case name_matches.length
    when 1 then return name_matches.first
    when 0 then raise %Q(#{subpath}: Multiple case insensitive partial match for: "#{search_name}": #{matching_items.map{ |i| i['name']}} but no case insensitive full match. Please be more specific or give exact name.)
    else raise "Two entities cannot have the same case insensitive name: #{name_matches.map{ |i| i['name']}}"
    end
  end
end

#oauth ⇒ Object

Returns the OAuth object (create, or cached if already created).

Returns:

  • the OAuth object (create, or cached if already created)



292
293
294
295
296
297
298
299
300
 
# File 'lib/aspera/rest.rb', line 292

def oauth
  if @oauth.nil?
    Aspera.assert(@auth_params[:type].eql?(:oauth2)){'no OAuth defined'}
    oauth_parameters = @auth_params.reject{ |k, _v| k.eql?(:type)}
    Log.dump(:oauth_parameters, oauth_parameters)
    @oauth = OAuth::Factory.instance.create(**oauth_parameters)
  end
  return @oauth
end

#params ⇒ Object

Returns creation parameters.

Returns:

  • creation parameters



237
238
239
240
241
242
243
244
245
 
# File 'lib/aspera/rest.rb', line 237

def params
  return {
    base_url:       @base_url,       # String
    auth:           @auth_params,    # Hash
    not_auth_codes: @not_auth_codes, # Array
    redirect_max:   @redirect_max,   # Integer
    headers:        @headers         # Hash
  }
end

#read(subpath, query = nil, **kwargs) ⇒ Object

Read: ‘GET`



518
519
520
 
# File 'lib/aspera/rest.rb', line 518

def read(subpath, query = nil, **kwargs)
  return call(operation: 'GET', subpath: subpath, headers: {'Accept' => MIME_JSON}, query: query, **kwargs)[:data]
end

#update(subpath, params, **kwargs) ⇒ Object

Update: ‘PUT`



523
524
525
 
# File 'lib/aspera/rest.rb', line 523

def update(subpath, params, **kwargs)
  return call(operation: 'PUT', subpath: subpath, headers: {'Accept' => MIME_JSON}, body: params, content_type: MIME_JSON, **kwargs)[:data]
end