class OmniAuth::Configuration

Attributes

allowed_request_methods[RW]
before_callback_phase[W]
before_options_phase[W]
before_request_phase[W]
camelizations[RW]
failure_raise_out_environments[RW]
form_css[RW]
full_host[RW]
logger[RW]
mock_auth[RW]
on_failure[W]
path_prefix[RW]
test_mode[RW]

Public Class Methods

default_logger() click to toggle source
# File lib/omniauth.rb, line 26
def self.default_logger
  logger = Logger.new(STDOUT)
  logger.progname = 'omniauth'
  logger
end
defaults() click to toggle source
# File lib/omniauth.rb, line 32
def self.defaults
  @defaults ||= {
    :camelizations => {},
    :path_prefix => '/auth',
    :on_failure => OmniAuth::FailureEndpoint,
    :failure_raise_out_environments => ['development'],
    :before_request_phase   => nil,
    :before_callback_phase  => nil,
    :before_options_phase   => nil,
    :form_css => Form::DEFAULT_CSS,
    :test_mode => false,
    :logger => default_logger,
    :allowed_request_methods => %i[get post],
    :mock_auth => {:default => AuthHash.new('provider' => 'default', 'uid' => '1234', 'info' => {'name' => 'Example User'})}
  }
end
new() click to toggle source
# File lib/omniauth.rb, line 49
def initialize
  self.class.defaults.each_pair { |k, v| send("#{k}=", v) }
end

Public Instance Methods

add_camelization(name, camelized) click to toggle source

This is a convenience method to be used by strategy authors so that they can add special cases to the camelization utility method that allows OmniAuth::Builder to work.

@param name [String] The underscored name, e.g. `oauth` @param camelized [String] The properly camelized name, e.g. 'OAuth'

# File lib/omniauth.rb, line 110
def add_camelization(name, camelized)
  camelizations[name.to_s] = camelized.to_s
end
add_mock(provider, original = {}) click to toggle source
# File lib/omniauth.rb, line 85
def add_mock(provider, original = {})
  # Create key-stringified new hash from given auth hash
  mock = {}
  original.each_pair do |key, val|
    mock[key.to_s] = if val.is_a? Hash
                       Hash[val.each_pair { |k, v| [k.to_s, v] }]
                     else
                       val
                     end
  end

  # Merge with the default mock and ensure provider is correct.
  mock = mock_auth[:default].dup.merge(mock)
  mock['provider'] = provider.to_s

  # Add it to the mocks.
  mock_auth[provider.to_sym] = mock
end
before_callback_phase(&block) click to toggle source
# File lib/omniauth.rb, line 61
def before_callback_phase(&block)
  if block_given?
    @before_callback_phase = block
  else
    @before_callback_phase
  end
end
before_options_phase(&block) click to toggle source
# File lib/omniauth.rb, line 69
def before_options_phase(&block)
  if block_given?
    @before_options_phase = block
  else
    @before_options_phase
  end
end
before_request_phase(&block) click to toggle source
# File lib/omniauth.rb, line 77
def before_request_phase(&block)
  if block_given?
    @before_request_phase = block
  else
    @before_request_phase
  end
end
on_failure(&block) click to toggle source
# File lib/omniauth.rb, line 53
def on_failure(&block)
  if block_given?
    @on_failure = block
  else
    @on_failure
  end
end