mcms_authentication 0.0.2

data/config/locales/devise.en.yml

@@ -0,0 +1,57 @@
+# Additional translations at https://github.com/plataformatec/devise/wiki/I18n
+
+en:
+  errors:
+    messages:
+      expired: "has expired, please request a new one"
+      not_found: "not found"
+      already_confirmed: "was already confirmed, please try signing in"
+      not_locked: "was not locked"
+      not_saved:
+        one: "1 error prohibited this %{resource} from being saved:"
+        other: "%{count} errors prohibited this %{resource} from being saved:"
+
+  devise:
+    failure:
+      already_authenticated: 'You are already signed in.'
+      unauthenticated: 'You need to sign in or sign up before continuing.'
+      unconfirmed: 'You have to confirm your account before continuing.'
+      locked: 'Your account is locked.'
+      invalid: 'Invalid email or password.'
+      invalid_token: 'Invalid authentication token.'
+      timeout: 'Your session expired, please sign in again to continue.'
+      inactive: 'Your account was not activated yet.'
+    sessions:
+      signed_in: 'Signed in successfully.'
+      signed_out: 'Signed out successfully.'
+    passwords:
+      send_instructions: 'You will receive an email with instructions about how to reset your password in a few minutes.'
+      updated: 'Your password was changed successfully. You are now signed in.'
+      updated_not_active: 'Your password was changed successfully.'
+      send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
+    confirmations:
+      send_instructions: 'You will receive an email with instructions about how to confirm your account in a few minutes.'
+      send_paranoid_instructions: 'If your email address exists in our database, you will receive an email with instructions about how to confirm your account in a few minutes.'
+      confirmed: 'Your account was successfully confirmed. You are now signed in.'
+    registrations:
+      signed_up: 'Welcome! You have signed up successfully.'
+      signed_up_but_unconfirmed: 'A message with a confirmation link has been sent to your email address. Please open the link to activate your account.'
+      signed_up_but_inactive: 'You have signed up successfully. However, we could not sign you in because your account is not yet activated.'
+      signed_up_but_locked: 'You have signed up successfully. However, we could not sign you in because your account is locked.'
+      updated: 'You updated your account successfully.'
+      update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and click on the confirm link to finalize confirming your new email address."
+      destroyed: 'Bye! Your account was successfully cancelled. We hope to see you again soon.'
+    unlocks:
+      send_instructions: 'You will receive an email with instructions about how to unlock your account in a few minutes.'
+      unlocked: 'Your account has been unlocked successfully. Please sign in to continue.'
+      send_paranoid_instructions: 'If your account exists, you will receive an email with instructions about how to unlock it in a few minutes.'
+    omniauth_callbacks:
+      success: 'Successfully authenticated from %{kind} account.'
+      failure: 'Could not authenticate you from %{kind} because "%{reason}".'
+    mailer:
+      confirmation_instructions:
+        subject: 'Confirmation instructions'
+      reset_password_instructions:
+        subject: 'Reset password instructions'
+      unlock_instructions:
+        subject: 'Unlock Instructions'

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"
+  sign_in: "Hi,Please Sign in"
+  default_uname: "The default email and password are both"
+  user_update_success: "%{user_email} updated successfully."
+  user_destroy_success: "%{user_email} successfully deleted."
+  user_create_success: "%{user_email} successfully created."

data/config/routes.rb

@@ -0,0 +1,24 @@
+Rails.application.routes.draw do
+   devise_for :users , :controllers => {:registrations => "users"} do
+
+    # giving mcms namespace /prefix
+
+    get "mcms/users/login",:to => "devise/sessions#new"
+    get "mcms/users/logout",:to => "devise/sessions#destroy"
+    get "mcms/users",:to => "users#index"
+    get "mcms/users/new",:to => "users#new"
+    post "mcms/users", :to => "users#create"
+    get "mcms/users/edit/:id",:to => "users#edit"
+    put "mcms/update_user",:to => "users#update"
+    delete "mcms/destroy_user",:to => "users#destroy_user"
+
+  end
+
+  resources :users, :controller => "users"
+
+  resources :roles ,:path => 'mcms/role' # with proper namespace/prefix
+
+  match "mcms/roles",:to => "roles#index" # namespacing roles
+
+  root :to => "home#index" # home page
+end

data/db/migrate/20120605112804_devise_create_users.rb

