simple_token_authentication 1.5.1 → 1.5.2

data/spec/lib/simple_token_authentication/token_comparator_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SimpleTokenAuthentication::TokenComparator do
+
+  it_behaves_like 'a token comparator'
+
+  it 'delegates token comparison to Devise.secure_compare', private: true do
+    devise = double()
+    allow(devise).to receive(:secure_compare).and_return('Devise.secure_compare response.')
+    stub_const('Devise', devise)
+
+    # delegating consists in sending the message
+    expect(Devise).to receive(:secure_compare)
+    response = subject.compare('A_raNd0MtoKeN', 'ano4heR-Tok3n')
+
+    # and returning the response
+    expect(response).to eq 'Devise.secure_compare response.'
+  end
+end

data/spec/lib/simple_token_authentication/token_generator_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SimpleTokenAuthentication::TokenGenerator do
+
+  it_behaves_like 'a token generator'
+
+  it 'delegates token generation to Devise.friendly_token', private: true do
+    devise = double()
+    allow(devise).to receive(:friendly_token).and_return('FRi3ndlY_TokeN')
+    stub_const('Devise', devise)
+
+    # delegating consists in sending the message
+    expect(Devise).to receive(:friendly_token)
+    response = subject.generate_token
+
+    # and returning the response
+    expect(response).to eq 'FRi3ndlY_TokeN'
+  end
+end

data/spec/lib/simple_token_authentication_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe SimpleTokenAuthentication do
+
+  it 'responds to :ensure_models_can_act_as_token_authenticatables', private: true do
+    expect(subject).to respond_to :ensure_models_can_act_as_token_authenticatables
+  end
+
+  it 'responds to :ensure_controllers_can_act_as_token_authentication_handlers', private: true do
+    expect(subject).to respond_to :ensure_controllers_can_act_as_token_authentication_handlers
+  end
+
+  context 'when ActiveRecord is available' do
+
+    before(:each) do
+      stub_const('ActiveRecord', Module.new)
+      stub_const('ActiveRecord::Base', Class.new)
+
+      # define a dummy ActiveRecord adapter
+      dummy_active_record_adapter = double()
+      allow(dummy_active_record_adapter).to receive(:base_class).and_return(ActiveRecord::Base)
+      stub_const('SimpleTokenAuthentication::Adapters::DummyActiveRecordAdapter',
+                                                       dummy_active_record_adapter)
+    end
+
+    describe '#ensure_models_can_act_as_token_authenticatables' do
+
+      before(:each) do
+        class SimpleTokenAuthentication::DummyModel < ActiveRecord::Base; end
+        @dummy_model = SimpleTokenAuthentication::DummyModel
+
+        expect(@dummy_model.new).to be_instance_of SimpleTokenAuthentication::DummyModel
+        expect(@dummy_model.new).to be_kind_of ActiveRecord::Base
+      end
+
+      after(:each) do
+        SimpleTokenAuthentication.send(:remove_const, :DummyModel)
+      end
+
+      it 'allows any kind of ActiveRecord::Base 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::DummyActiveRecordAdapter]
+
+        expect(@dummy_model).to respond_to :acts_as_token_authenticatable
+      end
+    end
+  end
+
+  context 'when ActionController::Base is available' do
+
+    before(:each) do
+      stub_const('ActionController::Base', Class.new)
+
+      # define a dummy ActionController::Base (a.k.a 'Rails') adapter
+      dummy_rails_adapter = double()
+      allow(dummy_rails_adapter).to receive(:base_class).and_return(ActionController::Base)
+      stub_const('SimpleTokenAuthentication::Adapters::DummyRailsAdapter', dummy_rails_adapter)
+    end
+
+    describe '#ensure_controllers_can_act_as_token_authentication_handlers' do
+
+      before(:each) do
+        class SimpleTokenAuthentication::DummyController < ActionController::Base; end
+        @dummy_controller = SimpleTokenAuthentication::DummyController
+
+        expect(@dummy_controller.new).to be_instance_of SimpleTokenAuthentication::DummyController
+        expect(@dummy_controller.new).to be_kind_of ActionController::Base
+      end
+
+      after(:each) do
+        SimpleTokenAuthentication.send(:remove_const, :DummyController)
+      end
+
+      it 'allows any kind of ActionController::Base to acts as token authentication handler', private: true do
+        expect(@dummy_controller).not_to respond_to :acts_as_token_authentication_handler_for
+
+        subject.ensure_controllers_can_act_as_token_authentication_handlers [
+                          SimpleTokenAuthentication::Adapters::DummyRailsAdapter]
+
+        expect(@dummy_controller).to respond_to :acts_as_token_authentication_handler_for
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'action_controller'
+require 'active_support'
+
+require 'simple_token_authentication'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f; puts f }
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

data/spec/support/dummy_classes_helper.rb

@@ -0,0 +1,80 @@
+# Create dummy classes to test modules with RSpec
+#
+# Usage:
+#
+#    describe SimpleTokenAuthentication::ModuleUnderTest do
+#
+#      after(:each) do
+#        ensure_examples_independence
+#      end
+#
+#      before(:each) do
+#        define_test_subjects_for_inclusion_of(SimpleTokenAuthentication::ModuleUnderTest)
+#      end
+#
+#      # spec examples...
+#
+#    end
+##
+
+
+# Returns a dummy class which includes the module under test.
+def define_dummy_class_which_includes(module_under_test)
+  unless defined? SimpleTokenAuthentication::SomeClass
+    SimpleTokenAuthentication.const_set(:SomeClass, Class.new)
+  end
+  SimpleTokenAuthentication::SomeClass.send :include, module_under_test
+  SimpleTokenAuthentication::SomeClass
+end
+
+# Returns a dummy class which extends the module under test.
+def define_dummy_class_which_extends(module_under_test)
+  unless defined? SimpleTokenAuthentication::SomeClass
+    SimpleTokenAuthentication.const_set(:SomeClass, Class.new)
+  end
+  SimpleTokenAuthentication::SomeClass.send :extend, module_under_test
+  SimpleTokenAuthentication::SomeClass
+end
+
+# Returns a dummy class which inherits from parent_class.
+def define_dummy_class_child_of(parent_class)
+  unless defined? SimpleTokenAuthentication::SomeChildClass
+    SimpleTokenAuthentication.const_set(:SomeChildClass, Class.new(parent_class))
+  end
+  SimpleTokenAuthentication::SomeChildClass
+end
+
+def ensure_examples_independence
+  SimpleTokenAuthentication.send(:remove_const, :SomeClass)
+  SimpleTokenAuthentication.send(:remove_const, :SomeChildClass)
+end
+
+# Must be used in coordination with ensure_examples_independence
+def define_test_subjects_for_inclusion_of(module_under_test)
+  klass       = define_dummy_class_which_includes(module_under_test)
+  child_klass = define_dummy_class_child_of(klass)
+
+  # all specs must apply to classes which include the module and their children
+  @subjects   = [klass, child_klass]
+end
+
+# Must be used in coordination with ensure_examples_independence
+def define_test_subjects_for_extension_of(module_under_test)
+  klass       = define_dummy_class_which_extends(module_under_test)
+  child_klass = define_dummy_class_child_of(klass)
+
+  # all specs must apply to classes which extend the module and their children
+  @subjects   = [klass, child_klass]
+end
+
+def double_user_model
+  user = double()
+  stub_const('User', user)
+  allow(user).to receive(:name).and_return('User')
+end
+
+def double_super_admin_model
+  super_admin = double()
+  stub_const('SuperAdmin', super_admin)
+  allow(super_admin).to receive(:name).and_return('SuperAdmin')
+end

data/spec/support/spec_for_adapter.rb

@@ -0,0 +1,6 @@
+RSpec.shared_examples 'an adapter' do
+
+  it 'responds to :base_class', public: true do
+    expect(@subject).to respond_to :base_class
+  end
+end

data/spec/support/spec_for_authentication_handler_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'an authentication handler' do
+
+  let(:authentication_handler) { described_class.new() }
+
+  it 'responds to :authenticate_entity!', private: true do
+    expect(authentication_handler).to respond_to :authenticate_entity!
+  end
+end

data/spec/support/spec_for_configuration_option_interface.rb

@@ -0,0 +1,28 @@
+RSpec.shared_examples 'a configuration option' do |option_name|
+
+  before(:each) do
+    @get_option = option_name.to_sym        # e.g. :sign_in_token
+    @set_option = option_name.+('=').to_sym # e.g. :sign_in_token=
+  end
+
+  it 'is accessible', private: true do
+    expect(@subject).to respond_to @get_option
+    expect(@subject).to respond_to @set_option
+  end
+
+  context 'once set' do
+
+    before(:each) do
+      @_original_value = @subject.send @get_option
+      @subject.send @set_option, 'custom header'
+    end
+
+    after(:each) do
+      @subject.send @set_option, @_original_value
+    end
+
+    it 'can be retrieved', private: true do
+      expect(@subject.send @get_option).to eq 'custom header'
+    end
+  end
+end

data/spec/support/spec_for_entities_manager_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'an entities manager' do
+
+  let(:entities_manager) { described_class.new() }
+
+  it 'responds to :find_or_create_entity', private: true do
+    expect(entities_manager).to respond_to :find_or_create_entity
+  end
+end

data/spec/support/spec_for_sign_in_handler_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'a sign in handler' do
+
+  let(:sign_in_hanlder) { described_class.new() }
+
+  it 'responds to :sign_in', private: true do
+    expect(sign_in_hanlder).to respond_to :sign_in
+  end
+end

data/spec/support/spec_for_token_comparator_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'a token comparator' do
+
+  let(:token_comparator) { described_class.new() }
+
+  it 'responds to :compare', public: true do
+    expect(token_comparator).to respond_to :compare
+  end
+end

data/spec/support/spec_for_token_generator_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'a token generator' do
+
+  let(:token_generator) { described_class.new() }
+
+  it 'responds to :generate_token', public: true do
+    expect(token_generator).to respond_to :generate_token
+  end
+end

data/spec/support/specs_for_token_authentication_handler_interface.rb

@@ -0,0 +1,8 @@
+RSpec.shared_examples 'a token authentication handler' do
+
+  let(:token_authentication_handler) { described_class }
+
+  it 'responds to :handle_token_authentication_for', private: true do
+    expect(token_authentication_handler).to respond_to :handle_token_authentication_for
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_token_authentication
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -65,89 +65,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: factory_girl_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: cucumber-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 description: 
 email:
 - gon.bulnes@gmail.com
@@ -158,44 +102,51 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- doc/README.md
 - lib/simple_token_authentication.rb
 - lib/simple_token_authentication/acts_as_token_authenticatable.rb
 - 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/rails_adapter.rb
 - lib/simple_token_authentication/configuration.rb
+- lib/simple_token_authentication/entities_manager.rb
+- 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_authentication_handler.rb
+- lib/simple_token_authentication/token_comparator.rb
+- lib/simple_token_authentication/token_generator.rb
 - lib/simple_token_authentication/version.rb
-- lib/tasks/cucumber.rake
 - lib/tasks/simple_token_authentication_tasks.rake
-- spec/dummy/README.rdoc
-- spec/dummy/Rakefile
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
+- spec/configuration/action_controller_callbacks_options_spec.rb
+- spec/configuration/fallback_to_devise_option_spec.rb
+- spec/configuration/header_names_option_spec.rb
+- spec/configuration/sign_in_token_option_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/adapter_spec.rb
+- spec/lib/simple_token_authentication/adapters/active_record_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/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
+- spec/lib/simple_token_authentication/token_comparator_spec.rb
+- spec/lib/simple_token_authentication/token_generator_spec.rb
+- spec/lib/simple_token_authentication_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_classes_helper.rb
+- spec/support/spec_for_adapter.rb
+- spec/support/spec_for_authentication_handler_interface.rb
+- 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_comparator_interface.rb
+- spec/support/spec_for_token_generator_interface.rb
+- spec/support/specs_for_token_authentication_handler_interface.rb
 homepage: https://github.com/gonzalo-bulnes/simple_token_authentication
 licenses:
 - GPLv3
@@ -216,40 +167,37 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Simple (but safe) token authentication for Rails apps or API with Devise.
 test_files:
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config.ru
-- spec/dummy/public/500.html
-- spec/dummy/public/422.html
-- spec/dummy/public/404.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/README.rdoc
-- spec/dummy/bin/rake
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/Rakefile
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/boot.rb
-- spec/dummy/config/routes.rb
-- spec/dummy/config/application.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
+- spec/lib/simple_token_authentication_spec.rb
+- spec/lib/simple_token_authentication/entities_manager_spec.rb
+- spec/lib/simple_token_authentication/sign_in_handler_spec.rb
+- spec/lib/simple_token_authentication/fallback_authentication_handler_spec.rb
+- spec/lib/simple_token_authentication/token_comparator_spec.rb
+- spec/lib/simple_token_authentication/configuration_spec.rb
+- 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_authentication_handler_spec.rb
+- spec/lib/simple_token_authentication/adapters/active_record_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
+- spec/configuration/action_controller_callbacks_options_spec.rb
+- spec/configuration/header_names_option_spec.rb
+- spec/configuration/fallback_to_devise_option_spec.rb
+- spec/configuration/sign_in_token_option_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_for_authentication_handler_interface.rb
+- spec/support/spec_for_entities_manager_interface.rb
+- spec/support/spec_for_adapter.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
+- spec/support/spec_for_sign_in_handler_interface.rb
+- spec/support/dummy_classes_helper.rb
+- spec/support/spec_for_token_generator_interface.rb
 has_rdoc: