TokAccess

Handle authentication of your users using tokens. Every ‘tokified’ user will have a association named toks.

A tok is an object that consist of two attributes: token, device_token.

You should use the device_token to identify the user devices in which the user has logged in and the token to authenticate the user request.

TokAccess use bcrypt has_secure_password and has_secure_token methods to handle the authentication process and tokens generation

Usage

  # somewhere in a controller that handle the users registration

  def sign_up
    user = User.new(user_params)
    if user.save
      # if the user is saved, an associated tok is created
      # and you can access that tok using the following methods
      token = user.get_token
      device_token = user.get_device_token
      #  return the tokens to the front-end.
    else
      # code if the user can't be saved
    end
  end

  # somewhere in your code, probably in you ApplicationController
  # let's say that you are sending a token in a header named
  # APP_TOKEN

  def current_user
    @current_user ||= User.validate_access(token: request.headers["HTTP_APP_TOKEN"])
  end

  def user_signed_in?
    !current_user.nil?
  end

  def current_token
    current_user ? current_user.get_token : nil
  end

  def current_device_token
    current_user ? current_user.get_device_token : nil
  end

  # After 15 minutes, the next user request will refresh the tokens.
  # it is necessary to send the tokens to the front-end again

  def tokens_refreshed?
    if current_user and current_user.refreshed?
      # Some code that allows you to send the tokens to the front-end
    end
  end

  # somewhere in a controller that handle the users sign in

  def sign_in
    user = User.find_by(email: params[:email])
    if user.tok_auth(params[:password])
      # if the user is authenticated successfully, a new tok is created
      # and you can access that tok using the following methods
      token = user.get_token
      device_token = user.get_device_token
      # then you should return to the front-end the tokens.
    else
      # code if the user authentication fails
    end
  end

  # somewhere in a controller that handle the users sign in
  # let's say that you are sending a device_token in a header named
  # APP_device_TOKEN

  def sign_in
    user = User.find_by(email: params[:email])
    if user.tok_auth(params[:password], request.headers["HTTP_APP_device_TOKEN"])
      # if the user is authenticated successfully and the tok related to the
      # given device_token is found, the token and device_token are regenerated
      # and you can access that tok using the get_token and get_device_token
      # methods.
      # if the user is authenticated successfully and the tok related to the
      # given device_token wasn't found, a new tok is created and you can access
      # that tok using the get_token and get_device_token
      # methods.
      token = user.get_token
      device_token = user.get_device_token
      # then you should return to the front-end the tokens.
    else
      # code if the user authentication fails
    end
  end

Accessing the toks from the user.


  user = User.validate_access(token: request.headers["HTTP_APP_TOKEN"])
  user.toks # UserTok collection.

If you need to generate a new tok without validating anything.

  # Previously created user.
  user = User.find(1)
  user.create_tok
  token = user.get_token
  device_token = user.get_device_token

Installation

Add this line to your application’s Gemfile:

gem 'tok_access', '~> 1.1.6'

And then execute:

$ bundle

Generating models

Generating a User model.

$ rails g tok_access:model User email:string nickname:string

The above command will generate two models: User and UserTok

The migration generated to create the User model will add a column named password_digest to store the password.

IMPORTANT: If you already have a User model, the command will generate just the migration to add the password_digest column

NOTE: You can generate any model to be ‘tokified’ just pass the name of the model

$ rails g tok_access:model Person email:string nickname:string

The above command will generate two models: Person and PersonTok

IMPORTANT: If you use the tok_access:model generator to destroy the model, the Model and ModelTok will be destroyed. It’s a better choice to do it manually

$ rails d model user
$ rails d model user_tok

Also, remember to remove the migrations…

License

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

tok_access

Handle authentication of your users using tokens.