Class: CastleDevise::Configuration

Inherits:
Object
  • Object
show all
Includes:
ActiveSupport::Configurable
Defined in:
lib/castle_devise/configuration.rb

Overview

Configuration object using ActiveSupport::Configurable

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#after_request_hooks ⇒ Array<Proc>

Returns Array of procs that will get called after a request to the Castle API.

Returns:

  • (Array<Proc>) —

    Array of procs that will get called after a request to the Castle API



40
 
# File 'lib/castle_devise/configuration.rb', line 40

config_accessor(:after_request_hooks) { [] }

#api_secret ⇒ String

Returns Your API secret.

Returns:

  • (String) —

    Your API secret



13
 
# File 'lib/castle_devise/configuration.rb', line 13

config_accessor(:api_secret)

#app_id ⇒ String

Returns Your Castle App ID.

Returns:

  • (String) —

    Your Castle App ID



17
 
# File 'lib/castle_devise/configuration.rb', line 17

config_accessor(:app_id)

#before_request_hooks ⇒ Array<Proc>

Returns Array of procs that will get called before a request to the Castle API.

Returns:

  • (Array<Proc>) —

    Array of procs that will get called before a request to the Castle API



36
 
# File 'lib/castle_devise/configuration.rb', line 36

config_accessor(:before_request_hooks) { [] }

#castle_client ⇒ Class

Returns Castle SDK client.

Returns:

  • (Class) —

    Castle SDK client



48
 
# File 'lib/castle_devise/configuration.rb', line 48

config_accessor(:castle_client) { ::Castle::Client.new }

#castle_sdk_facade_class ⇒ Class

Returns Castle API implementation.

Returns:

  • (Class) —

    Castle API implementation



44
 
# File 'lib/castle_devise/configuration.rb', line 44

config_accessor(:castle_sdk_facade_class) { ::CastleDevise::SdkFacade }

#logger ⇒ Logger

Returns A Logger instance. You might want to use Rails.logger here.

Returns:

  • (Logger) —

    A Logger instance. You might want to use Rails.logger here.



32
 
# File 'lib/castle_devise/configuration.rb', line 32

config_accessor(:logger) { Logger.new("/dev/null") }

#monitoring_mode ⇒ true, false

When CastleDevise is in monitoring mode, it sends requests to Castle but it doesn’t act on “deny” verdicts.

This mode is useful if you’re just checking Castle out and you’re not yet sure whether your configuration is correct so you don’t accidentally block legitimate users from logging in/registering.

Returns:

  • (true, false) —

    whether to act on deny requests or not



28
 
# File 'lib/castle_devise/configuration.rb', line 28

config_accessor(:monitoring_mode) { false }

Instance Method Details

#after_request(&blk) ⇒ Object

Adds a new after_request hook

Parameters:

  • blk (Proc) 


58
59
60
 
# File 'lib/castle_devise/configuration.rb', line 58

def after_request(&blk)
  after_request_hooks << blk
end

#before_request(&blk) ⇒ Object

Adds a new before_request hook

Parameters:

  • blk (Proc) 


52
53
54
 
# File 'lib/castle_devise/configuration.rb', line 52

def before_request(&blk)
  before_request_hooks << blk
end