simple_token_authentication 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a591bf010048a69bf6aa69ae30dfbf70447450e4
-  data.tar.gz: b9c3da152f4b7e45a09baa147877c51d9a87f3b5
+  metadata.gz: fe0b202d3e751ee7f584656ac3e1e5bf980ddc46
+  data.tar.gz: e579242f74cee8914dfbd2459b0078f1f487a80a
 SHA512:
-  metadata.gz: a634c6c89b380c907232ea0dff90ce3d790d0cf1810330317a58a1023ac4e627f8ff2f28bd772cd4f8d5ad214565605e22dbb60bd67c26196ab13b7ec529c8f0
-  data.tar.gz: 07ab409043bd4a4977af91c75d3bbcb7ce2c83c9781ed1ec77be2a798a6da871bc346ad1cf6799a1dd0846ee0a838eaca5a133158bf82ac13edd1cd42126bb09
+  metadata.gz: 7b77aed745f0220f4238c25f37be4bc68349288728acd91d11176abe3d34b7a7e510d493dff95be815986cac6375a0be4e629e508036d2e2f33a532bba98078c
+  data.tar.gz: bbd38d859ca4bbc6260851fbb8e9084da32d87e40af83afeeb0dacb7594235e4a814547114d622f3d96bc88ad4ce643afb446baabf4fc21c8ea1ec6e33792c07

data/README.md

@@ -28,20 +28,7 @@ Install [Devise][devise] with any modules you want, then add the gem to your `Ge
 gem 'simple_token_authentication'
 ```
 
-Define which controller will handle authentication (typ. `ApplicationController`):
-
-```ruby
-# app/controllers/application_controller.rb
-
-class ApplicationController < ActionController::Base
-  # ...
-  acts_as_token_authentication_handler
-
-  # ...
-end
-```
-
-Define which model or models will be token authenticatable (typ. `User`):
+First define which model or models will be token authenticatable (typ. `User`):
 
 ```ruby
 # app/models/user.rb
@@ -70,6 +57,19 @@ rails g migration add_authentication_token_to_users authentication_token:string:
 rake db:migrate
 ```
 
+Finally define which controller will handle authentication (typ. `ApplicationController`) for which _token authenticatable_ model:
+
+```ruby
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::Base
+  # ...
+  acts_as_token_authentication_handler_for User
+
+  # ...
+end
+```
+
 Usage
 -----
 
@@ -117,6 +117,17 @@ The resulting Cucumber features are a bit verbose, and their output when errors
 
 You can run the full test suite with `cd simple_token_authentication && rake`.
 
+### Executable documentation
+
+The Cucumber scenarii describe how to setup demonstration applications for different use cases. While you can read the `rake` output, you may prefer to read it in HTML format:
+
+```bash
+cd simple_token_authentication
+rake features_html # generate the features documentation
+
+# Open doc/features.html in your preferred web browser.
+```
+
 ### Contributions
 
 Contributions are welcome! I'm not keeping a list of contributors for now, but any PR which references us all will be welcome.

data/Rakefile

@@ -26,6 +26,10 @@ begin
     t.cucumber_opts = "--format pretty"
   end
 
+  Cucumber::Rake::Task.new(:features_html) do |t|
+    t.cucumber_opts = "--format html --out doc/features.html"
+  end
+
 rescue LoadError
   desc 'Cucumber rake task not available'
   task :features do

data/lib/simple_token_authentication/acts_as_token_authenticatable.rb

@@ -18,7 +18,7 @@ module SimpleTokenAuthentication
     def generate_authentication_token
       loop do
         token = Devise.friendly_token
-        break token unless User.where(authentication_token: token).first
+        break token unless self.class.where(authentication_token: token).first
       end
     end
 

data/lib/simple_token_authentication/acts_as_token_authentication_handler.rb

@@ -6,52 +6,67 @@ module SimpleTokenAuthentication
     # before editing this file, the discussion is very interesting.
 
     included do
-      private :authenticate_user_from_token!
+      private :authenticate_entity_from_token!
       # This is our new function that comes before Devise's one
-      before_filter :authenticate_user_from_token!
+      before_filter :authenticate_entity_from_token!
       # This is Devise's authentication
-      before_filter :authenticate_user!
+      before_filter :authenticate_entity!
     end
 
+    def authenticate_entity!
+      # Caution: entity should be a singular camel-cased name but could be pluralized or underscored.
+      self.method("authenticate_#{@@entity.name.singularize.underscore}!".to_sym).call
+    end
+
+
     # For this example, we are simply using token authentication
     # via parameters. However, anyone could use Rails's token
     # authentication features to get the token from a header.
-    def authenticate_user_from_token!
+    def authenticate_entity_from_token!
       # Set the authentication token params if not already present,
       # see http://stackoverflow.com/questions/11017348/rails-api-authentication-by-headers-token
-      if user_token = params[:user_token].blank? && request.headers["X-User-Token"]
-        params[:user_token] = user_token
+      params_token_name = "#{@@entity.name.singularize.underscore}_token".to_sym
+      params_email_name = "#{@@entity.name.singularize.underscore}_email".to_sym
+      header_token_name = "X-#{@@entity.name.singularize.camelize}-Token"
+      header_email_name = "X-#{@@entity.name.singularize.camelize}-Email"
+      if token = params[params_token_name].blank? && request.headers[header_token_name]
+        params[params_token_name] = token
       end
-      if user_email = params[:user_email].blank? && request.headers["X-User-Email"]
-        params[:user_email] = user_email
+      if email = params[params_email_name].blank? && request.headers[header_email_name]
+        params[params_email_name] = email
       end
 
