simple_token_authentication 1.14.0 → 1.15.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjIyYWI3MGE1N2VkNTY2ZTRhNjNmZWZjYzVmNjgwZmJkZWU2ODI3Mg==
-  data.tar.gz: !binary |-
-    OWRkMDUxNTA3MTBlNDhiYTk3NWE2ODJiOTZiMzUwZjlkYzg5MjBiNA==
+SHA1:
+  metadata.gz: 3954e4aa1084737bfce46e449f442d59c41a8f06
+  data.tar.gz: 87f0de62bcce94ab8431f63f952e0a02417c7ec2
 SHA512:
-  metadata.gz: !binary |-
-    NmQ5ZWRhNjM2MzMzY2ZhYjIyNDlkOTQ5NzQ2YzMyN2I1M2JhODc4NjkwNjM0
-    NGU1MTkxNWE2YzgxNzE2NTg4ZWRkZWZiYmM4OWZmNDc3Mzg3NjJlYjVlYjUz
-    Y2Q5ZDgwOWU4NWU1ZTdmMzZkNTM1YWYzN2FmYjI2ZDEyZjc5MjM=
-  data.tar.gz: !binary |-
-    NzZlODg5ZTk1YzY3ZDA2NmNlNjgxN2U1MGJiYTQyZjM5MDg4YjE4NmQ3NjY4
-    YmRhMDVhZDEzNmM1NWYwYmRmZjZlODJhMjczMDAzZWUxNWI4OGY4YWY4YWY5
-    NDFhYjZhNWMwY2ViNWM2Y2RjNzI0ZGE1OGM2ODM5NzczN2ExZWI=
+  metadata.gz: 44c18ed1a2446f3a064ca1b40fe168a55f90f4dee0ab7feb02a76e5abe439a1d572a81d7cd78fb85f2724b252c3d63f93bca13436cf9ab2d4c00536076c9e485
+  data.tar.gz: 5089b7ced8079351b5719e5c327ecddc006948daa9b8c604acb1df0b418260f5846cebddf728164df40db60ed4812e9f573cf2f8d2948467178ef4cd49e58271

data/Appraisals

@@ -1,7 +1,5 @@
 appraise 'rails_5_devise_4' do
-  # Until Mongoid 6 is released, allow Rails 5 dependencies to be installed,
-  # see https://github.com/gonzalo-bulnes/simple_token_authentication/issues/231
-  gem 'mongoid', git: 'https://github.com/mongodb/mongoid.git', branch: 'master'
+  # use gemspec constraints
 end
 
 appraise 'rails_4_devise_3' do
@@ -14,7 +12,8 @@ end
 appraise 'ruby_1.9.3_rails_3.2' do
   gem 'actionmailer', '>= 3.2.6', '< 4'
   gem 'actionpack', '>= 3.2.6', '< 4'
-  gem 'activerecord', '>= 3.2.6', '< 4'
+  gem 'activerecord', '>= 3.2.15', '< 4'
   gem 'mime-types', '< 3'
+  gem 'term-ansicolor', '~> 1.3.0'
   gem 'tins', '< 1.7.0'
 end

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.15.0] - 2017-01-14
+
+### Added
+
+- Support for hooks, specifically `after_successful_token_authentication` for now
+- A Contributor Code of Conduct to ensure everyone feels safe contributing
+
 ## [1.14.0] - 2016-07-09
 
 ### Added
@@ -253,6 +260,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This [gist][gist] did refactor the Jose Valim's code into an `ActiveSupport::Concern`.
 
 [gist]: https://gist.github.com/gonzalo-bulnes/7659739
+[1.15.0]: https://github.com/gonzalo-bulnes/simple_token_authentication/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/gonzalo-bulnes/simple_token_authentication/compare/v1.13.0...v1.14.0
 [1.13.0]: https://github.com/gonzalo-bulnes/simple_token_authentication/compare/v1.12.0...v1.13.0
 [1.12.0]: https://github.com/gonzalo-bulnes/simple_token_authentication/compare/v1.11.0...v1.12.0

