egoist 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6b402250800b2baaa5bacd32efadb63c68a3b9364fae92523b9eb3e13bd84ef
+  data.tar.gz: 609c7e240a70f6b33e98f1ed79c183e2a29fe466f94d49289562c905b2cb827a
+SHA512:
+  metadata.gz: db2aea02ff0afb797b5dc3b978553191e816df2e7a81019981fb04cbcc5a1530727de6bbe725c621b6c749d72d7b46f23d37aa49121ce8ecc7698fe3efffb632
+  data.tar.gz: 677256afb6d61ba83ee3ce1f1f2cd6aebaa43b1328b1840f03a77f226d030b32d6bcac9a36c2368177f826e88eaa4fa65a643353eb8b009c74b3c1d6e4df1019

data/.version

@@ -0,0 +1 @@
+0.5.0

data/lib/adapters/controller.rb

@@ -0,0 +1,51 @@
+klass =
+if defined? Rails
+  ActiveController::Base
+elsif defined? Lux
+  Lux::Controller
+end
+
+if klass
+  klass.class_eval do
+    def authorize *args, &block
+      opts = {}
+
+      @_is_policy_authorized = true
+
+      raise ArgumentErorr, 'authorize argument[s] not provided' unless args[0]
+
+      # authorize true
+      return if args[0].is_a? TrueClass
+
+      if !args[1]
+        # authorize :admin?
+        opts[:action] = args.first
+      elsif args[2]
+        # authorize @model, write?, CustomClass
+        # authorize @model, write?, class: CustomClass
+        opts[:model]  = args.first
+        opts[:action] = args[1]
+        opts[:class]  = args[2].is_a?(Hash) ? args[2][:class] : args[2]
+      else
+        # authorize @model, write?
+        opts[:model]  = args.first
+        opts[:action] = args[1]
+      end
+
+      # covert all authorize actions to bang actions (fail unless true)
+      action = opts.delete(:action).to_s.sub('?', '!')
+
+      # do it
+      Policy(opts).send(action, &block)
+    end
+
+    def is_authorized?
+      @_is_policy_authorized == true
+    end
+
+    def is_authorized!
+      raise ::Policy::Error.new('Request is not authorized!') unless is_authorized?
+      true
+    end
+  end
+end

data/lib/adapters/model.rb

@@ -0,0 +1,21 @@
+class Policy
+  module ModelAdapter
+    def self.can user, model
+      klass = '%sPolicy' % model.class
+      klass = Object.const_defined?(klass) ? klass.constantize : ::ModelPolicy
+      Policy(model: model || self, user: user, class: klass)
+    end
+  end
+end
+
+if defined? Rails
+  ActiveModel::Base.include Policy::ModelAdapter
+elsif defined? Sequel
+  class Sequel::Model
+    module InstanceMethods
+      def can user=nil
+        Policy::ModelAdapter.can user, self
+      end
+    end
+  end
+end

data/lib/egoist/base.rb

@@ -0,0 +1,81 @@
+class Policy
+  class << self
+    def can(model=nil, user=nil)
+      if model.is_a?(Hash)
+        user, model = model[:user], model[:model]
+      end
+
+      new(user: user, model: model).can
+    end
+  end
+
+  ###
+  
+  attr_reader :model, :user, :action
+
+  def initialize model:, user: nil
+    @model = model
+    @user  = user || current_user
+  end
+
+  # pass block if you want to handle errors yourself
+  # return true if false if block is passed
+  def can? action, *args, &block
+    @action = action
+      .to_s
+      .gsub(/[^\w+]/, '')
+      .concat('?')
+      .to_sym
+
+    # pre check
+    raise RuntimeError, 'Method name not allowed' if %i(can).index(@action)
+    raise NoMethodError, %[Policy check "#{@action}" not found in #{self.class}] unless respond_to?(@action)
+
+    call *args, &block
+  end
+
+  def can
+    Proxy.new self
+  end
+
+  private
+
+  # call has to be isolated because specific of error handling
+  def call *args, &block
+    raise Error, 'User is not defined, no access' unless @user
+
+    return true if before(@action)
+    return true if send(@action, *args)
+
+    raise Error, 'Access disabled in policy'
+  rescue Policy::Error => error
+    message = error.message
+    message += " - #{self.class}##{@action}"
+
+    if block
+      block.call(message)
+      false
+    else
+      raise Policy::Error, message
+    end
+  end
+
+  def before action
+    false
+  end
+
+  def error message
+    raise Policy::Error.new(message)
+  end
+
+  # get current user from globals if globals defined
+  def current_user
+    if defined?(User) && User.respond_to?(:current)
+      User.current
+    elsif defined?(Current) && Current.respond_to?(:user)
+      Current.user
+    else
+      raise RuntimeError.new('Current user not found in Policy#current_user')
+    end
+  end
+end

data/lib/egoist/error.rb

@@ -0,0 +1,4 @@
+class Policy
+  class Error < StandardError
+  end
+end

data/lib/egoist/global.rb

@@ -0,0 +1,16 @@
+# Policy(:application)              -> ApplicationPolicy.can(model: nil, user: current_user)
+# Policy(@post)                     -> PostPolict.can(model: @post, user: current_user)
+# Policy(@post, @user)              -> PostPolict.can(model: @post, user: @user)
+# Policy(model: @post, user: @user) -> PostPolict.can(model: @post, user: @user)
+def Policy model, user=nil
+  if model.is_a?(Hash)
+    user, model = model[:user], model[:model]
+  end
+
+  raise ArgumentError, 'Model not defined' unless model
+
+  klass = model.is_a?(Symbol) ? model : model.class
+  klass = ('%s_policy' % klass).classify.constantize
+
+  klass.new(user: user, model: model).can
+end

data/lib/egoist/proxy.rb

@@ -0,0 +1,28 @@
+class Policy
+  class Proxy
+    def initialize policy
+      @policy = policy
+    end
+
+    def method_missing name, *args, &block
+      name   = name.to_s.sub(/(.)$/, '')
+      action = $1
+
+      @policy.can?(name, *args)
+      @policy.model || true
+    rescue Policy::Error => error
+      if block_given?
+        yield
+        return nil
+      end
+
+      if action == '!'
+        raise error
+      elsif action == '?'
+        nil
+      else
+        raise ArgumentError.new('Bad policy method %s' % name)
+      end
+    end
+  end
+end

data/lib/egoist.rb

@@ -0,0 +1,7 @@
+require_relative 'egoist/base'
+require_relative 'egoist/error'
+require_relative 'egoist/proxy'
+require_relative 'egoist/global'
+
+require_relative 'adapters/controller'
+require_relative 'adapters/model'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: egoist
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Dino Reic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-04 00:00:00.000000000 Z
+dependencies: []
+description: Clean, simple explicit and strait-forward policy definitions.
+email: reic.dino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./.version"
+- "./lib/adapters/controller.rb"
+- "./lib/adapters/model.rb"
+- "./lib/egoist.rb"
+- "./lib/egoist/base.rb"
+- "./lib/egoist/error.rb"
+- "./lib/egoist/global.rb"
+- "./lib/egoist/proxy.rb"
+homepage: https://github.com/dux/egoist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby access policy library
+test_files: []