Class: TrophyApiClient::AsyncRequestClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, tenant_id: nil) ⇒ TrophyApiClient::AsyncRequestClient

Parameters:

  • base_url (String) (defaults to: nil)
  • environment (TrophyApiClient::Environment) (defaults to: TrophyApiClient::Environment::PRODUCTION)
  • max_retries (Long) (defaults to: nil) —

    The number of times to retry a failed request, defaults to 2.

  • timeout_in_seconds (Long) (defaults to: nil)
  • api_key (String)
  • tenant_id (String) (defaults to: nil) —

    The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/requests.rb', line 76

def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil,
               timeout_in_seconds: nil, tenant_id: nil)
  @default_environment = environment
  @api_key = api_key
  @headers = {}
  @headers["Tenant-ID"] = tenant_id unless tenant_id.nil?
  @conn = Faraday.new(headers: @headers) do |faraday|
    faraday.request :json
    faraday.response :raise_error, include_request: true
    faraday.adapter :async_http
    faraday.request :retry, { max: max_retries } unless max_retries.nil?
    faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
  end
end

Instance Attribute Details

#api_key ⇒ String (readonly)

Returns:

  • (String) 


63
64
65
 
# File 'lib/requests.rb', line 63

def api_key
  @api_key
end

#base_url ⇒ String (readonly)

Returns:

  • (String) 


61
62
63
 
# File 'lib/requests.rb', line 61

def base_url
  @base_url
end

#conn ⇒ Faraday (readonly)

Returns:

  • (Faraday) 


59
60
61
 
# File 'lib/requests.rb', line 59

def conn
  @conn
end

#default_environment ⇒ String (readonly)

Returns:

  • (String) 


65
66
67
 
# File 'lib/requests.rb', line 65

def default_environment
  @default_environment
end

Instance Method Details

#get_headers ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


99
100
101
102
103
 
# File 'lib/requests.rb', line 99

def get_headers
  headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "trophy_api_client" }
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
  headers
end

#get_url(environment:, request_options: nil) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
 
# File 'lib/requests.rb', line 94

def get_url(environment:, request_options: nil)
  request_options&.base_url || @default_environment[environment] || @base_url
end