mcms_authentication 0.0.2

data/app/controllers/users_controller.rb

@@ -0,0 +1,202 @@
+=begin
+
+  @File Name                            :users_controller.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This controller is responsible for managing users
+
+=end
+
+class UsersController <  Devise::RegistrationsController # inheriting Devise::Registrations controller to override the actions(CRUDS user)
+
+
+  prepend_before_filter :authenticate_user! # Obvious need of authetication before proceeding
+
+  load_and_authorize_resource # authorized users are allowed for the operations
+
+
+  # The following line seems to be redundant as we already said that every action requires authentication.
+  # But its actually not.We need to override devise behaviour to sign up non-logged in user.Here it needs a logged in user  
+  prepend_before_filter :require_no_authentication, :except => [ :new,:index, :create,:edit,:destroy_user,:update ]
+
+  layout HOME_LAYOUT # using a layout
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned GET mcms/users
+  #  @Purpose                              : Showing all existing users
+  
+  def index
+
+    @users = User.all # Selecting all users
+    
+    respond_to do |f|
+
+      f.html # HTML response
+
+      f.json {render :json => @users} # JSON response
+      
+    end
+    
+  end
+
+ 
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned GET mcms/users/new
+  #  @Purpose                              : Instantiating a new user
+
+  def new
+
+    @all_roles = Role.all # Roles needs to be there to select
+
+    super # else is upto devise
+    
+  end
+
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned POST mcms/users/
+  #  @Purpose                              : Creating a new user
+
+  def create
+    
+    build_resource # This helper is defined in devise which is building the resource (here user) so that we can have resource to be accessed here
+
+
+    @all_roles = Role.all # fetch all roles
+
+    if resource.save # saving the resource (here user)
+      
+      if resource.active_for_authentication? # (we are not bother about active which is done after confirmation.In our case user is active upon registartion.No confirmation is needed. )
+
+        # saving the roles
+
+        @all_roles.each do |role|
+
+          tmp = role.id.to_s + VALUE
+          
+         
+
+          RolesUser.create!(:user_id => resource.id , :role_id => Role.find_by_title(role.title).id) if params[tmp] == "1"
+         
+        end
+
+        flash[:notice] = t(:user_create_success,:user_email => resource.email ,:default => "#{resource.email} successfully created")
+        
+        redirect_to mcms_users_path
+      else
+
+        @all_roles.each do |role|
+
+          tmp = role.id.to_s + VALUE
+
+          RolesUser.create!(:user_id => resource.id , :role_id => Role.find_by_title(role.title).id) if params[tmp] == "1"
+
+        end
+        
+        set_flash_message :notice, :"signed_up_but_#{resource.inactive_message}" if is_navigational_format?
+
+        expire_session_data_after_sign_in!
+
+        respond_with resource, :location => after_inactive_sign_up_path_for(resource)
+        
+      end
+      
+    else
+      
+      clean_up_passwords resource
+      
+      respond_with resource
+      
+    end
+    
+  end
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned POST mcms/users/1/edit
+  #  @Purpose                              : Editing an existing user
+
+  def edit
+    
+    @all_roles = Role.all
+     
+    @user = User.find(params[:id]) # finding the user to be edited
+    
+    respond_to do |f|
+      f.html   #HTML response
+      f.json {render :json => @user} # JSON response
+    end
+    
+  end
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned POST mcms/users/1/edit
+  #  @Purpose                              : Updating an existing user
+
+  def update
+   
+    @user = User.find(params[:id]) # Finding the user to be updated
+
+    @all_roles = Role.all
+
+    # Following we are checking whether password field is kept blank ;so the old password stays.
+
+    params[:user].delete(:password) if params[:user][:password].blank?
+
+    params[:user].delete(:password_confirmation) if params[:user][:password].blank? and params[:user][:password_confirmation].blank?
+
+    # Updating the attributes of users
+
+    if @user.update_attributes(params[:user])
+
+      # Assigning updated roles
+      
+      @all_roles.each do |role|
+
+        tmp = role.id.to_s + VALUE
+
+        RolesUser.create!(:user_id => resource.id , :role_id => Role.find_by_title(role.title).id) if params[tmp] == "1" && RolesUser.find_by_role_id_and_user_id(Role.find_by_title(role.title).id,resource.id).nil?
+
+      end
+        
+      flash[:notice] = t(:user_update_success,:user_email => @user.email,:default => "#{@user.email} successfully updated")
+      
+      redirect_to mcms_users_path
+
+    else
+
+      render :action => 'edit'
+
+    end
+
+
+  end
+
+  # If the user needs to be destroyed
+  
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned DELETE mcms/users/1
+  #  @Purpose                              : Destroying an existing user
+
+  def destroy_user
+    
+    @user = User.find(params[:id]) # Find the user to be destroyed
+   
+    @user.destroy # destroy it
+
+    flash[:notice] = t(:user_destroy_success,:user_email => @user.email,:default => "#{@user.email} successfully deleted")
+
+    redirect_to mcms_users_path #go to all users list 
+    
+  end
+
+  
+end

data/app/models/ability.rb

