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

Direct Known Subclasses

Api::Alee, Api::AoC, Api::Ats, Api::Httpgw, Api::Node

Constant Summary collapse

ENTITY_NOT_FOUND =

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

'No such'
JSON_DECODE =

Content-Type that are JSON

['application/json', 'application/vnd.api+json', 'application/x-javascript'].freeze
@@global =

Global settings also valid for any subclass

{ # rubocop:disable Style/ClassVars
  user_agent:              'RubyAsperaRest',
  download_partial_suffix: '.http_partial',
  session_cb:              nil,
  progress_bar:            nil
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url:, auth: nil, not_auth_codes: nil, redirect_max: 0, headers: nil) ⇒ Rest

Returns a new instance of Rest.

Parameters:

  • base_url (String) —

    base URL of REST API

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

    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: nil) —

    codes that trigger a refresh/regeneration of bearer token

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

    max redirection allowed



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
230
231
232
 
# File 'lib/aspera/rest.rb', line 204

def initialize(
  base_url:,
  auth: nil,
  not_auth_codes: nil,
  redirect_max: 0,
  headers: nil
)
  Aspera.assert_type(base_url, String)
  # base url with no trailing slashes (note: string may be frozen)
  @base_url = base_url.gsub(%r{/+$}, '')
  # 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.nil? ? {type: :none} : auth
  Aspera.assert_type(@auth_params, Hash)
  Aspera.assert(@auth_params.key?(:type)){'no auth type defined'}
  @not_auth_codes = not_auth_codes.nil? ? ['401'] : not_auth_codes
  Aspera.assert_type(@not_auth_codes, Array)
  # persistent session
  @http_session = nil
  # OAuth object (created on demand)
  @oauth = nil
  @redirect_max = redirect_max
  @headers = headers.nil? ? {} : headers
  Aspera.assert_type(@headers, Hash)
  @headers['User-Agent'] ||= @@global[:user_agent]
end

Instance Attribute Details

#auth_params ⇒ Object (readonly)

Returns the value of attribute auth_params.



182
183
184
 
# File 'lib/aspera/rest.rb', line 182

def auth_params
  @auth_params
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



183
184
185
 
# File 'lib/aspera/rest.rb', line 183

def base_url
  @base_url
end

Class Method Details

.array_params(values) ⇒ Object

Build a parameter list prefixed with “[]”

Parameters:

  • values (Array) —

    list of values



56
57
58
 
# File 'lib/aspera/rest.rb', line 56

def array_params(values)
  return [ARRAY_PARAMS].concat(values)
end

.array_params?(values) ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/aspera/rest.rb', line 60

def array_params?(values)
  return values.first.eql?(ARRAY_PARAMS)
end

.basic_token(user, pass) ⇒ String

Returns Basic auth token.

Returns:

  • (String) —

    Basic auth token



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

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

.build_uri(url, query_hash = nil) ⇒ Object

Build URI from URL and parameters and check it is http or https, encode array [] parameters



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aspera/rest.rb', line 65

def build_uri(url, query_hash=nil)
  uri = URI.parse(url)
  Aspera.assert(%w[http https].include?(uri.scheme)){"REST endpoint shall be http/s not #{uri.scheme}"}
  return uri if query_hash.nil?
  Log.log.debug{Log.dump('query', query_hash)}
  Aspera.assert_type(query_hash, Hash)
  return uri if query_hash.empty?
  query = []
  query_hash.each do |k, v|
    case v
    when Array
      # support array for query parameter, there is no standard. Either p[]=1&p[]=2, or p=1&p=2
      suffix = array_params?(v) ? v.shift : ''
      v.each do |e|
        query.push(["#{k}#{suffix}", e])
      end
    else
      query.push([k, v])
    end
  end
  # [] is allowed in url parameters
  uri.query = URI.encode_www_form(query).gsub('%5B%5D=', '[]=')
  return uri
end

.decode_query(query) ⇒ Hash

decode query string as hash Does not support arrays in query string, no standard, e.g. PHP’s way is p[]=1&p=2