@@ -0,0 +1,68 @@
+=begin
+
+  @File Name                            :timestamp_devise_create_user.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-25
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :Migrations to create users
+
+=end
+
+class DeviseCreateUsers < ActiveRecord::Migration
+  
+  def change
+    
+    create_table(:mcms_users) do |t|
+      ## Database authenticatable
+      t.string :email,              :null => false, :default => ""
+      t.string :encrypted_password, :null => false, :default => ""
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Confirmable
+       t.string   :confirmation_token
+       t.datetime :confirmed_at
+       t.datetime :confirmation_sent_at
+       t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+       t.integer  :failed_attempts, :default => 0 # Only if lock strategy is :failed_attempts
+       t.string   :unlock_token # Only if unlock strategy is :email or :both
+       t.datetime :locked_at
+
+      ## Token authenticatable
+       t.string :authentication_token
+
+
+      t.timestamps
+    end
+
+     add_index :mcms_users, :email,                :unique => true
+     add_index :mcms_users, :reset_password_token, :unique => true
+     add_index :mcms_users, :confirmation_token,   :unique => true
+     add_index :mcms_users, :unlock_token,         :unique => true
+     add_index :mcms_users, :authentication_token, :unique => true
+     
+  end
+  
+end

data/db/migrate/20120608104637_create_roles.rb

@@ -0,0 +1,30 @@
+=begin
+******************************************************************************************************************
+
+  FileName:                                          20120608104637_devise_create_users.rb
+
+	Company Name and Copyright information:            Mindfire Solutions Pvt. Ltd.
+
+	Creator name and date:                             Indranil Mukherjee 08/06/2012
+
+	Description of the file contents:                  This is the migration file for creating role table for users
+                                                     In our case mcms_roles
+
+******************************************************************************************************************
+=end
+
+class CreateRoles < ActiveRecord::Migration
+
+  def change
+    
+    create_table :mcms_roles do |t|
+
+      t.string :title # only title column
+      
+      t.timestamps
+
+    end
+
+  end
+  
+end

data/db/migrate/20120608140424_create_roles_users.rb

@@ -0,0 +1,25 @@
+=begin
+******************************************************************************************************************
+
+  FileName:                                          20120608140424_devise_create_users.rb
+
+	Company Name and Copyright information:            Mindfire Solutions Pvt. Ltd.
+
+	Creator name and date:                             Indranil Mukherjee 08/06/2012
+
+	Description of the file contents:                  This is the migration file for creating roles_users table
+                                                     which is a join table for users and roles
+                                                     In our case mcms_roles_users
+
+******************************************************************************************************************
+=end
+
+class CreateRolesUsers < ActiveRecord::Migration
+  def change
+    create_table :mcms_roles_users do |t|
+      t.belongs_to :user
+      t.belongs_to :role
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120612050932_create_plugins.rb

@@ -0,0 +1,14 @@
+class CreatePlugins < ActiveRecord::Migration
+  def change
+    create_table :mcms_plugins do |t|
+      t.string :role_module
+      t.boolean :role_read
+      t.boolean :role_create
+      t.boolean :role_update
+      t.boolean :role_destroy
+      t.boolean :role_manage
+      t.belongs_to :role
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120625114340_create_existing_models.rb

@@ -0,0 +1,9 @@
+class CreateExistingModels < ActiveRecord::Migration
+  def change
+    create_table :mcms_existing_models do |t|
+      t.string :plugin_name
+      t.string :model_name
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120711064709_add_username_to_users.rb

@@ -0,0 +1,9 @@
+class AddUsernameToUsers < ActiveRecord::Migration
+  def change
+
+    add_column :mcms_users, :first_name, :string
+
+    add_column :mcms_users, :last_name, :string
+    
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,29 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
+#   Mayor.create(name: 'Emanuel', city: cities.first)
+#writting seeds 
+#puts "Enter admin user"
+#a = gets.chomp
+            
+#puts "Enter password"
+
+#b = gets.chomp
+
+User.create!(:email => 'admin@mcms.com' ,:password => 'admin123' )
+
+Role.create!(:title => 'superuser')
+
+
+u = User.find_by_email('admin@mcms.com')
+
+
+r = Role.find_by_title('superuser')
+
+
+RolesUser.create!(:user_id => u.id , :role_id => r.id)
+
+      

data/lib/generators/mcms_authentication/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate mcms_authentication Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/mcms_authentication/mcms_authentication_generator.rb

