authz 0.0.1.alpha5 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a9c75133e213a41cc09207af72865b97c6a24e3a696daef8c110b3c02559d4
-  data.tar.gz: c4d34fff38988c1316b34ebd7110d63d84c5b591a822d93dd4131d880a604e30
+  metadata.gz: 11eb26576b75d07281811a8edd39f3466efa899b50b43449ae52e5773bd2f70c
+  data.tar.gz: fbea210889be2ac5ecacea9375b209769a5dae48965f689114240d9e2cf28423
 SHA512:
-  metadata.gz: 35a1d18c6d9b8fff1040cfcc5d299fa44b0909efcd19d953104dc4b7f7f6651b10b1ab529cb71932695970d39285af28a6775e22f5a3094c1b22d31f595b056e
-  data.tar.gz: ac8a025937abc904166ae87589775379bf9698fd5a36718c4e20fad8b92d5987055350939380c2e6b54b13a60ebd10d9a2fd25a82ee351b0ded429741178a6f3
+  metadata.gz: 02dfc204ff545e89978836ebdf3e7380a49e33baa672aaf699c0e505a4cde32c90380cd130318a3fc49b14047388907de401fbcd7aa7abae589fad77fb27f16f
+  data.tar.gz: 8d2ddb35760c635f4ec0bd48bff13b6ce888495d17651aae1528ada79020648a489208db705abf87436317acaaa91c00cf2b6a5ea74a80138b44432f53103120

data/README.md

@@ -101,7 +101,7 @@ $ bundle install
 
 Then install Authz executing:
 ```bash
-$ rails authz:install
+$ rails g authz:install
 # => config/initializer/authz.rb gets created
 # => The authz migrations are installed
 $ rails db:migrate
@@ -583,7 +583,7 @@ can be significant in applications with highly dynamic views and requires specia
 
 Authz implements 3 different caching strategies to meet production-grade performance needs.
 
-#### In-request caching
+### In-request caching
 Authz uses [Active Record's SQL caching](https://guides.rubyonrails.org/caching_with_rails.html#sql-caching)
 to guarantee that any query that is repeated during the request-response cycle is not re-run against your database.
 This is a built-in feature and as developer you don't have to do anything to benefit from it.
@@ -591,7 +591,9 @@ This is a built-in feature and as developer you don't have to do anything to ben
 _Some developers like to silence the logging from Active Record's CACHE as it can
 pollute your logs. [Learn how to to that here.](https://github.com/serodriguez68/authz/wiki/Disable-Logging-of-CACHEd-SQL-queries-in-Rails)_
 
-#### Cross-request caching
+[Back to table of content](#table-of-content)
+
+### Cross-request caching
 Cross-request caching allows Authz to build a cache that can be re-used across multiple requests,
 reducing sharply the number of authorization related calls to your database.
 
@@ -605,7 +607,9 @@ To enable this feature:
 This can be toggled by running `rails dev:cache` on your terminal.
 3. Go to `config/initilizers/authz.rb` and set `config.cross_request_caching = true`.
 
-#### Fragment and Russian Doll caching
+[Back to table of content](#table-of-content)
+
+### Fragment and Russian Doll caching
 _Note:_
 
 _There are only two hard things in Computer Science: cache invalidation and naming things. 
@@ -686,6 +690,7 @@ However, _"mine"_ can resolve to different departments for `alice` and `bob` des
 a consequence, we need to include information about the departments in addition to `#roles_cache_key`in the fragment
 keys.
 
