README.md

cognito_rails

A gem to integrate AWS Cognito in your Rails app

Installation

Add the gem to your Gemfile

  gem 'cognito_rails'

Add an initializer for the configuration

cognito_credentials = if Rails.env.production?
                        Rails.application.credentials&.dig(:cognito, :production)
                      else
                        Rails.application.credentials&.dig(:cognito, :staging)
                      end

CognitoRails::Config.aws_client_credentials = {
  access_key_id: cognito_credentials&.dig(:access_key_id),
  secret_access_key: cognito_credentials&.dig(:secret_access_key),
}

CognitoRails::Config.aws_region = cognito_credentials&.dig(:region)
CognitoRails::Config.aws_user_pool_id = cognito_credentials&.dig(:user_pool_id)
CognitoRails::Config.default_user_class = 'User'
# Optional
CognitoRails::Config.logger = Rails.logger # To receive logs
CognitoRails::Config.cache_adapter = Rails.cache # To cache the JWT keys API call
CognitoRails::Config.skip_model_hooks = Rails.env.test? # To skip cognito user creation during tests

Controller

Add the ControllerConcern to your ApplicationController:

class ApplicationController < ActionController::Base
  cognito_authentication user_class: 'User'
end

This makes the logged user available to your controllers through the current_user attribute.

Model

Add as_cognito_user to your user models along with the mixin methods you need:

class User < ApplicationRecord
  validates :email, :phone, :role, presence: true
  validates :email, :phone, uniqueness: true

  as_cognito_user
  cognito_verify_email
  cognito_verify_phone
  cognito_password_policy :temporary
  define_cognito_attribute 'role', :role
  define_cognito_attribute 'test', 'some fixed value'

  has_many :projects, dependent: :restrict_with_error

  enum role: { user: 0, agency: 500, admin: 1000, superadmin: 9999 }
end

:email and :phone are automatically saved as Cognito attributes from the model. cognito_verify_email and cognito_verify_phone add email and phone verification on user creation. cognito_password_policy chose the password policy on user creation (:temporary, :user_provided), the default is :temporary define_cognito_attribute assign a custom Cognito attribute to the user. This won't work if you don't add the custom attribute through the Cognito console in advance

License

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

About Monade

cognito_rails is maintained by mònade srl.

We <3 open source software. Contact us for your next project!