usman 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f31f9f21333b58b50c216a35e54eb18ad8d059f
-  data.tar.gz: 2b4a5159166004dd7d74b919642dab7f04f28e6a
+  metadata.gz: 186410d08ecdc9176c36357015749759ec165feb
+  data.tar.gz: 7bc5124cf79f1e4eef9bb961fd07506c37e0c75d
 SHA512:
-  metadata.gz: 0d684c162f0cf90dc506b1d22d7674683469a5b3aec60c47effaddb0c07719f30fecc88c1fdd1ef0152a2591a51aee20f5fe04fd873478344cbfe9ed270e6be9
-  data.tar.gz: c20a39d2ef4d2d689cdb1ce6097117cca6d38fe892e18e2ea4d6ab5a9e92160a732ce2e93c0c42b1f4cf3db7f95e62fff61338a69be2788d59de9ca10011b254
+  metadata.gz: d3f4714ec4f68625769e502cafe8b47b04e42fd301d41dd78eb07ebbc246ee38a9d254748d432b8cc1f45bf63d7e363c5d24f0ab9a78782a3f3762f5c4bb9822
+  data.tar.gz: c4e5181bc21ed383ca9ebdf0ab6b5fb57e190e0d7b7373313ec6b5f5dbb3c289956b85e76977656456f55bb6e3da1a7c8e1662dfaf817542e1cb63489a6e3e2c

data/README.md

@@ -1,8 +1,8 @@
 # Usman
-Short description and motivation.
+Simple User & Feature Permission Management
 
 ## Usage
-How to use my plugin.
+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
 Add this line to your application's Gemfile:
@@ -21,18 +21,59 @@ Or install it yourself as:
 $ gem install usman
 ```
 
-## Contributing
-Contribution directions go here.
+# Installation Instructions
 
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## Copy the migrations
+
+Copy the migrations from the engines you are using
+Run the below command 
+
+```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 
+
+run rake task for loading dummy data for users and features to start with.
+
+## Mount the engine
+
+Mount usman engine in your application routes.rb
+
+```
+mount Usman::Engine => "/"
+```
+
+open browser and go to /sign_in url
 
-# Installation Instructions
 
-# in main application.rb
 
