simple_token_authentication 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e7a77a49ad9d0cecdf975b21c733087091a4671
-  data.tar.gz: 6ea3dea47399dc595603ebbe97bc859417bfe775
+  metadata.gz: a858d56cf65a5595155ab5b4e593d90c8c52e4b3
+  data.tar.gz: 48005f8c531276fe56de66bb371ad76ae61cd334
 SHA512:
-  metadata.gz: c8f34f63afbf988faccb9d952740ef54283846e1d9163d937323102e793948bed2567fd0cacca4c311cb6243d97b42223874045fad0f39b611d3e7bf29e889eb
-  data.tar.gz: 9409b4492ef48a1ceb2f3c4ed00a509e37cf0b9de0338486474fb5101c4eccb685eb09017d0a215944c6cafe453eeea9bb4bde06e1ec9bae5cc5f834437abdf0
+  metadata.gz: 21405a3b9a7b2728a7de067aa21aac10ab17217c1946bf4b2c980406a56e0af9b815e4f28cfe7f9136ebbfe8890e611d932ef0193a7e110dc296ce4731ff6e0a
+  data.tar.gz: baf60814272483318583370c68e9f21583c81929a4e5c3506cf58c609afe526e2581eaab68c21e3b8975c6928ea3cc1468ec6e03c103037503ac4d12469faaf7

data/README.md

@@ -32,6 +32,10 @@ Install [Devise][devise] with any modules you want, then add the gem to your `Ge
 gem 'simple_token_authentication'
 ```
 
+### Make models token authenticatable
+
+#### ActiveRecord
+
 First define which model or models will be token authenticatable (typ. `User`):
 
 ```ruby
@@ -61,7 +65,31 @@ 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:
+#### Mongoid
+
+Define which model or models will be token authenticatable (typ. `User`):
+
+```ruby
+# app/models/user.rb
+
+class User
+  include Mongoid::Document
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+
+  ## Token Authenticatable
+  acts_as_token_authenticatable
+  field :authentication_token
+
+  # ...
+end
+```
+
+### Allow controllers to handle token authentication
+
+Finally define which controllers will handle token authentication (typ. `ApplicationController`) for which _token authenticatable_ models:
 
 ```ruby
 # app/controllers/application_controller.rb

data/lib/simple_token_authentication.rb

@@ -5,6 +5,8 @@ require 'simple_token_authentication/configuration'
 module SimpleTokenAuthentication
   extend Configuration
 
+  NoAdapterAvailableError = Class.new(LoadError)
+
   private
 
   def self.ensure_models_can_act_as_token_authenticatables model_adapters
@@ -30,12 +32,18 @@ module SimpleTokenAuthentication
   #
   # Returns an Array of available adapters
   def self.load_available_adapters adapters_short_names
-    adapters_short_names.collect do |short_name|
+    available_adapters = adapters_short_names.collect do |short_name|
       adapter_name = "simple_token_authentication/adapters/#{short_name}_adapter"
-      if require adapter_name
+      if const_defined?(short_name.camelize) && require(adapter_name)
         adapter_name.camelize.constantize
       end
     end
+    available_adapters.compact!
+
+    # stop here if no constants are defined or no adequate adapters are present
+    raise SimpleTokenAuthentication::NoAdapterAvailableError if available_adapters.empty?
+
+    available_adapters
   end
 
   available_model_adapters = load_available_adapters SimpleTokenAuthentication.model_adapters

data/lib/simple_token_authentication/acts_as_token_authenticatable.rb

@@ -28,7 +28,7 @@ module SimpleTokenAuthentication
     end
 
     def token_suitable?(token)
-      not self.class.exists?(authentication_token: token)
+      self.class.where(authentication_token: token).count == 0
     end
 
     def token_generator

data/lib/simple_token_authentication/adapters/mongoid_adapter.rb

@@ -0,0 +1,14 @@
+require 'mongoid'
+require 'simple_token_authentication/adapter'
+
+module SimpleTokenAuthentication
+  module Adapters
+    class MongoidAdapter
+      extend SimpleTokenAuthentication::Adapter
+
+      def self.base_class
+        ::Mongoid::Document
+      end
+    end
+  end
+end

data/lib/simple_token_authentication/configuration.rb

@@ -12,7 +12,7 @@ module SimpleTokenAuthentication
     @@header_names = {}
     @@sign_in_token = false
     @@controller_adapters = ['rails']
-    @@model_adapters = ['active_record']
+    @@model_adapters = ['active_record', 'mongoid']
 
     # Allow the default configuration to be overwritten from initializers
     def configure

data/lib/simple_token_authentication/token_authentication_handler.rb

@@ -4,7 +4,6 @@ require 'active_support/concern'
 require 'simple_token_authentication/entities_manager'
 require 'simple_token_authentication/fallback_authentication_handler'
 require 'simple_token_authentication/sign_in_handler'
-require 'simple_token_authentication/token_authentication_handler'
 require 'simple_token_authentication/token_comparator'
 
 module SimpleTokenAuthentication
@@ -23,11 +22,6 @@ module SimpleTokenAuthentication
       private :token_comparator
       private :sign_in_handler
       private :find_record_from_identifier
-
-      # This is necessary to test which arguments were passed to sign_in
-      # from authenticate_entity_from_token!
-      # See https://github.com/gonzalo-bulnes/simple_token_authentication/pull/32
-      ::ActionController::Base.send :include, Devise::Controllers::SignInOut if Rails.env.test?
     end
 
     def authenticate_entity_from_token!(entity)
@@ -61,11 +55,7 @@ module SimpleTokenAuthentication
       # Rails 3 and 4 finder methods are supported,
       # see https://github.com/ryanb/cancan/blob/1.6.10/lib/cancan/controller_resource.rb#L108-L111
       record = nil
-      if entity.model.respond_to? "find_by"
-        record = email && entity.model.find_by(email: email)
-      elsif entity.model.respond_to? "find_by_email"
-        record = email && entity.model.find_by_email(email)
-      end
+      record = email && entity.model.where(email: email).first
     end
 
     def token_comparator
@@ -113,13 +103,13 @@ module SimpleTokenAuthentication
 
         class_eval do
           define_method method_name.to_sym do
-            lambda { |entity| authenticate_entity_from_token!(entity) }.call(entity)
+            lambda { |_entity| authenticate_entity_from_token!(_entity) }.call(entity)
           end
 
           define_method method_name_bang.to_sym do
-            lambda do |entity|
-              authenticate_entity_from_token!(entity)
-              authenticate_entity_from_fallback!(entity, fallback_authentication_handler)
+            lambda do |_entity|
+              authenticate_entity_from_token!(_entity)
+              authenticate_entity_from_fallback!(_entity, fallback_authentication_handler)
             end.call(entity)
           end
         end

data/lib/simple_token_authentication/version.rb

@@ -1,3 +1,3 @@
 module SimpleTokenAuthentication
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/spec/configuration/header_names_option_spec.rb

@@ -18,14 +18,14 @@ describe 'Simple Token Authentication' do
         # given one *c*orrect record (which is supposed to get signed in)
         @charles_record = double()
         [user, admin].each do |model|
-          allow(model).to receive(:find_by).with(email: 'charles@example.com').and_return(@charles_record)
+          allow(model).to receive(:where).with(email: 'charles@example.com').and_return([@charles_record])
         end
         allow(@charles_record).to receive(:authentication_token).and_return('ch4rlEs_toKeN')
 
         # and one *w*rong record (which should not be signed in)
         @waldo_record = double()
         [user, admin].each do |model|
-          allow(model).to receive(:find_by).with(email: 'waldo@example.com').and_return(@waldo_record)
+          allow(model).to receive(:where).with(email: 'waldo@example.com').and_return([@waldo_record])
         end
         allow(@waldo_record).to receive(:authentication_token).and_return('w4LdO_toKeN')
 
@@ -394,12 +394,12 @@ describe 'Simple Token Authentication' do
 
       # given one *c*orrect record (which is supposed to get signed in)
       @charles_record = double()
-      allow(user).to receive(:find_by).with(email: 'charles@example.com').and_return(@charles_record)
+      allow(user).to receive(:where).with(email: 'charles@example.com').and_return([@charles_record])
       allow(@charles_record).to receive(:authentication_token).and_return('ch4rlEs_toKeN')
 
       # and one *w*rong record (which should not be signed in)
       @waldo_record = double()
-      allow(user).to receive(:find_by).with(email: 'waldo@example.com').and_return(@waldo_record)
+      allow(user).to receive(:where).with(email: 'waldo@example.com').and_return([@waldo_record])
       allow(@waldo_record).to receive(:authentication_token).and_return('w4LdO_toKeN')
 
       # given a controller class which acts as token authentication handler

data/spec/lib/simple_token_authentication/adapter_spec.rb

@@ -10,8 +10,6 @@ describe 'Any class which extends SimpleTokenAuthentication::Adapter' do
     @subject = define_dummy_class_which_extends(SimpleTokenAuthentication::Adapter)
   end
 
-  it_behaves_like 'an adapter'
-
   describe '.base_class' do
 
     it 'raises an error if not overwritten', public: true do

data/spec/lib/simple_token_authentication/adapters/mongoid_adapter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'simple_token_authentication/adapters/mongoid_adapter'
+
+describe 'SimpleTokenAuthentication::Adapters::MongoidAdapter' do
+
+  before(:each) do
+    stub_const('Mongoid', Module.new)
+    stub_const('Mongoid::Document', double())
+
+    @subject = SimpleTokenAuthentication::Adapters::MongoidAdapter
+  end
+
+  it_behaves_like 'an adapter'
+
+  describe '.base_class' do
+
+    it 'is Mongoid::Document', private: true do
+      expect(@subject.base_class).to eq Mongoid::Document
+    end
+  end
+end

data/spec/lib/simple_token_authentication/configuration_spec.rb

@@ -29,8 +29,8 @@ describe SimpleTokenAuthentication::Configuration do
 
       it_behaves_like 'a configuration option', 'model_adapters'
 
-      it "defauts to ['active_record']", private: true do
-        expect(@subject.model_adapters).to eq ['active_record']
+      it "defauts to ['active_record', 'mongoid']", private: true do
+        expect(@subject.model_adapters).to eq ['active_record', 'mongoid']
       end
     end
 

data/spec/lib/simple_token_authentication/errors_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe SimpleTokenAuthentication::NoAdapterAvailableError do
+
+  it 'is a kind of LoadError', public: true do
+    expect(subject).to be_kind_of LoadError
+  end
+end

data/spec/lib/simple_token_authentication_spec.rb

@@ -48,6 +48,65 @@ describe SimpleTokenAuthentication do
     end
   end
 