@@ -0,0 +1,82 @@
+=begin
+
+  @File Name                            :ability.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This class is responsible for defining the abilities
+                                         of a particular user/current user
+
+=end
+
+class Ability
+
+  #including Cancan ability module
+  
+  include CanCan::Ability
+
+  #including Models module from lib/mcms_authentication/models.rb
+  
+  include Models
+
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned 
+  #  @Purpose                              : Managing user roles
+  
+  def initialize(user)
+    
+    #fetching all the roles of current user    
+    roles = Role.fetch_roles user
+    
+    
+  #defining abilities of current user
+  
+    roles.each do |role|
+      
+      can :manage, :all if role == "superuser"
+
+      # plugin access for a particular user role      
+      @accessible_plugins = Plugin.find_all_by_role_id(Role.find_by_title(role).id)
+
+      
+      
+      @accessible_plugins.each do |plugin|
+
+        
+        
+      #  models = get_relations plugin.role_module # getting associated models
+
+          models = ExistingModel.find_all_by_plugin_name(plugin.role_module.to_s)
+          
+        models.each do |model|
+
+          
+          # defining access control 
+         
+          can :read , model.model_name.constantize if plugin.role_read? # setting read authorization
+
+          can :create , model.model_name.constantize if plugin.role_create? # setting create authorization
+
+          can :update , model.model_name.constantize if plugin.role_update? # setting update authorization
+
+          can :destroy , model.model_name.constantize if plugin.role_destroy?  # setting destroy authorization
+
+          can :manage , model.model_name.constantize if plugin.role_manage?  # setting manage authorization
+
+        end
+        
+      end
+
+    end
+    
+  end
+end

data/app/models/existing_model.rb

@@ -0,0 +1,24 @@
+=begin
+
+  @File Name                            :application_controller.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-25
+
+  @Date Modified                        :2012-06-25
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This model is storing models related to plugins
+
+=end
+class ExistingModel < ActiveRecord::Base
+  
+  attr_accessible :plugin_name, :model_name
+  
+  self.table_name = "mcms_existing_models"
+  
+end

data/app/models/plugin.rb

@@ -0,0 +1,30 @@
+=begin
+
+  @File Name                            :plugin.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This model is responsible for defining logic tracking
+                                         access control of a particular module for a particular
+                                         role
+
+=end
+
+class Plugin < ActiveRecord::Base
+
+
+  self.table_name = 'mcms_plugins' # setting my custome table name with this model (required to be declared here/not in application.rb as it is limited to my gem)
+
+  attr_accessible :id, :role_module , :role_read , :role_create , :role_update , :role_destroy , :role_manage , :role_id
+
+  belongs_to :role # it belongs to role
+  
+end

data/app/models/role.rb

@@ -0,0 +1,70 @@
+=begin
+
+  @File Name                            :role.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This model is required for logic set of role related data
+
+=end
+
+class Role < ActiveRecord::Base
+  
+  self.table_name = 'mcms_roles' # setting my custome table name with this model (required to be declared here/not in application.rb as it is limited to my gem)
+
+  # it is associated with HABTM association to User model
+  
+  attr_accessible :title
+
+  has_many :roles_users 
+  
+  has_many :users, :through => :roles_users
+
+  has_many :plugins
+
+  # each role needs an unique title
+  
+  validates :title,:presence => true , :uniqueness => true
+
+  
+  #  @Params                               : Hash
+  #  @Returns                              : Array
+  #  @Purpose                              : This class method is responsible for fetching an user's roles
+
+  def self.fetch_roles user 
+  
+    roles = []
+
+    i = 0
+
+    if user.present?
+
+      if user.roles.present?
+
+        user.roles.each do |user_role|
+
+          roles[i] = user_role.title
+
+          i = i + 1
+
+        end
+
+      end
+      
+    end
+
+    
+    roles # returning the roles array
+
+  end
+
+  
+end

data/app/models/roles_user.rb

@@ -0,0 +1,33 @@
+=begin
+
+  @File Name                            :role.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This model is required for logic set of role user relation
+
+=end
+
+
+class RolesUser < ActiveRecord::Base
+  
+  # Join table/model for User and Role HABTM association
+  
+  self.table_name = 'mcms_roles_users'  # setting my custome table name with this model (required to be declared here/not in application.rb as it is limited to my gem)
+
+  attr_accessible :user_id , :role_id
+
+  belongs_to :user
+  
+  belongs_to :role
+
+   
+end

data/app/models/user.rb

@@ -0,0 +1,90 @@
+=begin
+
+  @File Name                            :role.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-14
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :The User model is responsible for tracking all the users logics
+                                         rules to be imposed on users crud
+
+=end
+
+class User < ActiveRecord::Base
+  
+  self.table_name = 'mcms_users' # setting my custome table name with this model (required to be declared here/not in application.rb as it is limited to my gem)
+
+
+  # The user model is added with  the following devise functionalities
+  
+  devise :database_authenticatable, :registerable,
+    :recoverable, :rememberable, :trackable, :validatable ,:token_authenticatable,
+    :lockable, :timeoutable
+
+  # every functionality is self explanatory
+
+  # for mass assignment we need the attributes to be accessible
+  
+  attr_accessible :email, :first_name,:last_name,:password, :password_confirmation, :remember_me , :utf8, :_method, :authenticity_token, :user, :id, :commit, :action, :controller, :format
+
+ 
+
+  #  @Params                               : Nothing
+  #  @Returns                              : Nothing
+  #  @Purpose                              : Cleaning up passwords
+
+  def clean_up_passwords
+
+    self.password = self.password_confirmation = nil
+
+  end
+
+  # HABTM association between Role and User model
+
+  has_many :roles_users
+  
+  has_many :roles, :through => :roles_users
+
+
+  #  @Params                               : String
+  #  @Returns                              : Boolean
+  #  @Purpose                              : whether the user has the passed role
+  
+  def has_role? role_title
+    
+    if self.roles.present?
+    
+    self.roles.each do |role|
+
+        if role.title == role_title
+
+          return true
+
+        else
+
+          return false
+
+        end
+
+    end
+
+    else
+
+      return false
+
+    end
+    
+  end
+
+
+  
+
+  
+end