simple_token_authentication 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aff7351e0178a92409d1092d897fba3190bf7931
-  data.tar.gz: 13cf3934848704cb786c32a88d2811ca957e2907
+  metadata.gz: 9f0598cbfab98dc89e4bd6a1ec862ef0c190b11e
+  data.tar.gz: 69e2239f4d6d51c230056f61051e6f1cc05a633f
 SHA512:
-  metadata.gz: 554b98719aee74a692f8bb5d80089f22ff1ce8ea85f2abdb3071b441a9decf87525d3e3f64aa24726e29f3fe0ed4b148352633ade88ffa0af8f49ede34003244
-  data.tar.gz: a15f550bac6dd2776aed33aebf543f8ee1806818817c6ed37fb8a965cb2ced54df1f618c6c3445cb6cb3e193341987c6bec1faa8291dfe95b0dd30ff98154fec
+  metadata.gz: c0eded2ae10fcb6bed035abb0f0c2715c7914aab698e51bf825e469dcb79e1f499088db73a30bb4ef722129a3ce80714ecf4ceac083face887df7514011d7802
+  data.tar.gz: c6ac775ebb4f855edb1799463af719bbf885de8ca7c2f2e8cad1e76a10ffba3f23f106a1c0dfddd87ca31f479efdf9de48e382c2d61394b686bd7210007ccd1d

data/lib/simple_token_authentication.rb

@@ -11,7 +11,7 @@ module SimpleTokenAuthentication
 
   def self.ensure_models_can_act_as_token_authenticatables model_adapters
     model_adapters.each do |model_adapter|
-      model_adapter.base_class.send :extend, SimpleTokenAuthentication::ActsAsTokenAuthenticatable
+      model_adapter.base_class.send :include, SimpleTokenAuthentication::ActsAsTokenAuthenticatable
     end
   end
 

data/lib/simple_token_authentication/acts_as_token_authenticatable.rb

@@ -1,14 +1,49 @@
-require 'simple_token_authentication/token_authenticatable'
+require 'active_support/concern'
+require 'simple_token_authentication/token_generator'
 
 module SimpleTokenAuthentication
   module ActsAsTokenAuthenticatable
+    extend ::ActiveSupport::Concern
 
-    # This module ensures that no TokenAuthenticatable behaviour
-    # is added before the class actually `acts_as_token_authenticatable`.
+    # Please see https://gist.github.com/josevalim/fb706b1e933ef01e4fb6
+    # before editing this file, the discussion is very interesting.
 
-    def acts_as_token_authenticatable(options = {})
-      include SimpleTokenAuthentication::TokenAuthenticatable
-      before_save :ensure_authentication_token
+    included do
+      private :generate_authentication_token
+      private :token_suitable?
+      private :token_generator
+    end
+
+    # Set an authentication token if missing
+    #
+    # Because it is intended to be used as a filter,
+    # this method is -and should be kept- idempotent.
+    def ensure_authentication_token
+      if authentication_token.blank?
+        self.authentication_token = generate_authentication_token(token_generator)
+      end
+    end
+
+    def generate_authentication_token(token_generator)
+      loop do
+        token = token_generator.generate_token
+        break token if token_suitable?(token)
+      end
+    end
+
+    def token_suitable?(token)
+      self.class.where(authentication_token: token).count == 0
+    end
+
+    # Private: Get one (always the same) object which behaves as a token generator
+    def token_generator
+      @token_generator ||= TokenGenerator.new
+    end
+
+    module ClassMethods
+      def acts_as_token_authenticatable(options = {})
+        before_save :ensure_authentication_token
+      end
     end
   end
 end

data/lib/simple_token_authentication/version.rb

@@ -1,3 +1,3 @@
 module SimpleTokenAuthentication
-  VERSION = "1.9.0"
+  VERSION = "1.9.1"
 end

data/spec/lib/simple_token_authentication/acts_as_token_authenticatable_spec.rb

