ecm_rbac 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d2fb5aa9df2560e3108782604386f1ef0a4ed1c
-  data.tar.gz: c83662e5bb3e4a978d8c5a0fb9f04614ba0d38d3
+  metadata.gz: 5ed4686cba3dff28833d93e5ab2537f8c99b10a0
+  data.tar.gz: ea2edbf2d87f23af58ec62653c6a360f682afc0f
 SHA512:
-  metadata.gz: c53db95549cce94c85e00ca64c2975c442be38c82d2988d3497648683bbb8a76cf13769a22de4a8732d18e7aa2bbf6c27d87fd92fd4139cb67074587f3da03b9
-  data.tar.gz: a2dbd6866250e12f345bbff1f7dbc045b1c35864547e4db28d63dac2924eb1b1cb409c4d9c345daf91d947d2d0c680ada61cbf41637b284ae42840b8522b47fc
+  metadata.gz: 11f7cd004056ffb25338cbe0fd69c4399a1bf6fbdb92048b806960e022887d2e9b634b27db5df045a8fffdfd98112ad61138a1a8bcc3c7e4f44ea27cbb3546b2
+  data.tar.gz: 8e5582e3436bb0a88153fddffb1cf3cfc62eec56368eab193ad08dd2c6d60b72299fb1b1acb7b1e2c73c84781343d93af8ec8bcd9ac5d3b8367c24d4496ab48b

data/app/services/ecm/rbac/import_default_permissions_service.rb

@@ -1,122 +1,151 @@
-require_dependency 'itsf_services'
+# require_dependency 'itsf_services'
 require_dependency 'active_model/validations/file_readability_validator'
 
-module Ecm::Rbac
-  class ImportDefaultPermissionsService < ApplicationService
-    class Result < ApplicationService::Result
-      attr_accessor :permissions, :roles, :role_permissions
-    end
-
-    attr_accessor :filename
+module Ecm
+  module Rbac
+    # Example:
+    #
+    #     # config/rbac.yml:
+    #     defaults:
+    #       permissions:
+    #         - posts/index
+    #         - posts/show
+    #       roles:
+    #         member:
+    #           - posts/index
+    #           - posts/show
+    #
+    #     # rails console:
+    #     Ecm::Rbac::ImportDefaultPermissionsService.call
+    #       =>
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Performing...
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]     Validating input...
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]       => Done
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Loaded YAML from /home/johndoe/rails_application/config/rbac.yml
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Checking for valid YAML structure
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Loaded 2 permissions
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Loaded 1 roles
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Saved 2 permissions
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Saved 1 roles
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]   Saved 2 role permissions
+    #         [Ecm::Rbac::ImportDefaultPermissionsService]     => Done
+    #
+    class ImportDefaultPermissionsService < ApplicationService
+      class Result < ApplicationService::Result
+        attr_accessor :permissions, :roles, :role_permissions
+      end
 
-    validates :filename, file_readability: true
+      attr_accessor :filename
 
-    def _perform
-      say 'Validating input' do
-        unless valid?
-          say "Inputs are invalid. Errors: #{errors.full_messages.to_sentence}"
-          say 'Aborted'
-          return
-        end
-      end
+      validates :filename, file_readability: true
 
-      return unless load_yaml
-      return unless yaml_structure_valid?
+      def _perform
+        # say 'Validating input' do
+        #   unless valid?
+        #     say "Inputs are invalid. Errors: #{errors.full_messages.to_sentence}"
+        #     say 'Aborted'
+        #     return
+        #   end
+        # end
 
-      load_permissions
-      load_roles
+        return unless load_yaml
+        return unless yaml_structure_valid?
 
-      @result.permissions = create_or_update_permissions
-      @result.roles = create_or_update_roles
-      @result.role_permissions = create_or_update_role_permissions
-    end
+        load_permissions
+        load_roles
 
-    private
+        @result.permissions = create_or_update_permissions
+        @result.roles = create_or_update_roles
+        @result.role_permissions = create_or_update_role_permissions
+      end
 
-    def filename
-      @filename ||= Ecm::Rbac.default_permissions_filename.call
-    end
+      private
 
-    def create_or_update_permissions
-      permissions = @permissions.collect do |permission_identifier|
-        Ecm::Rbac::Permission.where(identifier: permission_identifier).first_or_initialize.tap do |permission|
-          permission.save!
-        end
+      def filename
+        @filename ||= Ecm::Rbac.default_permissions_filename.call
       end
-      say "Saved #{permissions.count} permissions"
-      permissions
-    end
 
-    def create_or_update_roles
-      roles = @roles.collect do |role_identifier, permissions|
-        Ecm::Rbac::Role.where(identifier: role_identifier).first_or_initialize.tap do |role|
-          role.save!
+      def create_or_update_permissions
+        permissions = @permissions.collect do |permission_identifier|
+          Ecm::Rbac::Permission.where(identifier: permission_identifier).first_or_initialize.tap do |permission|
+            permission.save!
+          end
         end
+        say "Saved #{permissions.count} permissions"
+        permissions
       end
-      say "Saved #{roles.count} roles"
-      roles
-    end
 
-    def create_or_update_role_permissions
-      role_permissions = @roles.collect do |role_identifier, permissions|
-        role = Ecm::Rbac::Role.where(identifier: role_identifier).first
-        (permissions ||[]).collect do |permission_identifier|
-          permission = Ecm::Rbac::Permission.where(identifier: permission_identifier).first
-
-          Ecm::Rbac::RolePermission.where(role_id: role, permission_id: permission).first_or_initialize.tap do |role_permission|
-            role_permission.save!
+      def create_or_update_roles
+        roles = @roles.collect do |role_identifier, permissions|
+          Ecm::Rbac::Role.where(identifier: role_identifier).first_or_initialize.tap do |role|
+            role.save!
           end
         end
