Class: Merb::AuthenticationMixin::BasicAuthentication

Inherits:
Object
  • Object
show all
Includes:
ControllerExceptions
Defined in:
lib/merb-core/controller/mixins/authentication.rb

Constant Summary

Constants included from ControllerExceptions

ControllerExceptions::STATUS_CODES

Instance Method Summary collapse

Constructor Details

#initialize(controller, realm = "Application", &authenticator) ⇒ BasicAuthentication

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BasicAuthentication.



88
89
90
91
92
93
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 88

def initialize(controller, realm = "Application", &authenticator)
  @controller = controller
  @realm = realm
  @auth = Rack::Auth::Basic::Request.new(@controller.request.env)
  authenticate_or_request(&authenticator) if authenticator
end

Instance Method Details

#authenticate(&authenticator) ⇒ Object

Determines whether or not the user is authenticated using the criteria in the provided authenticator block.

Parameters

&authenticator

A block that decides whether the provided username and password

are valid.

Returns

Object

False if basic auth is not provided, otherwise the return value of the authenticator block.



104
105
106
107
108
109
110
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 104

def authenticate(&authenticator)
  if @auth.provided? and @auth.basic?
    authenticator.call(*@auth.credentials)
  else
    false
  end
end

#password ⇒ Object

Returns

String

The password provided in the request.



155
156
157
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 155

def password
  provided? ? @auth.credentials.last : nil
end

#provided? ⇒ Boolean

Returns

Boolean

Whether there has been any basic authentication credentials provided

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 139

def provided?
  @auth.provided?
end

#request ⇒ Object

Request basic authentication and halt the filter chain. This is for use in a before filter.

Throws

:halt with an “HTTP Basic: Access denied.” message with no layout, and sets the status to Unauthorized.



118
119
120
121
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 118

def request
  request!
  throw :halt, @controller.render("HTTP Basic: Access denied.\n", :status => Unauthorized.status, :layout => false)
end

#request! ⇒ Object

Sets headers to request basic auth.

Returns

String

Returns the empty string to provide a response body.



129
130
131
132
133
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 129

def request!
  @controller.status = Unauthorized.status
  @controller.headers['WWW-Authenticate'] = 'Basic realm="%s"' % @realm
  ""
end

#username ⇒ Object

Returns

String

The username provided in the request.



147
148
149
 
# File 'lib/merb-core/controller/mixins/authentication.rb', line 147

def username
  provided? ? @auth.credentials.first : nil
end