muck-users 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Ball
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,27 @@
+RestfulAuthenticationEngine
+====================
+
+The muck users engine is part of the muck framework and relies upon the muck_engine.
+
+This engine implements authlogic.  Some of the code contained was taken from here:
+http://railsforum.com/viewtopic.php?id=14216 and here
+http://github.com/activefx/restful_authentication_tutorial/tree/master
+
+Inspiration also came from:
+http://github.com/tsechingho/authlogic_bundle/tree/master
+
+Example
+=======
+After installing the engine just create a user model thus:
+
+class User < ActiveRecord::Base
+  acts_as_authentic
+  acts_as_muck_user
+end
+
+Then you will be able to go to:
+http//:localhost:3000/login
+http//:localhost:3000/signup
+
+
+Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muck-users"
+    gem.summary = "Easy to use user engine for Rails"
+    gem.email = "justinball@gmail.com"
+    gem.homepage = "http://github.com/jbasdf/muck-users"
+    gem.description = "Easily add user signup, login and other features to your application"
+    gem.authors = ["Justin Ball"]
+    gem.rubyforge_project = "muck-users"
+    gem.add_dependency "authlogic"
+    gem.add_dependency "muck-engine"
+    # gem.files.include %w( lib/muck-users 
+    #                       tasks/*
+    #                       db/migrate/*.rb
+    #                       app/**/**/**/*
+    #                       config/*
+    #                       locales/*
+    #                       rails/*
+    #                       test/*
+    #                       lib/**/* )
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+# rubyforge tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/muck-users/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+desc 'Test the muck-users gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muck-users #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/admin/muck/roles_controller.rb

@@ -0,0 +1,57 @@
+class Admin::Muck::RolesController < Admin::Muck::BaseController
+  unloadable
+  
+  def index
+    @user = User.find(params[:user_id])
+    @all_roles = Role.find(:all)
+  end
+
+  def show
+    @role = Role.new(params[:role])
+  end
+
+  def new
+    @role = Role.new(params[:role])
+  end
+
+  # POST /websites
+  # POST /websites.xml
+  def create
+    @role = Role.new(params[:role])
+
+    respond_to do |format|
+      if @role.save
+        flash[:notice] = I18n.t('muck.roles.role_created')
+        format.html { redirect_to(admin_roles_path(@role)) }
+        format.xml  { render :xml => @role, :status => :created, :location => @role }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @role.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  def edit
+    @role = Role.new(params[:role])
+  end
+
+  def update
+    @user = User.find(params[:user_id])
+    @role = Role.find(params[:id])
+    unless @user.has_role?(@role.rolename)
+      @user.roles << @role
+    end
+    redirect_to :action => 'index'
+  end
+
+  def destroy
+    @user = User.find(params[:user_id])
+    @role = Role.find(params[:id])
+    if @user.has_role?(@role.rolename)
+      @user.roles.delete(@role)
+    end
+    redirect_to :action => 'index'
+  end
+
+end
+

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