-      end.flatten
-      say "Saved #{role_permissions.count} role permissions"
-      role_permissions
-    end
-
-    def load_permissions
-      @permissions = @yaml[:defaults][:permissions] || []
-      say "Loaded #{@permissions.size} permissions"
-    end
+        say "Saved #{roles.count} roles"
+        roles
+      end
 
-    def load_roles
-      @roles = @yaml[:defaults][:roles] || []
-      say "Loaded #{@roles.size} roles"
-    end
+      def create_or_update_role_permissions
+        role_permissions = @roles.collect do |role_identifier, permissions|
+          role = Ecm::Rbac::Role.where(identifier: role_identifier).first
+          (permissions ||[]).collect do |permission_identifier|
+            permission = Ecm::Rbac::Permission.where(identifier: permission_identifier).first
 
-    def load_yaml
-      yaml = YAML.load_file(filename)
-      if yaml
-        say "Loaded YAML from #{filename}"
-        @yaml = yaml.with_indifferent_access
-      else
-        say "Could not load YAML from #{filename}"
-        @yaml = yaml
+            Ecm::Rbac::RolePermission.where(role_id: role, permission_id: permission).first_or_initialize.tap do |role_permission|
+              role_permission.save!
+            end
+          end
+        end.flatten
+        say "Saved #{role_permissions.count} role permissions"
+        role_permissions
       end
-    end
 
-    def yaml_structure_valid?
-      say "Checking for valid YAML structure"
-      unless @yaml.is_a?(Hash)
-        add_error_and_say(:yaml_file, "Expected file content of #{filename} to parse to a Hash, but was #{@yaml.class}")
-        return false
+      def load_permissions
+        @permissions = @yaml[:defaults][:permissions] || []
+        say "Loaded #{@permissions.size} permissions"
       end
 
-      unless @yaml.has_key?(:defaults)
-        add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:].")
-        return false
+      def load_roles
+        @roles = @yaml[:defaults][:roles] || []
+        say "Loaded #{@roles.size} roles"
       end
 
-      unless @yaml[:defaults].has_key?(:roles)
-        add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:][roles:].")
-        return false
+      def load_yaml
+        yaml = YAML.load_file(filename)
+        if yaml
+          say "Loaded YAML from #{filename}"
+          @yaml = yaml.with_indifferent_access
+        else
+          say "Could not load YAML from #{filename}"
+          @yaml = yaml
+        end
       end
 
+      def yaml_structure_valid?
+        say "Checking for valid YAML structure"
+        unless @yaml.is_a?(Hash)
+          add_error_and_say(:yaml_file, "Expected file content of #{filename} to parse to a Hash, but was #{@yaml.class}")
+          return false
+        end
+
+        unless @yaml.has_key?(:defaults)
+          add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:].")
+          return false
+        end
+
+        unless @yaml[:defaults].has_key?(:roles)
+          add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:][roles:].")
+          return false
+        end
 
-      unless @yaml[:defaults].has_key?(:permissions)
-        add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:][permissions:].")
-        return false
-      end
 
-      return true
+        unless @yaml[:defaults].has_key?(:permissions)
+          add_error_and_say(:yaml_file, "Expected yaml in #{filename} to have the key [defaults:][permissions:].")
+          return false
+        end
+
+        return true
+      end
     end
   end
 end

data/config/initializers/inject_user_concern.rb

@@ -1,6 +1,10 @@
 Rails.configuration.to_prepare do
-  puts "Including Model::Ecm::Rbac::UserConcern in #{Ecm::Rbac.user_class_name}"
-  Ecm::Rbac.user_class_name.constantize.class_eval do
-    include Model::Ecm::Rbac::UserConcern
+  begin
+    puts "Including Model::Ecm::Rbac::UserConcern in #{Ecm::Rbac.user_class_name}"
+    Ecm::Rbac.user_class_name.constantize.class_eval do
+      include Model::Ecm::Rbac::UserConcern
+    end
+  rescue NameError => e
+    "Could not include Model::Ecm::Rbac::UserConcern into #{Ecm::Rbac.user_class_name}. Error: #{e.message}"
   end
 end

data/lib/ecm/rbac/configuration.rb

@@ -10,7 +10,7 @@ module Ecm
 
       mattr_accessor(:user_class_name) { 'User' }
 
-      mattr_accessor(:default_permissions_filename) { -> { Rails.root.join('config', 'permissions', 'default.yml') }  }
+      mattr_accessor(:default_permissions_filename) { -> { Rails.root.join('config', 'rbac.yml') }  }
 
       def self.user_class
         user_class_name.constantize

data/lib/ecm/rbac/version.rb

@@ -1,5 +1,5 @@
 module Ecm
   module Rbac
-    VERSION = '1.2.1'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

data/lib/generators/ecm/rbac/install/templates/initializer.rb

@@ -8,7 +8,7 @@ Ecm::Rbac.configure do |config|
   # Set the path of your default permissions file that will be used by
   # Ecm::Rbac::ImportDefaultPermissionsService
   # 
-  # default: config.default_permissions_filename = -> { Rails.root.join('config', 'permissions', 'default.yml') }
+  # default: config.default_permissions_filename = -> { Rails.root.join('config', 'rbac.yml') }
   # 
-  config.default_permissions_filename = -> { Rails.root.join('config', 'permissions', 'default.yml') }
+  config.default_permissions_filename = -> { Rails.root.join('config', 'rbac.yml') }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecm_rbac
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Roberto Vasquez Angel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2018-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails