rules_engine_users 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+coverage.data
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Douglas
+
+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,17 @@
+= rules_engine_users
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Chris Douglas. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rules_engine_users"
+    gem.summary = %Q{Manage users and authentication}
+    gem.description = %Q{Manage users and authentication}
+    gem.email = "dougo.chris@gmail.com"
+    gem.homepage = "http://github.com/dougochris/rules_engine_users"
+    gem.authors = ["Chris Douglas"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rules_engine_users #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/rules_engine_users")

data/lib/rules_engine/controller_user_mail.rb

@@ -0,0 +1,29 @@
+module RulesEngine
+  class ControllerUserMail
+    
+    @@host = "localhost:3000"
+    def self.host
+      @@host
+    end
+    def self.host=(name)
+      @@host = name
+    end
+
+    @@from = "Do Not Reply <do_not_reply@localhost:3000>"
+    def self.from
+      @@from
+    end
+    def self.from=(from)
+      @@from = from
+    end
+
+    @@prefix = ""
+    def self.prefix
+      @@prefix
+    end
+    def self.prefix=(name)
+      @@prefix = name
+    end
+    
+  end
+end

data/lib/rules_engine/controller_users.rb

@@ -0,0 +1,170 @@
+module RulesEngine
+  module ControllerUsers
+    ######### Requires the following paths
+    ######### root_path
+
+    USER_ACCESS_LEVEL = [
+        ["Administrator",       User::ACCESS_LEVEL_ADMIN],
+        ["Account Disabled",    User::ACCESS_LEVEL_DISABLED]
+      ]
+    
+    # Inclusion hook to make #current_user #logged_in? and #logged_in_as_admin?
+    # available as ActionView helper methods.
+    def self.included(base)
+      base.send :helper_method, :current_user, :logged_in?, :logged_in_as_admin?, :logged_in_disabled?, :user_access_level, :user_access_levels
+      base.send :before_filter, :set_timezone
+  
+      base.class_eval do
+        extend ClassMethods
+      end  
+    end    
+
+    # Accesses the current user from the session. 
+    # Future calls avoid the database because nil is not equal to false.
+    def current_user
+      return nil if  @current_user == false
+      @current_user || (login_from_session || login_from_basic_auth || login_from_cookie)
+      @current_user || nil  
+    end
+    
+    # Returns true or false if the user is logged in.
+    # Preloads @current_user with the user model if they're logged in.
+    def logged_in?
+      !!current_user
+    end
+
+    def logged_in_as_admin?
+      logged_in? && current_user.access_level == User::ACCESS_LEVEL_ADMIN
+    end
+
+    def logged_in_disabled?
+      logged_in? && current_user.access_level == User::ACCESS_LEVEL_DISABLED
+    end
+
+    def login_required
+      unless logged_in?
+        flash[:error]="This page requires you to login"
+        access_denied
+      end
+    end
+    
+    def admin_access_required
+      login_required
+      return unless logged_in?
+      unless current_user.access_level ==  User::ACCESS_LEVEL_ADMIN
+        flash[:error]="This page requires administrator access"
+        user_access_denied
+      end
+    end    
+
+    def user_access_level(user)
+      match = USER_ACCESS_LEVEL.find {|value| value[1] == user.access_level}
+      match.nil? ? "unknown" : match[0]      
+    end
+
+    def user_access_levels
+      USER_ACCESS_LEVEL.sort {|a, b| a[1] <=> b[1]}
+    end
+
+    def set_timezone
+      Time.zone = logged_in? ? current_user.time_zone : "Eastern Time (US & Canada)"
+    end      
+
+    module ClassMethods
+      def define_access_level name, access_level
+        (class << self; self end).instance_eval do
+          USER_ACCESS_LEVEL << [name.to_s.titleize, access_level]
+        end
+        
+        (class << ActionController::Base; self end).instance_eval do
+          define_method "#{name}_access_level" do
+            access_level
+          end      
+        end
+        
+        define_method "logged_in_as_#{name}?" do
+          logged_in? && current_user.access_level >= access_level
+        end
+      
+        define_method "#{name}_access_required" do
+          login_required
+          return unless logged_in?
+          unless current_user.access_level >= access_level
+            flash[:error]="This page requires #{name} access"
+            user_access_denied
+          end
+        end
+        
+        self.send :helper_method, "logged_in_as_#{name}"
+      end
+    end  
+
+    protected
+      # Store the given user id in the session.
+      def current_user=(new_user)
+      
+        session[:user_id] = new_user ? new_user.id : nil
+        @current_user = new_user || false # store false 
+      end
+
+      def access_denied
+        respond_to do |format|
+          format.html do
+            session[:return_to] = request.request_uri
+            redirect_to user_login_path
+            return
+          end
+          format.js do
+            render :update do |page| 
+              page << "window.location.href = '#{user_login_path}';"
+            end
+          end              
+          #   format.any do
+          #     request_http_basic_authentication 'Web Password'
+          #   end
+          # end
+        end
+      end
+
+      def user_access_denied
+        respond_to do |format|
+          format.html do
+            redirect_to root_path
+          end
+          format.js do
+            render :update do |page| 
+              page << "window.location.href = '#{root_path}';"
+            end
+          end              
+        #   format.any do
+        #     request_http_basic_authentication 'Web Password'
+        #   end
+        end
+      end
+
+      # Called from #current_user.  First attempt to login by the user id stored in the session.
+      def login_from_session
+        self.current_user = User.find_by_id(session[:user_id]) if session[:user_id]
+      end
+
+      # Called from #current_user.  Now, attempt to login by basic authentication information.
+      def login_from_basic_auth
+        authenticate_with_http_basic do |name, password|
+          self.current_user = User.authenticate_by_login(name, password) || User.authenticate_by_email(name, password)
+        end
+      end
+
+      # Called from #current_user.  Finaly, attempt to login by an expiring token in the cookie.
+      def login_from_cookie
+        user = cookies[:auth_token] && User.authenticate_by_remember_token(cookies[:auth_token])
+        if user
+          cookies[:auth_token] = { :value => user.remember_token, :expires => user.remember_token_expires_at }
+          self.current_user = user
+        end
+      end
+  end
+end
+
+ActionController::Base.class_eval do
+  include RulesEngine::ControllerUsers
+end

data/lib/rules_engine_users.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/controller_users")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/controller_user_mail")
+
+