+  context 'when Mongoid is available' do
+
+    before(:each) do
+      stub_const('Mongoid', Module.new)
+      stub_const('Mongoid::Document', Class.new)
+
+      # define a dummy Mongoid adapter
+      dummy_mongoid_adapter = double()
+      allow(dummy_mongoid_adapter).to receive(:base_class).and_return(Mongoid::Document)
+      stub_const('SimpleTokenAuthentication::Adapters::DummyMongoidAdapter',
+                                                       dummy_mongoid_adapter)
+    end
+
+    describe '#ensure_models_can_act_as_token_authenticatables' do
+
+      before(:each) do
+        class SimpleTokenAuthentication::DummyModel < Mongoid::Document; end
+        @dummy_model = SimpleTokenAuthentication::DummyModel
+
+        expect(@dummy_model.new).to be_instance_of SimpleTokenAuthentication::DummyModel
+        expect(@dummy_model.new).to be_kind_of Mongoid::Document
+      end
+
+      after(:each) do
+        SimpleTokenAuthentication.send(:remove_const, :DummyModel)
+      end
+
+      it 'allows any kind of Mongoid::Document to act as token authenticatable', private: true do
+        expect(@dummy_model).not_to respond_to :acts_as_token_authenticatable
+
+        subject.ensure_models_can_act_as_token_authenticatables [
+                SimpleTokenAuthentication::Adapters::DummyMongoidAdapter]
+
+        expect(@dummy_model).to respond_to :acts_as_token_authenticatable
+      end
+    end
+  end
+
+  context 'when no ORM, ODM or OxM is available' do
+
+    before(:each) do
+      stub_const('ActiveRecord', Module.new)
+      stub_const('Mongoid', Module.new)
+    end
+
+    describe '#load_available_adapters' do
+
+      it 'raises NoAdapterAvailableError', private: true do
+        allow(subject).to receive(:require).and_return(true)
+        hide_const('ActiveRecord')
+        hide_const('Mongoid')
+
+        expect do
+          subject.load_available_adapters SimpleTokenAuthentication.model_adapters
+        end.to raise_error SimpleTokenAuthentication::NoAdapterAvailableError
+      end
+    end
+  end
+
   context 'when ActionController::Base is available' do
 
     before(:each) do

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'action_controller'
+require 'active_record'
+require 'mongoid'
 require 'active_support'
 
 require 'simple_token_authentication'

data/spec/support/spec_for_adapter.rb

@@ -3,4 +3,8 @@ RSpec.shared_examples 'an adapter' do
   it 'responds to :base_class', public: true do
     expect(@subject).to respond_to :base_class
   end
+
+  it 'defines :base_class', public: true do
+    expect { @subject.base_class }.not_to raise_error
+  end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: simple_token_authentication
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -92,6 +92,46 @@ dependencies:
     - - "~>"
       - !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: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: 
 email:
 - gon.bulnes@gmail.com
@@ -108,6 +148,7 @@ files:
 - lib/simple_token_authentication/acts_as_token_authentication_handler.rb
 - lib/simple_token_authentication/adapter.rb
 - lib/simple_token_authentication/adapters/active_record_adapter.rb
+- lib/simple_token_authentication/adapters/mongoid_adapter.rb
 - lib/simple_token_authentication/adapters/rails_adapter.rb
 - lib/simple_token_authentication/configuration.rb
 - lib/simple_token_authentication/entities_manager.rb
@@ -127,10 +168,12 @@ files:
 - spec/lib/simple_token_authentication/acts_as_token_authentication_handler_spec.rb
 - spec/lib/simple_token_authentication/adapter_spec.rb
 - spec/lib/simple_token_authentication/adapters/active_record_adapter_spec.rb
+- spec/lib/simple_token_authentication/adapters/mongoid_adapter_spec.rb
 - spec/lib/simple_token_authentication/adapters/rails_adapter_spec.rb
 - spec/lib/simple_token_authentication/configuration_spec.rb
 - spec/lib/simple_token_authentication/entities_manager_spec.rb
 - spec/lib/simple_token_authentication/entity_spec.rb
+- spec/lib/simple_token_authentication/errors_spec.rb
 - spec/lib/simple_token_authentication/fallback_authentication_handler_spec.rb
 - spec/lib/simple_token_authentication/sign_in_handler_spec.rb
 - spec/lib/simple_token_authentication/token_authentication_handler_spec.rb
@@ -182,7 +225,9 @@ test_files:
 - spec/lib/simple_token_authentication/acts_as_token_authenticatable_spec.rb
 - spec/lib/simple_token_authentication/acts_as_token_authentication_handler_spec.rb
 - spec/lib/simple_token_authentication/token_authentication_handler_spec.rb
+- spec/lib/simple_token_authentication/errors_spec.rb
 - spec/lib/simple_token_authentication/adapters/active_record_adapter_spec.rb
+- spec/lib/simple_token_authentication/adapters/mongoid_adapter_spec.rb
 - spec/lib/simple_token_authentication/adapters/rails_adapter_spec.rb
 - spec/lib/simple_token_authentication/entity_spec.rb
 - spec/lib/simple_token_authentication/adapter_spec.rb