alchemy-devise 3.6.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 383eb175fee8f22646e7755d5b52268d84ca3f6d
-  data.tar.gz: 0b5364a90b915afbe4be679e7be1823fe3e4ae9b
+  metadata.gz: 6503112660ffd7d7987f2a803c79ada797984a0c
+  data.tar.gz: f89664312b98e5e867d62c75be62a81a04618c9e
 SHA512:
-  metadata.gz: 83ad020d5e6e3ce17b23dd3b125181f6afcac9fead208d4911e6a178e60fdee4efab5b5b31348e105b5dd30ac5bd1fcb69d814da2c4307e36202c7efbd427629
-  data.tar.gz: b799fb04fe909e7fe383afc20ff0cfd140931ffc046f7ff0a62d6c4b7983d57d9e6553ff9cc616229f662c48dcde453c4efed5db7b732e21872296dae8fd39d3
+  metadata.gz: dbbc12bd8232f6a085e53315c8090c0027a294e7f16642055ab1f0c6a42c4393f39ec3c69d83fdb6b180e19e1cec02d5257ec9d14c6a8b99100edd8a4235b2a2
+  data.tar.gz: fd765d3f74e772b8cfbe222fc3875d53dc65220d4db1baed2c506167a06c8c1820d5419d966d0cca2bf6947072be9062b507f8b59c88bd8ceb0ee8e24740512e

data/README.md

@@ -1,10 +1,8 @@
-## Devise based authentication for Alchemy 3.5
+## Devise based authentication for AlchemyCMS 4.0
 