data/rails_generators/USAGE

@@ -0,0 +1,97 @@
+***************************************************************************
+
+*** EDIT config/routes.rb
+  map.root :controller => 'preview', :action => 'index' # only if map.root not set
+
+  map.with_options :controller => 'users', :path_prefix => '/user', :name_prefix => 'user_' do |user|
+    user.login  '/',                  :action => 'login_form',       :conditions => { :method => :get }
+    user.login  '/',                  :action => 'login',            :conditions => { :method => :post }
+    user.logout '/logout',            :action => 'logout'
+    user.pswd_forgot '/pswd_forgot',  :action => 'pswd_forgot_form', :conditions => { :method => :get }
+    user.pswd_forgot '/pswd_forgot',  :action => 'pswd_forgot',      :conditions => { :method => :post }
+    user.pswd_change '/pswd_change',  :action => 'pswd_change_form', :conditions => { :method => :get }
+    user.pswd_change '/pswd_change',  :action => 'pswd_change',      :conditions => { :method => :post }
+    user.details   '/user_details',   :action => 'user_details',     :conditions => { :method => :get }   
+    user.change '/user_change',       :action => 'user_change_form', :conditions => { :method => :get }
+    user.change '/user_change',       :action => 'user_change',      :conditions => { :method => :put }
+    user.pswd_reset  '/pswd_reset',   :action => 'pswd_reset_form',  :conditions => { :method => :get }
+    user.pswd_reset  '/pswd_reset',   :action => 'pswd_reset',       :conditions => { :method => :post }    
+    user.welcome  '/welcome',         :action => 'welcome_form',     :conditions => { :method => :get }
+    user.welcome  '/welcome',         :action => 'welcome',          :conditions => { :method => :post }    
+  end  
+
+  map.namespace :admin do |admin|
+    admin.resources :users, :controller => 'users'
+  end
+  
+*** EDIT config/environment.rb
+  config.gem 'will_paginate'
+  config.gem 'dougo_view_helpers'
+  config.gem 'dougo_model_helpers'
+  config.gem 'dougo_user_helpers'
+  
+  config.active_record.observers = :user_observer  
+
+ActionController::Base.define_access_level(:more_access,   70)
+ActionController::Base.define_access_level(:less_access,   60)
+
+*** EDIT config/environments/producton.rb
+  ActionMailer::Base.delivery_method = :smtp
+  ActionMailer::Base.smtp_settings = {
+    :address => '...',
+    :port => 25,
+    . . .  
+  }
+
+  Dougo::ControllerUserMail.host =   'domain.com'
+  Dougo::ControllerUserMail.from =   'domain.com'
+  Dougo::ControllerUserMail.prefix = 'My Cool App'
+
+
+*** EDIT config/environments/test.rb
+
+  config.gem 'cucumber-rails',   :lib => false, :version => '>=0.3.0'
+  config.gem 'database_cleaner', :lib => false, :version => '>=0.5.0'
+  config.gem 'webrat',           :lib => false, :version => '>=0.7.0'
+
+  config.gem "rspec",             :version => '>=1.3.0', :lib => false
+  config.gem "rspec-rails",       :version => '>=1.3.2', :lib => false
+  config.gem "faker",             :version => '>=0.3.1', :lib => false
+
+  config.gem "machinist",         :version => '>=1.0.6', :lib => false
+  config.gem 'rcov',              :version => '>=0.9.8', :lib => false
+  config.gem 'remarkable_rails',  :version => '>=3.1.13', :lib => false
+
+  require 'machinist/active_record'
+  require 'sham'
+  require 'faker'
+  require 'remarkable_rails'
+
+*** EDIT spec/spec_helper.rb
+  Spec::Runner.configure do |config|
+    ...
+  
+    config.before(:each, :behaviour_type => :controller) do
+      @controller.instance_eval { flash.stub!(:sweep) }
+    end  
+  
+*** RUN rake db:migrate
+
+*** EDIT app/views/preview/index.html.erb
+  <h1>User Pages</h1>
+  <ul>
+    <li><a href='/user/'>Login</a></li>
+    <li><a href='/user/logout'>Logout</a></li>
+    <li><a href='/user/user_details'>Your Details</a></li>
+    <li><a href='/user/pswd_forgot'>Password Forgot</a></li>
+    <li><a href='/user/pswd_change'>Password Change</a></li>
+    <li><a href='/user/pswd_reset'>Password Reset (Check logs for reset token)</a></li>
+    <li><a href='/user/welcome'>User Welcome (Check logs for reset token)</a></li>    
+    <li></li>
+    <li><a href='/admin/users'>Admin Users</a></li>
+  </ul>
+
+restart app and goto http://localhost:3000/preview  
+
+**************************************************************************
+

