https://github.com/monade/cognito_rails
Add Cognito authentication to your Rails API
https://github.com/monade/cognito_rails
aws-cognito cognito rails rails-api rails-authentication ruby
Last synced: about 2 months ago
JSON representation
Add Cognito authentication to your Rails API
- Host: GitHub
- URL: https://github.com/monade/cognito_rails
- Owner: monade
- License: mit
- Created: 2022-04-01T13:54:23.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T15:22:02.000Z (5 months ago)
- Last Synced: 2025-04-25T13:04:13.343Z (2 months ago)
- Topics: aws-cognito, cognito, rails, rails-api, rails-authentication, ruby
- Language: Ruby
- Homepage: https://monade.io/en/home-en/
- Size: 59.6 KB
- Stars: 5
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/cognito_rails)
# cognito_rails
A gem to integrate AWS Cognito in your Rails app
## Installation
Add the gem to your Gemfile
```ruby
gem 'cognito_rails'
```
Add an initializer for the configuration
```ruby
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:
```ruby
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:
```ruby
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](https://opensource.org/licenses/MIT).
## About Monade
cognito_rails is maintained by [mònade](https://monade.io).
We <3 open source software. [Contact us](https://monade.io/studio/contatti/) for your next project!