Module: CastleDevise

Defined in:
lib/castle_devise.rb,
lib/castle_devise/context.rb,
lib/castle_devise/patches.rb,
lib/castle_devise/version.rb,
lib/castle_devise/sdk_facade.rb,
lib/castle_devise/configuration.rb,
lib/castle_devise/controllers/helpers.rb,
lib/castle_devise/helpers/castle_helper.rb,
lib/castle_devise/patches/passwords_controller.rb,
lib/castle_devise/patches/registrations_controller.rb

Overview

CastleDevise consists of a few different parts:

  • Devise castle_protectable module defined in lib/castle_devise/models/

  • Minimal monkey patches to Devise controller defined in lib/castle_devise/patches/

  • Warden hooks defined in lib/castle_devise/hooks/

  • A Facade layer on top of the Castle SDK: SdkFacade

  • A Context object that contains all the data you might want to use when integrating Castle with your application: Context

Defined Under Namespace

Modules: Controllers, Helpers, Patches Classes: Configuration, Context, SdkFacade

Constant Summary collapse

VERSION = 
"0.4.3"

Class Method Summary collapse

Class Method Details

.castle ⇒ Castle::Client

Returns:

  • (Castle::Client) 


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

def castle
  @castle ||= configuration.castle_client
end

.configuration ⇒ CastleDevise::Configuration

Returns:



17
18
19
 
# File 'lib/castle_devise.rb', line 17

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yield Parameters:



27
28
29
30
31
32
33
34
 
# File 'lib/castle_devise.rb', line 27

def configure
  @sdk_facade = @castle = nil

  yield configuration

  Castle.api_secret = configuration.api_secret
  Castle.config.logger = configuration.logger
end

.logger ⇒ Logger

Returns:

  • (Logger) 


22
23
24
 
# File 'lib/castle_devise.rb', line 22

def logger
  configuration.logger
end

.monitoring_mode? ⇒ true, false

Returns whether in monitoring mode or not.

Returns:

  • (true, false) —

    whether in monitoring mode or not



37
38
39
 
# File 'lib/castle_devise.rb', line 37

def monitoring_mode?
  configuration.monitoring_mode
end

.sdk_facade ⇒ CastleDevise::SdkFacade

Returns:



42
43
44
45
46
47
48
 
# File 'lib/castle_devise.rb', line 42

def sdk_facade
  @sdk_facade ||= configuration.castle_sdk_facade_class.new(
    castle,
    configuration.before_request_hooks,
    configuration.after_request_hooks
  )
end