devise_token_authenticatable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375295d26a44cdcc5dccfcdc3ff7656d9cdf4df17cb9d7e9ed02ed213f61a907
-  data.tar.gz: 13dc2e748ae66eadf9085367da20016113f7271184c952f7772d6da92b8c1f6c
+  metadata.gz: 054cad82b8440b387847aa335eaf6a5f19b795f0b32ffbc4d6f8701d95f02811
+  data.tar.gz: 5ed7c55a1b40f7d4c2b7fa654d21159237cb2469b907d2d452a674e7ef9639ac
 SHA512:
-  metadata.gz: f4821dcdac4f96c66b44c2fd081fa030508295ec759c9500e38efa7d5458f23006cd3e6fdb69cb2680c9aeac084cb8158f2dc418ebc0e3c45f9ad125c55c710f
-  data.tar.gz: fda0f619bc558d6451bdaa2a25abdeaee73bdebe06a47600c05551aa5d6ee20d0aa0549ff65e02652084a5b5a2b08155a918a0088df0fbfadfdca49a6721d1d8
+  metadata.gz: d93c3bae83fc23566ba08b1efc3ea75756a3041435cde50fb00c169cdc618222d78f5f256442d0180eb6cf3cacc483a0a6f012f757c9dfdfe6b9ffa0704867d6
+  data.tar.gz: 373894492b060292563e2c582a78e3f60e8de1fa9f0e6a22af005626fd5128b56638a4e0d78ecc52e0dec2c6e2681583ccec94c92a1be47b831fb1637406a866

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    devise_token_authenticatable (0.1.3)
-      devise (~> 4.4, >= 4.4.3)
+    devise_token_authenticatable (0.1.4)
+      devise (~> 4.0, >= 4.0.0)
       jwt (~> 2.1)
 
 GEM

data/README.md

@@ -10,6 +10,15 @@ gem 'devise_token_authenticatable'
 
 ### Controllers
 
+For the controllers only, we provide the generator to install the gem.
+/!\ Warning, it will override `controllers/users/sessions_controller.rb` and `controllers/users/registrations_controller.rb` if they exist. /!\
+
+```ruby
+rails g devise_token_authenticatable:initializer
+```
+
+If you don't want to use the generator, you can install the gem manually (see below).
+
 Create an `users` directory in your `controllers` directory.
 In this `users` directory, create a `sessions` controller.
 Override the `create` action like this :
