passpartu 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1074ae228e7b5f0cfff3a9a2fc0acd58536a161451cab914b814e8b1bf44470
-  data.tar.gz: 4ecf5e75ec63192afd3d739b47dd646912de8b594f01e8553fd6f9df0d1dbfb6
+  metadata.gz: 982e32959b5022a455e42d2c1de190c0851f358cfd34c699ece8394e6af0d951
+  data.tar.gz: 2e81288b0af25837d0d4d97b14562e33f2813ca0b8741adbce66451568a99487
 SHA512:
-  metadata.gz: ceeac19430a29384cf70bf5755ed6786e06f76d981d1c42e81a677f8163211f46bc6a4bdb4eca6d9968cc7751d0c234392edfe6227c2dfd2c0c2f1132ab36cb0
-  data.tar.gz: 5d4aef534482fc686033d67c043e8378dc92c8bfecbb00672d81949fa5a63ccba6c36c3fd492267375a38854085eae4f13af6da8aa20c3df7e1c1c935ee39c40
+  metadata.gz: 3cebce1276892e0fd925be52bc3ed817b83b6aeb96d9b056b9d999d288b9cbe891189f36a8d6b904b1dac53bbd90eb10b2d6628e42f727d063bc300abbeb697d
+  data.tar.gz: 6caeffe92ffe0f8fe158c0d10c9d4eca18e88ac3acad3c14d7346673ca6740c7335564d53f10a9263f6ae2bcc533077fb18d84cfb25c68cac71717e7b4c01ff7

data/README.md

