Class: OmniAuth::Configuration

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/omniauth.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Returns a new instance of Configuration.


49
50
51
# File 'lib/omniauth.rb', line 49

def initialize
  self.class.defaults.each_pair { |k, v| send("#{k}=", v) }
end

Instance Attribute Details

#allowed_request_methodsObject

Returns the value of attribute allowed_request_methods


115
116
117
# File 'lib/omniauth.rb', line 115

def allowed_request_methods
  @allowed_request_methods
end

#before_callback_phase(&block) ⇒ Object


61
62
63
64
65
66
67
# 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) ⇒ Object


69
70
71
72
73
74
75
# 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) ⇒ Object


77
78
79
80
81
82
83
# File 'lib/omniauth.rb', line 77

def before_request_phase(&block)
  if block_given?
    @before_request_phase = block
  else
    @before_request_phase
  end
end

#camelizationsObject

Returns the value of attribute camelizations


115
116
117
# File 'lib/omniauth.rb', line 115

def camelizations
  @camelizations
end

#failure_raise_out_environmentsObject

Returns the value of attribute failure_raise_out_environments


115
116
117
# File 'lib/omniauth.rb', line 115

def failure_raise_out_environments
  @failure_raise_out_environments
end

#form_cssObject

Returns the value of attribute form_css


115
116
117
# File 'lib/omniauth.rb', line 115

def form_css
  @form_css
end

#full_hostObject

Returns the value of attribute full_host


115
116
117
# File 'lib/omniauth.rb', line 115

def full_host
  @full_host
end

#loggerObject

Returns the value of attribute logger


115
116
117
# File 'lib/omniauth.rb', line 115

def logger
  @logger
end

#mock_authObject

Returns the value of attribute mock_auth


115
116
117
# File 'lib/omniauth.rb', line 115

def mock_auth
  @mock_auth
end

#on_failure(&block) ⇒ Object


53
54
55
56
57
58
59
# File 'lib/omniauth.rb', line 53

def on_failure(&block)
  if block_given?
    @on_failure = block
  else
    @on_failure
  end
end

#path_prefixObject

Returns the value of attribute path_prefix


115
116
117
# File 'lib/omniauth.rb', line 115

def path_prefix
  @path_prefix
end

#test_modeObject

Returns the value of attribute test_mode


115
116
117
# File 'lib/omniauth.rb', line 115

def test_mode
  @test_mode
end

Class Method Details

.default_loggerObject


26
27
28
29
30
# File 'lib/omniauth.rb', line 26

def self.default_logger
  logger = Logger.new(STDOUT)
  logger.progname = 'omniauth'
  logger
end

.defaultsObject


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 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 => [:get, :post],
    :mock_auth => {:default => AuthHash.new('provider' => 'default', 'uid' => '1234', 'info' => {'name' => 'Example User'})}
  }
end

Instance Method Details

#add_camelization(name, camelized) ⇒ Object

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.

Parameters:

  • name (String)

    The underscored name, e.g. oauth

  • camelized (String)

    The properly camelized name, e.g. 'OAuth'


110
111
112
# File 'lib/omniauth.rb', line 110

def add_camelization(name, camelized)
  camelizations[name.to_s] = camelized.to_s
end

#add_mock(provider, original = {}) ⇒ Object


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# 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