alchemy-devise 2.1.0.beta2 → 2.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a79631af83bee6ed637c75edd08df15a48861e9
-  data.tar.gz: 777d89f378d5a1f88c4a2dd83cd997d6bd141ea7
+  metadata.gz: 0fc84b5db6709c2ee2a313c884bf01fe7918d3a4
+  data.tar.gz: 723db86398d568d7bc439ccdf59f926005aa40dd
 SHA512:
-  metadata.gz: 7341d8dd73175c47e02e575cb331757adc094f2774d482b5d107e333655107f233d83b6d7c24a000c96778f023fe7a59dc65f6f5e17b41023cb8c4dde4cacfaa
-  data.tar.gz: ef8fc35c4c1c3a0f9e7ea9b9b55d34f5c0344bbad1a3df81449c72fbe0ccf6d7ffc15644a95a33433f102843b730d68e68363ba9f1aa47babd66850ad4802383
+  metadata.gz: 1e80596dbc273ce6ef20ab890168fec1d09bee090aafce4f2096d233fc0acbc73840892aeafc815c43325a47380af95785f032bfe89afd101e599e563cedfcd5
+  data.tar.gz: 72ca9656f7220a5f2510ad866a546e51e47ac42688ca320e8655adf193b71cd6448f640f02cfa00ad22682208306a859692f6f820587f45c2ca976bbbb7d8be0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2010-2013, magic labs GmbH, Hamburg Germany
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+  Neither the name of the magic labs GmbH nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,90 @@
+## Devise based authentication for Alchemy 3.1
+
+[![Build Status](https://secure.travis-ci.org/AlchemyCMS/alchemy-devise.svg?branch=master)](http://travis-ci.org/AlchemyCMS/alchemy-devise) [![Coverage Status](https://img.shields.io/coveralls/AlchemyCMS/alchemy-devise.svg)](https://coveralls.io/r/AlchemyCMS/alchemy-devise?branch=master) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-devise.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/2.0.0), or the [latest stable branch (2.0-stable)](https://github.com/AlchemyCMS/alchemy-devise/tree/2.0-stable).**
+
+Alchemy 3.0 has dropped the authentication from its core. So now it is possibly to bring your own authentication and use it to authorize users in Alchemy.
+
+In order to bring the authentication from Alchemy back into your app (For instance, because you don't have your own user authorization), you can use this gem.
+
+## Install
+
+Just put the gem into your projects `Gemfile`.
+
+```ruby
+# Gemfile
+gem 'alchemy-devise', github: 'AlchemyCMS/alchemy-devise', branch: 'master'
+```
+
+**NOTE:** You normally want to use a stable branch, like `2.0-stable`.
+
+and run `bundle install`.
+
+Then run the installer:
+
+```shell
+$ bin/rails g alchemy:devise:install
+```
+
+## Upgrading
+
+After updating the gem, please run the installer again.
+
+```shell
+$ bundle update alchemy-devise
+$ bin/rails g alchemy:devise:install
+```
+
+## Testing
+
+If you want to contribute (and you should ^_^), you need to run the tests locally on your machine.
+
+Just follow these pretty rails standard way of testing projects:
+
+### 1. Once to prepare the test suite:
+
+Clone the repo to your local harddrive. Then
+
+```shell
+$ bundle install
+$ bin/rake alchemy:spec:prepare
+```
+
+### 2. Run the tests with:
+
+```shell
+$ bundle exec rspec
+```
+
+_Optional:_ Even shorter
+
+```shell
+$ bin/rake
+```
+
+That prepares the database and runs the Rspec task in one step.
+
+Getting Help
+------------
+
+* If you have bugs, please use the [issue tracker on Github](https://github.com/AlchemyCMS/alchemy-devise/issues).
+* For Q&A and general usage, please use the [User Group](http://groups.google.com/group/alchemy-cms) or the IRC channel.
+* New features should be discussed on our [Trello Board](https://trello.com/alchemycms). *PLEASE* don't use the Github issues for new features.
+
+Resources
+---------
+
+* Homepage: <http://alchemy-cms.com>
+* Live-Demo: <https://demo.alchemy-cms.com> (user: demo, password: demo123)
+* API Documentation: <http://rubydoc.info/github/AlchemyCMS/alchemy-devise>
+* Issue-Tracker: <https://github.com/AlchemyCMS/alchemy-devise/issues>
+* Sourcecode: <https://github.com/AlchemyCMS/alchemy-devise>
+* User Group: <http://groups.google.com/group/alchemy-cms>
+* IRC Channel: #alchemy_cms on irc.freenode.net
+* Discussion Board: <https://trello.com/alchemycms>
+
+License
+-------
+
+* BSD: <https://github.com/AlchemyCMS/alchemy-devise/LICENSE>

data/Rakefile

@@ -31,8 +31,7 @@ namespace :alchemy do
 
     desc "Prepares database for testing Alchemy"
     task :prepare do
-      system 'cd spec/dummy && RAILS_ENV=test bundle exec rake db:migrate:reset && cd -'
+      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 -'
     end
-
   end
 end

data/app/controllers/alchemy/admin/users_controller.rb

@@ -3,57 +3,67 @@ module Alchemy
     class UsersController < ResourcesController
 
       before_action :set_roles_and_genders, except: [:index, :destroy]
+      after_action :deliver_welcome_mail, only: [:create, :update]
 
       load_and_authorize_resource class: Alchemy::User,
         only: [:edit, :update, :destroy]
 
       authorize_resource class: Alchemy::User,
-        only: [:index, :new, :create]
+        only: [:index, :new, :signup, :create]
 
       handles_sortable_columns do |c|
         c.default_sort_value = :login
       end
 
+      helper_method :while_signup?, :can_update_role?
+
       def index
         if params[:query].present?
-          @users = User.where([
-           "LOWER(login) LIKE ? OR LOWER(email) LIKE ? OR LOWER(firstname) LIKE ? OR LOWER(lastname) LIKE ?",
-           "%#{params[:query].downcase}%",
-           "%#{params[:query].downcase}%",
-           "%#{params[:query].downcase}%",
-           "%#{params[:query].downcase}%"
-         ])
+          @users = User.search(params[:query])
         else
           @users = User.all
         end
-        @users = @users.page(params[:page] || 1).per(per_page_value_for_screen_size).order(sort_order)
+
+        @users = @users
+          .page(params[:page] || 1)
+          .per(per_page_value_for_screen_size)
+          .order(sort_order)
       end
 
       def new
         @user = User.new(send_credentials: true)
       end
 
+      def signup
+        if while_signup?
+          new
+        else
+          flash[:warning] = _t(:cannot_signup_more_then_once)
+          redirect_to admin_dashboard_path
+        end
+      end
+
       def create
-        @user = User.create(user_params)
-        render_errors_or_redirect(
-          @user,
-          admin_users_path,
-          _t("User created", :name => @user.name)
-        )
+        @user = User.new(user_params)
+
+        if while_signup?
+          signup_admin_or_redirect(@user)
+        else
+          create_user_or_redirect(@user)
+        end
       end
 
       def update
         # User is fetched via before filter
         if params[:user][:password].present?
-          @user.update_attributes(user_params)
+          @user.update(user_params)
         else
           @user.update_without_password(user_params)
         end
-        render_errors_or_redirect(
-          @user,
+
+        render_errors_or_redirect @user,
           admin_users_path,
           _t("User updated", :name => @user.name)
-        )
       end
 
       def destroy
@@ -68,7 +78,11 @@ module Alchemy
       private
 
       def set_roles_and_genders
-        @user_roles = User::ROLES.map { |role| [User.human_rolename(role), role] }
+        if can_update_role?
+          @user_roles = User::ROLES.map do |role|
+            [User.human_rolename(role), role]
+          end
+        end
         @user_genders = User.genders_for_select
       end
 
@@ -77,13 +91,44 @@ module Alchemy
       end
 
       def secure_attributes
-        if can?(:update_role, Alchemy::User)
+        if can_update_role?
           User::PERMITTED_ATTRIBUTES + [{alchemy_roles: []}]
         else
           User::PERMITTED_ATTRIBUTES
         end
       end
 
+      def while_signup?
+        User.count == 0
+      end
+
+      def signup_admin_or_redirect(user)
+        user.alchemy_roles = %w(admin)
+        if user.save
+          flash[:notice] = _t('Successfully signup admin user')
+          sign_in :user, user
+          redirect_to admin_pages_path
+        else
+          render :signup
+        end
+      end
+
+      def create_user_or_redirect(user)
+        user.save
+        render_errors_or_redirect user,
+          admin_users_path,
+          _t("User created", name: user.name)
+      end
+
+      def can_update_role?
+        can? :update_role, Alchemy::User
+      end
+
+      def deliver_welcome_mail
+        if @user.valid? && @user.send_credentials == '1'
+          @user.deliver_welcome_mail
+        end
+      end
     end
   end
 end

data/app/controllers/alchemy/user_sessions_controller.rb

@@ -1,8 +1,11 @@
 module Alchemy
   class UserSessionsController < ::Devise::SessionsController
-    include Locale
+    include Alchemy::Locale
+
+    before_action except: 'destroy' do
+      enforce_ssl if ssl_required? && !request.ssl?
+    end
 
-    before_action(except: 'destroy') { enforce_ssl if ssl_required? && !request.ssl? }
     before_action :check_user_count, :only => :new
 
     helper 'Alchemy::Admin::Base', 'Alchemy::Pages'
@@ -15,6 +18,7 @@ module Alchemy
 
     def create
       authenticate_user!
+
       if user_signed_in?
         store_screen_size
         if session[:redirect_path].blank?
@@ -23,7 +27,8 @@ module Alchemy
           # We have to strip double slashes from beginning of path, because of strange rails/rack bug.
           redirect_path = session[:redirect_path].gsub(/\A\/{2,}/, '/')
         end
-        redirect_to redirect_path, :notice => t(:signed_in, :scope => 'devise.sessions')
+        redirect_to redirect_path,
+          notice: t(:signed_in, scope: 'devise.sessions')
       else
         super
       end
@@ -40,7 +45,7 @@ module Alchemy
 
     def check_user_count
       if User.count == 0
-        redirect_to signup_path
+        redirect_to admin_signup_path
       end
     end
 
@@ -56,6 +61,5 @@ module Alchemy
         request.referer
       end
     end
-
   end
 end

data/app/mailers/alchemy/notifications.rb

@@ -21,13 +21,13 @@ module Alchemy
       )
     end
 
-    def reset_password_instructions(user, opts={})
+    def reset_password_instructions(user, token, opts={})
       @user = user
+      @token = token
       mail(
         to: user.email,
         subject: I18n.t("Reset password instructions")
       )
     end
-
   end
 end

data/app/models/alchemy/user.rb

@@ -1,5 +1,6 @@
-require 'userstamp'
+require 'devise/orm/active_record'
 require 'acts-as-taggable-on'
+require 'userstamp'
 
 module Alchemy
   class User < ActiveRecord::Base
@@ -42,8 +43,6 @@ module Alchemy
     # Unlock all locked pages before destroy.
     before_destroy :unlock_pages!
 
-    after_save :deliver_welcome_mail, if: -> { send_credentials == '1' }
-
     scope :admins,     -> { where(arel_table[:alchemy_roles].matches('%admin%')) }
     scope :logged_in,  -> { where('last_request_at > ?', logged_in_timeout.seconds.ago) }
     scope :logged_out, -> { where('last_request_at is NULL or last_request_at <= ?', logged_in_timeout.seconds.ago) }
@@ -65,6 +64,19 @@ module Alchemy
       def logged_in_timeout
         Config.get(:auto_logout_time).minutes.to_i
       end
+
+      # Search users that match query
+      #
+      # Attributes searched are: login, email, firstname, lastname
+      #
+      def search(query)
+        query = "%#{query.downcase}%"
+
+        where arel_table[:login].lower.matches(query)
+          .or arel_table[:email].lower.matches(query)
+          .or arel_table[:firstname].lower.matches(query)
+          .or arel_table[:lastname].lower.matches(query)
+      end
     end
 
     def role_symbols
@@ -156,12 +168,6 @@ module Alchemy
       update_column(:last_request_at, Time.now)
     end
 
-    private
-
-    def logged_in_timeout
-      self.class.logged_in_timeout
-    end
-
     # Delivers a welcome mail depending from user's role.
     #
     def deliver_welcome_mail
@@ -172,5 +178,10 @@ module Alchemy
       end
     end
 
+    private
+
+    def logged_in_timeout
+      self.class.logged_in_timeout
+    end
   end
 end

data/app/views/alchemy/admin/users/_fields.html.erb

@@ -6,19 +6,24 @@
 <%= f.input :lastname %>
 <%= f.input :login, autofocus: true %>
 <%= f.input :email %>
-<%= f.input :language, collection: translations_for_select, include_blank: false, input_html: {class: 'alchemy_selectbox'} %>
+<%= f.input :language,
+  collection: translations_for_select,
+  include_blank: false,
+  input_html: {class: 'alchemy_selectbox'} %>
 <%= f.input :password %>
 <%= f.input :password_confirmation %>
-<% if can? :update_role, @user %>
+<% if can_update_role? %>
   <%= f.input :alchemy_roles,
-    collection: Alchemy::User::ROLES.map { |role| [Alchemy::User.human_rolename(role), role] },
+    collection: @user_roles,
     input_html: {multiple: true, class: 'alchemy_selectbox'},
     as: 'select' %>
 <% end %>
-<% unless @signup %>
+<% unless while_signup? %>
   <div class="input tag_list">
     <%= f.label :tag_list %>
-    <%= render 'alchemy/admin/partials/autocomplete_tag_list', f: f, object: @user %>
+    <%= render 'alchemy/admin/partials/autocomplete_tag_list',
+      f: f,
+      object: @user %>
   </div>
 <% end %>
 <%= f.input :send_credentials, as: 'boolean' %>

data/app/views/alchemy/{users/new.html.erb → admin/users/signup.html.erb}

@@ -7,7 +7,7 @@
     <h1><%= _t('Welcome to Alchemy') %></h1>
     <p><%= _t("Please Signup") %></p>
   <% end %>
-  <%= alchemy_form_for @user do |f| %>
-    <%= render 'alchemy/admin/users/fields', f: f %>
+  <%= alchemy_form_for [:admin, @user] do |f| %>
+    <%= render 'fields', f: f %>
   <% end %>
 </div>