data/README.md

@@ -24,7 +24,9 @@ This gem packages the content of the gist and provides a set of convenient optio
 Installation
 ------------
 
-Install [Devise][devise] with any modules you want, then add the gem to your `Gemfile`:
+### In a nutshell
+
+First install [Devise][devise] and configure it with any modules you want, then add the gem to your `Gemfile` and `bundle install`:
 
 ```ruby
 # Gemfile
@@ -32,6 +34,29 @@ Install [Devise][devise] with any modules you want, then add the gem to your `Ge
 gem 'simple_token_authentication', '~> 1.0' # see semver.org
 ```
 
+Once that done, only two steps are required to setup token authentication:
+
+1. [Make one or more models token authenticatable][token_authenticatable] (ActiveRecord and Mongoid are supported)
+1. [Allow controllers to handle token authentication][token_authentication_handler] (Rails, Rails API, and `ActionController::Metal` are supported)
+
+_If you want more details about how the gem works, keep reading! We'll get to these two steps after the overview._
+
+  [token_authenticatable]: #make-models-token-authenticatable
+  [token_authentication_handler]: #allow-controllers-to-handle-token-authentication
+
+### Overview
+
+Simple Token Authentication provides the ability to manage an `authentication_token` from your model instances. A model with that ability enabled is said to be **token authenticatable** (typically, the `User` model will be made token authenticatable).
+
+The gem also provides the ability for any controller to handle token authentication for one or multiple _token authenticatable_ models. That ability allows, for example, to automatically sign in an `user` when the correct credentials are provided with a request. A controller with that ability enabled is said to behave as a **token authentication handler**.
+The token authentication credentials for a given request can be provided either in the form of [query params][authentication_method_query_params], or [HTTP headers][authentication_method_headers]. By default, the required credentials are the user's email and their authentication token.
+
+What happens when a request is provided with no credentials or incorrect credentials is [highly configurable][integration_with_other_authentication_methods] (some scenarios may require access to be denied, other may allow unauthenticated access, or provide others strategies to authenticate users). By default, when token authentication fails, Devise is used as a fallback to ensure a consistent behaviour with controllers that do not handle token authentication.
+
+  [authentication_method_query_params]: #authentication-method-1-query-params
+  [authentication_method_headers]: #authentication-method-2-request-headers
+  [integration_with_other_authentication_methods]: #integration-with-other-authentication-and-authorization-methods
+
 ### Make models token authenticatable
 
 #### ActiveRecord
@@ -250,6 +275,27 @@ To use no fallback when token authentication fails, set `fallback: :none`.
 
   [csrf]: https://github.com/gonzalo-bulnes/simple_token_authentication/issues/49
 
+### Hooks
+
+One hook is currently available to trigger custom behaviour after an user has been successfully authenticated through token authentication. To use it, override the `after_successful_token_authentication` method in the corresponding token authentication handler:
+
+```ruby
+# app/controller/application_controller.rb
+
+class ApplicationController < ActiveController::Base
+  acts_as_token_authentication_handler_for User
+
+  # ...
+
+  private
+
+    def after_successful_token_authentication
+      # Make the authentication token to be disposable - for example
+      renew_authentication_token!
+    end
+end
+```
+
 ### Testing
 
 Here is an example of how you can test-drive your configuration using [Minitest][minitest]:
@@ -322,6 +368,10 @@ Contributions are welcome! I'm not personally maintaining any [list of contribut
 
 Please be sure to [review the open issues][open-questions] and contribute with your ideas or code in the issue best suited to the topic. Keeping discussions in a single place makes easier to everyone interested in that topic to keep track of the contributions.
 
+Finally, please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
+
+  [coc]: ./CODE_OF_CONDUCT.md
+
 Credits
 -------
 

data/gemfiles/rails_4_devise_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    simple_token_authentication (1.14.0)
+    simple_token_authentication (1.15.0)
       actionmailer (>= 3.2.6, < 6)
       actionpack (>= 3.2.6, < 6)
       devise (>= 3.2, < 6)
@@ -9,36 +9,36 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.6)
-      activesupport (= 4.2.6)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
       globalid (>= 0.3.0)
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
-    activerecord (4.2.6)
-      activemodel (= 4.2.6)
-      activesupport (= 4.2.6)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       arel (~> 6.0)
-    activesupport (4.2.6)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -48,12 +48,11 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
-    arel (6.0.3)
+    arel (6.0.4)
     bcrypt (3.1.11)
-    bson (3.2.6)
-    builder (3.2.2)
+    bson (4.2.1)
+    builder (3.2.3)
     coderay (1.1.1)
-    connection_pool (2.2.0)
     devise (3.5.10)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
@@ -63,7 +62,7 @@ GEM
       warden (~> 1.2.3)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    globalid (0.3.6)
+    globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
     inch (0.7.1)
@@ -71,7 +70,7 @@ GEM
       sparkr (>= 0.2.0)
       term-ansicolor
       yard (~> 0.8.7.5)
-    json (1.8.3)
+    json (1.8.6)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -80,50 +79,47 @@ GEM
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.0.0)
-    minitest (5.9.0)
-    mongoid (4.0.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    mongo (2.4.1)
+      bson (>= 4.2.1, < 5.0.0)
+    mongoid (5.1.6)
       activemodel (~> 4.0)
-      moped (~> 2.0.0)
-      origin (~> 2.1)
+      mongo (~> 2.1)
+      origin (~> 2.2)
       tzinfo (>= 0.3.37)
-    moped (2.0.7)
-      bson (~> 3.0)
-      connection_pool (~> 2.0)
-      optionable (~> 0.2.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    optionable (0.2.0)
-    origin (2.2.0)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    origin (2.3.0)
     orm_adapter (0.5.0)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.6.4)
+    rack (1.6.5)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
+    rails-dom-testing (1.0.8)
       activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6)
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.6)
-      actionpack (= 4.2.6)
-      activesupport (= 4.2.6)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (11.2.2)
-    responders (2.1.2)
+    rake (12.0.0)
+    responders (2.3.0)
       railties (>= 4.2.0, < 5.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.0)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -134,11 +130,11 @@ GEM
     rspec-support (3.5.0)
     slop (3.6.0)
     sparkr (0.4.1)
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
-    thor (0.19.1)
+    thor (0.19.4)
     thread_safe (0.3.5)
-    tins (1.10.2)
+    tins (1.13.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     warden (1.2.6)
@@ -160,4 +156,4 @@ DEPENDENCIES
   simple_token_authentication!
 
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/gemfiles/rails_5_devise_4.gemfile

@@ -2,6 +2,4 @@
 
 source "https://rubygems.org"
 
-gem "mongoid", :git => "https://github.com/mongodb/mongoid.git", :branch => "master"
-
 gemspec :path => "../"

data/gemfiles/rails_5_devise_4.gemfile.lock

@@ -1,16 +1,7 @@
-GIT
-  remote: https://github.com/mongodb/mongoid.git
-  revision: f539cc6acd284bc87b64f6f043f74897d72387ad
-  branch: master
-  specs:
-    mongoid (6.0.0)
-      activemodel (~> 5.0)
-      mongo (~> 2.2)
-
 PATH
   remote: ../
   specs:
-    simple_token_authentication (1.14.0)
+    simple_token_authentication (1.15.0)
       actionmailer (>= 3.2.6, < 6)
       actionpack (>= 3.2.6, < 6)
       devise (>= 3.2, < 6)
@@ -18,35 +9,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (5.0.0)
-      actionpack (= 5.0.0)
-      actionview (= 5.0.0)
-      activejob (= 5.0.0)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.0)
-      actionview (= 5.0.0)
-      activesupport (= 5.0.0)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.0)
-      activesupport (= 5.0.0)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.0)
-      activesupport (= 5.0.0)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
       globalid (>= 0.3.6)
-    activemodel (5.0.0)
-      activesupport (= 5.0.0)
-    activerecord (5.0.0)
-      activemodel (= 5.0.0)
-      activesupport (= 5.0.0)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
       arel (~> 7.0)
-    activesupport (5.0.0)
+    activesupport (5.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -55,12 +46,12 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
-    arel (7.0.0)
+    arel (7.1.4)
     bcrypt (3.1.11)
-    bson (4.1.1)
-    builder (3.2.2)
+    bson (4.2.1)
+    builder (3.2.3)
     coderay (1.1.1)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.4)
     devise (4.2.0)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
@@ -69,7 +60,7 @@ GEM
       warden (~> 1.2.3)
     diff-lcs (1.2.5)
     erubis (2.7.0)
-    globalid (0.3.6)
+    globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
     inch (0.7.1)
@@ -86,40 +77,41 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    mongo (2.2.5)
-      bson (~> 4.0)
-    nokogiri (1.6.8)
+    minitest (5.10.1)
+    mongo (2.4.1)
+      bson (>= 4.2.1, < 5.0.0)
+    mongoid (6.0.3)
+      activemodel (~> 5.0)
+      mongo (~> 2.3)
+    nokogiri (1.7.0.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
     orm_adapter (0.5.0)
-    pkg-config (1.1.7)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails-dom-testing (2.0.1)
+    rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.0)
-      actionpack (= 5.0.0)
-      activesupport (= 5.0.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (11.2.2)
-    responders (2.2.0)
+    rake (12.0.0)
+    responders (2.3.0)
       railties (>= 4.2.0, < 5.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.1)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -130,11 +122,11 @@ GEM
     rspec-support (3.5.0)
     slop (3.6.0)
     sparkr (0.4.1)
-    term-ansicolor (1.3.2)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
-    thor (0.19.1)
+    thor (0.19.4)
     thread_safe (0.3.5)
-    tins (1.10.2)
+    tins (1.13.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     warden (1.2.6)
@@ -148,9 +140,9 @@ DEPENDENCIES
   activerecord (>= 3.2.6, < 6)
   appraisal (~> 2.0)
   inch (~> 0.4)
-  mongoid!
+  mongoid (>= 3.1.0, < 7)
   rspec (~> 3.0)
   simple_token_authentication!
 
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/gemfiles/ruby_1.9.3_rails_3.2.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "actionmailer", ">= 3.2.6", "< 4"
 gem "actionpack", ">= 3.2.6", "< 4"
-gem "activerecord", ">= 3.2.6", "< 4"
+gem "activerecord", ">= 3.2.15", "< 4"
 gem "mime-types", "< 3"
+gem "term-ansicolor", "~> 1.3.0"
 gem "tins", "< 1.7.0"
 
 gemspec :path => "../"

data/gemfiles/ruby_1.9.3_rails_3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    simple_token_authentication (1.14.0)
+    simple_token_authentication (1.15.0)
       actionmailer (>= 3.2.6, < 6)
       actionpack (>= 3.2.6, < 6)
       devise (>= 3.2, < 6)
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.22.2)
-      actionpack (= 3.2.22.2)
+    actionmailer (3.2.22.5)
+      actionpack (= 3.2.22.5)
       mail (~> 2.5.4)
-    actionpack (3.2.22.2)
-      activemodel (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
+    actionpack (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -22,15 +22,15 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.22.2)
-      activesupport (= 3.2.22.2)
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
-    activerecord (3.2.22.2)
-      activemodel (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
+    activerecord (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.22.2)
+    activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     appraisal (2.1.0)
@@ -58,7 +58,7 @@ GEM
       term-ansicolor
       yard (~> 0.8.7.5)
     journey (1.0.4)
-    json (1.8.3)
+    json (1.8.6)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
@@ -74,7 +74,7 @@ GEM
     origin (1.1.0)
     orm_adapter (0.5.0)
     polyglot (0.3.5)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
@@ -85,14 +85,14 @@ GEM
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    railties (3.2.22.2)
-      actionpack (= 3.2.22.2)
-      activesupport (= 3.2.22.2)
+    railties (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (11.2.2)
+    rake (12.0.0)
     rdoc (3.12.2)
       json (~> 1.4)
     responders (1.1.2)
@@ -101,7 +101,7 @@ GEM
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.0)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -119,14 +119,14 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
-    thor (0.19.1)
+    thor (0.19.4)
     thread_safe (0.3.5)
     tilt (1.4.1)
     tins (1.6.0)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.51)
+    tzinfo (0.3.52)
     warden (1.2.6)
       rack (>= 1.0)
     yard (0.8.7.6)
@@ -137,14 +137,15 @@ PLATFORMS
 DEPENDENCIES
   actionmailer (>= 3.2.6, < 4)
   actionpack (>= 3.2.6, < 4)
-  activerecord (>= 3.2.6, < 4)
+  activerecord (>= 3.2.15, < 4)
   appraisal (~> 2.0)
   inch (~> 0.4)
   mime-types (< 3)
   mongoid (>= 3.1.0, < 7)
   rspec (~> 3.0)
   simple_token_authentication!
+  term-ansicolor (~> 1.3.0)
   tins (< 1.7.0)
 
 BUNDLED WITH
-   1.11.2
+   1.13.6

data/lib/simple_token_authentication/token_authentication_handler.rb

@@ -27,11 +27,20 @@ module SimpleTokenAuthentication
       private :integrate_with_devise_case_insensitive_keys
     end
 
+    # This method is a hook and is meant to be overridden.
+    #
+    # It is not expected to return anything special,
+    # only its side effects will be used.
+    def after_successful_token_authentication
+      # intentionally left blank
+    end
+
     def authenticate_entity_from_token!(entity)
       record = find_record_from_identifier(entity)
 
       if token_correct?(record, entity, token_comparator)
         perform_sign_in!(record, sign_in_handler)
+        after_successful_token_authentication
       end
     end
 

data/lib/simple_token_authentication/version.rb

@@ -1,3 +1,3 @@
 module SimpleTokenAuthentication
-  VERSION = "1.14.0"
+  VERSION = "1.15.0".freeze
 end

data/spec/lib/simple_token_authentication/token_authentication_handler_spec.rb

@@ -691,4 +691,32 @@ describe 'Any class which includes SimpleTokenAuthentication::TokenAuthenticatio
       end
     end
   end
+
+  describe '#authenticate_entity_from_token!' do
+
+    let(:token_authentication_handler) { described_class.new }
+
+    before(:each) do
+        allow(token_authentication_handler).to receive(:find_record_from_identifier)
+        allow(token_authentication_handler).to receive(:perform_sign_in!)
+        allow(token_authentication_handler).to receive(:token_correct?).and_return(false)
+    end
+
+    it 'does not trigger the :after_successful_token_authentication hook', hooks: true, private: true do
+      expect(token_authentication_handler).not_to receive(:after_successful_token_authentication)
+      token_authentication_handler.send(:authenticate_entity_from_token!, double)
+    end
+
+    context 'after successful authentication' do
+
+      before(:each) do
+        allow(token_authentication_handler).to receive(:token_correct?).and_return(true)
+      end
+
+      it 'calls the :after_successful_token_authentication hook', hooks: true, protected: true do
+        expect(token_authentication_handler).to receive(:after_successful_token_authentication).once
+        token_authentication_handler.send(:authenticate_entity_from_token!, double)
+      end
+    end
+  end
 end

data/spec/support/specs_for_token_authentication_handler_interface.rb

@@ -5,4 +5,11 @@ RSpec.shared_examples 'a token authentication handler' do
   it 'responds to :handle_token_authentication_for', private: true do
     expect(token_authentication_handler).to respond_to :handle_token_authentication_for
   end
+
+  describe 'instance' do
+
+    it 'responds to :after_successful_token_authentication', hooks: true, private: true do
+      expect(token_authentication_handler.new).to respond_to :after_successful_token_authentication
+    end
+  end
 end

metadata

@@ -1,155 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: simple_token_authentication
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: 
@@ -167,7 +167,6 @@ files:
 - doc/README.md
 - gemfiles/rails_4_devise_3.gemfile
 - gemfiles/rails_4_devise_3.gemfile.lock
-- gemfiles/rails_4_devise_4.gemfile.lock
 - gemfiles/rails_5_devise_4.gemfile
 - gemfiles/rails_5_devise_4.gemfile.lock
 - gemfiles/ruby_1.9.3_rails_3.2.gemfile
@@ -237,17 +236,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: Simple (but safe) token authentication for Rails apps or API with Devise.
@@ -291,7 +290,7 @@ test_files:
 - gemfiles/rails_5_devise_4.gemfile
 - gemfiles/ruby_1.9.3_rails_3.2.gemfile
 - gemfiles/rails_4_devise_3.gemfile.lock
-- gemfiles/rails_4_devise_4.gemfile.lock
 - gemfiles/rails_5_devise_4.gemfile.lock
 - gemfiles/ruby_1.9.3_rails_3.2.gemfile.lock
 - Appraisals
+has_rdoc: 

data/gemfiles/rails_4_devise_4.gemfile.lock

@@ -1,159 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    simple_token_authentication (1.13.0)
-      actionmailer (>= 3.2.6, < 5)
-      actionpack (>= 3.2.6, < 5)
-      devise (>= 3.2, < 5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.6)
-      activesupport (= 4.2.6)
-      globalid (>= 0.3.0)
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activerecord (4.2.6)
-      activemodel (= 4.2.6)
-      activesupport (= 4.2.6)
-      arel (~> 6.0)
-    activesupport (4.2.6)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    appraisal (2.1.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (6.0.3)
-    bcrypt (3.1.11)
-    bson (3.2.6)
-    builder (3.2.2)
-    coderay (1.1.1)
-    connection_pool (2.2.0)
-    devise (4.0.0)
-      bcrypt (~> 3.0)
-      orm_adapter (~> 0.1)
-      railties (>= 4.1.0, < 5.1)
-      responders
-      warden (~> 1.2.3)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    inch (0.7.1)
-      pry
-      sparkr (>= 0.2.0)
-      term-ansicolor
-      yard (~> 0.8.7.5)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    method_source (0.8.2)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.0.0)
-    minitest (5.9.0)
-    mongoid (4.0.2)
-      activemodel (~> 4.0)
-      moped (~> 2.0.0)
-      origin (~> 2.1)
-      tzinfo (>= 0.3.37)
-    moped (2.0.7)
-      bson (~> 3.0)
-      connection_pool (~> 2.0)
-      optionable (~> 0.2.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    optionable (0.2.0)
-    origin (2.2.0)
-    orm_adapter (0.5.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.6)
-      actionpack (= 4.2.6)
-      activesupport (= 4.2.6)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (11.2.2)
-    responders (2.1.2)
-      railties (>= 4.2.0, < 5.1)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.0)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    slop (3.6.0)
-    sparkr (0.4.1)
-    term-ansicolor (1.3.2)
-      tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tins (1.10.2)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    warden (1.2.6)
-      rack (>= 1.0)
-    yard (0.8.7.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (>= 3.2.6, < 5)
-  appraisal (~> 2.0)
-  inch (~> 0.4)
-  mongoid (>= 3.1.0, < 5)
-  rspec (~> 3.0)
-  simple_token_authentication!
-
-BUNDLED WITH
-   1.11.2