@@ -15,22 +15,14 @@ describe DummyTokenGenerator do
   it_behaves_like 'a token generator'
 end
 
-describe 'Any class which extends SimpleTokenAuthentication::ActsAsTokenAuthenticatable (or any if its children)' do
+describe 'A token authenticatable class (or one of its children)' do
 
   after(:each) do
     ensure_examples_independence
   end
 
   before(:each) do
-    define_test_subjects_for_extension_of(SimpleTokenAuthentication::ActsAsTokenAuthenticatable)
-  end
-
-  it 'doesn\'t behave like a token authenticatable', public: true do
-    stub_const('SimpleTokenAuthentication::TokenAuthenticatable', Module.new)
-
-    @subjects.each do |subject|
-      expect(subject).not_to be_include SimpleTokenAuthentication::TokenAuthenticatable
-    end
+    define_test_subjects_for_inclusion_of(SimpleTokenAuthentication::ActsAsTokenAuthenticatable)
   end
 
   it 'responds to :acts_as_token_authenticatable', public: true do
@@ -39,46 +31,113 @@ describe 'Any class which extends SimpleTokenAuthentication::ActsAsTokenAuthenti
     end
   end
 
-  context 'when it explicitely acts as a token authenticatable' do
+  describe 'which supports the :before_save hook' do
 
-    it 'behaves like a token authenticatable (1)', rspec_3_error: true, public: true do
-      stub_const('SimpleTokenAuthentication::TokenAuthenticatable', Module.new)
+    context 'when it acts as token authenticatable' do
+      it 'ensures its instances have an authentication token before being saved (1)', rspec_3_error: true, public: true do
+        some_class = @subjects.first
 
-      some_class = @subjects.first
-      allow(some_class).to receive(:before_save)
+        expect(some_class).to receive(:before_save).with(:ensure_authentication_token)
+        some_class.acts_as_token_authenticatable
+      end
 
-      some_class.acts_as_token_authenticatable
-      expect(some_class).to be_include SimpleTokenAuthentication::TokenAuthenticatable
-    end
+      it 'ensures its instances have an authentication token before being saved (2)', rspec_3_error: true, public: true do
+        some_child_class = @subjects.last
 
-    it 'behaves like a token authenticatable (2)', rspec_3_error: true, public: true do
-      stub_const('SimpleTokenAuthentication::TokenAuthenticatable', Module.new)
+        expect(some_child_class).to receive(:before_save).with(:ensure_authentication_token)
+        some_child_class.acts_as_token_authenticatable
+      end
+    end
+  end
 
-      some_child_class = @subjects.last
-      allow(some_child_class).to receive(:before_save)
+  describe 'instance' do
 
-      some_child_class.acts_as_token_authenticatable
-      expect(some_child_class).to be_include SimpleTokenAuthentication::TokenAuthenticatable
+    it 'responds to :ensure_authentication_token', protected: true do
+      @subjects.map!{ |subject| subject.new }
+      @subjects.each do |subject|
+        expect(subject).to respond_to :ensure_authentication_token
+      end
     end
-  end
 
-  describe '.acts_as_token_authenticatable' do
+    context 'when some authentication tokens are already in use' do
 
-    context 'when the class supports the :before_save hook' do
+      before(:each) do
+        TOKENS_IN_USE = ['ExampleTok3n', '4notherTokeN']
 
-      it 'ensures its instances have an authentication token before being saved (1)', rspec_3_error: true, public: true do
-        some_class = @subjects.first
+        @subjects.each do |k|
+          k.class_eval do
 
-        expect(some_class).to receive(:before_save).with(:ensure_authentication_token)
-        some_class.acts_as_token_authenticatable
+            def initialize(args={})
+              @authentication_token = args[:authentication_token]
+              @token_generator = DummyTokenGenerator.new(
+                  tokens_to_be_generated: TOKENS_IN_USE + ['Dist1nCt-Tok3N'])
+            end
+
+            def authentication_token=(value)
+              @authentication_token = value
+            end
+
+            def authentication_token
+              @authentication_token
+            end
+
+            # the 'ExampleTok3n' is already in use
+            def token_suitable?(token)
+              not TOKENS_IN_USE.include? token
+            end
+
+            def token_generator
+              @token_generator
+            end
+          end
+        end
+        @subjects.map!{ |subject| subject.new }
       end
 