+
+```bash
+$ bundle exec rake usman:import:dummy:all verbose=false
+```
+
+
+
+## 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]
+```
+
+
+## Contributing
+
+Visit - https://github.com/right-solutions/usman
+Feel free to submit a patch 
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
 
-# add config/initializers/uptime.rb
-Dummy::BOOTED_AT = Time.now

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

@@ -2,12 +2,20 @@ module Usman
 	module Admin
 	  class DashboardController < Usman::Admin::BaseController
 
-	    # GET /dashboard
+	  	# GET /dashboard
 	    def index
 	    end
 
 	    private
 
+	    def breadcrumbs_configuration
+	      {
+	        heading: "Usman Dashboard",
+	        description: "A Quick view of users and roles",
+	        links: [{name: "Dashboard", link: admin_dashboard_path, icon: 'fa-dashboard'}]
+	      }
+	    end
+
 	    def set_navs
 	      set_nav("admin/dashboard")
 	    end

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

@@ -2,27 +2,6 @@ module Usman
   module Admin
     class FeaturesController < ResourceController
 
-      def index
-        @heading = "Manage Features"
-        @description = "Listing all features"
-        @links = [{name: "Dashboard", link: admin_dashboard_path, icon: 'fa-home'}, 
-                  {name: "Manage Features", link: admin_features_path, icon: 'fa-user', active: true}]
-        super
-      end
-
-      def create
-        @feature = Feature.new
-        @feature.assign_attributes(permitted_params)
-        save_resource(@feature)
-        get_collections
-      end
-
-      def update_status
-        @feature = Feature.find(params[:id])
-        @feature.update_attribute(:status, params[:status])
-        render :row
-      end
-
       private
 
       def get_collections
@@ -31,7 +10,7 @@ module Usman
         parse_filters
         apply_filters
         
-        @features = @relation.includes(:feature_image).page(@current_page).per(@per_page)
+        @features = @r_objects = @relation.includes(:feature_image).page(@current_page).per(@per_page)
 
         return true
       end
@@ -73,6 +52,21 @@ module Usman
         }
       end
 
+      def resource_controller_configuration
+        {
+          view_path: "/usman/admin/features"
+        }
+      end
+
+      def breadcrumbs_configuration
+        {
+          heading: "Manage Features",
+          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}]
+        }
+      end
+
       def permitted_params
         params.require(:feature).permit(:name)
       end

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

@@ -63,6 +63,21 @@ module Usman
         @filter_ui_settings = {}
       end
 
+      def resource_controller_configuration
+        {
+          view_path: "/demo/permissions"
+        }
+      end
+
+      def breadcrumbs_configuration
+        {
+          heading: "Manage Permissions",
+          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}]
+        }
+      end
+
       def permitted_params
         params.require(:permission).permit(:user_id, :feature_id, :can_create, :can_read, :can_update, :can_delete)
       end

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

@@ -6,6 +6,10 @@ module Usman
 
 	    before_action :configure_resource_controller
 
+	    def resource_url(obj)
+		    url_for([:admin, obj])
+		  end
+
 	  end
 	end
 end

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

@@ -0,0 +1,66 @@
+module Usman
+  module Admin
+    class RolesController < ResourceController
+
+      private
+
+      def get_collections
+        @relation = Role.where("")
+
+        parse_filters
+        apply_filters
+        
+        @roles = @r_objects = @relation.page(@current_page).per(@per_page)
+
+        return true
+      end
+
+      def apply_filters
+        @relation = @relation.search(@query) if @query
+        
+        @order_by = "created_at desc" 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_controller_configuration
+        {
+          js_view_path: "/kuppayam/workflows/parrot",
+          view_path: "/usman/admin/roles"
+        }
+      end
+
+      def breadcrumbs_configuration
+        {
+          heading: "Manage Roles",
+          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}]
+        }
+      end
+
+      def permitted_params
+        params.require(:role).permit(:name)
+      end
+
+      def set_navs
+        set_nav("admin/roles")
+      end
+
+    end
+  end
+end

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

@@ -2,42 +2,40 @@ module Usman
   module Admin
     class UsersController < ResourceController
 
-      def index
-        @heading = "Manage Users"
-        @description = "Listing all users"
-        @links = [{name: "Dashboard", link: admin_dashboard_path, icon: 'fa-home'}, 
-                  {name: "Manage Users", link: admin_users_path, icon: 'fa-user', active: true}]
-        super
-      end
-
-      def create
-        @user = User.new
-        @user.assign_attributes(permitted_params)
-        #@user.assign_default_password
-        save_resource(@user)
-        get_collections
-      end
-
       def make_super_admin
-        @user = User.find(params[:id])
-        @user.update_attribute(:super_admin, true)
-        render :row
+        @user = @r_object = User.find(params[:id])
+        if @user
+          @user.super_admin = true
+          if @user.valid?
+            @user.save
+            set_notification(true, I18n.t('status.success'), I18n.t('state.changed', item: default_item_name.titleize, new_state: @user.status))
+          else
+            set_notification(false, I18n.t('status.error'), I18n.translate("error"), @user.errors.full_messages.join("<br>"))
+          end
+        else
+          set_notification(false, I18n.t('status.not_found'), I18n.t('status.not_found', item: default_item_name.titleize))
+        end
+        render_row
       end
 
       def remove_super_admin
-        @user = User.find(params[:id])
-        @user.update_attribute(:super_admin, false)
-        render :row
-      end
-
-      def update_status
-        @user = User.find(params[:id])
-        @user.update_attribute(:status, params[:status])
-        render :row
+        @user = @r_object = User.find(params[:id])
+        if @user
+          @user.super_admin = false
+          if @user.valid?
+            @user.save
+            set_notification(true, I18n.t('status.success'), I18n.t('state.changed', item: default_item_name.titleize, new_state: @user.status))
+          else
+            set_notification(false, I18n.t('status.error'), I18n.translate("error"), @user.errors.full_messages.join("<br>"))
+          end
+        else
+          set_notification(false, I18n.t('status.not_found'), I18n.t('status.not_found', item: default_item_name.titleize))
+        end
+        render_row
       end
 
       def masquerade
-        @user = User.find(params[:id])
+        @user = @r_object = User.find(params[:id])
         masquerade_as_user(@user)
       end
 
@@ -45,12 +43,12 @@ module Usman
 
       def get_collections
         # Fetching the users
-        @relation = User.where("")
+        @relation = User.includes(:profile_picture).where("")
 
         parse_filters
         apply_filters
         
-        @users = @relation.includes(:profile_picture).page(@current_page).per(@per_page)
+        @users = @r_objects = @relation.page(@current_page).per(@per_page)
 
         return true
       end
@@ -104,6 +102,21 @@ module Usman
         }
       end
 
+      def resource_controller_configuration
+        {
+          view_path: "usman/admin/users"
+        }
+      end
+
+      def breadcrumbs_configuration
+        {
+          heading: "Manage Users",
+          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}]
+        }
+      end
+
       def permitted_params
         params.require(:user).permit(:name, :username, :email, :designation, :phone, :password, :password_confirmation)
       end

data/app/controllers/usman/sessions_controller.rb

@@ -7,27 +7,38 @@ module Usman
     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?
     end
 
     def create_session
+      set_title("Sign In")
       @registration_details = Usman::AuthenticationService.new(params)
+
       if @registration_details.error
-        set_notification_messages(@registration_details.error, :error)
+        
+        text = "#{I18n.t("#{@registration_details.error}.heading")}: #{I18n.t("#{@registration_details.error}.message")}"
+        set_flash_message(text, :error, false) if defined?(flash) && flash
+
         redirect_or_popup_to_default_sign_in_page
         return
       else
         @user = @registration_details.user
         session[:id] = @user.id
         @current_user = @user
-        set_notification_messages("authentication.logged_in", :success)
+        
+        text = "#{I18n.t("authentication.logged_in.heading")}: #{I18n.t("authentication.logged_in.message")}"
+        set_flash_message(text, :success, false) if defined?(flash) && flash
+
         redirect_to_appropriate_page_after_sign_in
         return
       end
     end
 
     def sign_out
-      set_notification_messages("authentication.logged_out", :success)
+      text = "#{I18n.t("authentication.logged_out.heading")}: #{I18n.t("authentication.logged_out.message")}"
+      set_flash_message(text, :success, false) if defined?(flash) && flash
+
       @current_user.end_session
       session.delete(:id)
       restore_last_user

data/app/helpers/usman/authentication_helper.rb

@@ -10,12 +10,12 @@ module Usman
     
     # Returns the default URL to which the system should redirect the user after successful authentication
     def default_redirect_url_after_sign_in
-      admin_dashboard_url    
+      usman.admin_dashboard_url    
     end
 
     # Returns the default URL to which the system should redirect the user after an unsuccessful attempt to authorise a resource/page
     def default_sign_in_url
-      sign_in_url
+      usman.sign_in_url
     end
 
     # Method to handle the redirection after unsuccesful authentication
@@ -65,17 +65,24 @@ 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?
-          #binding.pry
           @current_user = nil
           session.delete(:id)
-          set_notification_messages("authentication.session_expired", :error)
+          
+          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
-        set_notification_messages("authentication.permission_denied", :error)
+        text = "#{I18n.t("authentication.permission_denied.heading")}: #{I18n.t("authentication.permission_denied.message")}"
+        set_flash_message(text, :error, false) if defined?(flash) && flash
+
         redirect_or_popup_to_default_sign_in_page
         return
       end
@@ -84,7 +91,9 @@ 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?
-        set_notification_messages("authentication.permission_denied", :error)
+        text = "#{I18n.t("authentication.permission_denied.heading")}: #{I18n.t("authentication.permission_denied.message")}"
+        set_flash_message(text, :error, false) if defined?(flash) && flash
+
         redirect_or_popup_to_default_sign_in_page
       end
     end
@@ -95,7 +104,7 @@ module Usman
       return @last_user if @last_user
       if session[:last_user_id].present?
         @last_user = User.find_by_id(session[:last_user_id])
-        message = translate("users.sign_in_back", user: @last_user.name)
+        message = translate("authentication.sign_in_back", user: @last_user.name)
         set_flash_message(message, :success, false)
         session.destroy()
         session[:id] = @last_user.id if @last_user.present?
@@ -104,16 +113,13 @@ module Usman
     end
 
     def masquerade_as_user(user)
-      #if ["development", "it", "test"].include?(Rails.env)
-        message = translate("users.masquerade", user: user.name)
-        set_flash_message(message, :success, false)
-        session[:last_user_id] = current_user.id if current_user
-        user.start_session
-        session[:id] = user.id
-        default_redirect_url_after_sign_in
-        url = admin_dashboard_url
-        redirect_to url
-      #end
+      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
+      session[:id] = user.id
+      default_redirect_url_after_sign_in
+      redirect_to default_redirect_url_after_sign_in
     end
 
   end

data/app/models/feature.rb

@@ -1,7 +1,8 @@
-class Feature < ApplicationRecord
+class Feature < Usman::ApplicationRecord
+  
+  require 'import_error_handler.rb'
+  extend Usman::ImportErrorHandler
   
-  extend KuppayamValidators
-
   # Constants
   UNPUBLISHED = "unpublished"
   PUBLISHED = "published"
@@ -25,7 +26,7 @@ class Feature < ApplicationRecord
   has_one :feature_image, :as => :imageable, :dependent => :destroy, :class_name => "Image::FeatureImage"
 
 	# Validations
-	validate_string :name, mandatory: true
+	validates :name, presence: true
 	validates :status, :presence => true, :inclusion => {:in => STATUS.keys, :presence_of => :status, :message => "%{value} is not a valid status" }
 
   # ------------------
@@ -46,6 +47,51 @@ class Feature < ApplicationRecord
   scope :published, -> { where(status: PUBLISHED) }
   scope :disabled, -> { where(status: DISABLED) }
 
+  def self.save_row_data(row, base_path)
+
+    image_base_path = base_path + "images/"
+
+    row.headers.each{ |cell| row[cell] = row[cell].to_s.strip }
+
+    return if row[:name].blank?
+
+    feature = Feature.find_by_name(row[:name]) || Feature.new
+    feature.name = row[:name]
+    feature.status = Feature::UNPUBLISHED
+    
+    # Initializing error hash for displaying all errors altogether
+    error_object = Usman::ErrorHash.new
+
+    ## Adding a profile picture
+    begin
+      image_path = image_base_path + "features/#{feature.name.parameterize}.png"
+      image_path = image_base_path + "features/#{feature.name.parameterize}}.jpg" unless File.exists?(image_path)
+      if File.exists?(image_path)
+        feature.build_feature_image
+        feature.feature_image.image = File.open(image_path)
+      else
+        summary = "Feature Image not found for feature: #{feature.name}"
+        details = "#{image_path}/png doesn't exists"
+        error_object.warnings << { summary: summary, details: details }
+      end
+    rescue => e
+      summary = "Error during processing: #{$!}"
+      details = "Feature: #{feature.name}, Image Path: #{image_path}"
+      stack_trace = "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
+      error_object.errors << { summary: summary, details: details, stack_trace: stack_trace }
+    end if feature.feature_image.blank?
+
+    if feature.valid? && (feature.feature_image.blank? || feature.feature_image.valid?)
+      feature.save!
+    else
+      summary = "Error while saving feature: #{feature.name}"
+      details = "Error! #{feature.errors.full_messages.to_sentence}"
+      details << ", #{feature.feature_image.errors.full_messages.to_sentence}" if feature.feature_image
+      error_object.errors << { summary: summary, details: details }
+    end
+    return error_object
+  end
+
   # * Return full name
   # == Examples
   #   >>> feature.display_name

data/app/models/permission.rb

@@ -1,5 +1,8 @@
-class Permission < ApplicationRecord
+class Permission < Usman::ApplicationRecord
   
+  require 'import_error_handler.rb'
+  extend Usman::ImportErrorHandler
+
 	# Associations
   belongs_to :user
   belongs_to :feature
@@ -25,4 +28,49 @@ class Permission < ApplicationRecord
                                         LOWER(u.username) LIKE LOWER('%#{query}%') OR\
                                         LOWER(u.email) LIKE LOWER('%#{query}%') OR\
                                         LOWER(f.name) LIKE LOWER('%#{query}%')")}
+
+
+  def self.save_row_data(row, base_path)
+
+    image_base_path = base_path + "images/"
+
+    row.headers.each{ |cell| row[cell] = row[cell].to_s.strip }
+
+    return if row[:user].blank? || row[:feature].blank?
+
+    # Initializing error hash for displaying all errors altogether
+    error_object = Usman::ErrorHash.new
+
+    user = User.find_by_username(row[:user])
+    unless user
+      summary = "User '#{row[:user]}' doesn't exist"
+      error_object.errors << { summary: summary }
+      return error_object
+    end
+
+    feature = Feature.find_by_name(row[:feature])
+    unless feature
+      summary = "Feature '#{row[:feature]}' doesn't exist"
+      error_object.errors << { summary: summary }
+      return error_object
+    end
+
+    permission = Permission.where("user_id = ? AND feature_id = ?", user.id, feature.id).first || Permission.new
+    permission.user = user
+    permission.feature = feature
+    permission.can_create = row[:can_create]
+    permission.can_read = row[:can_read]
+    permission.can_update = row[:can_update]
+    permission.can_delete = row[:can_delete]
+    
+    if permission.valid?
+      permission.save!
+    else
+      summary = "Error while saving permission: #{user.name} - #{feature.name}"
+      details = "Error! #{permission.errors.full_messages.to_sentence}"
+      error_object.errors << { summary: summary, details: details }
+    end
+    return error_object
+  end
+
 end