@@ -0,0 +1,122 @@
+class Admin::Muck::UsersController < Admin::Muck::BaseController
+  unloadable
+  
+  before_filter :get_user, :only => [:update, :destroy]
+  
+  def index
+    @user_count = User.count
+    @user_inactive_count = User.inactive_count
+    @users = User.by_newest.paginate(:page => @page, :per_page => @per_page)
+    respond_to do |format|
+      format.html { render :template => 'admin/users/index' }
+    end
+  end
+
+  def inactive
+    @user_inactive_count = User.inactive_count
+    @users = User.inactive.paginate(:page => @page, :per_page => @per_page)
+    respond_to do |format|
+      format.html { render :template => 'admin/users/inactive' }
+    end
+  end
+  
+  def inactive_emails
+    @user_inactive_count = User.inactive_count
+    @users = User.inactive
+    respond_to do |format|
+      format.html { render :template => 'admin/users/inactive_emails' }
+    end
+  end
+  
+  def activate_all
+    User.activate_all
+    respond_to do |format|
+      format.html do
+        redirect_to inactive_admin_users_path
+      end
+    end
+  end
+
+  def search_results
+    @users = User.do_search( params[:query] ).paginate(:page => @page, :per_page => @per_page )
+  end
+  
+  def search
+    search_results
+    respond_to do |format|
+      format.html do
+        render :template => 'admin/users/index'
+      end
+    end
+  end
+
+  def ajax_search
+    search_results
+    respond_to do |format|
+      format.html do
+        render :partial => 'admin/users/table', :layout => false
+      end
+    end
+  end
+
+  def update
+    if is_me?(@user)
+      message = I18n.t("muck.users.cannot_deactivate_yourself")
+    else
+      if @user.force_activate!
+        message = I18n.t('muck.users.user_marked_active')
+      else
+        message = I18n.t('muck.users.user_marked_inactive')
+      end
+    end    
+    activate_text = '<div class="flasherror">' + message + '</div>'
+    activate_text << render_to_string(:partial => 'admin/users/activate', :locals => {:user => @user})
+    respond_to do |format|
+      format.js do
+        render :update do |page|
+          page.replace_html @user.dom_id('link'), activate_text
+        end
+      end
+    end
+  end
+
+  def enable
+    @user = User.find(params[:id])
+    if @user.update_attribute(:enabled, true)
+      self.current_user = @user
+      flash[:notice] = t("muck.users.user_enabled")
+    else
+      flash[:error] = t("muck.users.user_enable_problem")
+    end
+    redirect_to :action => 'index'
+  end
+  
+  def disable
+    @user = admin? ? User.find(params[:id]) : User.find(current_user)
+    if @user.update_attribute(:enabled, false)
+      flash[:notice] = t("users.user_disabled")
+    else
+      flash[:error] = t("users.user_disable_problem")
+    end
+    redirect_to :action => 'index'
+  end
+  
+  def destroy
+    @user.destroy
+    respond_to do |format|
+      format.html do
+        flash[:notice] = I18n.t('muck.users.user_successfully_deleted', :login => @user.login)
+        redirect_to admin_users_path
+      end
+      format.xml  { head :ok }
+      format.js { render(:update){|page| page.visual_effect :fade, "#{@user.dom_id('row')}".to_sym} }
+    end
+  end
+  
+  private 
+  
+  def get_user
+    @user = User.find_by_login(params[:id]) || User.find(params[:id])
+  end
+  
+end

data/app/controllers/muck/activations_controller.rb

@@ -0,0 +1,31 @@
+# new file app/controllers/activations_controller.rb
+class Muck::ActivationsController < ApplicationController
+  unloadable
+  
+  ssl_required :new
+  before_filter :not_logged_in_required, :only => [:new]
+  
+  def new
+    @user = User.find_using_perishable_token(params[:id])
+    if @user.blank?
+      flash[:notice] = t('muck.users.activation_not_found')
+      redirect_to new_user_path and return
+    end
+    
+    if @user.active?
+      flash[:notice] = t('muck.users.already_activated')
+      redirect_to login_path and return
+    end
+    
+    if @user.activate!
+      UserSession.create(@user)
+      flash[:notice] = t('muck.users.account_activated')
+      @user.deliver_activation_confirmation!
+      redirect_to welcome_user_path(@user)
+    else
+      render :action => :new
+    end
+    
+  end
+
+end

data/app/controllers/muck/password_resets_controller.rb