-      it 'ensures its instances have an authentication token before being saved (2)', rspec_3_error: true, public: true do
-        some_child_class = @subjects.last
+      it 'ensures its authentication token is unique', public: true do
+        @subjects.each do |subject|
+          subject.ensure_authentication_token
 
-        expect(some_child_class).to receive(:before_save).with(:ensure_authentication_token)
-        some_child_class.acts_as_token_authenticatable
+          expect(subject.authentication_token).not_to eq 'ExampleTok3n'
+          expect(subject.authentication_token).not_to eq '4notherTokeN'
+          expect(subject.authentication_token).to eq 'Dist1nCt-Tok3N'
+        end
       end
     end
   end
 end
+
+describe 'A class which includes a module which includes ActsAsTokenAuthenticatable and ActiveSupport::Concern (a.k.a Adapters::MongoidAdapter)' do
+
+  before(:each) do
+    base_module = Module.new do
+      extend ActiveSupport::Concern
+      include SimpleTokenAuthentication::ActsAsTokenAuthenticatable
+    end
+    stub_const('BaseModule', base_module)
+
+    @subject = Class.new do
+      include BaseModule
+    end
+  end
+
+  it 'responds to :acts_as_token_authenticatable', protected: true do
+    expect(@subject).to respond_to :acts_as_token_authenticatable
+  end
+end
+
+describe 'A class that inherits from a class which includes ActsAsTokenAuthenticatable (a.k.a Adapters::ActiveRecordAdapter)' do
+
+  before(:each) do
+    base_class = Class.new do
+      include SimpleTokenAuthentication::ActsAsTokenAuthenticatable
+    end
+    stub_const('BaseClass', base_class)
+
+    @subject = Class.new(BaseClass)
+  end
+
+  it 'responds to :acts_as_token_authenticatable', protected: true do
+    expect(@subject).to respond_to :acts_as_token_authenticatable
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_token_authentication
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -156,7 +156,6 @@ files:
 - lib/simple_token_authentication/entity.rb
 - lib/simple_token_authentication/fallback_authentication_handler.rb
 - lib/simple_token_authentication/sign_in_handler.rb
-- lib/simple_token_authentication/token_authenticatable.rb
 - lib/simple_token_authentication/token_authentication_handler.rb
 - lib/simple_token_authentication/token_comparator.rb
 - lib/simple_token_authentication/token_generator.rb
@@ -179,7 +178,6 @@ files:
 - 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_authenticatable_spec.rb
 - spec/lib/simple_token_authentication/token_authentication_handler_spec.rb
 - spec/lib/simple_token_authentication/token_comparator_spec.rb
 - spec/lib/simple_token_authentication/token_generator_spec.rb
@@ -191,7 +189,6 @@ files:
 - spec/support/spec_for_configuration_option_interface.rb
 - spec/support/spec_for_entities_manager_interface.rb
 - spec/support/spec_for_sign_in_handler_interface.rb
-- spec/support/spec_for_token_authenticatable_interface.rb
 - spec/support/spec_for_token_comparator_interface.rb
 - spec/support/spec_for_token_generator_interface.rb
 - spec/support/specs_for_token_authentication_handler_interface.rb
@@ -229,7 +226,6 @@ test_files:
 - spec/lib/simple_token_authentication/token_generator_spec.rb
 - 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_authenticatable_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
@@ -247,7 +243,6 @@ test_files:
 - spec/support/spec_for_authentication_handler_interface.rb
 - spec/support/spec_for_entities_manager_interface.rb
 - spec/support/spec_for_adapter.rb
-- spec/support/spec_for_token_authenticatable_interface.rb
 - spec/support/specs_for_token_authentication_handler_interface.rb
 - spec/support/spec_for_token_comparator_interface.rb
 - spec/support/spec_for_configuration_option_interface.rb

data/lib/simple_token_authentication/token_authenticatable.rb

@@ -1,43 +0,0 @@
-require 'active_support/concern'
-require 'simple_token_authentication/token_generator'
-
-module SimpleTokenAuthentication
-  module TokenAuthenticatable
-    extend ::ActiveSupport::Concern
-
-    # Please see https://gist.github.com/josevalim/fb706b1e933ef01e4fb6
-    # before editing this file, the discussion is very interesting.
-
-    included do
-      private :generate_authentication_token
-      private :token_suitable?
-      private :token_generator
-    end
-
-    # Set an authentication token if missing
-    #
-    # Because it is intended to be used as a filter,
-    # this method is -and should be kept- idempotent.
-    def ensure_authentication_token
-      if authentication_token.blank?
-        self.authentication_token = generate_authentication_token(token_generator)
-      end
-    end
-
-    def generate_authentication_token(token_generator)
-      loop do
-        token = token_generator.generate_token
-        break token if token_suitable?(token)
-      end
-    end
-
-    def token_suitable?(token)
-      self.class.where(authentication_token: token).count == 0
-    end
-
-    # Private: Get one (always the same) object which behaves as a token generator
-    def token_generator
-      @token_generator ||= TokenGenerator.new
-    end
-  end
-end

data/spec/lib/simple_token_authentication/token_authenticatable_spec.rb

@@ -1,68 +0,0 @@
-require 'spec_helper'
-
-class DummyTokenGenerator
-  def initialize(args={})
-    @tokens_to_be_generated = args[:tokens_to_be_generated]
-  end
-
-  def generate_token
-    @tokens_to_be_generated.shift
-  end
-end
-
-describe DummyTokenGenerator do
-  it_behaves_like 'a token generator'
-end
-
-describe 'Any instance of a class which includes SimpleTokenAuthentication::TokenAuthenticatable' do
-
-  let(:described_class) do
-    define_dummy_class_which_includes SimpleTokenAuthentication::TokenAuthenticatable
-  end
-
-  after(:each) do
-    # ensure_examples_independence
-    SimpleTokenAuthentication.send(:remove_const, :SomeClass)
-  end
-
-  it_behaves_like 'a token authenticatable'
-
-  let(:subject) { described_class.new() }
-
-  describe '#ensure_authentication_token' do
-
-    context 'when some authentication tokens are already in use' do
-
-      before(:each) do
-        TOKENS_IN_USE = ['ExampleTok3n', '4notherTokeN']
-
-        subject.instance_eval do
-
-          @token_generator = DummyTokenGenerator.new(
-            tokens_to_be_generated: TOKENS_IN_USE + ['Dist1nCt-Tok3N'])
-
-          def authentication_token=(value)
-            @authentication_token = value
-          end
-
-          def authentication_token
-            @authentication_token
-          end
-
-          # the 'ExampleTok3n' is already in use
-          def token_suitable?(token)
-            not TOKENS_IN_USE.include? token
-          end
-        end
-      end
-
-      it 'ensures its authentication token is unique', public: true do
-        subject.ensure_authentication_token
-
-        expect(subject.authentication_token).not_to eq 'ExampleTok3n'
-        expect(subject.authentication_token).not_to eq '4notherTokeN'
-        expect(subject.authentication_token).to eq 'Dist1nCt-Tok3N'
-      end
-    end
-  end
-end

data/spec/support/spec_for_token_authenticatable_interface.rb

@@ -1,8 +0,0 @@
-RSpec.shared_examples 'a token authenticatable' do
-
-  let(:token_authenticatable) { described_class.new() }
-
-  it 'responds to :ensure_authentication_token', private: true do
-    expect(token_authenticatable).to respond_to :ensure_authentication_token
-  end
-end