class Youtube::Configuration
All configuration including auth info and base URI for the API access are configured in this class.
Constants
- ENVIRONMENTS
All the environments the SDK can run in.
Attributes
environments[R]
backoff_factor[R]
environment[R]
http_client[R]
The attribute readers for properties.
max_retries[R]
retry_interval[R]
retry_methods[R]
retry_statuses[R]
timeout[R]
Public Class Methods
new(timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], environment: Environment::PRODUCTION)
click to toggle source
# File lib/youtube/configuration.rb, line 38 def initialize(timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], environment: Environment::PRODUCTION) # The value to use for connection timeout @timeout = timeout # The number of times to retry an endpoint call if it fails @max_retries = max_retries # Pause in seconds between retries @retry_interval = retry_interval # The amount to multiply each successive retry's interval amount # by in order to provide backoff @backoff_factor = backoff_factor # A list of HTTP statuses to retry @retry_statuses = retry_statuses # A list of HTTP methods to retry @retry_methods = retry_methods # Current API environment @environment = String(environment) # The Http Client to use for making requests. @http_client = create_http_client end
Public Instance Methods
clone_with(timeout: nil, max_retries: nil, retry_interval: nil, backoff_factor: nil, retry_statuses: nil, retry_methods: nil, environment: nil)
click to toggle source
# File lib/youtube/configuration.rb, line 69 def clone_with(timeout: nil, max_retries: nil, retry_interval: nil, backoff_factor: nil, retry_statuses: nil, retry_methods: nil, environment: nil) timeout ||= self.timeout max_retries ||= self.max_retries retry_interval ||= self.retry_interval backoff_factor ||= self.backoff_factor retry_statuses ||= self.retry_statuses retry_methods ||= self.retry_methods environment ||= self.environment Configuration.new(timeout: timeout, max_retries: max_retries, retry_interval: retry_interval, backoff_factor: backoff_factor, retry_statuses: retry_statuses, retry_methods: retry_methods, environment: environment) end
create_http_client()
click to toggle source
# File lib/youtube/configuration.rb, line 87 def create_http_client FaradayClient.new(timeout: timeout, max_retries: max_retries, retry_interval: retry_interval, backoff_factor: backoff_factor, retry_statuses: retry_statuses, retry_methods: retry_methods) end
get_base_uri(server = Server::DEFAULT)
click to toggle source
Generates the appropriate base URI for the environment and the server. @param [Configuration::Server] The server enum for which the base URI is required. @return [String] The base URI.
# File lib/youtube/configuration.rb, line 106 def get_base_uri(server = Server::DEFAULT) ENVIRONMENTS[environment][server].clone end