Authenticatable

An authentication framework based on Warden that provides a set of security features, strategies and helpers to build your own customized authentication logic.

Installation

Add the following line to Gemfile:

gem "authenticatable", "~> 2.0"

and run bundle install from your terminal to install it.

Getting started

The user model

Generate a User model with the fields required for email and password authentication:

$ rails g model user email:uniq password_digest

Authenticatable doesn't require any database columns by default. However, if you want to be able to authenticate a user by password, you should at least include an :email and a :password_digest field.

Register the scope

You need to register all scopes in the initializer file config/initializers/authenticatable.rb. The default value is user which means that you can skip this step if your user model is User.

Authenticatable.setup |config| do
  config.scopes = %i[user]
end

Helpers

Authenticatable will generate helpers for each registered scope on initialization. If your model is something other than User, replace "_user" with "_yourmodel".

Signing in a user.

sign_in!(@user) # => true|false

Retrieving the current authenticated user.

current_user # => <User>|nil

Check if a user is authenticated.

user_signed_in? # => true|false

Examples

All examples below expects that you've already created an authenticatable model with class name User and scope :user.

Signing in with email & password

@user = User.find_by(email: params[:email])

if @user&.authenticate(params[:password])
  sign_in!(@user)
  redirect_to user_path(@user), notice: "You've signed in!"
else
  flash.now[:alert] = "Wrong username or credentials"
  render :new
end

Signing in with OmniAuth

class SessionsController < ApplicationController
  skip_before_action :verify_authenticity_token, only: :callback

  def callback
    auth_hash = request.env['omniauth.auth']
    @user = User.find_or_create_from_auth_hash(auth_hash)
    sign_in! @user
    redirect_to user_path(@user)
  end
end

Contributing

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Versioning

This library aims to adhere to Semantic Versioning. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision. For example:

gem "authenticatable", "~> 2.0"

License

The gem is available as open source under the terms of the MIT License.