@@ -33,14 +42,6 @@ class Users::RegistrationsController < Devise::RegistrationsController
 end
 ```
 
-Add this in your application controller
-
-```ruby
-class ApplicationController < ActionController::Base
-  include Devise::Controllers::TokenAuthenticatable
-end
-```
-
 Use "before_action :token_authenticate_user!" instead of "before_action :authenticate_user!"
 
 ### Models

data/devise_token_authenticatable.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency('devise', '~> 4.4', '>= 4.4.3')
+  spec.add_dependency('devise', '~> 4.0', '>= 4.0.0')
   spec.add_dependency('jwt', '~> 2.1')
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/devise_token_authenticatable.rb

@@ -1,5 +1,11 @@
-require 'devise_token_authenticatable/controllers/token_authenticatable'
+require 'devise'
 require 'devise_token_authenticatable/models/token_authenticatable'
 require 'devise_token_authenticatable/strategies/token_authenticatable'
+require 'devise_token_authenticatable/rails'
+
+module Devise
+  mattr_accessor :token_ip_verifier
+  @@token_ip_verifier = false
+end
 
 Devise.add_module :token_authenticatable, controller: true, model: true, strategy: true, no_input: true

data/lib/devise_token_authenticatable/models/token_authenticatable.rb

@@ -11,10 +11,20 @@ module Devise
 
       def access_token(remote_ip = nil)
         current_sign_in_at = self.respond_to?(:timedout?) && Time.now.utc
-        current_sign_in_ip = self.respond_to?(:current_sign_in_ip) && remote_ip
+        current_sign_in_ip = self.token_ip_verifier && remote_ip
 
         Base64.strict_encode64(JWT.encode({ id: id, current_sign_in_at: current_sign_in_at, current_sign_in_ip: current_sign_in_ip }, Devise.secret_key, 'HS256'))
       end
+
+      def token_ip_verifier
+        self.class.token_ip_verifier
+      end
+
+    protected
+
+      module ClassMethods
+        Devise::Models.config(self, :token_ip_verifier)
+      end
     end
   end
 end

data/lib/devise_token_authenticatable/rails.rb

@@ -0,0 +1,9 @@
+require 'devise_token_authenticatable/controllers/token_authenticatable'
+
+module DeviseTokenAuthenticatable
+  class Engine < ::Rails::Engine
+    ActiveSupport.on_load(:action_controller) do
+      include Devise::Controllers::TokenAuthenticatable
+    end
+  end
+end

data/lib/devise_token_authenticatable/strategies/token_authenticatable.rb

@@ -13,7 +13,7 @@ module Devise
 
         return fail(:timeout) if resource.respond_to?(:timedout?) && !env['devise.skip_timeout'] && resource.timedout?(current_sign_in_at)
 
-        if validate(resource) { !resource.respond_to?(:current_sign_in_ip) || request.remote_ip == current_sign_in_ip }
+        if validate(resource) { !resource.token_ip_verifier || request.remote_ip == current_sign_in_ip }
           success!(resource)
         end
 

data/lib/devise_token_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseTokenAuthenticatable
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/generators/devise_token_authenticatable/initializer_generator.rb

@@ -0,0 +1,56 @@
+require 'rails/generators/base'
+
+# Je me suis servi de :
+
+# - la documentation des generators
+# https://guides.rubyonrails.org/generators.html
+
+# - Depuis Rails 3.0, la gem Thor permet de manipuler facilement des fichiers, dont create_file et inject_into_file
+# https://github.com/erikhuda/thor
+# https://www.rubydoc.info/github/wycats/thor/master/Thor/Actions/InjectIntoFile
+module DeviseTokenAuthenticatable
+  class InitializerGenerator < Rails::Generators::Base
+    desc "This generator initializes devise_token_authenticatable's gem configs"
+
+    ## Déclaration des constantes
+
+    SESSIONS_COMMENT_LINE = "# SessionsController generated by devise_token_authenticatable\n\n"
+    REGISTRATIONS_COMMENT_LINE = "# RegistrationsController generated by devise_token_authenticatable\n\n"
+
+    ## Initialisation SessionsController
+
+    def create_sessions_controller
+      # Possible de le faire en une seule ligne avec un create_file(file, content)
+      # J'ai utilisé deux lignes pour la PR pour utiliser les fonctions de Thor
+      create_file 'app/controllers/users/sessions_controller.rb', InitializerGenerator::SESSIONS_COMMENT_LINE
+      inject_into_file "app/controllers/users/sessions_controller.rb", write_sessions_controller, after: InitializerGenerator::SESSIONS_COMMENT_LINE
+    end
+
+    def write_sessions_controller
+<<RUBY
+class Users::SessionsController < Devise::SessionsController
+  def create
+    super do
+      set_user_access_token!
+    end
+  end
+end
+RUBY
+    end
+
+    ## Initialisation RegistrationsController
+
+    def create_registrations_controller
+      create_file 'app/controllers/users/registrations_controller.rb', InitializerGenerator::REGISTRATIONS_COMMENT_LINE
+      inject_into_file "app/controllers/users/registrations_controller.rb", write_registrations_controller, after: InitializerGenerator::REGISTRATIONS_COMMENT_LINE
+    end
+
+    def write_registrations_controller
+<<RUBY
+class Users::RegistrationsController < Devise::RegistrationsController
+  prepend_before_action :set_user_access_token!, only: %i[edit update destroy]
+end
+RUBY
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_token_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jonathan PHILIPPE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.3
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.4.3
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -90,8 +90,10 @@ files:
 - lib/devise_token_authenticatable.rb
 - lib/devise_token_authenticatable/controllers/token_authenticatable.rb
 - lib/devise_token_authenticatable/models/token_authenticatable.rb
+- lib/devise_token_authenticatable/rails.rb
 - lib/devise_token_authenticatable/strategies/token_authenticatable.rb
 - lib/devise_token_authenticatable/version.rb
+- lib/generators/devise_token_authenticatable/initializer_generator.rb
 homepage: ''
 licenses:
 - MIT