Class: Janus::Strategies::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/janus/strategies/base.rb

Overview

Base class for writing authentication strategies.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, manager) ⇒ Base

:nodoc:



7
8
9
10
 
# File 'lib/janus/strategies/base.rb', line 7

def initialize(scope, manager) # :nodoc:
  @scope, @manager = scope, manager
  @request, @cookies = manager.request, manager.cookies
end

Instance Attribute Details

#cookies ⇒ Object (readonly)

Returns the value of attribute cookies.



5
6
7
 
# File 'lib/janus/strategies/base.rb', line 5

def cookies
  @cookies
end

#manager ⇒ Object (readonly)

Returns the value of attribute manager.



5
6
7
 
# File 'lib/janus/strategies/base.rb', line 5

def manager
  @manager
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



5
6
7
 
# File 'lib/janus/strategies/base.rb', line 5

def request
  @request
end

#scope ⇒ Object (readonly)

Returns the value of attribute scope.



5
6
7
 
# File 'lib/janus/strategies/base.rb', line 5

def scope
  @scope
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



5
6
7
 
# File 'lib/janus/strategies/base.rb', line 5

def user
  @user
end

Instance Method Details

#auth_method ⇒ Object 



35
36
37
 
# File 'lib/janus/strategies/base.rb', line 35

def auth_method
  :login
end

#authenticate! ⇒ Object

Raises:

  • (StandardError) 


31
32
33
 
# File 'lib/janus/strategies/base.rb', line 31

def authenticate!
  raise StandardError.new("You must define the #{self.class.name}#authenticate! method.")
end

#pass ⇒ Object 



16
17
 
# File 'lib/janus/strategies/base.rb', line 16

def pass
end

#resource ⇒ Object 



27
28
29
 
# File 'lib/janus/strategies/base.rb', line 27

def resource
  @resource ||= scope.to_s.camelize.constantize
end

#success!(user) ⇒ Object 



19
20
21
 
# File 'lib/janus/strategies/base.rb', line 19

def success!(user)
  @user = user
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/janus/strategies/base.rb', line 23

def success?
  !@user.nil?
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/janus/strategies/base.rb', line 12

def valid?
  true
end