Grape compatibility for devise_token_auth + devise + rails setup
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Initial commit Jun 20, 2015
lib Bump version to 0.1.4 Oct 11, 2016
spec Initial commit Jun 20, 2015
.gitignore Initial commit Jun 20, 2015
.rspec Initial commit Jun 20, 2015
.travis.yml Initial commit Jun 20, 2015
CHANGELOG.md Update CHANGELOG Oct 13, 2015
Gemfile Initial commit Jun 20, 2015
LICENSE.txt Initial commit Jun 20, 2015
README.md Update README Oct 13, 2015
Rakefile
grape_devise_token_auth.gemspec Modify devise and DTA version dependencies Oct 11, 2016

README.md

GrapeDeviseTokenAuth

GrapeDeviseTokenAuth gem is a compatibility layer between devise_token_auth and grape. It is useful when mounting a grape API in a rails application where devise (or devise_token_auth + devise) is already present. It is reliant on devise_token_auth and devise, therefore it is not suitable for grape where these are not present. If you are looking for a pure grape solution, you should check out grape_token_auth.

The majority of the hard work and credit goes to Lyann Dylan Hurley and his fantastic devise_token_auth gem. I merely have ported this to work well with grape.

Installation

Add this line to your application's Gemfile:

gem 'grape_devise_token_auth'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape_devise_token_auth

Usage

Place this line in an initializer in your rails app or at least somewhere before the grape API will get loaded:

GrapeDeviseTokenAuth.setup!

Within the Grape API:

class Posts < Grape::API
  auth :grape_devise_token_auth, resource_class: :user

  helpers GrapeDeviseTokenAuth::AuthHelpers

  # ...
end

The resource class option allows you to specific the scope that will be authenticated, this corresponds to your devise mapping.

Individual endpoints can now be authenticated by calling authenticate_YOUR_MAPPING_HERE! (e.g. authenticate_user!) within them.

For Example:

get '/' do
  authenticate_user!
  present Post.all
end

alternatively to protect all routes place the call in a before block:

before do
  authenticate_user!
end

There is also a authenticate_user version of this helper (notice that it lacks of exclamation mark) that doen't fail nor returns 401.

A full example setup can be found here

Note about ignoring existing warden users

If you are having issues with users persisting across logins or you do not want to integrate with devise, you can disable the integration with devise during setup as so:

GrapeDeviseTokenAuth.setup! do |config|
  config.ignore_existing_warden_users = true
end

Testing and Example

Currently I am using this repo to test this gem, eventually I plan on migrating the tests into the grape_devise_token_auth repo. For now though, I refer you to that repo for how to integrate with an existing devise and devise_token_auth repo.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/grape_devise_token_auth/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request