usman 0.1.5 → 0.1.6dev2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a630b45bb4de548d1b215cce4650ee42985682a1
-  data.tar.gz: b634c8f8410fc48d28e622f823efdfb546f86b15
+  metadata.gz: 9ec7d0671d92ce351c4882f0bbe8857fdcb18ab2
+  data.tar.gz: 81c5d13af42fd0ae271e5c4a68ec6fe117164154
 SHA512:
-  metadata.gz: 190ac35f562e78b71ed702b800c543a307155fd558d0014b5ad38480335d799f305e0fdd12a35b3bcac7c03160222b0c590226c2859eea8af9ac69a1c7169bbc
-  data.tar.gz: e018c0a66b0b40fe71e42d9251cfa3017aef88584460b39b5ba9f61886d4f1f1ad57f91ce1205c8da83bedc12e9dfa585e39b8a38d17a992d2316d4cfc34e047
+  metadata.gz: 67cd7e26738632cc4a3fc1ca72f3cc4c512b2578ee1a988a950f331e746b3510b8a4dee7102bd4a60579f884339691df99edda6a8d5abb00fec7e0cac35a5345
+  data.tar.gz: da160eabaa5d3927601dc1b1cd546ff569b07ba47ae773cb1e66efec27c58c25f41a87248f5fd97ea9af82c069aa4245c623c26fdfba3d114c1874e2f9257248

data/README.md

@@ -1,7 +1,7 @@
 # Usman
-Simple User & Feature Permission Management
 
-## Usage
+Simple User & Feature Permission Management with APIs.
+
 Usman is a mountable plugin and it requires another full pluggin named kuppayam to run. Kuppayam offers usman the UI skin with basic modules for running like Polymorphic Image and Document Models etc.
 
 ## Installation
@@ -21,23 +21,19 @@ Or install it yourself as:
 $ gem install usman
 ```
 
-# Installation Instructions
+# Usage
 
-## Copy the migrations
+## Installing the kuppayam & usman migrations
 
-Copy the migrations from the engines you are using
-Run the below command 
+Usman uses kuppayam skins and hence it requires the basic migrations from kuppayam to run
+Run the below command to copy the migrations from the kuppayam engine.
 
 ```bash
 $ bundle exec rake railties:install:migrations
 ```
 
-This will copy migrations from kuppayam and usman engines
-which will have migrations to create images, documents, users, features and permissions respectively. 
-
-## Create Dummy Data 
+This will copy migrations from kuppayam and usman engines which will have migrations to create images, documents, users, features and permissions respectively. 
 
-run rake task for loading dummy data for users and features to start with.
 
 ## Mount the engine
 
@@ -49,23 +45,59 @@ mount Usman::Engine => "/"
 
 open browser and go to /sign_in url
 
+## Railties order
+
+Specify the railties order if required in main application.rb
+
+``
+config.autoload_paths << "app/services"
+config.railties_order = [:main_app, Usman::Engine, Kuppayam::Engine, :all]
+```
 
+# Seeding Data 
 
+run rake task for loading dummy data for users and features to start with.
 
 ```bash
 $ bundle exec rake usman:import:dummy:all verbose=false
 ```
 
+["users", "features", "permissions", "roles"]
 
+You could also do it individually but the above command will run in the following order - users, features, permissions, roles. This order is important as features need users to be imported first.
 
-## Specify the railties order if required
+```bash
+$ bundle exec rake usman:import:dummy:users verbose=false
+$ bundle exec rake usman:import:dummy:features verbose=false
+$ bundle exec rake usman:import:dummy:permissions verbose=false
+$ bundle exec rake usman:import:dummy:roles verbose=false
+```
 
-in main application.rb
+# Import Data
 
+You could override the seed files with your data.
+just create db/import_data in your project folder and create the following files filled with your data in the required format (checkout the dummy csvs in usman db/import_data/dummy/features.csv) for the columns required
+
+for e.g:
+
+create users.csv in db/import_data/ foler and fill data in it and run 
+
+```bash
+$ bundle exec rake usman:import:users verbose=false
 ```
