Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/launchpadlab/lp_token_auth
Simple token authentication
https://github.com/launchpadlab/lp_token_auth
authentication jwt rails
Last synced: 12 days ago
JSON representation
Simple token authentication
- Host: GitHub
- URL: https://github.com/launchpadlab/lp_token_auth
- Owner: LaunchPadLab
- License: mit
- Created: 2017-02-07T02:21:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T03:50:27.000Z (9 months ago)
- Last Synced: 2024-10-22T22:37:03.757Z (17 days ago)
- Topics: authentication, jwt, rails
- Language: Ruby
- Size: 71.3 KB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](http://www.rubydoc.info/github/LaunchPadLab/lp_token_auth)
[](https://travis-ci.org/LaunchPadLab/lp_token_auth)
[](https://codeclimate.com/repos/593aabffc759c90269001912/coverage)
[](https://codeclimate.com/repos/593aabffc759c90269001912/feed)
# LP Token Auth
Simple token authentication logic with JWTs for Rails apps. No baked in routing, just the barebones logic you need to implement token authentication with JWTs.
* [Installation](#installation)
* [Usage](#usage)
* [Examples](#examples)
* [Migration Guide](#migration-guide)
## Installation
Add this line to your application's Gemfile:
`gem 'lp_token_auth'`
And then execute:
`$ bundle`
Or install it yourself as:
`$ gem install lp_token_auth`
## Usage
1. Run `bundle exec rails generate lp_token_auth:install` to generate an initializer at `../config/initalizers/lp_token_auth.rb`. See the initializer for more details about what is configurable.
2. In the most senior controller that you want to authenticate, add `include LpTokenAuth::Controller`. This gives you 4 methods that are available in this and all child controllers:
+ `login(user)` - Given a valid user, this will generate a JWT and return it. The token should be sent to the client and passed in the 'Authorization' header in all subsequent requests to the server.
+ `authenticate_request!` - This is a `before_action` to use in your controllers that will extract the token from the header and authenticate it before proceeding. If the resource class that you're using is not the default `User`, you may override the `authenticate_request!` method by creating a custom `before_action`, in which you may pass in the resource class name.
```
class AuthenticationController < ApplicationController
include LpTokenAuth::Controller
before_action :authenticate_request
protected
def authenticate_request
authenticate_request!('AdminUser')
end
end
```
+ `authenticate_token!(token)` - This is called by `authenticate_request!` but is available to use if you ever need to manually authenticate a token.
+ `current_user` - This returns the current user identified by `authenticate!`. It is available after logging in the user or authenticating.
3. All errors will return an instance of `LpTokenAuth::Error`
## Migration Guide
Version 2.0 contains breaking changes for LP Token Auth. This migration guide contains instructions for using v2.0. [Migration Guide](https://github.com/LaunchPadLab/lp_token_auth/blob/master/migration-guide.md)
## Examples
### Controller
```
class AuthenticatingController < ApplicationController
include LpTokenAuth::Controller
before_action :authenticate_request!
rescue_from LpTokenAuth::Error, with: :unauthorized
protected
def unauthorized(error)
render json: { data: error.message }, status: :unauthorized
end
end
```
### Api Request
```
// Using fetch api
const jwt = '...'
fetch('localhost:3000/authenticated-route', {
headers: {
'Authorization': `Bearer ${jwt}`
...
}
...
})
```
## Development
+ `git clone [email protected]:LaunchPadLab/lp_token_auth.git`
+ `bundle install`
### Testing
+ Run tests with `rake`
## FAQ
### Can I use this without ActiveRecord?
Almost! There is a slight dependence on the ActiveRecord method `find`, which is used in order to decode a token based on the resource's `id`. The current workaround is to make sure the resource class you're using implements `find`, and has either a column `id` or implements a method called `id`.
## Authenticate away!