Module: Nucleo::Configurations::Default

Defined in:
lib/nucleo/configurations/default.rb

Constant Summary collapse

API_HOST =
"https//api.quicksprout.com".freeze
USER_AGENT =
("Nucleo Web Application Gem %s" % [Nucleo::Client::VERSION]).freeze
MEDIA_TYPE =
"application/json".freeze
CONTENT_TYPE =
"application/json".freeze

Class Method Summary collapse

Class Method Details

.access_tokenString, Nil

Return the ENV access token or nil

Returns:

  • (String, Nil)


22
23
24
# File 'lib/nucleo/configurations/default.rb', line 22

def self.access_token
  ENV['NUCLEO_ACCESS_TOKEN']
end

.api_hostString

Return the ENV API Host or the default production API host.

Returns:

  • (String)


30
31
32
# File 'lib/nucleo/configurations/default.rb', line 30

def self.api_host
  ENV.fetch('NUCLEO_API_HOST', API_HOST)
end

.cache_loggerNucleo::Logger

Return the default logger to STDOUT

Returns:



75
76
77
# File 'lib/nucleo/configurations/default.rb', line 75

def self.cache_logger
  Nucleo::Logger.new(STDOUT)
end

.connection_optionsHash

Returns a set of default connection options

Returns:

  • (Hash)

    Connection Options



89
90
91
92
93
94
95
96
97
# File 'lib/nucleo/configurations/default.rb', line 89

def self.connection_options
  {
    :headers => {
      :accept       => self.media_type,
      :user_agent   => self.user_agent,
      :content_type => self.content_type
    }
  }
end

.content_typeString

Return the ENV Content-Type header or default constant.

Returns:

  • (String)


46
47
48
# File 'lib/nucleo/configurations/default.rb', line 46

def self.content_type
  ENV.fetch('NUCLEO_CONTENT_TYPE', CONTENT_TYPE)
end

.detailed_loggerNucleo::Logger

Return the default logger to STDOUT

Returns:



68
69
70
# File 'lib/nucleo/configurations/default.rb', line 68

def self.detailed_logger
  Nucleo::Logger.new(STDOUT)
end

.loggerNucleo::Logger

Return the default logger to STDOUT

Returns:



82
83
84
# File 'lib/nucleo/configurations/default.rb', line 82

def self.logger
  Nucleo::Logger.new(STDOUT)
end

.media_typeString

Return the ENV Accept header or default constant.

Returns:

  • (String)


38
39
40
# File 'lib/nucleo/configurations/default.rb', line 38

def self.media_type
  ENV.fetch('NUCLEO_MEDIA_TYPE', MEDIA_TYPE)
end

.optionsHash

Return the collection of default options and values

Returns:

  • (Hash)

    Keys and values of default configuration



15
16
17
# File 'lib/nucleo/configurations/default.rb', line 15

def self.options
  Hash[Nucleo::Configuration.keys.map { |key| [key, __send__(key)] }]
end

.request_loggerNucleo::Logger

Return the default logger to STDOUT

Returns:



61
62
63
# File 'lib/nucleo/configurations/default.rb', line 61

def self.request_logger
  Nucleo::Logger.new(STDOUT)
end

.user_agentString

REturn the ENV User-Agent header or default constant.

Returns:

  • (String)


54
55
56
# File 'lib/nucleo/configurations/default.rb', line 54

def self.user_agent
  ENV.fetch('NUCLEO_USER_AGENT', USER_AGENT)
end