diff --git a/README.md b/README.md
index 520d0bc7c..3182172fe 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,22 @@
-# Contributors wanted!
-
-See our [Contribution Guidelines](https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/CONTRIBUTING.md). We're making an effort to bring back this gem and fix everything open! Feel free to submit pull requests, review pull requests, or review open issues. If you'd like to get in contact, [Zach Feldman](https://github.com/zachfeldman) has been wrangling this effort, you can reach him with his name @gmail. Further discussion of this in [this issue](https://github.com/lynndylanhurley/devise_token_auth/issues/969).
-
-
-
-
+# Devise Token Auth
[](http://badge.fury.io/rb/devise_token_auth)
[](https://travis-ci.org/lynndylanhurley/devise_token_auth)
-[](https://codeclimate.com/github/lynndylanhurley/devise_token_auth)
-[](https://codeclimate.com/github/lynndylanhurley/devise_token_auth)
+[](https://codeclimate.com/github/lynndylanhurley/devise_token_auth)
+[](https://codeclimate.com/github/lynndylanhurley/devise_token_auth/coverage)
[](https://gemnasium.com/lynndylanhurley/devise_token_auth)
-[](https://rubygems.org/gems/devise_token_auth)
-[](#backers)
-[](#sponsors)
+[](https://rubygems.org/gems/devise_token_auth)
+[](#backers)
+[](#sponsors)
+[](https://gitter.im/lynndylanhurley/devise_token_auth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-## Simple, secure token based authentication for Rails.
+Simple, multi-client and secure token-based authentication for Rails.
-[](https://gitter.im/lynndylanhurley/devise_token_auth?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+If you're building SPA or a mobile app, and you want authentication, you need tokens, not cookies.
+This gem refreshes the tokens on each request, and expires them in a short time, so the app is secure.
+Also, it maintains a session for each client/device, so you can have as many sessions as you want.
-This gem provides the following features:
+## Main features
* Seamless integration with:
* [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) for [AngularJS](https://github.com/angular/angular.js)
@@ -28,66 +25,19 @@ This gem provides the following features:
* [jToker](https://github.com/lynndylanhurley/j-toker) for [jQuery](https://jquery.com/)
* Oauth2 authentication using [OmniAuth](https://github.com/intridea/omniauth).
* Email authentication using [Devise](https://github.com/plataformatec/devise), including:
- * User registration
- * Password reset
- * Account updates
- * Account deletion
-* Support for [multiple user models](https://github.com/lynndylanhurley/devise_token_auth#using-multiple-models).
-* It is [secure](#security).
-
-# Live Demos
-
-[Here is a demo](http://ng-token-auth-demo.herokuapp.com/) of this app running with the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module and [AngularJS](https://github.com/angular/angular.js).
-
-[Here is a demo](https://angular2-token.herokuapp.com) of this app running with the [Angular2-Token](https://github.com/neroniaky/angular2-token) service and [Angular2](https://github.com/angular/angular).
-
-[Here is a demo](https://j-toker-demo.herokuapp.com/) of this app using the [jToker](https://github.com/lynndylanhurley/j-toker) plugin and [React](http://facebook.github.io/react/).
-
-The fully configured api used in these demos can be found [here](https://github.com/lynndylanhurley/devise_token_auth_demo).
+ * User registration, update and deletion
+ * Login and logout
+ * Password reset, account confirmation
+* Support for [multiple user models](./docs/usage/multiple_models.md).
+* It is [secure](docs/security.md).
-# Troubleshooting
-
-Please read the [issue reporting guidelines](#issue-reporting) before posting issues.
-
-# Table of Contents
-
-* [Dependencies](#dependencies)
-* [Configuration TL;DR](#configuration-tldr)
-* [Usage TL;DR](#usage-tldr)
-* [Configuration Continued](#configuration-cont)
- * [Initializer Settings](#initializer-settings)
- * [OmniAuth Authentication](#omniauth-authentication)
- * [OmniAuth Provider Settings](#omniauth-provider-settings)
- * [Email Authentication](#email-authentication)
- * [Customizing Devise Verbiage](#customizing-devise-verbiage)
- * [Cross Origin Requests (CORS)](#cors)
-* [Usage Continued](#usage-cont)
- * [Mounting Routes](#mounting-routes)
- * [Controller Integration](#controller-methods)
- * [Model Integration](#model-concerns)
- * [Using Multiple User Classes](#using-multiple-models)
- * [Excluding Modules](#excluding-modules)
- * [Custom Controller Overrides](#custom-controller-overrides)
- * [Passing blocks to Controllers](#passing-blocks-controllers)
- * [Email Template Overrides](#email-template-overrides)
- * [Testing](#testing)
-* [Issue Reporting Guidelines](#issue-reporting)
-* [FAQ](#faq)
- * [Can I use this gem alongside standard Devise?](#can-i-use-this-gem-alongside-standard-devise)
-* [Conceptual Diagrams](#conceptual)
- * [Token Management](#about-token-management)
- * [Batch Requests](#about-batch-requests)
-* [Security](#security)
-* [Callouts](#callouts)
-* [Contribution Guidelines](#contributing)
-
-# Dependencies
This project leverages the following gems:
* [Devise](https://github.com/plataformatec/devise)
* [OmniAuth](https://github.com/intridea/omniauth)
-# Installation
+## Installation
+
Add the following to your `Gemfile`:
~~~ruby
@@ -100,885 +50,49 @@ Then install the gem using bundle:
bundle install
~~~
-# Configuration TL;DR
-
-You will need to create a [user model](#model-concerns), [define routes](#mounting-routes), [include concerns](#controller-methods), and you may want to alter some of the [default settings](#initializer-settings) for this gem. Run the following command for an easy one-step installation:
-
-~~~bash
-rails g devise_token_auth:install [USER_CLASS] [MOUNT_PATH]
-~~~
-
-**Example**:
-
-~~~bash
-rails g devise_token_auth:install User auth
-~~~
-
-This generator accepts the following optional arguments:
-
-| Argument | Default | Description |
-|---|---|---|
-| USER_CLASS | `User` | The name of the class to use for user authentication. |
-| MOUNT_PATH | `auth` | The path at which to mount the authentication routes. [Read more](#usage-tldr). |
-
-The following events will take place when using the install generator:
-
-* An initializer will be created at `config/initializers/devise_token_auth.rb`. [Read more](#initializer-settings).
-
-* A model will be created in the `app/models` directory. If the model already exists, a concern will be included at the top of the file. [Read more](#model-concerns).
-
-* Routes will be appended to file at `config/routes.rb`. [Read more](#mounting-routes).
-
-* A concern will be included by your application controller at `app/controllers/application_controller.rb`. [Read more](#controller-methods).
-
-* A migration file will be created in the `db/migrate` directory. Inspect the migrations file, add additional columns if necessary, and then run the migration:
-
- ~~~bash
- rake db:migrate
- ~~~
-
-You may also need to configure the following items:
-
-* **OmniAuth providers** when using 3rd party oauth2 authentication. [Read more](#omniauth-authentication).
-* **Cross Origin Request Settings** when using cross-domain clients. [Read more](#cors).
-* **Email** when using email registration. [Read more](#email-authentication).
-* **Multiple model support** may require additional steps. [Read more](#using-multiple-models).
-
-[Jump here](#configuration-cont) for more configuration information.
-
-# Usage TL;DR
-
-The following routes are available for use by your client. These routes live relative to the path at which this engine is mounted (`auth` by default). These routes correspond to the defaults used by the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module for [AngularJS](https://angularjs.org/) and the [jToker](https://github.com/lynndylanhurley/j-toker) plugin for [jQuery](https://jquery.com/).
-
-| path | method | purpose |
-|:-----|:-------|:--------|
-| / | POST | Email registration. Requires **`email`**, **`password`**, **`password_confirmation`**, and **`confirm_success_url`** params (this last one can be omitted if you have set `config.default_confirm_success_url` in `config/initializers/devise_token_auth.rb`). A verification email will be sent to the email address provided. Upon clicking the link in the confirmation email, the API will redirect to the URL specified in **`confirm_success_url`**. Accepted params can be customized using the [`devise_parameter_sanitizer`](https://github.com/plataformatec/devise#strong-parameters) system. |
-| / | DELETE | Account deletion. This route will destroy users identified by their **`uid`**, **`access-token`** and **`client`** headers. |
-| / | PUT | Account updates. This route will update an existing user's account settings. The default accepted params are **`password`** and **`password_confirmation`**, but this can be customized using the [`devise_parameter_sanitizer`](https://github.com/plataformatec/devise#strong-parameters) system. If **`config.check_current_password_before_update`** is set to `:attributes` the **`current_password`** param is checked before any update, if it is set to `:password` the **`current_password`** param is checked only if the request updates user password. |
-| /sign_in | POST | Email authentication. Requires **`email`** and **`password`** as params. This route will return a JSON representation of the `User` model on successful login along with the `access-token` and `client` in the header of the response. |
-| /sign_out | DELETE | Use this route to end the user's current session. This route will invalidate the user's authentication token. You must pass in **`uid`**, **`client`**, and **`access-token`** in the request headers. |
-| /:provider | GET | Set this route as the destination for client authentication. Ideally this will happen in an external window or popup. [Read more](#omniauth-authentication). |
-| /:provider/callback | GET/POST | Destination for the oauth2 provider's callback uri. `postMessage` events containing the authenticated user's data will be sent back to the main client window from this page. [Read more](#omniauth-authentication). |
-| /validate_token | GET | Use this route to validate tokens on return visits to the client. Requires **`uid`**, **`client`**, and **`access-token`** as params. These values should correspond to the columns in your `User` table of the same names. |
-| /password | POST | Use this route to send a password reset confirmation email to users that registered by email. Accepts **`email`** and **`redirect_url`** as params. The user matching the `email` param will be sent instructions on how to reset their password. `redirect_url` is the url to which the user will be redirected after visiting the link contained in the email. |
-| /password | PUT | Use this route to change users' passwords. Requires **`password`** and **`password_confirmation`** as params. This route is only valid for users that registered by email (OAuth2 users will receive an error). It also checks **`current_password`** if **`config.check_current_password_before_update`** is not set `false` (disabled by default). |
-| /password/edit | GET | Verify user by password reset token. This route is the destination URL for password reset confirmation. This route must contain **`reset_password_token`** and **`redirect_url`** params. These values will be set automatically by the confirmation email that is generated by the password reset request. |
-
-[Jump here](#usage-cont) for more usage information.
-
-# Configuration cont.
-
-## Initializer settings
-
-The following settings are available for configuration in `config/initializers/devise_token_auth.rb`:
-
-| Name | Default | Description|
-|---|---|---|
-| **`change_headers_on_each_request`** | `true` | By default the access-token header will change after each request. The client is responsible for keeping track of the changing tokens. Both [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) and [jToker](https://github.com/lynndylanhurley/j-toker) do this out of the box. While this implementation is more secure, it can be difficult to manage. Set this to false to prevent the `access-token` header from changing after each request. [Read more](#about-token-management). |
-| **`token_lifespan`** | `2.weeks` | Set the length of your tokens' lifespans. Users will need to re-authenticate after this duration of time has passed since their last login. |
-| **`batch_request_buffer_throttle`** | `5.seconds` | Sometimes it's necessary to make several requests to the API at the same time. In this case, each request in the batch will need to share the same auth token. This setting determines how far apart the requests can be while still using the same auth token. [Read more](#about-batch-requests). |
-| **`omniauth_prefix`** | `"/omniauth"` | This route will be the prefix for all oauth2 redirect callbacks. For example, using the default '/omniauth' setting, the github oauth2 provider will redirect successful authentications to '/omniauth/github/callback'. [Read more](#omniauth-provider-settings). |
-| **`default_confirm_success_url`** | `nil` | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful email confirmation. If this param is set, the API will redirect to this value when no value is provided by the client. |
-| **`default_password_reset_url`** | `nil` | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful password resets. If this param is set, the API will redirect to this value when no value is provided by the client. |
-| **`redirect_whitelist`** | `nil` | As an added security measure, you can limit the URLs to which the API will redirect after email token validation (password reset, email confirmation, etc.). This value should be an array containing matches to the client URLs to be visited after validation. Wildcards are supported. |
-| **`enable_standard_devise_support`** | `false` | By default, only Bearer Token authentication is implemented out of the box. If, however, you wish to integrate with legacy Devise authentication, you can do so by enabling this flag. NOTE: This feature is highly experimental! |
-| **`remove_tokens_after_password_reset`** | `false` | By default, old tokens are not invalidated when password is changed. Enable this option if you want to make passwords updates to logout other devices. |
-| **`default_callbacks`** | `true` | By default User model will include the `DeviseTokenAuth::Concerns::UserOmniauthCallbacks` concern, which has `email`, `uid` validations & `uid` synchronization callbacks. |
-| **`bypass_sign_in`** | `true` | By default DeviseTokenAuth will not check user's `#active_for_authentication?` which includes confirmation check on each call (it will do it only on sign in). If you want it to be validated on each request (for example, to be able to deactivate logged in users on the fly), set it to false. |
-
-
-Additionally, you can configure other aspects of devise by manually creating the traditional devise.rb file at `config/initializers/devise.rb`. Here are some examples of what you can do in this file:
-
-~~~ruby
-Devise.setup do |config|
- # The e-mail address that mail will appear to be sent from
- # If absent, mail is sent from "please-change-me-at-config-initializers-devise@example.com"
- config.mailer_sender = "support@myapp.com"
-
- # If using rails-api, you may want to tell devise to not use ActionDispatch::Flash
- # middleware b/c rails-api does not include it.
- # See: http://stackoverflow.com/q/19600905/806956
- config.navigational_formats = [:json]
-end
-~~~
-
-## OmniAuth authentication
-
-If you wish to use omniauth authentication, add all of your desired authentication provider gems to your `Gemfile`.
-
-**OmniAuth example using github, facebook, and google**:
-~~~ruby
-gem 'omniauth-github'
-gem 'omniauth-facebook'
-gem 'omniauth-google-oauth2'
-~~~
-
-Then run `bundle install`.
-
-[List of oauth2 providers](https://github.com/intridea/omniauth/wiki/List-of-Strategies)
-
-## OmniAuth provider settings
-
-In `config/initializers/omniauth.rb`, add the settings for each of your providers.
-
-These settings must be obtained from the providers themselves.
-
-**Example using github, facebook, and google**:
-~~~ruby
-# config/initializers/omniauth.rb
-Rails.application.config.middleware.use OmniAuth::Builder do
- provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET'], scope: 'email,profile'
- provider :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET']
- provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET']
-end
-~~~
-
-The above example assumes that your provider keys and secrets are stored in environmental variables. Use the [figaro](https://github.com/laserlemon/figaro) gem (or [dotenv](https://github.com/bkeepers/dotenv) or [secrets.yml](https://github.com/rails/rails/blob/v4.1.0/railties/lib/rails/generators/rails/app/templates/config/secrets.yml) or equivalent) to accomplish this.
-
-#### OmniAuth callback settings
-
-The "Callback URL" setting that you set with your provider must correspond to the [omniauth prefix](#initializer-settings) setting defined by this app. **This will be different than the omniauth route that is used by your client application**.
-
-For example, the demo app uses the default `omniauth_prefix` setting `/omniauth`, so the "Authorization callback URL" for github must be set to "http://devise-token-auth-demo.herokuapp.com**/omniauth**/github/callback".
-
-**Github example for the demo site**:
-
-
-The url for github authentication will be different for the client. The client should visit the API at `/[MOUNT_PATH]/:provider` for omniauth authentication.
-
-For example, given that the app is mounted using the following settings:
-
-~~~ruby
-# config/routes.rb
-mount_devise_token_auth_for 'User', at: 'auth'
-~~~
-
-The client configuration for github should look like this:
-
-**Angular.js setting for authenticating using github**:
-~~~javascript
-angular.module('myApp', ['ng-token-auth'])
- .config(function($authProvider) {
- $authProvider.configure({
- apiUrl: 'http://api.example.com'
- authProviderPaths: {
- github: '/auth/github' // <-- note that this is different than what was set with github
- }
- });
- });
-~~~
-
-**jToker settings for github should look like this:
-
-~~~javascript
-$.auth.configure({
- apiUrl: 'http://api.example.com',
- authProviderPaths: {
- github: '/auth/github' // <-- note that this is different than what was set with github
- }
-});
-~~~
-
-This incongruence is necessary to support multiple user classes and mounting points.
-
-#### Note for [pow](http://pow.cx/) and [xip.io](http://xip.io) users
-
-If you receive `redirect-uri-mismatch` errors from your provider when using pow or xip.io urls, set the following in your development config:
-
-~~~ruby
-# config/environments/development.rb
-
-# when using pow
-OmniAuth.config.full_host = "http://app-name.dev"
-
-# when using xip.io
-OmniAuth.config.full_host = "http://xxx.xxx.xxx.app-name.xip.io"
-~~~
-
-## Email authentication
-If you wish to use email authentication, you must configure your Rails application to send email. [Read here](http://guides.rubyonrails.org/action_mailer_basics.html) for more information.
-
-I recommend using [mailcatcher](http://mailcatcher.me/) for development.
-
-##### mailcatcher development example configuration:
-~~~ruby
-# config/environments/development.rb
-Rails.application.configure do
- config.action_mailer.default_url_options = { :host => 'your-dev-host.dev' }
- config.action_mailer.delivery_method = :smtp
- config.action_mailer.smtp_settings = { :address => 'your-dev-host.dev', :port => 1025 }
-end
-~~~
-
-If you wish to send custom e-mails instead of using the default devise templates, you can [do that too](#email-template-overrides).
-
-## Customizing Devise Verbiage
-Devise Token Auth ships with intelligent default wording for everything you need. But that doesn't mean you can't make it more awesome. You can override the [devise defaults](https://github.com/plataformatec/devise/blob/master/config/locales/en.yml) by creating a YAML file at `config/locales/devise.en.yml` and assigning whatever custom values you want. For example, to customize the subject line of your devise e-mails, you could do this:
-
-~~~yaml
-en:
- devise:
- mailer:
- confirmation_instructions:
- subject: "Please confirm your e-mail address"
- reset_password_instructions:
- subject: "Reset password request"
-~~~
-
-## CORS
-
-If your API and client live on different domains, you will need to configure your Rails API to allow [cross origin requests](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing). The [rack-cors](https://github.com/cyu/rack-cors) gem can be used to accomplish this.
-
-The following **dangerous** example will allow cross domain requests from **any** domain. Make sure to whitelist only the needed domains.
-
-##### Example rack-cors configuration:
-~~~ruby
-# gemfile
-gem 'rack-cors', :require => 'rack/cors'
-
-# config/application.rb
-module YourApp
- class Application < Rails::Application
- config.middleware.use Rack::Cors do
- allow do
- origins '*'
- resource '*',
- :headers => :any,
- :expose => ['access-token', 'expiry', 'token-type', 'uid', 'client'],
- :methods => [:get, :post, :options, :delete, :put]
- end
- end
- end
-end
-~~~
-
-Make extra sure that the `Access-Control-Expose-Headers` includes `access-token`, `expiry`, `token-type`, `uid`, and `client` (as is set in the example above by the`:expose` param). If your client experiences erroneous 401 responses, this is likely the cause.
-
-CORS may not be possible with older browsers (IE8, IE9). I usually set up a proxy for those browsers. See the [ng-token-auth readme](https://github.com/lynndylanhurley/ng-token-auth) or the [jToker readme](https://github.com/lynndylanhurley/j-toker) for more information.
-
-# Usage cont.
-
-## Mounting Routes
-
-The authentication routes must be mounted to your project. This gem includes a route helper for this purpose:
-
-**`mount_devise_token_auth_for`** - similar to `devise_for`, this method is used to append the routes necessary for user authentication. This method accepts the following arguments:
-
-| Argument | Type | Default | Description |
-|---|---|---|---|
-|`class_name`| string | 'User' | The name of the class to use for authentication. This class must include the [model concern described here](#model-concerns). |
-| `options` | object | {at: 'auth'} | The [routes to be used for authentication](#usage) will be prefixed by the path specified in the `at` param of this object. |
-
-**Example**:
-~~~ruby
-# config/routes.rb
-mount_devise_token_auth_for 'User', at: 'auth'
-~~~
-
-Any model class can be used, but the class will need to include [`DeviseTokenAuth::Concerns::User`](#model-concerns) for authentication to work properly.
-
-You can mount this engine to any route that you like. `/auth` is used by default to conform with the defaults of the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module and the [jToker](https://github.com/lynndylanhurley/j-toker) plugin.
-
-
-## Controller Methods
-
-### Concerns
-
-This gem includes a [Rails concern](http://api.rubyonrails.org/classes/ActiveSupport/Concern.html) called `DeviseTokenAuth::Concerns::SetUserByToken`. Include this concern to provide access to [controller methods](#controller-methods) such as [`authenticate_user!`](#authenticate-user), [`user_signed_in?`](#user-signed-in), etc.
-
-The concern also runs an [after_action](http://guides.rubyonrails.org/action_controller_overview.html#filters) that changes the auth token after each request.
-
-It is recommended to include the concern in your base `ApplicationController` so that all children of that controller include the concern as well.
-
-##### Concern example:
-
-~~~ruby
-# app/controllers/application_controller.rb
-class ApplicationController < ActionController::Base
- include DeviseTokenAuth::Concerns::SetUserByToken
-end
-~~~
-
-### Methods
-
-This gem provides access to all of the following [devise helpers](https://github.com/plataformatec/devise#controller-filters-and-helpers):
-
-| Method | Description |
-|---|---|
-| **`before_action :authenticate_user!`** | Returns a 401 error unless a `User` is signed-in. |
-| **`current_user`** | Returns the currently signed-in `User`, or `nil` if unavailable. |
-| **`user_signed_in?`** | Returns `true` if a `User` is signed in, otherwise `false`. |
-| **`devise_token_auth_group`** | Operate on multiple user classes as a group. [Read more](#group-access) |
-
-Note that if the model that you're trying to access isn't called `User`, the helper method names will change. For example, if the user model is called `Admin`, the methods would look like this:
-
-* `before_action :authenticate_admin!`
-* `admin_signed_in?`
-* `current_admin`
-
-
-##### Example: limit access to authenticated users
-~~~ruby
-# app/controllers/test_controller.rb
-class TestController < ApplicationController
- before_action :authenticate_user!
-
- def members_only
- render json: {
- data: {
- message: "Welcome #{current_user.name}",
- user: current_user
- }
- }, status: 200
- end
-end
-~~~
-
-### Token Header Format
-
-The authentication information should be included by the client in the headers of each request. The headers follow the [RFC 6750 Bearer Token](http://tools.ietf.org/html/rfc6750) format:
-
-##### Authentication headers example:
-~~~
-"access-token": "wwwww",
-"token-type": "Bearer",
-"client": "xxxxx",
-"expiry": "yyyyy",
-"uid": "zzzzz"
-~~~
-
-The authentication headers (each one is a seperate header) consists of the following params:
-
-| param | description |
-|---|---|
-| **`access-token`** | This serves as the user's password for each request. A hashed version of this value is stored in the database for later comparison. This value should be changed on each request. |
-| **`client`** | This enables the use of multiple simultaneous sessions on different clients. (For example, a user may want to be authenticated on both their phone and their laptop at the same time.) |
-| **`expiry`** | The date at which the current session will expire. This can be used by clients to invalidate expired tokens without the need for an API request. |
-| **`uid`** | A unique value that is used to identify the user. This is necessary because searching the DB for users by their access token will make the API susceptible to [timing attacks](http://codahale.com/a-lesson-in-timing-attacks/). |
-
-The authentication headers required for each request will be available in the response from the previous request. If you are using the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) AngularJS module or the [jToker](https://github.com/lynndylanhurley/j-toker) jQuery plugin, this functionality is already provided.
-
-## Model Concerns
-
-##### DeviseTokenAuth::Concerns::User
-
-Typical use of this gem will not require the use of any of the following model methods. All authentication should be handled invisibly by the [controller concerns](#controller-methods) described above.
-
-Models that include the `DeviseTokenAuth::Concerns::User` concern will have access to the following public methods (read the above section for context on `token` and `client`):
-
-* **`valid_token?`**: check if an authentication token is valid. Accepts a `token` and `client` as arguments. Returns a boolean.
+## [Docs](https://maicolben.gitbooks.io/devise-token-auth/content/docs/config/)
- **Example**:
- ~~~ruby
- # extract token + client_id from auth header
- client_id = request.headers['client']
- token = request.headers['access-token']
+## Need help?
- @resource.valid_token?(token, client_id)
- ~~~
+Please use [StackOverflow](https://stackoverflow.com/questions/tagged/devise-token-auth) for help requests and how-to questions.
-* **`create_new_auth_token`**: creates a new auth token with all of the necessary metadata. Accepts `client` as an optional argument. Will generate a new `client` if none is provided. Returns the authentication headers that should be sent by the client as an object.
+Please open GitHub issues for bugs and enhancements only, not general help requests. Please search previous issues (and Google and StackOverflow) before creating a new issue.
- **Example**:
- ~~~ruby
- # extract client_id from auth header
- client_id = request.headers['client']
+Please read the [ISSUE_TEMPLATE.md] before posting issues.
- # update token, generate updated auth headers for response
- new_auth_header = @resource.create_new_auth_token(client_id)
+## [FAQ](docs/faq.md)
- # update response with the header that will be required by the next request
- response.headers.merge!(new_auth_header)
- ~~~
+## Contributors wanted!
-* **`build_auth_header`**: generates the auth header that should be sent to the client with the next request. Accepts `token` and `client` as arguments. Returns a string.
+See our [Contribution Guidelines](https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/CONTRIBUTING.md). Feel free to submit pull requests, review pull requests, or review open issues. If you'd like to get in contact, [Zach Feldman](https://github.com/zachfeldman) has been wrangling this effort, you can reach him with his name @gmail. Further discussion of this in [this issue](https://github.com/lynndylanhurley/devise_token_auth/issues/969).
- **Example**:
- ~~~ruby
- # create client id and token
- client_id = SecureRandom.urlsafe_base64(nil, false)
- token = SecureRandom.urlsafe_base64(nil, false)
+## Live Demos
- # store client + token in user's token hash
- @resource.tokens[client_id] = {
- token: BCrypt::Password.create(token),
- expiry: (Time.zone.now + @resource.token_lifespan).to_i
- }
-
- # generate auth headers for response
- new_auth_header = @resource.build_auth_header(token, client_id)
-
- # update response with the header that will be required by the next request
- response.headers.merge!(new_auth_header)
- ~~~
-
-## Using multiple models
-
-### View Live Multi-User Demos
-
-* [AngularJS](http://ng-token-auth-demo.herokuapp.com/multi-user)
-* [Angular2](https://angular2-token.herokuapp.com)
-* [React + jToker](http://j-toker-demo.herokuapp.com/#/alt-user)
-
-This gem supports the use of multiple user models. One possible use case is to authenticate visitors using a model called `User`, and to authenticate administrators with a model called `Admin`. Take the following steps to add another authentication model to your app:
-
-1. Run the install generator for the new model.
- ~~~
- rails g devise_token_auth:install Admin admin_auth
- ~~~
-
- This will create the `Admin` model and define the model's authentication routes with the base path `/admin_auth`.
-
-1. Define the routes to be used by the `Admin` user within a [`devise_scope`](https://github.com/plataformatec/devise#configuring-routes).
-
- **Example**:
-
- ~~~ruby
- Rails.application.routes.draw do
- # when using multiple models, controllers will default to the first available
- # devise mapping. routes for subsequent devise mappings will need to defined
- # within a `devise_scope` block
-
- # define :users as the first devise mapping:
- mount_devise_token_auth_for 'User', at: 'auth'
-
- # define :admins as the second devise mapping. routes using this class will
- # need to be defined within a devise_scope as shown below
- mount_devise_token_auth_for "Admin", at: 'admin_auth'
-
- # this route will authorize requests using the User class
- get 'demo/members_only', to: 'demo#members_only'
-
- # routes within this block will authorize requests using the Admin class
- devise_scope :admin do
- get 'demo/admins_only', to: 'demo#admins_only'
- end
- end
- ~~~
-
-1. Configure any `Admin` restricted controllers. Controllers will now have access to the methods [described here](#methods):
- * `before_action :authenticate_admin!`
- * `current_admin`
- * `admin_signed_in?`
-
-
-### Group access
-
-It is also possible to control access to multiple user types at the same time using groups. The following example shows how to limit controller access to both `User` and `Admin` users.
-
-##### Example: group authentication
-
-~~~ruby
-class DemoGroupController < ApplicationController
- devise_token_auth_group :member, contains: [:user, :admin]
- before_action :authenticate_member!
-
- def members_only
- render json: {
- data: {
- message: "Welcome #{current_member.name}",
- user: current_member
- }
- }, status: 200
- end
-end
-~~~
-
-In the above example, the following methods will be available (in addition to `current_user`, `current_admin`, etc.):
-
- * `before_action: :authenticate_member!`
- * `current_member`
- * `member_signed_in?`
-
-## Excluding Modules
-
-By default, almost all of the Devise modules are included:
-* [`database_authenticatable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/database_authenticatable.rb)
-* [`registerable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/registerable.rb)
-* [`recoverable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/recoverable.rb)
-* [`trackable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/trackable.rb)
-* [`validatable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/validatable.rb)
-* [`confirmable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/confirmable.rb)
-* [`omniauthable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/omniauthable.rb)
-
-You may not want all of these features enabled in your app. That's OK! You can mix and match to suit your own unique style.
-
-The following example shows how to disable email confirmation.
-
-##### Example: disable email confirmation
-
-Just list the devise modules that you want to include **before** including the `DeviseTokenAuth::Concerns::User` model concern.
-
-~~~ruby
-# app/models/user.rb
-class User < ActiveRecord::Base
-
- # notice this comes BEFORE the include statement below
- # also notice that :confirmable is not included in this block
- devise :database_authenticatable, :recoverable,
- :trackable, :validatable, :registerable,
- :omniauthable
-
- # note that this include statement comes AFTER the devise block above
- include DeviseTokenAuth::Concerns::User
-end
-~~~
-
-Some features include routes that you may not want mounted to your app. The following example shows how to disable OAuth and its routes.
-
-##### Example: disable OAuth authentication
-
-First instruct the model not to include the `omniauthable` module.
-
-~~~ruby
-# app/models/user.rb
-class User < ActiveRecord::Base
-
- # notice that :omniauthable is not included in this block
- devise :database_authenticatable, :confirmable,
- :recoverable, :trackable, :validatable,
- :registerable
-
- include DeviseTokenAuth::Concerns::User
-end
-~~~
-
-Now tell the route helper to `skip` mounting the `omniauth_callbacks` controller:
-
-~~~ruby
-Rails.application.routes.draw do
- # config/routes.rb
- mount_devise_token_auth_for 'User', at: 'auth', skip: [:omniauth_callbacks]
-end
-~~~
-
-## Custom Controller Overrides
-
-The built-in controllers can be overridden with your own custom controllers.
-
-For example, the default behavior of the [`validate_token`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb#L6) method of the [`TokenValidationController`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb) is to return the `User` object as json (sans password and token data). The following example shows how to override the `validate_token` action to include a model method as well.
-
-##### Example: controller overrides
-
-~~~ruby
-# config/routes.rb
-Rails.application.routes.draw do
- ...
- mount_devise_token_auth_for 'User', at: 'auth', controllers: {
- token_validations: 'overrides/token_validations'
- }
-end
-
-# app/controllers/overrides/token_validations_controller.rb
-module Overrides
- class TokenValidationsController < DeviseTokenAuth::TokenValidationsController
-
- def validate_token
- # @resource will have been set by set_user_by_token concern
- if @resource
- render json: {
- data: @resource.as_json(methods: :calculate_operating_thetan)
- }
- else
- render json: {
- success: false,
- errors: ["Invalid login credentials"]
- }, status: 401
- end
- end
- end
-end
-~~~
-
-## Overriding rendering methods
-To customize json rendering, implement the following protected controller methods, for success methods, assume that the @resource object is available:
-
-### Registrations Controller
-* render_create_error_missing_confirm_success_url
-* render_create_error_redirect_url_not_allowed
-* render_create_success
-* render_create_error
-* render_create_error_email_already_exists
-* render_update_success
-* render_update_error
-* render_update_error_user_not_found
-
-
-### Sessions Controller
-* render_new_error
-* render_create_success
-* render_create_error_not_confirmed
-* render_create_error_bad_credentials
-* render_destroy_success
-* render_destroy_error
-
-
-### Passwords Controller
-* render_create_error_missing_email
-* render_create_error_missing_redirect_url
-* render_create_error_not_allowed_redirect_url
-* render_create_success
-* render_create_error
-* render_update_error_unauthorized
-* render_update_error_password_not_required
-* render_update_error_missing_password
-* render_update_success
-* render_update_error
-
-### Token Validations Controller
-* render_validate_token_success
-* render_validate_token_error
-
-##### Example: all :controller options with default settings:
-
-~~~ruby
-mount_devise_token_auth_for 'User', at: 'auth', controllers: {
- confirmations: 'devise_token_auth/confirmations',
- passwords: 'devise_token_auth/passwords',
- omniauth_callbacks: 'devise_token_auth/omniauth_callbacks',
- registrations: 'devise_token_auth/registrations',
- sessions: 'devise_token_auth/sessions',
- token_validations: 'devise_token_auth/token_validations'
-}
-~~~
-
-**Note:** Controller overrides must implement the expected actions of the controllers that they replace.
-
-## Passing blocks to Controllers
-
-It may be that you simply want to _add_ behavior to existing controllers without having to re-implement their behavior completely. In this case, you can do so by creating a new controller that inherits from any of DeviseTokenAuth's controllers, overriding whichever methods you'd like to add behavior to by passing a block to `super`:
-
-```ruby
-class Custom::RegistrationsController < DeviseTokenAuth::RegistrationsController
-
- def create
- super do |resource|
- resource.do_something(extra)
- end
- end
-
-end
-```
-
-Your block will be performed just before the controller would usually render a successful response.
-
-## Email Template Overrides
-
-You will probably want to override the default email templates for email sign-up and password-reset confirmation. Run the following command to copy the email templates into your app:
-
-~~~bash
-rails generate devise_token_auth:install_views
-~~~
-
-This will create two new files:
-
-* `app/views/devise/mailer/reset_password_instructions.html.erb`
-* `app/views/devise/mailer/confirmation_instructions.html.erb`
-
-These files may be edited to suit your taste. You can customize the e-mail subjects like [this](#customizing-devise-verbiage).
-
-**Note:** if you choose to modify these templates, do not modify the `link_to` blocks unless you absolutely know what you are doing.
-
-## Testing
-
-In order to authorise a request when testing your API you will need to pass the four headers through with your request, the easiest way to gain appropriate values for those headers is to use `resource.create_new_auth_token` e.g.
-
-```Ruby
- request.headers.merge! resource.create_new_auth_token
- get '/api/authenticated_resource'
- # success
-```
-
-# Issue Reporting
-
-When posting issues, please include the information mentioned in the [ISSUE_TEMPLATE.md].
-
-[ISSUE_TEMPLATE.md]: https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/ISSUE_TEMPLATE.md
-
-# FAQ
-
-### Can I use this gem alongside standard Devise?
-
-Yes! But you will need to enable the support of separate routes for standard Devise. So do something like this:
-
-#### config/initializers/devise_token_auth.rb
-~~~ruby
-DeviseTokenAuth.setup do |config|
- # config.enable_standard_devise_support = false
-end
-~~~
-
-#### config/routes.rb
-~~~ruby
-Rails.application.routes.draw do
-
- # standard devise routes available at /users
- # NOTE: make sure this comes first!!!
- devise_for :users
-
- # token auth routes available at /api/v1/auth
- namespace :api do
- scope :v1 do
- mount_devise_token_auth_for 'User', at: 'auth'
- end
- end
-
-end
-~~~
-
-### Why are the `new` routes included if this gem doesn't use them?
-
-Removing the `new` routes will require significant modifications to devise. If the inclusion of the `new` routes is causing your app any problems, post an issue in the issue tracker and it will be addressed ASAP.
-
-### I'm having trouble using this gem alongside [ActiveAdmin](http://activeadmin.info/)...
-
-For some odd reason, [ActiveAdmin](http://activeadmin.info/) extends from your own app's `ApplicationController`. This becomes a problem if you include the `DeviseTokenAuth::Concerns::SetUserByToken` concern in your app's `ApplicationController`.
-
-The solution is to use two separate `ApplicationController` classes - one for your API, and one for ActiveAdmin. Something like this:
-
-~~~ruby
-# app/controllers/api_controller.rb
-# API routes extend from this controller
-class ApiController < ActionController::Base
- include DeviseTokenAuth::Concerns::SetUserByToken
-end
-
-# app/controllers/application_controller.rb
-# leave this for ActiveAdmin, and any other non-api routes
-class ApplicationController < ActionController::Base
-end
-~~~
-
-### How can I use this gem with Grape?
-
-You may be interested in [GrapeTokenAuth](https://github.com/mcordell/grape_token_auth) or [GrapeDeviseTokenAuth](https://github.com/mcordell/grape_devise_token_auth).
-
-### I already have a user, how can I add the new fields?
-
-Check [Setup migrations for an existing User table](https://github.com/lynndylanhurley/devise_token_auth/wiki/Setup-migrations-for-an-existing-User-table)
-
-
-# Conceptual
-
-None of the following information is required to use this gem, but read on if you're curious.
-
-## About token management
-
-Tokens should be invalidated after each request to the API. The following diagram illustrates this concept:
-
-
-
-During each request, a new token is generated. The `access-token` header that should be used in the next request is returned in the `access-token` header of the response to the previous request. The last request in the diagram fails because it tries to use a token that was invalidated by the previous request.
-
-The only case where an expired token is allowed is during [batch requests](#about-batch-requests).
-
-These measures are taken by default when using this gem.
-
-## About batch requests
-
-By default, the API should update the auth token for each request ([read more](#about-token-management)). But sometimes it's necessary to make several concurrent requests to the API, for example:
-
-##### Batch request example
-
-~~~javascript
-$scope.getResourceData = function() {
-
- $http.get('/api/restricted_resource_1').success(function(resp) {
- // handle response
- $scope.resource1 = resp.data;
- });
-
- $http.get('/api/restricted_resource_2').success(function(resp) {
- // handle response
- $scope.resource2 = resp.data;
- });
-};
-~~~
-
-In this case, it's impossible to update the `access-token` header for the second request with the `access-token` header of the first response because the second request will begin before the first one is complete. The server must allow these batches of concurrent requests to share the same auth token. This diagram illustrates how batch requests are identified by the server:
-
-
-
-The "5 second" buffer in the diagram is the default used this gem.
-
-The following diagram details the relationship between the client, server, and access tokens used over time when dealing with batch requests:
-
-
-
-Note that when the server identifies that a request is part of a batch request, the user's auth token is not updated. The auth token will be updated and returned with the first request in the batch, and the subsequent requests in the batch will not return a token. This is necessary because the order of the responses cannot be guaranteed to the client, and we need to be sure that the client does not receive an outdated token *after* the the last valid token is returned.
-
-This gem automatically manages batch requests. You can change the time buffer for what is considered a batch request using the `batch_request_buffer_throttle` parameter in `config/initializers/devise_token_auth.rb`.
-
-
-# Security
-
-This gem takes the following steps to ensure security.
-
-This gem uses auth tokens that are:
-* [changed after every request](#about-token-management) (can be [turned off](https://github.com/lynndylanhurley/devise_token_auth/#initializer-settings)),
-* [of cryptographic strength](http://ruby-doc.org/stdlib-2.1.0/libdoc/securerandom/rdoc/SecureRandom.html),
-* hashed using [BCrypt](https://github.com/codahale/bcrypt-ruby) (not stored in plain-text),
-* securely compared (to protect against timing attacks),
-* invalidated after 2 weeks (thus requiring users to login again)
-
-These measures were inspired by [this stackoverflow post](http://stackoverflow.com/questions/18605294/is-devises-token-authenticatable-secure).
-
-This gem further mitigates timing attacks by using [this technique](https://gist.github.com/josevalim/fb706b1e933ef01e4fb6).
-
-But the most important step is to use HTTPS. You are on the hook for that.
-
-# Callouts
-
-Thanks to the following contributors:
+[Here is a demo](http://ng-token-auth-demo.herokuapp.com/) of this app running with the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module and [AngularJS](https://github.com/angular/angular.js).
-* [@booleanbetrayal](https://github.com/booleanbetrayal)
-* [@zachfeldman](https://github.com/zachfeldman)
-* [@MaicolBen](https://github.com/MaicolBen)
-* [@guilhermesimoes](https://github.com/guilhermesimoes)
-* [@jasonswett](https://github.com/jasonswett)
-* [@m2omou](https://github.com/m2omou)
-* [@smarquez1](https://github.com/smarquez1)
-* [@jartek](https://github.com/jartek)
-* [@nicolas-besnard](https://github.com/nicolas-besnard)
-* [@tbloncar](https://github.com/tbloncar)
-* [@nickL](https://github.com/nickL)
-* [@mchavarriagam](https://github.com/mchavarriagam)
+[Here is a demo](https://angular2-token.herokuapp.com) of this app running with the [Angular2-Token](https://github.com/neroniaky/angular2-token) service and [Angular2](https://github.com/angular/angular).
-# Contributing
+[Here is a demo](https://j-toker-demo.herokuapp.com/) of this app using the [jToker](https://github.com/lynndylanhurley/j-toker) plugin and [React](http://facebook.github.io/react/).
-See the [CONTRIBUTING.md] document.
+The fully configured api used in these demos can be found [here](https://github.com/lynndylanhurley/devise_token_auth_demo).
-[CONTRIBUTING.md]: https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/CONTRIBUTING.md
## Contributors
-This project exists thanks to all the people who contribute. [[Contribute](https://github.com/lynndylanhurley/devise_token_auth/blob/master/.github/CONTRIBUTING.md)].
-
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/devise_token_auth#backer)]
-
+[](https://opencollective.com/devise_token_auth#backers)
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/devise_token_auth#sponsor)]
-
-
-
-
-
-
-
-
-
-
-
-
+[](https://opencollective.com/devise_token_auth/sponsor/0/website) [](https://opencollective.com/devise_token_auth/sponsor/1/website) [](https://opencollective.com/devise_token_auth/sponsor/2/website) [](https://opencollective.com/devise_token_auth/sponsor/3/website) [](https://opencollective.com/devise_token_auth/sponsor/4/website) [](https://opencollective.com/devise_token_auth/sponsor/5/website) [](https://opencollective.com/devise_token_auth/sponsor/6/website) [](https://opencollective.com/devise_token_auth/sponsor/7/website) [](https://opencollective.com/devise_token_auth/sponsor/8/website) [](https://opencollective.com/devise_token_auth/sponsor/9/website)
-# License
+## License
This project uses the WTFPL
diff --git a/SUMMARY.md b/SUMMARY.md
new file mode 100644
index 000000000..a2cd8182b
--- /dev/null
+++ b/SUMMARY.md
@@ -0,0 +1,27 @@
+# Summary
+
+* Introduction
+ * [Installation](README.md#installation)
+ * [Need help?](README.md#need-help)
+ * [Live demos](README.md#live-demos)
+* Configuration
+ * [Introduction](docs/config/README.md)
+ * [Initializer Settings](docs/config/initialization.md)
+ * [OmniAuth](docs/config/omniauth.md)
+ * [Email Authentication](docs/config/email_auth.md)
+ * [Customizing Devise Verbiage](docs/config/devise.md)
+ * [Cross Origin Requests (CORS)](docs/config/cors.md)
+* Usage
+ * [Introduction](docs/usage/README.md)
+ * [Mounting Routes](docs/usage/routes.md)
+ * [Controller Integration](docs/usage/controller_methods.md)
+ * [Model Integration](docs/usage/model_concerns.md)
+ * [Using Multiple User Classes](docs/usage/multiple_models.md)
+ * [Excluding Modules](docs/usage/excluding_models.md)
+ * [Custom Controller/Email Overrides](docs/usage/overrides.md)
+ * [Testing](docs/usage/testing.md)
+* [FAQ](docs/faq.md)
+* [Conceptual Diagrams](docs/conceptual.md)
+ * [Token Management](docs/conceptual.md#about-token-management)
+ * [Batch Requests](docs/conceptual.md#about-batch-requests)
+* [Security](docs/security.md)
diff --git a/docs/conceptual.md b/docs/conceptual.md
new file mode 100644
index 000000000..9ebf5fbf5
--- /dev/null
+++ b/docs/conceptual.md
@@ -0,0 +1,50 @@
+# Conceptual
+
+None of the following information is required to use this gem, but read on if you're curious.
+
+## About token management
+
+Tokens should be invalidated after each request to the API. The following diagram illustrates this concept:
+
+
+
+During each request, a new token is generated. The `access-token` header that should be used in the next request is returned in the `access-token` header of the response to the previous request. The last request in the diagram fails because it tries to use a token that was invalidated by the previous request.
+
+The only case where an expired token is allowed is during [batch requests](#about-batch-requests).
+
+These measures are taken by default when using this gem.
+
+## About batch requests
+
+By default, the API should update the auth token for each request ([read more](#about-token-management)). But sometimes it's necessary to make several concurrent requests to the API, for example:
+
+##### Batch request example
+
+~~~javascript
+$scope.getResourceData = function() {
+
+ $http.get('/api/restricted_resource_1').success(function(resp) {
+ // handle response
+ $scope.resource1 = resp.data;
+ });
+
+ $http.get('/api/restricted_resource_2').success(function(resp) {
+ // handle response
+ $scope.resource2 = resp.data;
+ });
+};
+~~~
+
+In this case, it's impossible to update the `access-token` header for the second request with the `access-token` header of the first response because the second request will begin before the first one is complete. The server must allow these batches of concurrent requests to share the same auth token. This diagram illustrates how batch requests are identified by the server:
+
+
+
+The "5 second" buffer in the diagram is the default used this gem.
+
+The following diagram details the relationship between the client, server, and access tokens used over time when dealing with batch requests:
+
+
+
+Note that when the server identifies that a request is part of a batch request, the user's auth token is not updated. The auth token will be updated and returned with the first request in the batch, and the subsequent requests in the batch will not return a token. This is necessary because the order of the responses cannot be guaranteed to the client, and we need to be sure that the client does not receive an outdated token *after* the the last valid token is returned.
+
+This gem automatically manages batch requests. You can change the time buffer for what is considered a batch request using the `batch_request_buffer_throttle` parameter in `config/initializers/devise_token_auth.rb`.
diff --git a/docs/config/README.md b/docs/config/README.md
new file mode 100644
index 000000000..6ea0faaee
--- /dev/null
+++ b/docs/config/README.md
@@ -0,0 +1,43 @@
+## Configuration TL;DR
+
+You will need to create a [user model](/docs/usage/model_concerns.md), [define routes](/docs/usage/routes.md), [include concerns](/docs/usage/controller_methods.md), and you may want to alter some of the [default settings](initialization.md) for this gem. Run the following command for an easy one-step installation:
+
+~~~bash
+rails g devise_token_auth:install [USER_CLASS] [MOUNT_PATH]
+~~~
+
+**Example**:
+
+~~~bash
+rails g devise_token_auth:install User auth
+~~~
+
+This generator accepts the following optional arguments:
+
+| Argument | Default | Description |
+|---|---|---|
+| USER_CLASS | `User` | The name of the class to use for user authentication. |
+| MOUNT_PATH | `auth` | The path at which to mount the authentication routes. [Read more](#usage-tldr). |
+
+The following events will take place when using the install generator:
+
+* An initializer will be created at `config/initializers/devise_token_auth.rb`. [Read more](initialization.md).
+
+* A model will be created in the `app/models` directory. If the model already exists, a concern will be included at the top of the file. [Read more](/docs/usage/model_concerns.md).
+
+* Routes will be appended to file at `config/routes.rb`. [Read more](/docs/usage/routes.md).
+
+* A concern will be included by your application controller at `app/controllers/application_controller.rb`. [Read more](/docs/usage/controller_methods.md).
+
+* A migration file will be created in the `db/migrate` directory. Inspect the migrations file, add additional columns if necessary, and then run the migration:
+
+ ~~~bash
+ rake db:migrate
+ ~~~
+
+You may also need to configure the following items:
+
+* **OmniAuth providers** when using 3rd party oauth2 authentication. [Read more](omniauth.md).
+* **Cross Origin Request Settings** when using cross-domain clients. [Read more](cors.md).
+* **Email** when using email registration. [Read more](email-auth.md).
+* **Multiple model support** may require additional steps. [Read more](/docs/usage/multiple_models.md).
diff --git a/docs/config/cors.md b/docs/config/cors.md
new file mode 100644
index 000000000..ddea7d6e1
--- /dev/null
+++ b/docs/config/cors.md
@@ -0,0 +1,30 @@
+## CORS
+
+If your API and client live on different domains, you will need to configure your Rails API to allow [cross origin requests](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing). The [rack-cors](https://github.com/cyu/rack-cors) gem can be used to accomplish this.
+
+The following **dangerous** example will allow cross domain requests from **any** domain. Make sure to whitelist only the needed domains.
+
+##### Example rack-cors configuration:
+~~~ruby
+# gemfile
+gem 'rack-cors', :require => 'rack/cors'
+
+# config/application.rb
+module YourApp
+ class Application < Rails::Application
+ config.middleware.use Rack::Cors do
+ allow do
+ origins '*'
+ resource '*',
+ headers: :any,
+ expose: ['access-token', 'expiry', 'token-type', 'uid', 'client'],
+ methods: [:get, :post, :options, :delete, :put]
+ end
+ end
+ end
+end
+~~~
+
+Make extra sure that the `Access-Control-Expose-Headers` includes `access-token`, `expiry`, `token-type`, `uid`, and `client` (as is set in the example above by the`:expose` param). If your client experiences erroneous 401 responses, this is likely the cause.
+
+CORS may not be possible with older browsers (IE8, IE9). I usually set up a proxy for those browsers. See the [ng-token-auth readme](https://github.com/lynndylanhurley/ng-token-auth) or the [jToker readme](https://github.com/lynndylanhurley/j-toker) for more information.
diff --git a/docs/config/devise.md b/docs/config/devise.md
new file mode 100644
index 000000000..e2319c5a5
--- /dev/null
+++ b/docs/config/devise.md
@@ -0,0 +1,13 @@
+## Customizing Devise Verbiage
+
+Devise Token Auth ships with intelligent default wording for everything you need. But that doesn't mean you can't make it more awesome. You can override the [devise defaults](https://github.com/plataformatec/devise/blob/master/config/locales/en.yml) by creating a YAML file at `config/locales/devise.en.yml` and assigning whatever custom values you want. For example, to customize the subject line of your devise e-mails, you could do this:
+
+~~~yaml
+en:
+ devise:
+ mailer:
+ confirmation_instructions:
+ subject: "Please confirm your e-mail address"
+ reset_password_instructions:
+ subject: "Reset password request"
+~~~
diff --git a/docs/config/email_auth.md b/docs/config/email_auth.md
new file mode 100644
index 000000000..043dc3e0a
--- /dev/null
+++ b/docs/config/email_auth.md
@@ -0,0 +1,16 @@
+## Email authentication
+If you wish to use email authentication, you must configure your Rails application to send email. [Read here](http://guides.rubyonrails.org/action_mailer_basics.html) for more information.
+
+I recommend using [mailcatcher](https://mailcatcher.me/) for development.
+
+##### mailcatcher development example configuration:
+~~~ruby
+# config/environments/development.rb
+Rails.application.configure do
+ config.action_mailer.default_url_options = { host: 'your-dev-host.dev' }
+ config.action_mailer.delivery_method = :smtp
+ config.action_mailer.smtp_settings = { address: 'your-dev-host.dev', port: 1025 }
+end
+~~~
+
+If you wish to send custom e-mails instead of using the default devise templates, you can [do that too](/docs/usage/overrides.md#email-template-overrides).
diff --git a/docs/config/initialization.md b/docs/config/initialization.md
new file mode 100644
index 000000000..8423edb82
--- /dev/null
+++ b/docs/config/initialization.md
@@ -0,0 +1,33 @@
+## Initializer settings
+
+The following settings are available for configuration in `config/initializers/devise_token_auth.rb`:
+
+| Name | Default | Description|
+|---|---|---|
+| **`change_headers_on_each_request`** | `true` | By default the access-token header will change after each request. The client is responsible for keeping track of the changing tokens. Both [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) and [jToker](https://github.com/lynndylanhurley/j-toker) do this out of the box. While this implementation is more secure, it can be difficult to manage. Set this to false to prevent the `access-token` header from changing after each request. [Read more](#about-token-management). |
+| **`token_lifespan`** | `2.weeks` | Set the length of your tokens' lifespans. Users will need to re-authenticate after this duration of time has passed since their last login. |
+| **`batch_request_buffer_throttle`** | `5.seconds` | Sometimes it's necessary to make several requests to the API at the same time. In this case, each request in the batch will need to share the same auth token. This setting determines how far apart the requests can be while still using the same auth token. [Read more](#about-batch-requests). |
+| **`omniauth_prefix`** | `"/omniauth"` | This route will be the prefix for all oauth2 redirect callbacks. For example, using the default '/omniauth' setting, the github oauth2 provider will redirect successful authentications to '/omniauth/github/callback'. [Read more](#omniauth-provider-settings). |
+| **`default_confirm_success_url`** | `nil` | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful email confirmation. If this param is set, the API will redirect to this value when no value is provided by the client. |
+| **`default_password_reset_url`** | `nil` | By default this value is expected to be sent by the client so that the API knows where to redirect users after successful password resets. If this param is set, the API will redirect to this value when no value is provided by the client. |
+| **`redirect_whitelist`** | `nil` | As an added security measure, you can limit the URLs to which the API will redirect after email token validation (password reset, email confirmation, etc.). This value should be an array containing matches to the client URLs to be visited after validation. Wildcards are supported. |
+| **`enable_standard_devise_support`** | `false` | By default, only Bearer Token authentication is implemented out of the box. If, however, you wish to integrate with legacy Devise authentication, you can do so by enabling this flag. NOTE: This feature is highly experimental! |
+| **`remove_tokens_after_password_reset`** | `false` | By default, old tokens are not invalidated when password is changed. Enable this option if you want to make passwords updates to logout other devices. |
+| **`default_callbacks`** | `true` | By default User model will include the `DeviseTokenAuth::Concerns::UserOmniauthCallbacks` concern, which has `email`, `uid` validations & `uid` synchronization callbacks. |
+| **`bypass_sign_in`** | `true` | By default DeviseTokenAuth will not check user's `#active_for_authentication?` which includes confirmation check on each call (it will do it only on sign in). If you want it to be validated on each request (for example, to be able to deactivate logged in users on the fly), set it to false. |
+
+
+Additionally, you can configure other aspects of devise by manually creating the traditional devise.rb file at `config/initializers/devise.rb`. Here are some examples of what you can do in this file:
+
+~~~ruby
+Devise.setup do |config|
+ # The e-mail address that mail will appear to be sent from
+ # If absent, mail is sent from "please-change-me-at-config-initializers-devise@example.com"
+ config.mailer_sender = "support@myapp.com"
+
+ # If using rails-api, you may want to tell devise to not use ActionDispatch::Flash
+ # middleware b/c rails-api does not include it.
+ # See: https://stackoverflow.com/q/19600905/806956
+ config.navigational_formats = [:json]
+end
+~~~
diff --git a/docs/config/omniauth.md b/docs/config/omniauth.md
new file mode 100644
index 000000000..d6b25dd2a
--- /dev/null
+++ b/docs/config/omniauth.md
@@ -0,0 +1,94 @@
+# OmniAuth
+
+## OmniAuth authentication
+
+If you wish to use omniauth authentication, add all of your desired authentication provider gems to your `Gemfile`.
+
+**OmniAuth example using github, facebook, and google**:
+~~~ruby
+gem 'omniauth-github'
+gem 'omniauth-facebook'
+gem 'omniauth-google-oauth2'
+~~~
+
+Then run `bundle install`.
+
+[List of oauth2 providers](https://github.com/intridea/omniauth/wiki/List-of-Strategies)
+
+## OmniAuth provider settings
+
+In `config/initializers/omniauth.rb`, add the settings for each of your providers.
+
+These settings must be obtained from the providers themselves.
+
+**Example using github, facebook, and google**:
+~~~ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+ provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET'], scope: 'email,profile'
+ provider :facebook, ENV['FACEBOOK_KEY'], ENV['FACEBOOK_SECRET']
+ provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET']
+end
+~~~
+
+The above example assumes that your provider keys and secrets are stored in environmental variables. Use the [figaro](https://github.com/laserlemon/figaro) gem (or [dotenv](https://github.com/bkeepers/dotenv) or [secrets.yml](https://github.com/rails/rails/blob/v4.1.0/railties/lib/rails/generators/rails/app/templates/config/secrets.yml) or equivalent) to accomplish this.
+
+#### OmniAuth callback settings
+
+The "Callback URL" setting that you set with your provider must correspond to the [omniauth prefix](initialization.md) setting defined by this app. **This will be different than the omniauth route that is used by your client application**.
+
+For example, the demo app uses the default `omniauth_prefix` setting `/omniauth`, so the "Authorization callback URL" for github must be set to "https://devise-token-auth-demo.herokuapp.com**/omniauth**/github/callback".
+
+**Github example for the demo site**:
+
+
+The url for github authentication will be different for the client. The client should visit the API at `/[MOUNT_PATH]/:provider` for omniauth authentication.
+
+For example, given that the app is mounted using the following settings:
+
+~~~ruby
+# config/routes.rb
+mount_devise_token_auth_for 'User', at: 'auth'
+~~~
+
+The client configuration for github should look like this:
+
+**Angular.js setting for authenticating using github**:
+~~~javascript
+angular.module('myApp', ['ng-token-auth'])
+ .config(function($authProvider) {
+ $authProvider.configure({
+ apiUrl: 'https://api.example.com'
+ authProviderPaths: {
+ github: '/auth/github' // <-- note that this is different than what was set with github
+ }
+ });
+ });
+~~~
+
+**jToker settings for github should look like this:
+
+~~~javascript
+$.auth.configure({
+ apiUrl: 'https://api.example.com',
+ authProviderPaths: {
+ github: '/auth/github' // <-- note that this is different than what was set with github
+ }
+});
+~~~
+
+This incongruence is necessary to support multiple user classes and mounting points.
+
+#### Note for [pow](http://pow.cx/) and [xip.io](http://xip.io) users
+
+If you receive `redirect-uri-mismatch` errors from your provider when using pow or xip.io urls, set the following in your development config:
+
+~~~ruby
+# config/environments/development.rb
+
+# when using pow
+OmniAuth.config.full_host = "http://app-name.dev"
+
+# when using xip.io
+OmniAuth.config.full_host = "http://xxx.xxx.xxx.app-name.xip.io"
+~~~
diff --git a/docs/faq.md b/docs/faq.md
new file mode 100644
index 000000000..d48256be4
--- /dev/null
+++ b/docs/faq.md
@@ -0,0 +1,134 @@
+## FAQ
+
+### Can I use this gem alongside standard Devise?
+
+Yes! But you will need to enable the support of separate routes for standard Devise. So do something like this:
+
+#### config/initializers/devise_token_auth.rb
+~~~ruby
+DeviseTokenAuth.setup do |config|
+ config.enable_standard_devise_support = true
+end
+~~~
+
+#### config/routes.rb
+~~~ruby
+Rails.application.routes.draw do
+
+ # standard devise routes available at /users
+ # NOTE: make sure this comes first!!!
+ devise_for :users
+
+ # token auth routes available at /api/v1/auth
+ namespace :api do
+ scope :v1 do
+ mount_devise_token_auth_for 'User', at: 'auth'
+ end
+ end
+
+end
+~~~
+
+### Why are the `new` routes included if this gem doesn't use them?
+
+Removing the `new` routes will require significant modifications to devise. If the inclusion of the `new` routes is causing your app any problems, post an issue in the issue tracker and it will be addressed ASAP.
+
+### I'm having trouble using this gem alongside [ActiveAdmin](https://activeadmin.info/)...
+
+For some odd reason, [ActiveAdmin](https://activeadmin.info/) extends from your own app's `ApplicationController`. This becomes a problem if you include the `DeviseTokenAuth::Concerns::SetUserByToken` concern in your app's `ApplicationController`.
+
+The solution is to use two separate `ApplicationController` classes - one for your API, and one for ActiveAdmin. Something like this:
+
+~~~ruby
+# app/controllers/api_controller.rb
+# API routes extend from this controller
+class ApiController < ActionController::Base
+ include DeviseTokenAuth::Concerns::SetUserByToken
+end
+
+# app/controllers/application_controller.rb
+# leave this for ActiveAdmin, and any other non-api routes
+class ApplicationController < ActionController::Base
+end
+~~~
+
+
+### How can I use this gem with Grape?
+
+You may be interested in [GrapeTokenAuth](https://github.com/mcordell/grape_token_auth) or [GrapeDeviseTokenAuth](https://github.com/mcordell/grape_devise_token_auth).
+
+### What's the reset password flow?
+
+This is the overall workflow for a User to reset their password:
+
+- user goes to a page on the front end site which contains a form with a single text field, they type their email address into this field and click a button to submit the form
+
+- that form submission sends a request to the API: `POST /auth/password` with some parameters: `email` (the email supplied in the field) & `redirect_url` (a page in the front end site that will contain a form with `password` and `password_confirmation` fields)
+
+- the API responds to this request by generating a `reset_password_token` and sending an email (the `reset_password_instructions.html.erb` file from devise) to the email address provided within the `email` parameter
+ - we need to modify the `reset_password_instructions.html.erb` file to point to the API: `GET /auth/password/edit`
+ - for example, if you have your API under the `api/v1` namespaces: `<%= link_to 'Change my password', edit_api_v1_user_password_url(reset_password_token: @token, config: message['client-config'].to_s, redirect_url: message['redirect-url'].to_s) %>` (I came up with this `link_to` by referring to [this line](https://github.com/lynndylanhurley/devise_token_auth/blob/15bf7857eca2d33602c7a9cb9d08db8a160f8ab8/app/views/devise/mailer/reset_password_instructions.html.erb#L5))
+
+- the user clicks the link in the email, which brings them to the 'Verify user by password reset token' endpoint (`GET /password/edit`)
+
+- this endpoint verifies the user and redirects them to the `redirect_url` (or the one you set in an initializer as default_password_reset_url) with the auth headers if they are who they claim to be (if their `reset_password_token` matches a User record)
+
+- this `redirect_url` is a page on the frontend which contains a `password` and `password_confirmation` field
+
+- the user submits the form on this frontend page, which sends a request to API: `PUT /auth/password` with the `password` and `password_confirmation` parameters. In addition headers need to be included from the url params (you get these from the url as query params). A side note, ensure that the header names follow the convention outlined in `config/initializers/devise_token_auth.rb`; at this time of writing it is: `uid`, `client` and `access-token`.
+ - _Ensure that the `uid` sent in the headers is not URL-escaped. e.g. it should be bob@example.com, not bob%40example.com_
+
+- the API changes the user's password and responds back with a success message
+
+- the front end needs to manually redirect the user to its login page after receiving this success response
+
+- the user logs in
+
+The next diagram shows how it works:
+
+
+
+If you get in any trouble configuring or overriding the behavior, you can check the [issue #604](https://github.com/lynndylanhurley/devise_token_auth/issues/604).
+
+
+### I already have a user, how can I add the new fields?
+
+1. First, remove the migration generated by the following command`rails g devise_token_auth:install [USER_CLASS] [MOUNT_PATH]` and then:.
+2. Create another fresh migration:
+
+```ruby
+
+ # create migration by running a command like this (where `User` is your USER_CLASS table):
+ # `rails g migration AddTokensToUsers provider:string uid:string tokens:text`
+
+ def up
+ add_column :users, :provider, :string, null: false, default: 'email'
+ add_column :users, :uid, :string, null: false, default: ''
+ add_column :users, :tokens, :text
+
+ # if your existing User model does not have an existing **encrypted_password** column uncomment below line.
+ # add_column :users, :encrypted_password, :null => false, :default => ""
+
+ # the following will update your models so that when you run your migration
+
+ # updates the user table immediately with the above defaults
+ User.reset_column_information
+
+ # finds all existing users and updates them.
+ # if you change the default values above you'll also have to change them here below:
+ User.find_each do |user|
+ user.uid = user.email
+ user.provider = 'email'
+ user.save!
+ end
+
+ # to speed up lookups to these columns:
+ add_index :users, [:uid, :provider], unique: true
+ end
+
+ def down
+ # if you added **encrypted_password** above, add here to successfully rollback
+ remove_columns :users, :provider, :uid, :tokens
+ end
+
+```
diff --git a/docs/password_diagram_reset.jpg b/docs/password_diagram_reset.jpg
new file mode 100644
index 000000000..a0aff487f
Binary files /dev/null and b/docs/password_diagram_reset.jpg differ
diff --git a/docs/security.md b/docs/security.md
new file mode 100644
index 000000000..a339d6758
--- /dev/null
+++ b/docs/security.md
@@ -0,0 +1,16 @@
+# Security
+
+This gem takes the following steps to ensure security.
+
+This gem uses auth tokens that are:
+* [changed after every request](#about-token-management) (can be [turned off](https://github.com/lynndylanhurley/devise_token_auth/#initializer-settings)),
+* [of cryptographic strength](https://ruby-doc.org/stdlib-2.1.0/libdoc/securerandom/rdoc/SecureRandom.html),
+* hashed using [BCrypt](https://github.com/codahale/bcrypt-ruby) (not stored in plain-text),
+* securely compared (to protect against timing attacks),
+* invalidated after 2 weeks (thus requiring users to login again)
+
+These measures were inspired by [this stackoverflow post](https://stackoverflow.com/questions/18605294/is-devises-token-authenticatable-secure).
+
+This gem further mitigates timing attacks by using [this technique](https://gist.github.com/josevalim/fb706b1e933ef01e4fb6).
+
+But the most important step is to use HTTPS. You are on the hook for that.
diff --git a/docs/usage/README.md b/docs/usage/README.md
new file mode 100644
index 000000000..1363ca772
--- /dev/null
+++ b/docs/usage/README.md
@@ -0,0 +1,17 @@
+## Usage TL;DR
+
+The following routes are available for use by your client. These routes live relative to the path at which this engine is mounted (`auth` by default). These routes correspond to the defaults used by the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module for [AngularJS](https://angularjs.org/) and the [jToker](https://github.com/lynndylanhurley/j-toker) plugin for [jQuery](https://jquery.com/).
+
+| path | method | purpose |
+|:-----|:-------|:--------|
+| / | POST | Email registration. Requires **`email`**, **`password`**, **`password_confirmation`**, and **`confirm_success_url`** params (this last one can be omitted if you have set `config.default_confirm_success_url` in `config/initializers/devise_token_auth.rb`). A verification email will be sent to the email address provided. Upon clicking the link in the confirmation email, the API will redirect to the URL specified in **`confirm_success_url`**. Accepted params can be customized using the [`devise_parameter_sanitizer`](https://github.com/plataformatec/devise#strong-parameters) system. |
+| / | DELETE | Account deletion. This route will destroy users identified by their **`uid`**, **`access-token`** and **`client`** headers. |
+| / | PUT | Account updates. This route will update an existing user's account settings. The default accepted params are **`password`** and **`password_confirmation`**, but this can be customized using the [`devise_parameter_sanitizer`](https://github.com/plataformatec/devise#strong-parameters) system. If **`config.check_current_password_before_update`** is set to `:attributes` the **`current_password`** param is checked before any update, if it is set to `:password` the **`current_password`** param is checked only if the request updates user password. |
+| /sign_in | POST | Email authentication. Requires **`email`** and **`password`** as params. This route will return a JSON representation of the `User` model on successful login along with the `access-token` and `client` in the header of the response. |
+| /sign_out | DELETE | Use this route to end the user's current session. This route will invalidate the user's authentication token. You must pass in **`uid`**, **`client`**, and **`access-token`** in the request headers. |
+| /:provider | GET | Set this route as the destination for client authentication. Ideally this will happen in an external window or popup. [Read more](#omniauth-authentication). |
+| /:provider/callback | GET/POST | Destination for the oauth2 provider's callback uri. `postMessage` events containing the authenticated user's data will be sent back to the main client window from this page. [Read more](#omniauth-authentication). |
+| /validate_token | GET | Use this route to validate tokens on return visits to the client. Requires **`uid`**, **`client`**, and **`access-token`** as params. These values should correspond to the columns in your `User` table of the same names. |
+| /password | POST | Use this route to send a password reset confirmation email to users that registered by email. Accepts **`email`** and **`redirect_url`** as params. The user matching the `email` param will be sent instructions on how to reset their password. `redirect_url` is the url to which the user will be redirected after visiting the link contained in the email. |
+| /password | PUT | Use this route to change users' passwords. Requires **`password`** and **`password_confirmation`** as params. This route is only valid for users that registered by email (OAuth2 users will receive an error). It also checks **`current_password`** if **`config.check_current_password_before_update`** is not set `false` (disabled by default). |
+| /password/edit | GET | Verify user by password reset token. This route is the destination URL for password reset confirmation. This route must contain **`reset_password_token`** and **`redirect_url`** params. These values will be set automatically by the confirmation email that is generated by the password reset request. |
diff --git a/docs/usage/controller_methods.md b/docs/usage/controller_methods.md
new file mode 100644
index 000000000..85ba353b9
--- /dev/null
+++ b/docs/usage/controller_methods.md
@@ -0,0 +1,77 @@
+## Controller Methods
+
+### Concerns
+
+This gem includes a [Rails concern](http://api.rubyonrails.org/classes/ActiveSupport/Concern.html) called `DeviseTokenAuth::Concerns::SetUserByToken`. Include this concern to provide access to controller methods such as `authenticate_user!`, `user_signed_in?`, etc.
+
+The concern also runs an [after_action](http://guides.rubyonrails.org/action_controller_overview.html#filters) that changes the auth token after each request.
+
+It is recommended to include the concern in your base `ApplicationController` so that all children of that controller include the concern as well.
+
+##### Concern example:
+
+~~~ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+ include DeviseTokenAuth::Concerns::SetUserByToken
+end
+~~~
+
+### Methods
+
+This gem provides access to all of the following [devise helpers](https://github.com/plataformatec/devise#controller-filters-and-helpers):
+
+| Method | Description |
+|---|---|
+| **`before_action :authenticate_user!`** | Returns a 401 error unless a `User` is signed-in. |
+| **`current_user`** | Returns the currently signed-in `User`, or `nil` if unavailable. |
+| **`user_signed_in?`** | Returns `true` if a `User` is signed in, otherwise `false`. |
+| **`devise_token_auth_group`** | Operate on multiple user classes as a group. [Read more](#group-access) |
+
+Note that if the model that you're trying to access isn't called `User`, the helper method names will change. For example, if the user model is called `Admin`, the methods would look like this:
+
+* `before_action :authenticate_admin!`
+* `admin_signed_in?`
+* `current_admin`
+
+
+##### Example: limit access to authenticated users
+~~~ruby
+# app/controllers/test_controller.rb
+class TestController < ApplicationController
+ before_action :authenticate_user!
+
+ def members_only
+ render json: {
+ data: {
+ message: "Welcome #{current_user.name}",
+ user: current_user
+ }
+ }, status: 200
+ end
+end
+~~~
+
+### Token Header Format
+
+The authentication information should be included by the client in the headers of each request. The headers follow the [RFC 6750 Bearer Token](https://tools.ietf.org/html/rfc6750) format:
+
+##### Authentication headers example:
+~~~
+"access-token": "wwwww",
+"token-type": "Bearer",
+"client": "xxxxx",
+"expiry": "yyyyy",
+"uid": "zzzzz"
+~~~
+
+The authentication headers (each one is a seperate header) consists of the following params:
+
+| param | description |
+|---|---|
+| **`access-token`** | This serves as the user's password for each request. A hashed version of this value is stored in the database for later comparison. This value should be changed on each request. |
+| **`client`** | This enables the use of multiple simultaneous sessions on different clients. (For example, a user may want to be authenticated on both their phone and their laptop at the same time.) |
+| **`expiry`** | The date at which the current session will expire. This can be used by clients to invalidate expired tokens without the need for an API request. |
+| **`uid`** | A unique value that is used to identify the user. This is necessary because searching the DB for users by their access token will make the API susceptible to [timing attacks](https://codahale.com/a-lesson-in-timing-attacks/). |
+
+The authentication headers required for each request will be available in the response from the previous request. If you are using the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) AngularJS module or the [jToker](https://github.com/lynndylanhurley/j-toker) jQuery plugin, this functionality is already provided.
diff --git a/docs/usage/excluding_models.md b/docs/usage/excluding_models.md
new file mode 100644
index 000000000..d1a920e82
--- /dev/null
+++ b/docs/usage/excluding_models.md
@@ -0,0 +1,61 @@
+## Excluding Modules
+
+By default, almost all of the Devise modules are included:
+* [`database_authenticatable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/database_authenticatable.rb)
+* [`registerable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/registerable.rb)
+* [`recoverable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/recoverable.rb)
+* [`trackable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/trackable.rb)
+* [`validatable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/validatable.rb)
+* [`confirmable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/confirmable.rb)
+* [`omniauthable`](https://github.com/plataformatec/devise/blob/master/lib/devise/models/omniauthable.rb)
+
+You may not want all of these features enabled in your app. That's OK! You can mix and match to suit your own unique style.
+
+The following example shows how to disable email confirmation.
+
+##### Example: disable email confirmation
+
+Just list the devise modules that you want to include **before** including the `DeviseTokenAuth::Concerns::User` model concern.
+
+~~~ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+
+ # notice this comes BEFORE the include statement below
+ # also notice that :confirmable is not included in this block
+ devise :database_authenticatable, :recoverable,
+ :trackable, :validatable, :registerable,
+ :omniauthable
+
+ # note that this include statement comes AFTER the devise block above
+ include DeviseTokenAuth::Concerns::User
+end
+~~~
+
+Some features include routes that you may not want mounted to your app. The following example shows how to disable OAuth and its routes.
+
+##### Example: disable OAuth authentication
+
+First instruct the model not to include the `omniauthable` module.
+
+~~~ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+
+ # notice that :omniauthable is not included in this block
+ devise :database_authenticatable, :confirmable,
+ :recoverable, :trackable, :validatable,
+ :registerable
+
+ include DeviseTokenAuth::Concerns::User
+end
+~~~
+
+Now tell the route helper to `skip` mounting the `omniauth_callbacks` controller:
+
+~~~ruby
+Rails.application.routes.draw do
+ # config/routes.rb
+ mount_devise_token_auth_for 'User', at: 'auth', skip: [:omniauth_callbacks]
+end
+~~~
diff --git a/docs/usage/model_concerns.md b/docs/usage/model_concerns.md
new file mode 100644
index 000000000..e2ad78f7c
--- /dev/null
+++ b/docs/usage/model_concerns.md
@@ -0,0 +1,53 @@
+## Model Concerns
+
+##### DeviseTokenAuth::Concerns::User
+
+Typical use of this gem will not require the use of any of the following model methods. All authentication should be handled invisibly by the [controller concerns](controller_methods.md).
+
+Models that include the `DeviseTokenAuth::Concerns::User` concern will have access to the following public methods (read the above section for context on `token` and `client`):
+
+* **`valid_token?`**: check if an authentication token is valid. Accepts a `token` and `client` as arguments. Returns a boolean.
+
+ **Example**:
+ ~~~ruby
+ # extract token + client_id from auth header
+ client_id = request.headers['client']
+ token = request.headers['access-token']
+
+ @resource.valid_token?(token, client_id)
+ ~~~
+
+* **`create_new_auth_token`**: creates a new auth token with all of the necessary metadata. Accepts `client` as an optional argument. Will generate a new `client` if none is provided. Returns the authentication headers that should be sent by the client as an object.
+
+ **Example**:
+ ~~~ruby
+ # extract client_id from auth header
+ client_id = request.headers['client']
+
+ # update token, generate updated auth headers for response
+ new_auth_header = @resource.create_new_auth_token(client_id)
+
+ # update response with the header that will be required by the next request
+ response.headers.merge!(new_auth_header)
+ ~~~
+
+* **`build_auth_header`**: generates the auth header that should be sent to the client with the next request. Accepts `token` and `client` as arguments. Returns a string.
+
+ **Example**:
+ ~~~ruby
+ # create client id and token
+ client_id = SecureRandom.urlsafe_base64(nil, false)
+ token = SecureRandom.urlsafe_base64(nil, false)
+
+ # store client + token in user's token hash
+ @resource.tokens[client_id] = {
+ token: BCrypt::Password.create(token),
+ expiry: (Time.zone.now + @resource.token_lifespan).to_i
+ }
+
+ # generate auth headers for response
+ new_auth_header = @resource.build_auth_header(token, client_id)
+
+ # update response with the header that will be required by the next request
+ response.headers.merge!(new_auth_header)
+ ~~~
diff --git a/docs/usage/multiple_models.md b/docs/usage/multiple_models.md
new file mode 100644
index 000000000..cb06e16ca
--- /dev/null
+++ b/docs/usage/multiple_models.md
@@ -0,0 +1,77 @@
+## Using multiple models
+
+### View Live Multi-User Demos
+
+* [AngularJS](https://ng-token-auth-demo.herokuapp.com/multi-user)
+* [Angular2](https://angular2-token.herokuapp.com)
+* [React + jToker](https://j-toker-demo.herokuapp.com/#/alt-user)
+
+This gem supports the use of multiple user models. One possible use case is to authenticate visitors using a model called `User`, and to authenticate administrators with a model called `Admin`. Take the following steps to add another authentication model to your app:
+
+1. Run the install generator for the new model.
+ ~~~
+ rails g devise_token_auth:install Admin admin_auth
+ ~~~
+
+ This will create the `Admin` model and define the model's authentication routes with the base path `/admin_auth`.
+
+1. Define the routes to be used by the `Admin` user within a [`devise_scope`](https://github.com/plataformatec/devise#configuring-routes).
+
+ **Example**:
+
+ ~~~ruby
+ Rails.application.routes.draw do
+ # when using multiple models, controllers will default to the first available
+ # devise mapping. routes for subsequent devise mappings will need to defined
+ # within a `devise_scope` block
+
+ # define :users as the first devise mapping:
+ mount_devise_token_auth_for 'User', at: 'auth'
+
+ # define :admins as the second devise mapping. routes using this class will
+ # need to be defined within a devise_scope as shown below
+ mount_devise_token_auth_for "Admin", at: 'admin_auth'
+
+ # this route will authorize requests using the User class
+ get 'demo/members_only', to: 'demo#members_only'
+
+ # routes within this block will authorize requests using the Admin class
+ devise_scope :admin do
+ get 'demo/admins_only', to: 'demo#admins_only'
+ end
+ end
+ ~~~
+
+1. Configure any `Admin` restricted controllers. Controllers will now have access to the methods [described here](#methods):
+ * `before_action :authenticate_admin!`
+ * `current_admin`
+ * `admin_signed_in?`
+
+
+### Group access
+
+It is also possible to control access to multiple user types at the same time using groups. The following example shows how to limit controller access to both `User` and `Admin` users.
+
+##### Example: group authentication
+
+~~~ruby
+class DemoGroupController < ApplicationController
+ devise_token_auth_group :member, contains: [:user, :admin]
+ before_action :authenticate_member!
+
+ def members_only
+ render json: {
+ data: {
+ message: "Welcome #{current_member.name}",
+ user: current_member
+ }
+ }, status: 200
+ end
+end
+~~~
+
+In the above example, the following methods will be available (in addition to `current_user`, `current_admin`, etc.):
+
+ * `before_action: :authenticate_member!`
+ * `current_member`
+ * `member_signed_in?`
diff --git a/docs/usage/overrides.md b/docs/usage/overrides.md
new file mode 100644
index 000000000..9b990269e
--- /dev/null
+++ b/docs/usage/overrides.md
@@ -0,0 +1,126 @@
+## Custom Controller Overrides
+
+The built-in controllers can be overridden with your own custom controllers.
+
+For example, the default behavior of the [`validate_token`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb#L6) method of the [`TokenValidationController`](https://github.com/lynndylanhurley/devise_token_auth/blob/8a33d25deaedb4809b219e557e82ec7ec61bf940/app/controllers/devise_token_auth/token_validations_controller.rb) is to return the `User` object as json (sans password and token data). The following example shows how to override the `validate_token` action to include a model method as well.
+
+##### Example: controller overrides
+
+~~~ruby
+# config/routes.rb
+Rails.application.routes.draw do
+ ...
+ mount_devise_token_auth_for 'User', at: 'auth', controllers: {
+ token_validations: 'overrides/token_validations'
+ }
+end
+
+# app/controllers/overrides/token_validations_controller.rb
+module Overrides
+ class TokenValidationsController < DeviseTokenAuth::TokenValidationsController
+
+ def validate_token
+ # @resource will have been set by set_user_by_token concern
+ if @resource
+ render json: {
+ data: @resource.as_json(methods: :calculate_operating_thetan)
+ }
+ else
+ render json: {
+ success: false,
+ errors: ["Invalid login credentials"]
+ }, status: 401
+ end
+ end
+ end
+end
+~~~
+
+## Overriding rendering methods
+To customize json rendering, implement the following protected controller methods, for success methods, assume that the @resource object is available:
+
+### Registrations Controller
+* render_create_error_missing_confirm_success_url
+* render_create_error_redirect_url_not_allowed
+* render_create_success
+* render_create_error
+* render_create_error_email_already_exists
+* render_update_success
+* render_update_error
+* render_update_error_user_not_found
+
+
+### Sessions Controller
+* render_new_error
+* render_create_success
+* render_create_error_not_confirmed
+* render_create_error_bad_credentials
+* render_destroy_success
+* render_destroy_error
+
+
+### Passwords Controller
+* render_create_error_missing_email
+* render_create_error_missing_redirect_url
+* render_create_error_not_allowed_redirect_url
+* render_create_success
+* render_create_error
+* render_update_error_unauthorized
+* render_update_error_password_not_required
+* render_update_error_missing_password
+* render_update_success
+* render_update_error
+
+### Token Validations Controller
+* render_validate_token_success
+* render_validate_token_error
+
+##### Example: all :controller options with default settings:
+
+~~~ruby
+mount_devise_token_auth_for 'User', at: 'auth', controllers: {
+ confirmations: 'devise_token_auth/confirmations',
+ passwords: 'devise_token_auth/passwords',
+ omniauth_callbacks: 'devise_token_auth/omniauth_callbacks',
+ registrations: 'devise_token_auth/registrations',
+ sessions: 'devise_token_auth/sessions',
+ token_validations: 'devise_token_auth/token_validations'
+}
+~~~
+
+**Note:** Controller overrides must implement the expected actions of the controllers that they replace.
+
+## Passing blocks to Controllers
+
+It may be that you simply want to _add_ behavior to existing controllers without having to re-implement their behavior completely. In this case, you can do so by creating a new controller that inherits from any of DeviseTokenAuth's controllers, overriding whichever methods you'd like to add behavior to by passing a block to `super`:
+
+```ruby
+class Custom::RegistrationsController < DeviseTokenAuth::RegistrationsController
+
+ def create
+ super do |resource|
+ resource.do_something(extra)
+ end
+ end
+
+end
+```
+
+Your block will be performed just before the controller would usually render a successful response.
+
+## Email Template Overrides
+
+You will probably want to override the default email templates for email sign-up and password-reset confirmation. Run the following command to copy the email templates into your app:
+
+~~~bash
+rails generate devise_token_auth:install_views
+~~~
+
+This will create two new files:
+
+* `app/views/devise/mailer/reset_password_instructions.html.erb`
+* `app/views/devise/mailer/confirmation_instructions.html.erb`
+
+These files may be edited to suit your taste. You can customize the e-mail subjects like [this](/docs/config/devise.md).
+
+**Note:** if you choose to modify these templates, do not modify the `link_to` blocks unless you absolutely know what you are doing.
diff --git a/docs/usage/routes.md b/docs/usage/routes.md
new file mode 100644
index 000000000..0105f3183
--- /dev/null
+++ b/docs/usage/routes.md
@@ -0,0 +1,20 @@
+## Mounting Routes
+
+The authentication routes must be mounted to your project. This gem includes a route helper for this purpose:
+
+**`mount_devise_token_auth_for`** - similar to `devise_for`, this method is used to append the routes necessary for user authentication. This method accepts the following arguments:
+
+| Argument | Type | Default | Description |
+|---|---|---|---|
+|`class_name`| string | 'User' | The name of the class to use for authentication. This class must include the [model concern described here](#model-concerns). |
+| `options` | object | {at: 'auth'} | The [routes to be used for authentication](#usage) will be prefixed by the path specified in the `at` param of this object. |
+
+**Example**:
+~~~ruby
+# config/routes.rb
+mount_devise_token_auth_for 'User', at: 'auth'
+~~~
+
+Any model class can be used, but the class will need to include [`DeviseTokenAuth::Concerns::User`](model_concerns.md) for authentication to work properly.
+
+You can mount this engine to any route that you like. `/auth` is used by default to conform with the defaults of the [ng-token-auth](https://github.com/lynndylanhurley/ng-token-auth) module and the [jToker](https://github.com/lynndylanhurley/j-toker) plugin.
diff --git a/docs/usage/testing.md b/docs/usage/testing.md
new file mode 100644
index 000000000..d8a2ed134
--- /dev/null
+++ b/docs/usage/testing.md
@@ -0,0 +1,168 @@
+# Testing
+
+In order to authorize a request when testing your API you will need to pass the four headers through with your request, the easiest way to gain appropriate values for those headers is to use `resource.create_new_auth_token` e.g.
+
+```Ruby
+ request.headers.merge! resource.create_new_auth_token
+ get '/api/authenticated_resource'
+ # success
+```
+
+Check #75 if you have any problem or doubt.
+
+## Testing with Rspec
+
+### (a) General Request Specs
+
+Below are some generic examples which may assist in helping you devise (pun intended) your own tests:
+
+```ruby
+# I've called it authentication_test_spec.rb and placed it in the spec/requests folder
+require 'rails_helper'
+include ActionController::RespondWith
+
+# The authentication header looks something like this:
+# {"access-token"=>"abcd1dMVlvW2BT67xIAS_A", "token-type"=>"Bearer", "client"=>"LSJEVZ7Pq6DX5LXvOWMq1w", "expiry"=>"1519086891", "uid"=>"darnell@konopelski.info"}
+
+describe 'Whether access is ocurring properly', type: :request do
+ before(:each) do
+ @current_user = FactoryBot.create(:user)
+ @client = FactoryBot.create :client
+ end
+
+ context 'context: general authentication via API, ' do
+ it "doesn't give you anything if you don't log in" do
+ get api_client_path(@client)
+ expect(response.status).to eq(401)
+ end
+
+ it 'gives you an authentication code if you are an existing user and you satisfy the password' do
+ login
+ # puts "#{response.headers.inspect}"
+ # puts "#{response.body.inspect}"
+ expect(response.has_header?('access-token')).to eq(true)
+ end
+
+ it 'gives you a status 200 on signing in ' do
+ login
+ expect(response.status).to eq(200)
+ end
+
+ it 'gives you an authentication code if you are an existing user and you satisfy the password' do
+ login
+ expect(response.has_header?('access-token')).to eq(true)
+ end
+
+ it 'first get a token, then access a restricted page' do
+ login
+ auth_params = get_auth_params_from_login_response_headers(response)
+ new_client = FactoryBot.create(:client)
+ get api_find_client_by_name_path(new_client.name), headers: auth_params
+ expect(response).to have_http_status(:success)
+ end
+
+ it 'deny access to a restricted page with an incorrect token' do
+ login
+ auth_params = get_auth_params_from_login_response_headers(response).tap do |h|
+ h.each do |k, _v|
+ if k == 'access-token'
+ h[k] = '123'
+ end end
+ end
+ new_client = FactoryBot.create(:client)
+ get api_find_client_by_name_path(new_client.name), headers: auth_params
+ expect(response).not_to have_http_status(:success)
+ end
+ end
+
+ RSpec.shared_examples 'use authentication tokens of different ages' do |token_age, http_status|
+ let(:vary_authentication_age) { token_age }
+
+ it 'uses the given parameter' do
+ expect(vary_authentication_age(token_age)).to have_http_status(http_status)
+ end
+
+ def vary_authentication_age(token_age)
+ login
+ auth_params = get_auth_params_from_login_response_headers(response)
+ new_client = FactoryBot.create(:client)
+ get api_find_client_by_name_path(new_client.name), headers: auth_params
+ expect(response).to have_http_status(:success)
+
+ allow(Time).to receive(:now).and_return(Time.now + token_age)
+
+ get api_find_client_by_name_path(new_client.name), headers: auth_params
+ response
+ end
+ end
+
+ context 'test access tokens of varying ages' do
+ include_examples 'use authentication tokens of different ages', 2.days, :success
+ include_examples 'use authentication tokens of different ages', 5.years, :unauthorized
+ end
+
+ def login
+ post api_user_session_path, params: { email: @current_user.email, password: 'password' }.to_json, headers: { 'CONTENT_TYPE' => 'application/json', 'ACCEPT' => 'application/json' }
+ end
+
+ def get_auth_params_from_login_response_headers(response)
+ client = response.headers['client']
+ token = response.headers['access-token']
+ expiry = response.headers['expiry']
+ token_type = response.headers['token-type']
+ uid = response.headers['uid']
+
+ auth_params = {
+ 'access-token' => token,
+ 'client' => client,
+ 'uid' => uid,
+ 'expiry' => expiry,
+ 'token_type' => token_type
+ }
+ auth_params
+ end
+end
+
+```
+
+### (b) How to create an authorisation header from Scratch
+
+```ruby
+require 'rails_helper'
+include ActionController::RespondWith
+
+def create_auth_header_from_scratch
+ # You need to set up factory bot to use this method
+ @current_user = FactoryBot.create(:user)
+ # create client id and token
+ client_id = SecureRandom.urlsafe_base64(nil, false)
+ token = SecureRandom.urlsafe_base64(nil, false)
+
+ # store client + token in user's token hash
+ @current_user.tokens[client_id] = {
+ token: BCrypt::Password.create(token),
+ expiry: (Time.now + 1.day).to_i
+ }
+
+ # Now we have to pretend like an API user has already logged in.
+ # (When the user actually logs in, the server will send the user
+ # - assuming that the user has correctly and successfully logged in
+ # - four auth headers. We are to then use these headers to access
+ # things which are typically restricted
+ # The following assumes that the user has received those headers
+ # and that they are then using those headers to make a request
+
+ new_auth_header = @current_user.build_auth_header(token, client_id)
+
+ puts 'This is the new auth header'
+ puts new_auth_header.to_s
+
+ # update response with the header that will be required by the next request
+ puts response.headers.merge!(new_auth_header).to_s
+end
+```
+
+### Further Examples of Request Specs
+
+* https://gist.github.com/blaze182/3a59a6af8c6a7aaff7bf5f8078a5f2b6
+* https://gist.github.com/niinyarko/f146f24a50125d55396f63043a2696e7