Class: AssemblyAI::AsyncRequestClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil, timeout_in_seconds: nil, user_agent: nil) ⇒ AssemblyAI::AsyncRequestClient

Parameters:

  • environment (AssemblyAI::Environment) (defaults to: AssemblyAI::Environment::DEFAULT)
  • base_url (String) (defaults to: nil)
  • 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)
  • user_agent (AssemblyAI::UserAgent) (defaults to: nil) 


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

def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
               timeout_in_seconds: nil, user_agent: nil)
  @default_environment = environment
  @base_url = environment || base_url
  @headers = {
    "X-Fern-Language": "Ruby",
    "X-Fern-SDK-Name": "assemblyai",
    "X-Fern-SDK-Version": AssemblyAI::Gemconfig::VERSION,
    "Authorization": api_key.to_s,
    "User-Agent": AssemblyAI::UserAgent.merge(AssemblyAI::DefaultUserAgent.instance.user_agent, user_agent).serialize
  }
  @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

#base_url ⇒ String (readonly)

Returns:

  • (String) 


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

def base_url
  @base_url
end

#conn ⇒ Faraday (readonly)

Returns:

  • (Faraday) 


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

def conn
  @conn
end

#default_environment ⇒ String (readonly)

Returns:

  • (String) 


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

def default_environment
  @default_environment
end

#headers ⇒ Hash{String => String} (readonly)

Returns:

  • (Hash{String => String}) 


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

def headers
  @headers
end

Instance Method Details

#get_url(request_options: nil) ⇒ String

Parameters:

Returns:

  • (String) 


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

def get_url(request_options: nil)
  request_options&.base_url || @default_environment || @base_url
end