+[Back to table of content](#table-of-content)
 
 ## Authorization Good and Bad Practices
 A non exhaustive list of generally accepted authorization wisdom and things we've learned from using Authz ourselves:
@@ -736,6 +741,7 @@ If you don't, you will get an `ActionController::RoutingError No route matches..
 if you mounted Authz `as: authz` in your router, use: 
 ```authz_link_to 'Authorization Admin', authz.root_url, skip_scoping: true```.
  
+[Back to table of content](#table-of-content)
 
 ## License
 Licensed under the MIT license, see the separate LICENSE.txt file.

data/app/assets/javascripts/authz/3_authz_flash.js

@@ -0,0 +1,18 @@
+window.azFlash = {
+  init: function(){
+    $('.az-flash').addClass('is-active')
+    this.bindClickToClose();
+    window.setTimeout(function(){
+      $('.az-flash').removeClass('is-active')
+    }, 6000)
+  },
+  bindClickToClose: function(){
+    $('.az-flash-close').click(function(){
+      $(this).parent().removeClass('is-active')
+    })
+  }
+}
+
+$(document).ready(function() {
+  window.azFlash.init()
+})

data/app/assets/javascripts/authz/pending_controller_actions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/authz/multiselect.scss.erb

@@ -0,0 +1 @@
+.ms-container{background:transparent no-repeat 50% 50%;width:370px}.ms-container:after{content:".";display:block;height:0;line-height:0;font-size:0;clear:both;min-height:0;visibility:hidden}.ms-container .ms-selectable,.ms-container .ms-selection{background:#fff;color:#555555;float:left;width:45%}.ms-container .ms-selection{float:right}.ms-container .ms-list{-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border linear 0.2s, box-shadow linear 0.2s;-moz-transition:border linear 0.2s, box-shadow linear 0.2s;-ms-transition:border linear 0.2s, box-shadow linear 0.2s;-o-transition:border linear 0.2s, box-shadow linear 0.2s;transition:border linear 0.2s, box-shadow linear 0.2s;border:1px solid #ccc;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;position:relative;height:200px;padding:0;overflow-y:auto}.ms-container .ms-list.ms-focus{border-color:rgba(82,168,236,0.8);-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6);outline:0;outline:thin dotted \9}.ms-container ul{margin:0;list-style-type:none;padding:0}.ms-container .ms-optgroup-container{width:100%}.ms-container .ms-optgroup-label{margin:0;padding:5px 0px 0px 5px;cursor:pointer;color:#999}.ms-container .ms-selectable li.ms-elem-selectable,.ms-container .ms-selection li.ms-elem-selection{border-bottom:1px #eee solid;padding:2px 10px;color:#555;font-size:14px}.ms-container .ms-selectable li.ms-hover,.ms-container .ms-selection li.ms-hover{cursor:pointer;color:#fff;text-decoration:none;background-color:#08c}.ms-container .ms-selectable li.disabled,.ms-container .ms-selection li.disabled{background-color:#eee;color:#aaa;cursor:text}

data/app/assets/stylesheets/authz/workspace.sass

@@ -8,6 +8,9 @@ $sidebar-width: 250px
   overflow-x: hidden
   overflow-y: scroll
   padding: 1rem
+  display: flex
+  flex-direction: column
+  justify-content: space-between
 
 .az-content
   padding-left: $sidebar-width
@@ -27,3 +30,17 @@ table.table
     &.is-clickable
       &:hover
         cursor: pointer
+
+.az-flash
+  max-width: 18rem
+  position: fixed
+  transition: all 0.5s ease
+  z-index: 10
+  right: 2rem
+  bottom: 2rem
+  transform: translate(calc(18rem + 3rem), 0rem)
+  &.is-bottom-right
+    bottom: 2rem
+    right: 2rem
+  &.is-active
+    transform: translate(0rem, 0rem)

data/app/controllers/authz/bulk/controller_actions_controller.rb

@@ -0,0 +1,45 @@
+require_dependency "authz/application_controller"
+
+module Authz
+  class Bulk::ControllerActionsController < ApplicationController
+
+    def create
+      if params[:create_all] = 'true'
+        ActiveRecord::Base.transaction do
+          @pending_actions = ::Authz::ControllerAction.pending
+          @pending_actions.each do |controller_action_hash|
+            ::Authz::ControllerAction.create!(
+              controller: controller_action_hash[:controller],
+              action: controller_action_hash[:action],
+            )
+          end
+        end
+        flash[:success] = "#{@pending_actions.count} actions successfully created!"
+        redirect_to root_path
+      else
+        flash[:notice] = 'Partial bulk creation not implemented yet'
+        redirect_to root_path
+      end
+    end
+
+    def destroy
+      if params[:destroy_all] = 'true'
+        ActiveRecord::Base.transaction do
+          @stale_actions = ::Authz::ControllerAction.stale
+          @stale_actions.each do |controller_action_hash|
+            ::Authz::ControllerAction.find_by(
+              controller: controller_action_hash[:controller],
+              action: controller_action_hash[:action],
+            ).destroy!
+          end
+        end
+        flash[:success] = "#{@stale_actions.count} actions successfully destroyed!"
+        redirect_to root_path
+      else
+        flash[:notice] = 'Partial bulk deletion not implemented yet'
+        redirect_to root_path
+      end
+    end
+
+  end
+end

data/app/controllers/authz/business_processes_controller.rb

@@ -21,7 +21,9 @@ module Authz
       @business_process = BusinessProcess.new(business_process_params)
       if @business_process.save
         redirect_to business_process_path(@business_process)
+        flash[:success] = "#{@business_process.name} created successfully"
       else
+        flash.now[:error] = "There was an issue creating this business process"
         render 'new'
       end
     end
@@ -33,8 +35,10 @@ module Authz
     def update
       @business_process = BusinessProcess.find(params[:id])
       if @business_process.update(business_process_params)
+        flash[:success] = "#{@business_process.name} updated successfully"
         redirect_to business_process_path(@business_process)
       else
+        flash.now[:error] = "There was an issue updating this business process"
         render 'edit'
       end
     end
@@ -42,8 +46,10 @@ module Authz
     def destroy
       @business_process = BusinessProcess.find(params[:id])
       if @business_process.destroy
+        flash[:success] = "#{@business_process.name} destroyed successfully"
         redirect_to business_processes_path
       else
+        flash.now[:error] = "There was an issue destroying #{@business_process.name}"
         render 'show'
       end
     end

data/app/controllers/authz/controller_actions_controller.rb

@@ -19,8 +19,10 @@ module Authz
     def create
       @controller_action = ControllerAction.new(controller_action_create_params)
       if @controller_action.save
+        flash[:success] = "#{@controller_action.to_s} created successfully"
         redirect_to controller_action_path(@controller_action)
       else
+        flash.now[:error] = "There was an issue creating this controller action"
         render 'new'
       end
     end
@@ -32,8 +34,10 @@ module Authz
     def update
       @controller_action = ControllerAction.find(params[:id])
       if @controller_action.update(controller_action_update_params)
+        flash[:success] = "#{@controller_action.to_s} updated successfully"
         redirect_to controller_action_path(@controller_action)
       else
+        flash.now[:error] = "There was an issue updating #{@controller_action.to_s}"
         render 'edit'
       end
     end
@@ -41,8 +45,10 @@ module Authz
     def destroy
       @controller_action = ControllerAction.find(params[:id])
       if @controller_action.destroy
+        flash[:success] = "#{@controller_action.to_s} destroyed successfully"
         redirect_to controller_actions_path
       else
+        flash.now[:error] = "There was an issue destroying #{@controller_action.to_s}"
         render 'show'
       end
     end

data/app/controllers/authz/home_controller.rb

@@ -3,13 +3,8 @@ require_dependency "authz/application_controller"
 module Authz
   class HomeController < ApplicationController
     def index
-      routes = Rails.application.routes.set.anchored_routes.map(&:defaults).uniq
-      not_found = []
-      routes.each do |route|
-        ca = ControllerAction.find_by(controller: route[:controller], action: route[:action])
-        not_found << route unless ca
-      end
-      @non_created_controller_actions = not_found
+      @pending_controller_actions = ControllerAction.pending
+      @stale_controller_actions = ControllerAction.stale
       @invalid_scoping_rules = ScopingRule.where.not(scopable: Authz::Scopables::Base.get_scopables_names).pluck(:scopable).uniq
     end
   end

data/app/controllers/authz/pending_controller_actions_controller.rb

@@ -0,0 +1,10 @@
+require_dependency "authz/application_controller"
+
+module Authz
+  class PendingControllerActionsController < ApplicationController
+    def index
+      @pending_controller_actions = ControllerAction.pending
+                                                    .sort_by { |ca| ca[:controller] }
+    end
+  end
+end

data/app/controllers/authz/rolables_controller.rb

@@ -20,8 +20,10 @@ module Authz
     def update
       @rolable = rolable.find(params[:id])
       if @rolable.update(rolable_params)
+        flash[:success] = "#{@rolable.authz_label} updated successfully"
         redirect_to send("#{@rolable.model_name.singular}_path", @rolable)
       else
+        flash.now[:error] = "There was an issue updating #{@rolable.authz_label}"
         render 'edit'
       end
     end

data/app/controllers/authz/roles_controller.rb

@@ -25,8 +25,10 @@ module Authz
     def create
       @role = Role.new(role_params)
       if @role.save
+        flash[:success] = "#{@role.name} created successfully"
         redirect_to role_path(@role)
       else
+        flash.now[:error] = "There was an issue creating this role"
         render 'new'
       end
     end
@@ -38,8 +40,10 @@ module Authz
     def update
       @role = Role.find(params[:id])
       if @role.update(role_params)
+        flash[:success] = "#{@role.name} updated successfully"
         redirect_to role_path(@role)
       else
+        flash.now[:error] = "There was an issue updating this role"
         render 'edit'
       end
     end
@@ -47,8 +51,10 @@ module Authz
     def destroy
       @role = Role.find(params[:id])
       if @role.destroy
+        flash[:success] = "#{@role.name} destroyed successfully"
         redirect_to roles_path
       else
+        flash.now[:error] = "There was an issue destroying #{@role.name}"
         render 'show'
       end
     end

data/app/controllers/authz/scoping_rules_controller.rb

@@ -15,8 +15,10 @@ module Authz
       @scoping_rule = ScopingRule.new(scoping_rule_params.merge(authz_role_id: @role.id))
       @available_keywords = @scopable.constantize.available_keywords
       if @scoping_rule.save
+        flash[:success] = "Configured #{@scoping_rule.scopable}:#{@scoping_rule.keyword} for #{@role.name}"
         redirect_to role_path(@role)
       else
+        flash.now[:error] = 'There was an issue adding this scoping rule'
         render 'new'
       end
     end
@@ -31,8 +33,10 @@ module Authz
       @role = Role.find(params[:role_id])
       @scoping_rule = ScopingRule.find(params[:id])
       if @scoping_rule.update(scoping_rule_update_params)
+        flash[:success] = "Configured #{@scoping_rule.scopable}:#{@scoping_rule.keyword} for #{@role.name}"
         redirect_to role_path(@role)
       else
+        flash.now[:error] = 'There was an issue updating this scoping rule'
         @available_keywords = @scoping_rule.scopable.constantize.available_keywords
         render 'edit'
       end

data/app/controllers/authz/stale_controller_actions_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "authz/application_controller"
+
+module Authz
+  class StaleControllerActionsController < ApplicationController
+    def index
+      @stale_controller_actions = ControllerAction.stale
+    end
+  end
+end

data/app/helpers/authz/application_helper.rb

@@ -1,16 +1,16 @@
 module Authz
   module ApplicationHelper
-    # def title(text)
-    #   content_for :title, text
-    # end
-    #
-    # def meta_title
-    #   if content_for?(:title)
-    #     "#{yield(:title)} | Authz"
-    #   else
-    #     "Authz"
-    #   end
-    # end
-
+    def flash_class(name)
+      case name
+      when 'success'
+        'is-success'
+      when 'error'
+        'is-danger'
+      when 'notice'
+        'is-primary'
+      when 'alert'
+        'is-warning'
+      end
+    end
   end
 end

data/app/models/authz/controller_action.rb

@@ -51,6 +51,35 @@ module Authz
       res
     end
 
+    # Returns array of controller actions found in router but not in controller actions
+    def self.pending
+      # TODO: Refactor and test
+      ca_pairs = []
+      reachable_controller_actions.each do | c_name, action_arr |
+        action_arr.each do |a_name|
+          ca_pairs << { controller: c_name, action: a_name }
+        end
+      end
+
+      pending = []
+      ca_pairs.each do |route|
+        ca = find_by(controller: route[:controller], action: route[:action])
+        pending << route unless ca
+      end
+
+      pending
+    end
+
+    def self.stale
+      # TODO: Refactor and test
+      stale = []
+      find_each do |ca|
+        is_included = reachable_controller_actions[ca.controller].try(:include?, ca.action)
+        stale << ca unless is_included
+      end
+      stale
+    end
+
     # Instance Methods
     # ==========================================================================
     def to_s

data/app/views/authz/home/index.html.slim

@@ -1,37 +1,62 @@
-
 = content_for :nav_title do
   | Maintenance Dashboard
 
 section.section
   .container
-    h2.title.is-4 Controller Actions
+    h2.title Controller Actions
     .columns
-      .column.is-one-quarter
-        .card
-          .card-content.has-text-centered
-            p.title = number_with_delimiter @non_created_controller_actions.count
-            p Controller actions to be created
       .column
-        .card
-          table.table.is-fullwidth
-            thead
-              tr
-                th Controller
-                th Action
-                th
-            tbody
-              - if @non_created_controller_actions.blank?
-                tr
-                  td.has-text-centered[colspan="3"] Up to date!
+        .content
+          .card
+            .card-content.has-text-centered
+              p.title.is-1 = number_with_delimiter @pending_controller_actions.count
+              p.subtitle Controller Actions to be created
+              - if @pending_controller_actions.blank?
+                p Everything's up to date
               - else
-                - @non_created_controller_actions.each do |h|
-                  tr
-                    td = h[:controller]
-                    td = h[:action]
-                    td
+                .card-content
+                  .buttons.is-centered
+                    = authz_link_to 'Review', pending_controller_actions_path, { class: 'button is-primary' }, skip_scoping:  true
+            .card-content
+              p If there are controller actions to be created this could mean that someone:
+              ul
+                li created new routes that need to be present in the system. You should create them!
+                li created routes that don't need to be in the system. Developers should clean them up.
+
+      .column
+        .content
+          .card
+            .card-content.has-text-centered
+              p.title.is-1 = number_with_delimiter @stale_controller_actions.count
+              p.subtitle Stale Controller Actions
+              - if @stale_controller_actions.blank?
+                p Everything's up to date
+              - else
+                .card-content
+                  .buttons.is-centered
+                    = authz_link_to 'Review', stale_controller_actions_path, { class: 'button is-primary' }, skip_scoping:  true
+            .card-content
+              p Stale controller actions could mean someone:
+              ul
+                li removed them from your application's router by accident
+                li removed them from your applicaiton's router and need to be removed from the database as well
+
+
+
+
 section.section
   .container
-    h2.title.is-4 Unused scopable keywords
+    h2.title Scoping
+    .content
+      h3.title.is-4 Suspicious keywords
+      .columns
+        .column
+          p.has-text-justified These are keywords that are present in your database but either have been removed from your source code at each scopable's configuration file or have been created progamatically skipping validations.
+        .column
+          p.has-text-justified No keywords should be present in these tables. If there are some, ask these questions to clean up:
+          ul
+            li Did someone remove scopable keywords?
+            li Did someone udpate records skipping validations?
     .columns
       - ::Authz::Scopables::Base.get_scopables_names.each do |scoping_module|
         .column
@@ -53,17 +78,22 @@ section.section
 
 section.section
   .container
-    h2.title.is-4 Scopables not in codebase
+    h3.title.is-4 Scopable not in codebase
     .columns
-      .column.is-one-quarter
-        .card
-          .card-content.has-text-centered
-            p.title = @invalid_scoping_rules.count
-            p Scopables removed from code but still present in the database
+      .column
+        .content
+          p.has-text-justified Developers may remove scopes in your codebase leaving stale rules in your database. To fix this you can:
+          ul
+            li Check with your developer to see if this is expected behaviour. The code that includes scopables in the system may have been accidentally deleted
+            li Remove all Scoping Rule instances in your database that are not present in code.
+
       .column
         .card
           table.table.is-fullwidth
             tbody
+              - if @invalid_scoping_rules.blank?
+                tr
+                  td.has-text-centered All scopables in your database are correctly configured in your codebase
               - @invalid_scoping_rules.each do |rule_name|
                 tr
                   td = rule_name