-      user_email = params[:user_email].presence
+      email = params[params_email_name].presence
       # See https://github.com/ryanb/cancan/blob/1.6.10/lib/cancan/controller_resource.rb#L108-L111
-      if User.respond_to? "find_by"
-        user = user_email && User.find_by(email: user_email)
-      elsif User.respond_to? "find_by_email"
-        user = user_email && User.find_by_email(user_email)
+      entity = nil
+      if @@entity.respond_to? "find_by"
+        entity = email && @@entity.find_by(email: email)
+      elsif @@entity.respond_to? "find_by_email"
+        entity = email && @@entity.find_by_email(email)
       end
 
       # Notice how we use Devise.secure_compare to compare the token
       # in the database with the token given in the params, mitigating
       # timing attacks.
-      if user && Devise.secure_compare(user.authentication_token, params[:user_token])
-        # Notice we are passing store false, so the user is not
+      if entity && Devise.secure_compare(entity.authentication_token, params[params_token_name])
+        # Notice we are passing store false, so the entity is not
         # actually stored in the session and a token is needed
         # for every request. If you want the token to work as a
         # sign in token, you can simply remove store: false.
-        sign_in user, store: false
+        sign_in entity, store: false
       end
     end
+
+    def self.set_entity entity
+      @@entity = entity
+    end
   end
 
   module ActsAsTokenAuthenticationHandler
     extend ActiveSupport::Concern
 
     # I have insulated the methods into an additional module to avoid before_filters
-    # to be applied by the `included` block before acts_as_token_authentication_handler was called.
+    # to be applied by the `included` block before acts_as_token_authentication_handler_for was called.
     # See https://github.com/gonzalo-bulnes/simple_token_authentication/issues/8#issuecomment-31707201
 
     included do
@@ -59,9 +74,15 @@ module SimpleTokenAuthentication
     end
 
     module ClassMethods
-      def acts_as_token_authentication_handler(options = {})
+      def acts_as_token_authentication_handler_for(entity, options = {})
+        SimpleTokenAuthentication::ActsAsTokenAuthenticationHandlerMethods.set_entity entity
         include SimpleTokenAuthentication::ActsAsTokenAuthenticationHandlerMethods
       end
+
+      def acts_as_token_authentication_handler
+        ActiveSupport::Deprecation.warn "`acts_as_token_authentication_handler()` is deprecated and may be removed from future releases, use `acts_as_token_authentication_handler_for(User)` instead.", caller
+        acts_as_token_authentication_handler_for User
+      end
     end
   end
 end

data/lib/simple_token_authentication/version.rb

@@ -1,3 +1,3 @@
 module SimpleTokenAuthentication
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/dummy/config/initializers/devise.rb

@@ -4,7 +4,7 @@ Devise.setup do |config|
   # The secret key used by Devise. Devise uses this key to generate
   # random tokens. Changing this key will render invalid all existing
   # confirmation, reset password and unlock tokens in the database.
-  config.secret_key = 'a90b8d34ad3bb776d4bf0b590151727656f29456ceb4a0a9e2dd9d338379434258a727e9591282dd4c8259ec9ac7903b59bcb274cd916f5ea7ac241861b50a92'
+  config.secret_key = '67fdb5ef83612b1c364294f2650098154c98ab478e115e6cac5da51f57c2847e4c2ae4706be212db4a74f4947cb151b7d5ffb409b424799ccedf2a67b48ddeb6'
 
   # ==> Mailer Configuration
   # Configure the e-mail address which will be shown in Devise::Mailer,
@@ -95,7 +95,7 @@ Devise.setup do |config|
   config.stretches = Rails.env.test? ? 1 : 10
 
   # Setup a pepper to generate the encrypted password.
-  # config.pepper = '5f8af8bb9878af28f5dbeb36d06526de47194f1a365942a1f2e99cf4b4d3351257e3bdf946b2cffee0a368fb94975834bd0b9c3aa7f5ba1f90e9065fba97805a'
+  # config.pepper = '4a1413e8413a51d2dd28e92b9b0414ee0b6ecffc3dd3ce0dfe7b226805efe51d78e61e2121bea905ef76782159c8bec605915af0e25255946459747d3d5ea7bc'
 
   # ==> Configuration for :confirmable
   # A period that the user is allowed to access the website even without

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_token_authentication
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -170,8 +170,8 @@ files:
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
 - spec/dummy/db/seeds.rb
-- spec/dummy/db/migrate/20140126083111_add_authentication_token_to_users.rb
-- spec/dummy/db/migrate/20140126083109_devise_create_users.rb
+- spec/dummy/db/migrate/20140220080144_add_authentication_token_to_users.rb
+- spec/dummy/db/migrate/20140220080143_devise_create_users.rb
 - spec/dummy/log/test.log
 - spec/dummy/README.rdoc
 - spec/dummy/config/initializers/wrap_parameters.rb
@@ -237,8 +237,8 @@ test_files:
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
 - spec/dummy/db/seeds.rb
-- spec/dummy/db/migrate/20140126083111_add_authentication_token_to_users.rb
-- spec/dummy/db/migrate/20140126083109_devise_create_users.rb
+- spec/dummy/db/migrate/20140220080144_add_authentication_token_to_users.rb
+- spec/dummy/db/migrate/20140220080143_devise_create_users.rb
 - spec/dummy/log/test.log
 - spec/dummy/README.rdoc
 - spec/dummy/config/initializers/wrap_parameters.rb