@@ -0,0 +1,81 @@
+class Muck::PasswordResetsController < ApplicationController
+  unloadable
+  
+  ssl_required :edit, :update
+  ssl_allowed :new, :create
+  before_filter :not_logged_in_required
+  before_filter :load_user_using_perishable_token, :only => [:edit, :update]
+
+  # Enter email address to recover password 
+  def new
+    @title = t('muck.users.recover_password')
+    respond_to do |format|
+      format.html { render :template => 'password_resets/new' }
+    end
+  end
+
+  # Forgot password action
+  def create
+    @title = t('muck.users.recover_password')
+    if @user = User.find_by_email(params[:email])
+      @user.deliver_password_reset_instructions!
+      flash[:notice] = t('muck.users.password_reset_link_sent')
+      respond_to do |format|
+        format.html { redirect_to login_path }
+      end
+    else
+      flash[:notice] = t('muck.users.could_not_find_user_with_email')
+      respond_to do |format|
+        format.html { render :template => 'password_resets/new' }
+      end
+    end  
+  end
+
+  # Action triggered by clicking on the /reset_password/:id link recieved via email
+  # Makes sure the id code is included
+  # Checks that the id code matches a user in the database
+  # Then if everything checks out, shows the password reset fields
+  def edit
+    @title = t('muck.users.reset_password')
+    respond_to do |format|
+      format.html { render :template => 'password_resets/edit' }
+    end
+  end
+
+  # Reset password action /reset_password/:id
+  # Checks once again that an id is included and makes sure that the password field isn't blank
+  def update
+    if @user.reset_password!(params[:user])
+      flash[:success] = t('muck.users.password_updated')
+      respond_to do |format|
+        format.html { redirect_to account_url }
+      end
+    else
+      respond_to do |format|
+        format.html { render :template => 'password_resets/edit' }
+      end
+    end
+  end
+
+  private
+  
+  def load_user_using_perishable_token
+    @user = User.find_using_perishable_token(params[:id])
+    unless @user
+      flash[:notice] = t('muck.users.sorry_invalid_reset_code')
+      respond_to do |format|
+        format.html { redirect_to root_url }
+      end      
+    end
+  end
+  
+  def permission_denied
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.users.already_logged_in')
+        redirect_to account_url
+      end
+    end
+  end
+
+end

data/app/controllers/muck/user_sessions_controller.rb

@@ -0,0 +1,40 @@
+class Muck::UserSessionsController < ApplicationController
+  unloadable
+  
+  ssl_required :new, :create
+  before_filter :login_required, :only => :destroy
+  before_filter :not_logged_in_required, :only => [:new, :create]
+  
+  def new
+    @title = t('muck.users.sign_in_title')
+    @user_session = UserSession.new
+    respond_to do |format|
+      format.html { render :template => 'user_sessions/new' }
+    end
+  end
+  
+  def create
+    @title = t('muck.users.sign_in_title')
+    @user_session = UserSession.new(params[:user_session])
+    if @user_session.save
+      flash[:notice] = t('muck.users.login_success')
+      respond_to do |format|
+        format.html { redirect_back_or_default user_path(@user_session.user) }
+      end
+    else
+      flash[:notice] = t('muck.users.login_fail')
+      respond_to do |format|
+        format.html { render :template => 'user_sessions/new' }
+      end
+    end
+  end
+  
+  def destroy
+    @title = t('muck.users.sign_out_title')
+    current_user_session.destroy
+    flash[:notice] = t('muck.users.login_out_success')
+    respond_to do |format|
+      format.html { redirect_back_or_default login_path }
+    end
+  end
+end

data/app/controllers/muck/username_request_controller.rb

@@ -0,0 +1,43 @@
+class Muck::UsernameRequestController < ApplicationController
+  unloadable
+  
+  ssl_allowed :new, :create
+  before_filter :not_logged_in_required
+
+  # Enter email address to recover username 
+  def new
+    @title = t('muck.users.username_request')
+    respond_to do |format|
+      format.html { render :template => 'username_request/new' }
+    end
+  end
+
+  # Forgot username action
+  def create
+    @title = t('muck.users.username_request')
+    if @user = User.find_by_email(params[:request_username][:email])
+      @user.deliver_username_request!
+      flash[:notice] = t('muck.users.username_sent')
+      respond_to do |format|
+        format.html { redirect_to login_path }
+      end
+    else
+      flash[:notice] = t('muck.users.could_not_find_user_with_email')
+      respond_to do |format|
+        format.html { render :template => 'username_request/new' }
+      end
+    end  
+  end
+
+  private
+  
+  def permission_denied
+    respond_to do |format|
+      format.html do
+        flash[:notice] = t('muck.users.already_logged_in')
+        redirect_to account_url
+      end
+    end
+  end
+
+end