module Yt::Config
Provides methods to read and write global configuration settings.
A typical usage is to set the API keys retrieved from the {console.developers.google.com Google Developers Console}.
@example Set the API key for a server-only YouTube app:
Yt.configure do |config| config.api_key = 'ABCDEFGHIJ1234567890' end
@example Set the API client id/secret for a web-client YouTube app:
Yt.configure do |config| config.client_id = 'ABCDEFGHIJ1234567890' config.client_secret = 'ABCDEFGHIJ1234567890' end
Note that Yt.configure has precedence over values through with environment variables (see {Yt::Models::Configuration}).
Public Instance Methods
Returns the global {Yt::Models::Configuration} object.
While this method can be used to read and write configuration settings, it is easier to use {Yt::Config#configure} Yt.configure}.
@example
Yt.configuration.api_key = 'ABCDEFGHIJ1234567890'
@return [Yt::Models::Configuration] The global configuration.
# File lib/yt/config.rb, line 45 def configuration @configuration ||= Yt::Configuration.new end
Yields the global configuration to the given block.
@example
Yt.configure do |config| config.api_key = 'ABCDEFGHIJ1234567890' end
@yield [Yt::Models::Configuration] The global configuration.
# File lib/yt/config.rb, line 32 def configure yield configuration if block_given? end