@@ -0,0 +1,110 @@
+=begin
+
+  @File Name                            :mcms_authentication_generator.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-14
+
+  @Date Modified                        :2012-06-25
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :This file is responsible to install mcms_authentication module in other application/module
+
+=end
+
+class McmsAuthenticationGenerator < Rails::Generators::NamedBase
+  
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "Installing MCMS_AUTHENTICATION"
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned 
+  #  @Purpose                              : Copies all the migrations
+
+  def add_migrations
+
+    say "Copying migrations........."
+
+    rake("mcms_authentication_engine:install:migrations")
+
+    # create file deb/seeds.rb to parent app if not exists
+      create_file "db/seeds.rb" unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+
+      # append data to app's seeds.rb
+      append_file 'db/seeds.rb', :verbose => true do
+
+        <<-EOH
+
+        McmsAuthentication::Engine.load_seed
+
+        EOH
+
+      end # end block
+  
+  end
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned 
+  #  @Purpose                              : Copies all the libraries required
+
+  def copy_core_libraries
+
+    copy_file "models.rb", "lib/mcms_authentication/models.rb" # module logic
+    
+  end
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned
+  #  @Purpose                              : Configurations are done here
+  
+  def configure
+
+    insert_into_file File.join('app/controllers', 'application_controller.rb'), :after => "ActionController::Base\n" do
+
+
+      ' 
+        include ApplicationHelper #including application_helper for the availability of filters
+        #  The following snippet is responsible for rescuing from exception generated by CanCan gem
+                  #  for denying a particular module access with a notice to user and redirecting to root_url
+                  rescue_from CanCan::AccessDenied do |exception|
+
+                       flash[:error] = t(:access_denied,:default => "You are not authorized for doing this operation")
+                  redirect_to root_url
+
+                  end
+
+          #end of configuration
+
+      '
+    end
+    
+  end
+
+  #  @Params                               : No parameter
+  #  @Returns                              : Nothing is returned 
+  #  @Purpose                              : Final instructions for developers who will use the gem
+
+  def prompt_user
+
+    say "\ndon't forget to run the following \n
+          
+          rake db:migrate\n
+          rake db:seed\n
+
+          in the controllers where you want to apply auth\n
+
+          prepend_before_filter :authenticate_user!  \n
+
+          load_and_authorize_resource  \n
+
+          Enjoy!\n\n"
+    
+  end
+
+  
+end

data/lib/generators/mcms_authentication/templates/asset_manager.rb

@@ -0,0 +1,117 @@
+=begin
+
+  @File Name                            :asset_manager.rb
+
+	@Company Name                         :Mindfire Solutions Pvt. Ltd.
+
+	@Creator Name                         :Indranil Mukherjee
+
+	@Date Created                         :2012-06-04
+
+  @Date Modified                        :2012-06-15
+
+  @Last Modification Details            :Making it as mcms project standard
+
+  @Purpose                              :Dynamically include assets
+
+=end
+
+class AssetManager
+
+  #Class methods start here
+
+  #include_css
+  #checking the file type if array then loop to include neither simple includes
+  def self.include_css file
+    if file.class == Array
+      file.each do |f|
+        include_css_file_individual f
+      end
+    else
+      include_css_file_individual file
+    end
+  end
+
+  #include_contrib_library
+  #includes the javascripts in contrib folder those are the mandatory libraries
+  def self.include_contrib_library library
+    include_js_library library, :contrib
+  end
+
+
+  #include_local_library method
+  #includes the javascripts those are localy added
+  def self.include_local_library library
+    include_js_library library, :local
+  end
+
+  #include_js_library method
+  #includes the javascripts those are localy added
+  def self.include_js_library library, type = :local
+    Rails.logger.debug library.inspect
+    if library.class == Array
+      library.each do |l|
+        include_js_library_individual l, type
+      end
+    else
+      include_js_library_individual library, type
+    end
+  end
+
+
+  #get_libraries method
+  #return all javscripts included array
+  def self.get_libraries
+    return @@js_includes
+  end
+
+  #get_css method
+  #return css_includes array
+  #gloabal varibale
+  def self.get_css
+    return @@css_includes
+  end
+
+  #Private methods started here
+  private
+  @@js_includes = []
+  @@css_includes = []
+
+  #Pushing javascript libraries in the gloabal @@js_includes variable
+  def self.include_js_library_individual library, type
+
+    file = ""
+
+    case type
+      when :local
+        if library.class == Symbol
+          file = library.to_s + ".js"
+        else
+          file = library
+        end
+      when :contrib
+        file = "contrib/" + @@libraries[library]
+    end
+
+    @@js_includes << file unless file.blank? or @@js_includes.include? file
+
+  end
+
+#pushing individual css files
+  def self.include_css_file_individual file
+
+    if file.class == Symbol
+      file = file.to_s + '.css'
+    end
+
+    @@css_includes << file  unless file.blank? or @@css_includes.include? file
+  end
+
+#Registering javascript libraries
+  @@libraries = {
+    :core_ui            => "ui.core.js",
+    :jquery_widget      => "ui.widget.js",
+    :jquery_tab         => "ui.tabs.js"
+  }
+
+end