@@ -1,4 +1,4 @@
-# Passpartu v0.6.0 - [changelog](https://github.com/coaxsoft/passpartu/blob/master/CHANGELOG.md)
+# Passpartu v1.0.0 - [changelog](https://github.com/coaxsoft/passpartu/blob/master/CHANGELOG.md)
 
 Passpartu makes policies great again (works awesome with [Pundit](https://rubygems.org/gems/pundit)).
 
@@ -132,6 +132,37 @@ Check user roles AND policy rule
   user_agent.agent_can?(:orders, :edit, except: [:admin, :manager]) { user_agent.orders.include?(order) }
 ```
 
+#### Waterfall check
+Allow or restrict absolutely everything for particular role or/and particular domain.
+```ruby
+# ./config/initializers/passpartu.rb
+
+Passpartu.configure do |config|
+  config.check_waterfall = true
+end
+```
+
+```yml
+# ./config/passpartu.yml
+
+super_admin: true
+super_looser: false
+medium_looser:
+  orders:
+    create: true
+    delete: false
+  products: true
+```
+```ruby
+user_super_admin.can?(:do, :whatever, :want) # true
+user_super_loser.can?(:do, :whatever, :want) # false
+user_medium_loser.can?(:orders, :create) # true
+user_medium_loser.can?(:orders, :delete) # false
+user_medium_loser.can?(:products, :create) # true
+user_medium_loser.can?(:products, :create, :and_delete) # true
+```
+
+
 ##### Real life example
 You need to check custom rule for agent
 ```yml

data/lib/passpartu.rb

@@ -1,13 +1,18 @@
+# frozen_string_literal: true
+
 require 'passpartu/version'
 require 'yaml'
 require_relative 'passpartu/patcher'
 require_relative 'passpartu/verify'
 require_relative 'passpartu/block_verify'
 require_relative 'passpartu/validate_result'
+require_relative 'passpartu/check_waterfall'
 require_relative 'passpartu/user' # for testing only
 
 module Passpartu
   class Error < StandardError; end
+  class PolicyYmlNotFoundError < StandardError; end
+  class WaterfallError < StandardError; end
 
   def self.included(policy_class)
     Passpartu::Patcher.call(policy_class)
@@ -27,17 +32,23 @@ module Passpartu
   end
 
   class Config
-    attr_accessor :policy, :raise_policy_missed_error
+    attr_accessor :policy, :raise_policy_missed_error, :check_waterfall
     attr_reader :policy_file
 
+    DEFAULT_POLICY_FILE = './config/passpartu.yml'
+
     def initialize
-      @policy_file = './config/passpartu.yml'
-      @policy = YAML.load_file(policy_file)
+      @policy_file = DEFAULT_POLICY_FILE
+      @policy = YAML.load_file(policy_file) if File.exist?(policy_file)
       @raise_policy_missed_error = true
+      @check_waterfall = false
     end
 
     def policy_file=(file = nil)
-      @policy_file = file || './config/passpartu.yml'
+      @policy_file = file || DEFAULT_POLICY_FILE
+
+      raise PolicyYmlNotFoundError unless File.exist?(policy_file)
+
       @policy = YAML.load_file(policy_file)
     end
   end

data/lib/passpartu/block_verify.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passpartu
   class BlockVerify < ::Passpartu::Verify
     def call

data/lib/passpartu/check_waterfall.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Passpartu
+  class CheckWaterfall
+    attr_reader :waterfall, :policy_hash
+    def initialize(role, keys)
+      @waterfall = [role] + keys
+      @policy_hash = Passpartu.policy
+    end
+
+    def self.call(role, keys)
+      new(role, keys).call
+    end
+
+    def call
+      patch_boolean_classes
+      @result = policy_hash.dig(*waterfall)
+      reset_boolean_classes
+
+      @result
+    end
+
+    def patch_boolean_classes
+      TrueClass.define_method(:dig) { |*_keys| true }
+      FalseClass.define_method(:dig) { |*_keys| false }
+    end
+
+    def reset_boolean_classes
+      TrueClass.undef_method(:dig)
+      FalseClass.undef_method(:dig)
+    end
+  end
+end

data/lib/passpartu/patcher.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Passpartu
   class Patcher
     attr_reader :klass
     def initialize(klass)
+      raise PolicyYmlNotFoundError if Passpartu.policy.nil?
+
       @klass = klass
     end
 

data/lib/passpartu/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # for testing only
 
 module Passpartu

data/lib/passpartu/validate_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passpartu
   class ValidateResult
     class PolicyMissedError < StandardError; end

data/lib/passpartu/verify.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Passpartu
   class Verify
-    CRUD_KEY = 'crud'.freeze
+    CRUD_KEY = 'crud'
 
     attr_reader :role, :keys, :result, :only, :except, :block
 
@@ -12,6 +14,8 @@ module Passpartu
       @only = Array(only).map(&:to_s) if present?(only)
       @except = Array(exclusion).map(&:to_s) if present?(exclusion) && !@only
       @block = block
+
+      raise PolicyYmlNotFoundError if Passpartu.policy.nil?
     end
 
     def self.call(role, keys, only: nil, except: nil, skip: nil, &block)
@@ -21,10 +25,17 @@ module Passpartu
     def call
       return false if role_ignore?
 
-      check_policy
-      check_crud if policy_missed? && last_key_crud?
+      check_waterfall_if
+      default_check
+      check_crud_if
 
       validate_result
+    rescue StandardError => e
+      if ['TrueClass does not have #dig method', 'FalseClass does not have #dig method'].include?(e.message)
+        raise WaterfallError.new "Looks like you want to use check_waterfall feature, but it's set to 'false'. Otherwise check your #{Passpartu.config.policy_file} for validness"
+      else
+        raise e
+      end
     end
 
     private
@@ -36,17 +47,17 @@ module Passpartu
       false
     end
 
-    def check_policy
+    def default_check
+      return unless policy_missed?
+
       @result = Passpartu.policy.dig(role, *keys)
     end
 
-    def check_crud
-      change_crud_key
-      check_policy
-    end
+    def check_crud_if
+      return unless policy_missed? && last_key_crud?
 
-    def change_crud_key
       @keys[-1] = CRUD_KEY
+      default_check
     end
 
     def policy_missed?
@@ -61,6 +72,12 @@ module Passpartu
       %w[create read update delete].include?(keys[-1])
     end
 
+    def check_waterfall_if
+      return unless Passpartu.config.check_waterfall && policy_missed?
+
+      @result = Passpartu::CheckWaterfall.call(role, keys)
+    end
+
     def blank?(item)
       item.respond_to?(:empty?) ? !!item.empty? : !item
     end

data/lib/passpartu/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Passpartu
-  VERSION = '0.6.0'.freeze
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passpartu
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - README.md
 - lib/passpartu.rb
 - lib/passpartu/block_verify.rb
+- lib/passpartu/check_waterfall.rb
 - lib/passpartu/patcher.rb
 - lib/passpartu/user.rb
 - lib/passpartu/validate_result.rb
@@ -89,7 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Passpartu makes policies great again