Parameters:

  • query (String) —

    query string

Returns:

  • (Hash) —

    decoded query



94
95
96
97
98
99
100
 
# File 'lib/aspera/rest.rb', line 94

def decode_query(query)
  URI.decode_www_form(query).each_with_object({}) do |pair, h|
    key = pair.first
    raise "Array not supported in query string: #{key}" if key.include?('[]') || h.key?(key)
    h[key] = pair.last
  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`



120
121
122
123
124
125
126
 
# File 'lib/aspera/rest.rb', line 120

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) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/aspera/rest.rb', line 158

def parse_header(header)
  type, *params = header.split(/;\s*/)
  parameters = params.map do |param|
    one = param.split(/=\s*/)
    one[0] = one[0].to_sym
    one[1] = one[1].gsub(/\A"|"\z/, '')
    one
  end.to_h
  { type: type.downcase, parameters: parameters }
end

.remote_certificate_chain(url, as_string: true) ⇒ String

Returns PEM certificates of remote server.

Returns:

  • (String) —

    PEM certificates of remote server



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

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

.set_parameters(**options) ⇒ Object

set global parameters



146
147
148
149
150
151
 
# File 'lib/aspera/rest.rb', line 146

def set_parameters(**options)
  options.each do |key, value|
    Aspera.assert(@@global.key?(key)){"Unknown Rest option #{key}"}
    @@global[key] = value
  end
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



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/aspera/rest.rb', line 105

def start_http_session(base_url)
  uri = build_uri(base_url)
  # 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
  @@global[: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

.user_agent ⇒ String

Returns HTTP agent name.

Returns:

  • (String) —

    HTTP agent name



154
155
156
 
# File 'lib/aspera/rest.rb', line 154

def user_agent
  return @@global[:user_agent]
end

Instance Method Details

#call(operation:, subpath: nil, query: nil, body: nil, body_type: nil, save_to_file: nil, return_error: false, headers: nil) ⇒ 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

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

    body parameters

  • body_type (Symbol) (defaults to: nil) —

    type of body parameters (:json, :www, :text, nil)

  • save_to_file (filepath) (defaults to: nil)
  • return_error (bool) (defaults to: false)
  • headers (Hash) (defaults to: nil) —

    additional headers



254
255
256
257
258
259
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
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
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
 
# File 'lib/aspera/rest.rb', line 254

def call(
  operation:,
  subpath: nil,
  query: nil,
  body: nil,
  body_type: nil,
  save_to_file: nil,
  return_error: false,
  headers: nil
)
  subpath = subpath.to_s if subpath.is_a?(Symbol)
  subpath = '' if subpath.nil?
  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)
  Log.log.debug{"#{operation} [#{subpath}]".red.bold.bg_green}
  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.token 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 body_type
    when :json
      req.body = JSON.generate(body) # , ascii_only: true
      req['Content-Type'] = 'application/json'
    when :www
      req.body = URI.encode_www_form(body)
      req['Content-Type'] = 'application/x-www-form-urlencoded'
    when :text
      req.body = body
      req['Content-Type'] = 'text/plain'
    when nil
    else
      raise "unsupported body 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.log.debug{Log.dump(:req_body, req.body)}
    # we try the call, and will retry only if oauth, as we can, first with refresh, and then re-auth if refresh is bad
    oauth_tries ||= 2
    # initialize with number of initial retries allowed, nil gives zero
    tries_remain_redirect = @redirect_max.to_i 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'] || 'text/plain')[: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') &&
          !result[:http]['Content-Length'].nil? &&
          !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'])
          if disposition[:parameters].key?(:filename)
            target_file = File.join(File.dirname(target_file), disposition[:parameters][:filename])
          end
        end
        # download with temp filename
        target_file_tmp = "#{target_file}#{@@global[:download_partial_suffix]}"
        Log.log.debug{"saving to: #{target_file}"}
        written_size = 0
        @@global[:progress_bar]&.event(session_id: 1, type: :session_start)
        @@global[:progress_bar]&.event(session_id: 1, type: :session_size, info: total_size)
        File.open(target_file_tmp, 'wb') do |file|
          result[:http].read_body do |fragment|
            file.write(fragment)
            written_size += fragment.length
            @@global[:progress_bar]&.event(session_id: 1, type: :transfer, info: written_size)
          end
        end
        @@global[:progress_bar]&.event(session_id: 1, type: :end)
        # rename at the end
        File.rename(target_file_tmp, target_file)
        file_saved = true
      end
    end
    # 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}"}
    result[:data] = case result_mime
    when *JSON_DECODE
      JSON.parse(result[:http].body) rescue result[:http].body
    else # when 'text/plain'
      result[:http].body
    end
    Log.log.debug{"result: code=#{result[:http].code} mime=#{result_mime}"}
    Log.log.debug{Log.dump('data', result[:data])}
    RestErrorAnalyzer.instance.raise_on_error(req, result)
    File.write(save_to_file, result[:http].body) unless file_saved || save_to_file.nil?
  rescue RestCallError => e
    # 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.token(refresh: true)
      rescue RestCallError => e_tok
        e = e_tok
        Log.log.error('refresh failed'.bg_red)
        # regenerate a brand new token
        req['Authorization'] = oauth.token(refresh: true)
      end
      Log.log.debug{"using new token=#{headers['Authorization']}"}
      retry if (oauth_tries -= 1).nonzero?
    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, query: query, body: body, body_type: body_type,
        save_to_file: save_to_file, return_error: return_error, headers: headers)
    end
    # raise exception if could not retry and not return error in result
    raise e unless return_error
  end
  Log.log.debug{"result=#{result}"}
  return result
end

#cancel(subpath) ⇒ Object 



442
443
444
 
# File 'lib/aspera/rest.rb', line 442

def cancel(subpath)
  return call(operation: 'CANCEL', subpath: subpath, headers: {'Accept' => 'application/json'})
end

#create(subpath, params) ⇒ Object

CRUD methods here



426
427
428
 
# File 'lib/aspera/rest.rb', line 426

def create(subpath, params)
  return call(operation: 'POST', subpath: subpath, headers: {'Accept' => 'application/json'}, body: params, body_type: :json)
end

#delete(subpath, params = nil) ⇒ Object 



438
439
440
 
# File 'lib/aspera/rest.rb', line 438

def delete(subpath, params=nil)
  return call(operation: 'DELETE', subpath: subpath, headers: {'Accept' => 'application/json'}, query: params)
end

#lookup_by_name(subpath, search_name, query = {}) ⇒ Object

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

Parameters:

  • subpath —

    path of entity in API

  • search_name —

    name of searched entity

  • query (defaults to: {}) —

    additional search query parameters



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/aspera/rest.rb', line 452

def lookup_by_name(subpath, search_name, query={})
  # returns entities matching the query (it matches against several fields in case insensitive way)
  matching_items = read(subpath, query.merge({'q' => search_name}))[:data]
  # 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.) # rubocop:disable Layout/LineLength
    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)



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

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.log.debug{Log.dump('oauth parameters', oauth_parameters)}
    @oauth = OAuth::Factory.instance.create(**oauth_parameters)
  end
  return @oauth
end

#params ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/aspera/rest.rb', line 185

def params
  return {
    base_url:       @base_url,
    auth:           @auth_params,
    not_auth_codes: @not_auth_codes,
    redirect_max:   @redirect_max,
    headers:        @headers
  }
end

#read(subpath, query = nil) ⇒ Object 



430
431
432
 
# File 'lib/aspera/rest.rb', line 430

def read(subpath, query=nil)
  return call(operation: 'GET', subpath: subpath, headers: {'Accept' => 'application/json'}, query: query)
end

#update(subpath, params) ⇒ Object 



434
435
436
 
# File 'lib/aspera/rest.rb', line 434

def update(subpath, params)
  return call(operation: 'PUT', subpath: subpath, headers: {'Accept' => 'application/json'}, body: params, body_type: :json)
end