Type:
Module

Makes it dead easy to do HTTP Basic authentication.

Simple Basic example

 class PostsController < ApplicationController
   http_basic_authenticate_with name: "dhh", password: "secret", except: :index

   def index
     render plain: "Everyone can see me!"
   end

   def edit
     render plain: "I'm only accessible if you know the password"
   end
end

Advanced Basic example

Here is a more advanced Basic example where only Atom feeds and the XML API is protected by HTTP authentication, the regular HTML interface is protected by a session approach:

class ApplicationController < ActionController::Base
  before_action :set_account, :authenticate

  protected
    def set_account
      @account = Account.find_by(url_name: request.subdomains.first)
    end

    def authenticate
      case request.format
      when Mime::XML, Mime::ATOM
        if user = authenticate_with_http_basic { |u, p| @account.users.authenticate(u, p) }
          @current_user = user
        else
          request_http_basic_authentication
        end
      else
        if session_authenticated?
          @current_user = @account.users.find(session[:authenticated][:user_id])
        else
          redirect_to(login_url) and return false
        end
      end
    end
end

In your integration tests, you can do something like this:

def test_access_granted_from_xml
  get(
    "/notes/1.xml", nil,
    'HTTP_AUTHORIZATION' => ActionController::HttpAuthentication::Basic.encode_credentials(users(:dhh).name, users(:dhh).password)
  )

  assert_equal 200, status
end
authenticate

authenticate(request, &login_procedure) Instance Public methods

2015-06-20 00:00:00
user_name_and_password

user_name_and_password(request) Instance Public methods

2015-06-20 00:00:00
authentication_request

authentication_request(controller, realm) Instance Public methods

2015-06-20 00:00:00
encode_credentials

encode_credentials(user_name, password) Instance Public methods

2015-06-20 00:00:00
auth_scheme

auth_scheme(request) Instance Public methods

2015-06-20 00:00:00
auth_param

auth_param(request) Instance Public methods

2015-06-20 00:00:00
has_basic_credentials?

has_basic_credentials?(request) Instance Public methods

2015-06-20 00:00:00
decode_credentials

decode_credentials(request) Instance Public methods

2015-06-20 00:00:00