-config.autoload_paths << "app/services"
-config.railties_order = [:main_app, Usman::Engine, Kuppayam::Engine, :all]
-```
+
+## Testing the gem
+
+cd spec/dummy
+rails db:create db:migrate
+
+rails s -p <port>
+
+## Running rspec
+rails db:create db:migrate RAILS_ENV
+
+# run rspec from the rails root folder and not from dummy folder as spec helper has been linked to dummy.
+rspec 
 
 
 ## Contributing

data/app/controllers/usman/admin/base_controller.rb

@@ -5,6 +5,7 @@ module Usman
       layout 'kuppayam/admin'
       
       before_action :require_user
+      before_action :require_site_admin
       
       private
 
@@ -12,6 +13,27 @@ module Usman
         set_title("Usman Admin | User Management Module")
       end
 
+      def require_site_admin
+        return true if @current_user && @current_user.super_admin?
+        unless @current_user && @current_user.has_role?("Site Admin")
+          respond_to do |format|
+            format.html {
+              #text = "#{I18n.t("authentication.permission_denied.heading")}: #{I18n.t("authentication.permission_denied.message")}"
+              #set_flash_message(text, :error, false) if defined?(flash) && flash
+              redirect_after_unsuccessful_authentication
+            }
+            format.js {
+              @params_hsh = {}
+              @params_hsh[:client_app] = params[:client_app] if params[:client_app]
+              @params_hsh[:redirect_back_url] = params[:redirect_back_url] if params[:redirect_back_url]
+              @params_hsh[:requested_url] = request.original_url if request.get?
+              
+              render(:partial => 'usman/sessions/sign_in.js.erb', :handlers => [:erb], :formats => [:js])
+            }
+          end
+        end
+      end
+
       def configure_filter_param_mapping
         @filter_param_mapping = default_filter_param_mapping
         @filter_param_mapping[:super_admin] = :sa

data/app/controllers/usman/admin/dashboard_controller.rb

@@ -10,7 +10,7 @@ module Usman
 
 	    def breadcrumbs_configuration
 	      {
-	        heading: "Usman Dashboard",
+	        heading: "User Dashboard",
 	        description: "A Quick view of users and roles",
 	        links: [{name: "Dashboard", link: admin_dashboard_path, icon: 'fa-dashboard'}]
 	      }

data/app/controllers/usman/admin/features_controller.rb

@@ -54,6 +54,8 @@ module Usman
 
       def resource_controller_configuration
         {
+          page_title: "Features",
+          js_view_path: "/kuppayam/workflows/parrot",
           view_path: "/usman/admin/features"
         }
       end
@@ -61,9 +63,10 @@ module Usman
       def breadcrumbs_configuration
         {
           heading: "Manage Features",
+          icon: "lincons-diamond",
           description: "Listing all Features",
           links: [{name: "Home", link: admin_dashboard_path, icon: 'fa-home'}, 
-                    {name: "Manage Features", link: admin_permissions_path, icon: 'fa-calendar', active: true}]
+                    {name: "Manage Features", link: admin_features_path, icon: 'fa-calendar', active: true}]
         }
       end
 

data/app/controllers/usman/admin/permissions_controller.rb

@@ -2,29 +2,20 @@ module Usman
   module Admin
     class PermissionsController < ResourceController
 
-      def index
-        @heading = "Manage Permissions"
-        @description = "Listing all permissions"
-        @links = [{name: "Dashboard", link: admin_dashboard_path, icon: 'fa-home'}, 
-                  {name: "Manage Permissions", link: admin_permissions_path, icon: 'fa-user', active: true}]
-        super
-      end
-
       def create
-        @permission = Permission.where(" user_id = ? AND feature_id = ? ", permitted_params[:user_id], permitted_params[:feature_id]).first || Permission.new
+        @permission = @r_object = Permission.where(" user_id = ? AND feature_id = ? ", permitted_params[:user_id], permitted_params[:feature_id]).first || Permission.new
         @permission.assign_attributes(permitted_params)
-        save_resource(@permission)
-
+        save_resource
         get_collections
       end
 
       def update
-        @permission = Permission.find_by_id(params[:id])
+        @permission = @r_object = Permission.find_by_id(params[:id])
         # The form will not submit can_create 0 if it is not selected
         # hence making it false by default and letting it update by itself.
         @permission.assign_attributes({"can_create": "0", "can_read": "0", "can_update": "0", "can_delete": "0"})
         @permission.assign_attributes(permitted_params)
-        save_resource(@permission)
+        save_resource
         get_collections
       end
 
@@ -36,7 +27,7 @@ module Usman
         parse_filters
         apply_filters
         
-        @permissions = @relation.includes(:user, :feature).page(@current_page).per(@per_page)
+        @permissions = @r_objects = @relation.includes(:user, :feature).page(@current_page).per(@per_page)
 
         return true
       end
@@ -65,13 +56,16 @@ module Usman
 
       def resource_controller_configuration
         {
-          view_path: "/demo/permissions"
+          page_title: "Permissions",
+          js_view_path: "/kuppayam/workflows/parrot",
+          view_path: "/usman/admin/permissions"
         }
       end
 
       def breadcrumbs_configuration
         {
           heading: "Manage Permissions",
+          icon: "fa-lock",
           description: "Listing all Permissions",
           links: [{name: "Home", link: admin_dashboard_path, icon: 'fa-home'}, 
                     {name: "Manage Permissions", link: admin_permissions_path, icon: 'fa-calendar', active: true}]

data/app/controllers/usman/admin/resource_controller.rb

@@ -4,7 +4,9 @@ module Usman
 
 	  	include ResourceHelper
 
-	    before_action :configure_resource_controller
+	    before_action :require_user
+	  	before_action :require_site_admin
+	  	before_action :configure_resource_controller
 
 	    def resource_url(obj)
 		    url_for([:admin, obj])

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

@@ -18,7 +18,7 @@ module Usman
       def apply_filters
         @relation = @relation.search(@query) if @query
         
-        @order_by = "created_at desc" unless @order_by
+        @order_by = "name ASC" unless @order_by
         @relation = @relation.order(@order_by)
       end
 
@@ -39,7 +39,8 @@ module Usman
 
       def resource_controller_configuration
         {
-          js_view_path: "/kuppayam/workflows/parrot",
+          page_title: "Roles",
+          js_view_path: "/kuppayam/workflows/peacock",
           view_path: "/usman/admin/roles"
         }
       end
@@ -47,6 +48,7 @@ module Usman
       def breadcrumbs_configuration
         {
           heading: "Manage Roles",
+          icon: "fa-lock",
           description: "Listing all Roles",
           links: [{name: "Home", link: admin_dashboard_path, icon: 'fa-home'}, 
                     {name: "Manage Roles", link: admin_roles_path, icon: 'fa-calendar', active: true}]

data/app/controllers/usman/admin/user_roles_controller.rb

@@ -0,0 +1,142 @@
+module Usman
+  module Admin
+    class UserRolesController < ResourceController
+
+      before_action :get_role
+      
+      def index
+        get_collections
+        respond_to do |format|
+          format.html {}
+          format.js  { 
+            js_view_path = @resource_options && @resource_options[:js_view_path] ? "#{@resource_options[:js_view_path]}/index" : :index 
+            render js_view_path
+          }
+        end
+      end
+
+      def show
+        @user = @r_object = @resource_options[:class].find_by_id(params[:id])
+        set_notification(false, I18n.t('status.error'), I18n.t('status.not_found', item: default_item_name.titleize)) unless @r_object
+        render_accordingly
+      end
+
+      def new
+        @user = User.new
+        render_accordingly
+      end
+
+      def create
+        @user = @r_object = User.find_by_id(permitted_params[:id])
+        if @user.add_role(@role)
+          set_notification(true, I18n.t('status.success'), "Role '#{@role.name}' has been assigned to the user '#{@user.name}'")
+        else
+          set_notification(false, I18n.t('status.success'), "Failed to assign the Role '#{@role.name}'")
+        end
+        action_name = params[:action].to_s == "create" ? "new" : "edit"
+        render_or_redirect(false, resource_url(@r_object), action_name)
+      end
+
+      def destroy
+        @user = @r_object = User.find_by_id(params[:id])
+        if @user
+          if @user.remove_role(@role)
+            get_collections
+            set_flash_message(I18n.t('success.deleted'), :success)
+            set_notification(true, I18n.t('status.success'), "Role '#{@role.name}' has been removed for the user '#{@user.name}'")
+            @destroyed = true
+          else
+            message = I18n.t('errors.failed_to_delete', item: default_item_name.titleize)
+            set_flash_message(message, :failure)
+            set_notification(false, I18n.t('status.success'), "Failed to remove the Role '#{@role.name}'")
+            @destroyed = false
+          end
+        else
+          set_notification(false, I18n.t('status.error'), I18n.t('status.not_found', item: default_item_name.titleize))
+        end
+
+        respond_to do |format|
+          format.html {}
+          format.js  { 
+            js_view_path = @resource_options && @resource_options[:js_view_path] ? "#{@resource_options[:js_view_path]}/destroy" : :destroy 
+            render js_view_path
+          }
+        end
+
+      end
+
+      private
+
+      def get_role
+        @role = Role.find_by_id(params[:role_id])
+      end
+
+      def get_collections
+        @relation = @role.users.where("")
+
+        parse_filters
+        apply_filters
+        
+        @users = @r_objects = @relation.page(@current_page).per(@per_page)
+        
+        return true
+      end
+
+      def apply_filters
+        @relation = @relation.search(@query) if @query
+        
+        @order_by = "name ASC" unless @order_by
+        @relation = @relation.order(@order_by)
+      end
+
+      def configure_filter_settings
+        @filter_settings = {
+          string_filters: [
+            { filter_name: :query }
+          ],
+          boolean_filters: [],
+          reference_filters: [],
+          variable_filters: [],
+        }
+      end
+
+      def configure_filter_ui_settings
+        @filter_ui_settings = {}
+      end
+
+      def resource_url(obj)
+        url_for([:admin, @role, obj])
+      end
+
+      def resource_controller_configuration
+        {
+          collection_name: :users,
+          item_name: :user,
+          class: User,
+          show_modal_after_create: false,
+          show_modal_after_update: false,
+          page_title: "Manage User Roles",
+          js_view_path: "/kuppayam/workflows/parrot",
+          view_path: "/usman/admin/user_roles"
+        }
+      end
+
+      def breadcrumbs_configuration
+        {
+          heading: "Manage User Roles",
+          description: "Listing all User Roles",
+          links: [{name: "Home", link: admin_dashboard_path, icon: 'fa-home'}]
+        }
+      end
+
+      def permitted_params
+        params.require(:user).permit(:id)
+      end
+
+      def set_navs
+        set_nav("admin/roles/user_roles")
+      end
+
+    end
+  end
+end

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

@@ -59,7 +59,7 @@ module Usman
         
         # Normal users should not be able to view super admins
         # He should not be seeing admins even while searching
-        if @current_user.is_super_admin?
+        if @current_user.super_admin?
           @relation = @relation.where("super_admin IS #{@super_admin.to_s.upcase}") if @super_admin.nil? == false && @query.nil?
         else
           @relation = @relation.where("super_admin IS FALSE")
@@ -104,13 +104,16 @@ module Usman
 
       def resource_controller_configuration
         {
-          view_path: "usman/admin/users"
+          page_title: "Users",
+          js_view_path: "/kuppayam/workflows/peacock",
+          view_path: "/usman/admin/users"
         }
       end
 
       def breadcrumbs_configuration
         {
           heading: "Manage Users",
+          icon: "fa-user",
           description: "Listing all Users",
           links: [{name: "Home", link: admin_dashboard_path, icon: 'fa-home'}, 
                     {name: "Manage Users", link: admin_users_path, icon: 'fa-user', active: true}]

data/app/controllers/usman/application_controller.rb

@@ -5,9 +5,5 @@ module Usman
 
     before_action :current_user
 
-  	def set_default_title
-	    set_title("Usman - User Management System")
-	  end
-
   end
 end

data/app/controllers/usman/sessions_controller.rb

@@ -3,17 +3,20 @@ module Usman
 
     layout 'kuppayam/blank'
 
+    rescue_from ActionController::InvalidAuthenticityToken, :with => :rescue_from_invalid_authenticity_token
+
     before_action :require_user, :only => :sign_out
     skip_before_action :set_navs
     
     def sign_in
       set_title("Sign In")
-      redirect_to_appropriate_page_after_sign_in if @current_user && !@current_user.token_expired?
+      redirect_to_appropriate_page_after_sign_in if @current_user
     end
 
     def create_session
       set_title("Sign In")
-      @registration_details = Usman::AuthenticationService.new(params)
+      registration_params = { login_handle: params[:login_handle], password: params[:password], remote_ip: request.remote_ip}
+      @registration_details = Usman::AuthenticationService.new(registration_params)
 
       if @registration_details.error
         

data/app/helpers/usman/authentication_helper.rb

@@ -10,7 +10,14 @@ module Usman
     
     # Returns the default URL to which the system should redirect the user after successful authentication
     def default_redirect_url_after_sign_in
-      usman.admin_dashboard_url    
+      main_app.user_landing_url
+      # if @current_user.has_role?("Admin")
+      #   main_app.admin_dashboard_url
+      # elsif @current_user.has_role?("Admin")
+      #   main_app.store_dashboard_url
+      # else
+      #   main_app.admin_dashboard_url
+      # end
     end
 
     # Returns the default URL to which the system should redirect the user after an unsuccessful attempt to authorise a resource/page
@@ -22,11 +29,11 @@ module Usman
     # This method should also handle the redirection if it has come through a client appliction for authentication
     # In that case, it should persist the params passed by the client application
     def redirect_after_unsuccessful_authentication
-      params_hsh = {}
-      params_hsh[:client_app] = params[:client_app] if params[:client_app]
-      params_hsh[:redirect_back_url] = params[:redirect_back_url] if params[:redirect_back_url]
-      params_hsh[:requested_url] = request.original_url if request.get?
-      redirect_to add_query_params(default_sign_in_url, params_hsh)
+      @params_hsh = {}
+      @params_hsh[:client_app] = params[:client_app] if params[:client_app]
+      @params_hsh[:redirect_back_url] = params[:redirect_back_url] if params[:redirect_back_url]
+      @params_hsh[:requested_url] = request.original_url if request.get?
+      redirect_to add_query_params(default_sign_in_url, @params_hsh)
       return
     end
 
@@ -43,12 +50,30 @@ module Usman
       return
     end
 
+    def rescue_from_invalid_authenticity_token
+      text = "#{I18n.t("authentication.session_expired.heading")}"
+      set_flash_message(text, :error, false) if defined?(flash) && flash
+      respond_to do |format|
+        format.html {
+          redirect_to add_query_params(default_sign_in_url)
+        }
+        format.js {
+          render(:partial => 'usman/sessions/sign_in.js.erb', :handlers => [:erb], :formats => [:js])
+        }
+      end
+    end
+
     def redirect_or_popup_to_default_sign_in_page
       respond_to do |format|
         format.html {
           redirect_after_unsuccessful_authentication
         }
         format.js {
+          @params_hsh = {}
+          @params_hsh[:client_app] = params[:client_app] if params[:client_app]
+          @params_hsh[:redirect_back_url] = params[:redirect_back_url] if params[:redirect_back_url]
+          @params_hsh[:requested_url] = request.original_url if request.get?
+          
           render(:partial => 'usman/sessions/sign_in.js.erb', :handlers => [:erb], :formats => [:js])
         }
       end
@@ -65,22 +90,8 @@ module Usman
     # This method is usually used as a before filter to secure some of the actions which requires the user to be signed in.
     def require_user
       current_user
-
-      if @current_user
-        if @current_user.token_expired?
-          @current_user = nil
-          session.delete(:id)
-          
-          text = "#{I18n.t("authentication.session_expired.heading")}: #{I18n.t("authentication.session_expired.message")}"
-          set_flash_message(text, :error, false) if defined?(flash) && flash
-
-          redirect_or_popup_to_default_sign_in_page
-          return
-        else
-          @current_user.update_token if @current_user.token_about_to_expire?
-        end
-      else
-        text = "#{I18n.t("authentication.permission_denied.heading")}: #{I18n.t("authentication.permission_denied.message")}"
+      unless @current_user
+        text = "#{I18n.t("authentication.login_required.heading")}"
         set_flash_message(text, :error, false) if defined?(flash) && flash
 
         redirect_or_popup_to_default_sign_in_page
@@ -90,7 +101,7 @@ module Usman
 
     # This method is usually used as a before filter from admin controllers to ensure that the logged in user is a super admin
     def require_super_admin
-      unless @current_user.is_super_admin?
+      unless @current_user.super_admin?
         text = "#{I18n.t("authentication.permission_denied.heading")}: #{I18n.t("authentication.permission_denied.message")}"
         set_flash_message(text, :error, false) if defined?(flash) && flash
 
@@ -116,9 +127,8 @@ module Usman
       message = translate("authentication.masquerade", user: user.name)
       set_flash_message(message, :success, false)
       session[:last_user_id] = current_user.id if current_user
-      user.start_session
+      user.start_session(params[:remote_ip])
       session[:id] = user.id
-      default_redirect_url_after_sign_in
       redirect_to default_redirect_url_after_sign_in
     end