Module: TokenAction

Defined in:
lib/token_action.rb,
lib/token_action/engine.rb,
lib/token_action/version.rb,
lib/token_action/orm/mongoid.rb,
lib/token_action/concerns/model.rb,
lib/token_action/orm/active_record.rb,
lib/generators/token_action_generator.rb,
lib/token_action/concerns/token_generator.rb,
app/controllers/token_action/tokens_controller.rb,
app/controllers/token_action/application_controller.rb

Defined Under Namespace

Modules: Generators, Model, TokenGenerator Classes: ApplicationController, Engine, Token, TokensController

Constant Summary collapse

VERSION = 
"0.0.2"

Class Method Summary collapse

Class Method Details

.failure_url ⇒ String

Returns the default failure URL.

Returns:

  • (String) —

    the default failure URL



30
31
32
33
34
35
36
 
# File 'lib/token_action.rb', line 30

def self.failure_url
  if Proc === @@failure_url
    @@failure_url.call
  else
    @@failure_url
  end
end

.failure_url=(failure_url) ⇒ Object

Sets the default failure URL.

Parameters:

  • a (String, Proc) —

    default failure URL



41
42
43
 
# File 'lib/token_action.rb', line 41

def self.failure_url=(failure_url)
  @@failure_url = failure_url
end

.friendly_token ⇒ String

Returns a random alphanumeric string.

Returns:

  • (String) —

    a random alphanumeric string

See Also:

  • Devise::friendly_token


65
66
67
 
# File 'lib/token_action.rb', line 65

def self.friendly_token
  SecureRandom.base64(15).tr('+/=lIO0', 'pqrsxyz')
end

.setup {|_self| ... } ⇒ Object

Configures TokenAction.

  • ‘success_url`: the default success URL

  • ‘failure_url`: the default failure URL

Examples:

require 'token_action'

TokenAction.setup do |config|
  config.success_url = '/home'
  config.failure_url = '/oops'
end

Yields:

  • (_self)

Yield Parameters:

  • _self (TokenAction) —

    the object that the method was called on



57
58
59
 
# File 'lib/token_action.rb', line 57

def self.setup
  yield self
end

.success_url ⇒ String

Returns the default success URL.

Returns:

  • (String) —

    the default success URL



12
13
14
15
16
17
18
 
# File 'lib/token_action.rb', line 12

def self.success_url
  if Proc === @@success_url
    @@success_url.call
  else
    @@success_url
  end
end

.success_url=(success_url) ⇒ Object

Sets the default success URL.

Parameters:

  • a (String, Proc) —

    default success URL



23
24
25
 
# File 'lib/token_action.rb', line 23

def self.success_url=(success_url)
  @@success_url = success_url
end