Class: Merb::AuthenticationMixin::BasicAuthentication

Inherits:

Object

• Object
• Merb::AuthenticationMixin::BasicAuthentication

show all

Includes:

ControllerExceptions

Defined in:

merb-core/lib/merb-core/controller/mixins/authentication.rb

Constant Summary

Constant Summary

Constants included from ControllerExceptions

ControllerExceptions::STATUS_CODES

Instance Method Summary (collapse)

• - (Object) authenticate(&authenticator)

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

• - (BasicAuthentication) initialize(controller, realm = "Application", &authenticator) constructor private

  A new instance of BasicAuthentication.

• - (String) password

  The password provided in the request.

• - (Boolean) provided?

  Whether there has been any basic authentication credentials provided.

• - (Object) request

  Request basic authentication and halt the filter chain.

• - (String) request!

  Sets headers to request basic auth.

• - (String) username

  The username provided in the request.

87
88
89
90
91
92

# File 'merb-core/lib/merb-core/controller/mixins/authentication.rb', line 87

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

105
106
107
108
109
110
111

# File 'merb-core/lib/merb-core/controller/mixins/authentication.rb', line 105

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

153
154
155

# File 'merb-core/lib/merb-core/controller/mixins/authentication.rb', line 153

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

139
140
141

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

def provided?
  @auth.provided?
end

120
121
122
123

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

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

130
131
132
133
134

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

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

146
147
148

# File 'merb-core/lib/merb-core/controller/mixins/authentication.rb', line 146

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