Class: Yt::Configuration

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

Overview

Provides an object to store global configuration settings.

This class is typically not used directly, but by calling Yt.configure, which creates and updates a single instance of Models::Configuration.

An alternative way to set global configuration settings is by storing them in the following environment variables:

  • YT_CLIENT_ID to store the Client ID for web/device apps

  • YT_CLIENT_SECRET to store the Client Secret for web/device apps

  • YT_API_KEY to store the API key for server/browser apps

  • YT_LOG_LEVEL to store the verbosity level of the logs

In case both methods are used together, Yt.configure takes precedence.

Examples:

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

Set the API client id/secret for a web-client YouTube app:

ENV['YT_CLIENT_ID'] = 'ABCDEFGHIJ1234567890'
ENV['YT_CLIENT_SECRET'] = 'ABCDEFGHIJ1234567890'

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Initialize the global configuration settings, using the values of the specified following environment variables by default.


55
56
57
58
59
60
# File 'lib/yt/configuration.rb', line 55

def initialize
  @client_id = ENV['YT_CLIENT_ID']
  @client_secret = ENV['YT_CLIENT_SECRET']
  @api_key = ENV['YT_API_KEY']
  @log_level = ENV['YT_LOG_LEVEL']
end

Instance Attribute Details

#access_tokenString


48
49
50
# File 'lib/yt/configuration.rb', line 48

def access_token
  @access_token
end

#api_keyString

Returns the API key for server/browser YouTube applications.


42
43
44
# File 'lib/yt/configuration.rb', line 42

def api_key
  @api_key
end

#client_idString

Returns the Client ID for web/device YouTube applications.


34
35
36
# File 'lib/yt/configuration.rb', line 34

def client_id
  @client_id
end

#client_secretString

Returns the Client Secret for web/device YouTube applications.


38
39
40
# File 'lib/yt/configuration.rb', line 38

def client_secret
  @client_secret
end

#log_levelString


45
46
47
# File 'lib/yt/configuration.rb', line 45

def log_level
  @log_level
end

#refresh_tokenString


51
52
53
# File 'lib/yt/configuration.rb', line 51

def refresh_token
  @refresh_token
end

Instance Method Details

#debugging?Boolean


70
71
72
# File 'lib/yt/configuration.rb', line 70

def debugging?
  %w(devel debug).include? log_level.to_s
end

#developing?Boolean


64
65
66
# File 'lib/yt/configuration.rb', line 64

def developing?
  %w(devel).include? log_level.to_s
end