-[![Build Status](https://secure.travis-ci.org/AlchemyCMS/alchemy-devise.svg?branch=master)](http://travis-ci.org/AlchemyCMS/alchemy-devise)
+[![Build Status](https://secure.travis-ci.org/AlchemyCMS/alchemy-devise.svg?branch=4.0-stable)](http://travis-ci.org/AlchemyCMS/alchemy-devise)
 
-[![Gem Version](https://badge.fury.io/rb/alchemy-devise.svg)](http://badge.fury.io/rb/alchemy-devise) [![Test Coverage](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/coverage.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/coverage) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/gpa.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise) [![security](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master.svg)](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master) [![Dependency Status](https://gemnasium.com/AlchemyCMS/alchemy-devise.svg)](https://gemnasium.com/AlchemyCMS/alchemy-devise)
-
-**CAUTION: This master branch is a development branch that can contain bugs. For productive environments you should use the [current Ruby gem version](https://rubygems.org/gems/alchemy-devise/versions/3.5.0), or the [latest stable branch (3.5-stable)](https://github.com/AlchemyCMS/alchemy-devise/tree/3.5-stable).**
+[![Gem Version](https://badge.fury.io/rb/alchemy-devise.svg)](http://badge.fury.io/rb/alchemy-devise) [![Test Coverage](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/coverage.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/coverage) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/gpa.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise) [![security](https://hakiri.io/github/AlchemyCMS/alchemy-devise/4.0-stable.svg)](https://hakiri.io/github/AlchemyCMS/alchemy-devise/4.0-stable) [![Dependency Status](https://gemnasium.com/AlchemyCMS/alchemy-devise.svg)](https://gemnasium.com/AlchemyCMS/alchemy-devise)
 
 AlchemyCMS has no authentication in its core. So it is possibly to bring your own authentication and use it to authorize users in AlchemyCMS. If you don't have your own authentication, you can use this gem.
 
@@ -14,11 +12,9 @@ Just put the gem into your projects `Gemfile`.
 
 ```ruby
 # Gemfile
-gem 'alchemy-devise', github: 'AlchemyCMS/alchemy-devise', branch: 'master'
+gem 'alchemy-devise', github: 'AlchemyCMS/alchemy-devise', branch: '4.0-stable'
 ```
 
-**NOTE:** You normally want to use a stable branch, like `3.5-stable`.
-
 and run `bundle install`.
 
 Then run the installer:
@@ -36,6 +32,34 @@ $ bundle update alchemy-devise
 $ bin/rails g alchemy:devise:install
 ```
 
+## Devise modules
+
+Default Devise modules included in `Alchemy::User` model
+
+- `:database_authenticatable`
+- `:trackable`
+- `:validatable`
+- `:timeoutable`
+- `:recoverable`
+
+If you want to add additional modules into the Alchemy user class append them to `Alchemy.devise_modules` in an initializer in your app.
+
+### Register additional modules example
+
+```ruby
+# config/initializers/alchemy.rb
+Alchemy.devise_modules << :registerable
+```
+
+### Using old encryption
+
+If your app uses an old encryption that needs the +devise-encryptable+ gem you also need to load the devise module.
+
+```ruby
+# config/initializers/alchemy.rb
+Alchemy.devise_modules << :encryptable
+```
+
 ## Testing
 
 If you want to contribute (and you should ^_^), you need to run the tests locally on your machine.

data/Rakefile

@@ -28,10 +28,16 @@ Bundler::GemHelper.install_tasks
 
 namespace :alchemy do
   namespace :spec do
-
     desc "Prepares database for testing Alchemy"
     task :prepare do
-      system 'cd spec/dummy && RAILS_ENV=test bundle exec rake db:migrate:reset && RAILS_ENV=test bundle exec rails g alchemy:devise:install --force && cd -'
+      system <<-BASH
+cd spec/dummy
+export RAILS_ENV=test
+bin/rake db:environment:set
+bin/rake db:migrate:reset
+bin/rails g alchemy:devise:install --force
+cd -
+BASH
     end
   end
 end

data/app/models/alchemy/user.rb

@@ -16,19 +16,8 @@ module Alchemy
       :send_credentials,
       :tag_list
     ]
-    DEVISE_MODULES = [
-      :database_authenticatable,
-      :trackable,
-      :validatable,
-      :timeoutable,
-      :recoverable
-    ]
-    # If the app uses an old encryption it uses the devise-encryptable gem
-    # therefore we have to load the devise module
-    if (::Devise::Models::Encryptable rescue false)
-      DEVISE_MODULES.push(:encryptable)
-    end
-    devise *DEVISE_MODULES
+
+    devise *Alchemy.devise_modules
 
     acts_as_taggable
     acts_as_tagger

data/db/migrate/20131015124700_create_alchemy_users.rb

@@ -1,4 +1,4 @@
-class CreateAlchemyUsers < ActiveRecord::Migration
+class CreateAlchemyUsers < ActiveRecord::Migration[4.2]
   def up
     return if table_exists?(:alchemy_users)
     create_table "alchemy_users" do |t|

data/db/migrate/20131225232042_add_alchemy_roles_to_alchemy_users.rb

@@ -1,4 +1,4 @@
-class AddAlchemyRolesToAlchemyUsers < ActiveRecord::Migration
+class AddAlchemyRolesToAlchemyUsers < ActiveRecord::Migration[4.2]
   def up
     # Updating old :roles column (since Alchemy CMS v2.6)
     if column_exists?(:alchemy_users, :roles)

data/db/migrate/20141209144532_add_indexes_to_alchemy_users.rb

@@ -1,4 +1,4 @@
-class AddIndexesToAlchemyUsers < ActiveRecord::Migration
+class AddIndexesToAlchemyUsers < ActiveRecord::Migration[4.2]
   def up
     add_index :alchemy_users, :firstname
     add_index :alchemy_users, :lastname

data/lib/alchemy/devise.rb

@@ -1,6 +1,41 @@
 require "alchemy/devise/engine"
 
 module Alchemy
+  # Devise modules included in +Alchemy::User+ model
+  #
+  # === Default modules
+  #
+  #     [
+  #.      :database_authenticatable,
+  #       :trackable,
+  #       :validatable,
+  #       :timeoutable,
+  #       :recoverable
+  #.    ]
+  #
+  # If you want to add additional modules into the Alchemy user class append
+  # them to this collection in an initializer in your app.
+  #
+  # === Example
+  #
+  #     # config/initializers/alchemy.rb
+  #     Alchemy.devise_modules << :registerable
+  #
+  # If your app uses an old encryption that needs the +devise-encryptable+ gem
+  # you also need to load the devise module.
+  #
+  #     Alchemy.devise_modules << :encryptable
+  #
+  def self.devise_modules
+    @devise_modules ||= [
+      :database_authenticatable,
+      :trackable,
+      :validatable,
+      :timeoutable,
+      :recoverable
+    ]
+  end
+
   module Devise
   end
 end

data/lib/alchemy/devise/test_support/factories.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :alchemy_user, class: 'Alchemy::User' do
     sequence(:login) { |n| "john_#{n}.doe" }
     sequence(:email) { |n| "john_#{n}@doe.com" }

data/lib/alchemy/devise/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module Devise
-    VERSION = "3.6.0"
+    VERSION = "4.0.0"
   end
 end

data/spec/controllers/admin/users_controller_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 module Alchemy
   describe Admin::UsersController do
+    routes { Alchemy::Engine.routes }
+
     let(:admin) { build_stubbed(:alchemy_admin_user) }
     let(:user)  { build_stubbed(:alchemy_user) }
 
@@ -16,21 +18,21 @@ module Alchemy
 
       context 'with matching search query' do
         it "lists all matching users" do
-          alchemy_get :index, q: { email_cont: user.email }
+          get :index, params: {q: { email_cont: user.email }}
           expect(assigns(:users)).to include(user)
         end
       end
 
       context 'with non-matching search query' do
         it "lists all matching users" do
-          alchemy_get :index, q: { email_cont: "Tarzan" }
+          get :index, params: {q: { email_cont: "Tarzan" }}
           expect(assigns(:users)).not_to include(user)
         end
       end
 
       context 'without search query' do
         it "lists all users" do
-          alchemy_get :index
+          get :index
           expect(assigns(:users)).to include(user)
         end
       end
@@ -41,7 +43,7 @@ module Alchemy
         before { allow(User).to receive_messages(count: 1) }
 
         it "redirects to admin dashboard" do
-          alchemy_get :signup
+          get :signup
           expect(response).to redirect_to(admin_dashboard_path)
         end
       end
@@ -50,8 +52,12 @@ module Alchemy
     describe '#create' do
       before { ActionMailer::Base.deliveries.clear }
 
+      around do |example|
+        perform_enqueued_jobs { example.run }
+      end
+
       it "creates an user record" do
-        alchemy_post :create, user: attributes_for(:alchemy_user)
+        post :create, params: {user: attributes_for(:alchemy_user)}
         expect(Alchemy::User.count).to eq(1)
       end
 
@@ -59,27 +65,27 @@ module Alchemy
         before { allow(User).to receive(:count).and_return(0) }
 
         it "sets the user role to admin." do
-          alchemy_post :create, user: attributes_for(:alchemy_admin_user)
+          post :create, params: {user: attributes_for(:alchemy_admin_user)}
           expect(assigns(:user).alchemy_roles).to include("admin")
         end
 
         context "with valid params" do
           it "signs the user in." do
             expect(controller).to receive(:sign_in)
-            alchemy_post :create, user: attributes_for(:alchemy_admin_user)
+            post :create, params: {user: attributes_for(:alchemy_admin_user)}
           end
         end
       end
 
       context "with send_credentials set to '1'" do
         it "should send an email notification" do
-          alchemy_post :create, user: attributes_for(:alchemy_user).merge(send_credentials: '1')
+          post :create, params: {user: attributes_for(:alchemy_user).merge(send_credentials: '1')}
           expect(ActionMailer::Base.deliveries).not_to be_empty
         end
 
         context 'with invalid user' do
           it "does not send an email notification" do
-            alchemy_post :create, user: {send_credentials: '1', email: ''}
+            post :create, params: {user: {send_credentials: '1', email: ''}}
             expect(ActionMailer::Base.deliveries).to be_empty
           end
         end
@@ -87,22 +93,24 @@ module Alchemy
 
       context "with send_credentials set to true" do
         it "should not send an email notification" do
-          alchemy_post :create, user: attributes_for(:alchemy_user).merge(send_credentials: true)
+          post :create, params: {user: attributes_for(:alchemy_user).merge(send_credentials: true)}
           expect(ActionMailer::Base.deliveries).to be_empty
         end
       end
 
       context "with send_credentials left blank" do
         it "should not send an email notification" do
-          alchemy_post :create, user: attributes_for(:alchemy_user)
+          post :create, params: {user: attributes_for(:alchemy_user)}
           expect(ActionMailer::Base.deliveries).to be_empty
         end
       end
     end
 
     describe '#update' do
-      before do
-        ActionMailer::Base.deliveries.clear
+      before { ActionMailer::Base.deliveries.clear }
+
+      around do |example|
+        perform_enqueued_jobs { example.run }
       end
 
       context "with empty password passed" do
@@ -116,7 +124,7 @@ module Alchemy
             .to receive(:update_without_password)
             .with(params_hash).and_return(true)
 
-          alchemy_post :update, id: user.id, user: params_hash, format: :js
+          post :update, params: {id: user.id, user: params_hash, format: :js}
         end
       end
 
@@ -129,7 +137,7 @@ module Alchemy
           }
           expect(user).to receive(:update).with(params_hash)
 
-          alchemy_post :update, id: user.id, user: params_hash, format: :js
+          post :update, params: {id: user.id, user: params_hash, format: :js}
         end
       end
 
@@ -137,13 +145,13 @@ module Alchemy
         let(:user) { create(:alchemy_admin_user) }
 
         it "should send an email notification" do
-          alchemy_post :update, id: user.id, user: {send_credentials: '1'}
+          post :update, params: {id: user.id, user: {send_credentials: '1'}}
           expect(ActionMailer::Base.deliveries).to_not be_empty
         end
 
         context 'with invalid user' do
           it "does not send an email notification" do
-            alchemy_post :update, id: user.id, user: {send_credentials: '1', email: ''}
+            post :update, params: {id: user.id, user: {send_credentials: '1', email: ''}}
             expect(ActionMailer::Base.deliveries).to be_empty
           end
         end
@@ -153,7 +161,7 @@ module Alchemy
         let(:user) { create(:alchemy_admin_user) }
 
         it "should not send an email notification" do
-          alchemy_post :update, id: user.id, user: {email: user.email}
+          post :update, params: {id: user.id, user: {email: user.email}}
           expect(ActionMailer::Base.deliveries).to be_empty
         end
       end
@@ -170,7 +178,7 @@ module Alchemy
           expect(user)
             .to receive(:update_without_password)
             .with({'alchemy_roles' => ['Administrator']})
-          alchemy_post :update, id: user.id, user: {alchemy_roles: ['Administrator']}, format: :js
+          post :update, params: {id: user.id, user: {alchemy_roles: ['Administrator']}, format: :js}
         end
       end
 
@@ -184,7 +192,7 @@ module Alchemy
 
         it "updates user without role" do
           expect(user).to receive(:update_without_password).with({})
-          alchemy_post :update, id: user.id, user: {alchemy_roles: ['Administrator']}, format: :js
+          post :update, params: {id: user.id, user: {alchemy_roles: ['Administrator']}, format: :js}
         end
       end
     end
@@ -192,7 +200,7 @@ module Alchemy
     describe '#destroy' do
       it "redirects to users list" do
         expect(user).to receive(:destroy).and_return(true)
-        alchemy_delete :destroy, id: user.id
+        delete :destroy, params: {id: user.id}
         expect(response).to redirect_to(admin_users_path)
       end
     end

data/spec/controllers/user_sessions_controller_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe Alchemy::UserSessionsController do
+  routes { Alchemy::Engine.routes }
+
   before do
     @request.env["devise.mapping"] = Devise.mappings[:user]
   end
@@ -8,7 +10,7 @@ describe Alchemy::UserSessionsController do
   context 'without users present' do
     describe '#new' do
       it "redirects to signup form" do
-        alchemy_get :new
+        get :new
         is_expected.to redirect_to(admin_signup_path)
       end
 
@@ -18,7 +20,7 @@ describe Alchemy::UserSessionsController do
         end
 
         it 'redirects to https' do
-          alchemy_get :new
+          get :new
           is_expected.to redirect_to(
             login_url(protocol: 'https', host: "test.host")
           )
@@ -39,7 +41,7 @@ describe Alchemy::UserSessionsController do
 
         context 'without redirect path in session' do
           it "redirects to dashboard" do
-            alchemy_post :create, user: user_params
+            post :create, params: {user: user_params}
             expect(response).to redirect_to(admin_dashboard_path)
           end
         end
@@ -47,19 +49,19 @@ describe Alchemy::UserSessionsController do
         context 'with redirect path in session' do
           it "redirects to these params" do
             session[:redirect_path] = admin_users_path
-            alchemy_post :create, user: user_params
+            post :create, params: {user: user_params}
             expect(response).to redirect_to(admin_users_path)
           end
         end
 
         it "stores users screen size" do
-          alchemy_post :create, user: user_params, user_screensize: screen_size
+          post :create, params: {user: user_params, user_screensize: screen_size}
           expect(session[:screen_size]).to eq(screen_size)
         end
 
         context 'without valid params' do
           it "renders login form" do
-            alchemy_post :create, user: {login: ''}
+            post :create, params: {user: {login: ''}}
             is_expected.to render_template(:new)
           end
         end
@@ -77,44 +79,44 @@ describe Alchemy::UserSessionsController do
 
       it "should unlock all pages" do
         expect(user).to receive(:unlock_pages!)
-        alchemy_delete :destroy
+        delete :destroy
       end
 
       context 'comming from admin area' do
         before do
-          allow(controller.request)
-            .to receive(:referer)
-            .and_return('/admin_users')
+          allow_any_instance_of(ActionController::TestRequest).to receive(:referer) do
+            '/admin_users'
+          end
         end
 
         it "redirects to root" do
-          alchemy_delete :destroy
+          delete :destroy
           is_expected.to redirect_to(root_path)
         end
       end
 
       context 'no referer present' do
         before do
-          allow(controller.request)
-            .to receive(:referer)
-            .and_return(nil)
+          allow_any_instance_of(ActionController::TestRequest).to receive(:referer) do
+            nil
+          end
         end
 
         it "redirects to root" do
-          alchemy_delete :destroy
+          delete :destroy
           is_expected.to redirect_to(root_path)
         end
       end
 
       context 'referer not from admin area' do
         before do
-          allow(controller.request)
-            .to receive(:referer)
-            .and_return('/imprint')
+          allow_any_instance_of(ActionController::TestRequest).to receive(:referer) do
+            '/imprint'
+          end
         end
 
         it "redirects to root" do
-          alchemy_delete :destroy
+          delete :destroy
           is_expected.to redirect_to('/imprint')
         end
       end