data/rails_generators/manifests/rules_engine_users.rb

@@ -0,0 +1,79 @@
+class RulesEngineUsersManifest
+  def self.populate_record(m)
+
+    %W(
+      app/controllers
+      app/controllers/admin
+      app/models
+      app/views/admin/users
+      app/views/user_mailer
+      app/views/users
+      db/migrate
+      doc
+      features/admin/user
+      features/admin/user/step_definitions
+      features/support
+      features/user
+      features/user/step_definitions
+      spec/controllers
+      spec/controllers/admin
+      spec/models
+      spec/support
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+      app/controllers/admin/users_controller.rb
+      app/controllers/users_controller.rb
+      app/models/user.rb
+      app/models/user_mailer.rb
+      app/models/user_observer.rb
+      app/views/admin/users/_form.html.erb
+      app/views/admin/users/edit.html.erb
+      app/views/admin/users/index.html.erb
+      app/views/admin/users/new.html.erb
+      app/views/admin/users/show.html.erb
+      app/views/user_mailer/forgot_password.html.erb
+      app/views/user_mailer/welcome_message.html.erb
+      app/views/users/change_form.html.erb
+      app/views/users/details.html.erb
+      app/views/users/login_form.html.erb
+      app/views/users/pswd_change_form.html.erb
+      app/views/users/pswd_forgot_form.html.erb
+      app/views/users/pswd_reset_form.html.erb
+      app/views/users/welcome_form.html.erb
+      db/migrate/20100104014507_create_users.rb
+      doc/README.rules_engine_users
+      doc/README.rules_engine_users_paths
+      features/admin/user/edit.feature
+      features/admin/user/index.feature
+      features/admin/user/new.feature
+      features/admin/user/show.feature
+      features/admin/user/step_definitions/edit_steps.rb
+      features/admin/user/step_definitions/index_steps.rb
+      features/admin/user/step_definitions/show_steps.rb
+      features/support/blueprint_users.rb
+      features/user/change.feature
+      features/user/details.feature
+      features/user/login.feature
+      features/user/pswd_change.feature
+      features/user/pswd_forgot.feature
+      features/user/pswd_reset.feature
+      features/user/step_definitions/login_steps.rb
+      features/user/step_definitions/pswd_reset_steps.rb
+      features/user/step_definitions/welcome_steps.rb
+      features/user/welcome.feature
+      spec/controllers/admin/users_controller_spec.rb
+      spec/controllers/users_controller_spec.rb
+      spec/models/user_mailer_spec.rb
+      spec/models/user_observer_spec.rb
+      spec/models/user_spec.rb
+      spec/support/rules_engine_macros.rb
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+
+  end
+end

data/rails_generators/manifests/rules_engine_users.yml

@@ -0,0 +1,32 @@
+contents :
+  - app/views/admin/users  
+  - app/views/user_mailer
+  - app/views/users
+
+  - features/user
+  - features/admin/user
+    
+files :  
+  - doc/README.rules_engine_users
+  - doc/README.rules_engine_users_paths
+
+  - app/controllers/users_controller.rb
+
+  - app/controllers/admin/users_controller.rb
+        
+  - app/models/user.rb          
+  - app/models/user_mailer.rb   
+  - app/models/user_observer.rb
+
+  - db/migrate/20100104014507_create_users.rb
+
+  - spec/controllers/users_controller_spec.rb
+  - spec/controllers/admin/users_controller_spec.rb
+  
+  - spec/models/user_spec.rb
+  - spec/models/user_mailer_spec.rb
+  - spec/models/user_observer_spec.rb
+
+  - spec/support/rules_engine_macros.rb
+  
+  - features/support/blueprint_users.rb

data/rails_generators/rules_engine_users_generator.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/manifests/rules_engine_users')
+
+class RulesEngineUsersGenerator < Rails::Generator::Base
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+
+  def after_generate
+    puts ''
+    puts '******************************************************'
+    puts 'open doc/README.rules_engine_users for more instructions'
+    puts ''
+  end
+
+  def manifest
+    record do |m|
+      RulesEngineUsersManifest.populate_record(m)
+    end
+  end
+end

data/rails_generators/templates/app/controllers/admin/users_controller.rb

@@ -0,0 +1,64 @@
+class Admin::UsersController < ApplicationController    
+
+  # before_filter :login_required
+  before_filter :admin_access_required  
+
+  before_filter :only => [:show, :edit, :update, :destroy] do |controller|
+    controller.re_load_model :user, {:param_id => :id, :redirect_path => :admin_users_path}
+  end
+
+  def index
+    klass = User
+    
+    if params[:query_type] == 'email'
+      klass = klass.by_ge_email(params[:query]) unless params[:query].blank?
+      klass = klass.order_email
+    elsif params[:query_type] == 'login'
+      klass = klass.by_ge_login(params[:query]) unless params[:query].blank?
+      klass = klass.order_login
+    elsif params[:query_type] == 'full_name'
+      klass = klass.by_ge_full_name(params[:query]) unless params[:query].blank?
+      klass = klass.order_full_name
+    else
+      klass = klass.order_full_name
+    end    
+
+    @users = klass.paginate(:page => params[:page], :per_page => 20)
+  end
+
+  def show
+  end
+
+  def new
+    @user = User.new(:time_zone => 'Eastern Time (US & Canada)', :access_level => User::ACCESS_LEVEL_DISABLED)
+  end
+
+  def create
+    @user = User.new(params[:user])    
+    if @user.save
+      flash[:success] = "Welcome email sent to new user"
+      redirect_to(admin_user_path(@user))
+    else
+      render :action => "new"
+    end
+  end
+
+  def edit    
+  end
+
+  def update
+    if @user.update_attributes(params[:user])
+      flash[:success] = 'User Updated'
+      redirect_to(admin_user_path(@user))
+    else
+      render :action => "edit"
+    end
+  end
+
+  def destroy
+    @user.destroy
+    flash[:success] = 'User Deleted'
+    redirect_to(admin_users_path)
+  end
+  
+end