miau 1.1.1 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d207e809bfd3a605612092afc04287df2def3175e71a0a0b2c98c0ce491e1402
-  data.tar.gz: 4d5985b0b22a467848c0d5e1bc3fd14a22b3231b928e42fafa922f1faa5520fc
+  metadata.gz: bfe1c8f3bc0844078afe66eb87172eb9d372e727cedc6a3d99e276b37b741c4a
+  data.tar.gz: 0dc15287104641bec95f8073387e047770dfd5b02f5f5e5980f6357f460450fb
 SHA512:
-  metadata.gz: ba62cbe78a200045d483bb6b3c544fdbd57aa1a7b24a20ed73b8d5a3304d31420d088441edee0c2d16feaa4223c468375f1e985a78e38263c427e6e139173d6f
-  data.tar.gz: ff00545b68b70128919cc417ba69906e38eaf5decab73681bed88dc291fc648e8cdfa0c40e32942d08ed82605384ad5c76dd0723514f2a95cf6ec7e8deefdb62
+  metadata.gz: 913283a22edaf93ce62275e9a93e30971fdeacd15ba8eb3f5d5066a74d745535a6d992aac40ca94fae58eb006f3bcb4cb8a6bcb28496e9a105509e250a28d8f2
+  data.tar.gz: effe13f27bd0da506d83203c0f454f9df5fd6305c726184d7eb13e92d903719fa8df2fc1fe768ec58ff43a917e3c6c102a3aee76c99957020000a13a285c5767

data/README.md

@@ -44,13 +44,12 @@ end
 ```ruby
 # app/policies/application_policy.rb             # app/policies/posts_policy.rb
   class ApplicationPolicy                          class PostsPolicy < ApplicationPolicy
-    attr_reader :user, :resource                     ...
+    attr_reader :user, :resource, :action                     ...
                                                      def update
-    def initalize(user, resource)                      user.admin? && resource.published?
-      @user = user                                   end
-      @resource = resource                           ...
-    end                                            end
-  end
+    ...                                                user.admin? && resource.published?
+  end                                                end
+                                                     ...
+                                                   end
 ```
 
 "authorize!" will raise an exception (which can be handled by "rescue")
@@ -67,6 +66,8 @@ a corresponding policy method is called.
 
 The policy method has access to the "user" and the "resource".
 
+The "controller" policy method has access to the "user" and the "action".
+
 "user" is set by the default method "miau_user" (can be overwritten) as:
 
 ```ruby

data/lib/miau/application_policy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class ApplicationPolicy
-  attr_accessor :user, :resource
+  attr_accessor :user, :resource, :action
 
   def self.miau(actions, meth = nil, &block)
     kls = name.underscore[0..-8] # remove "_policy"

data/lib/miau/error.rb

@@ -3,15 +3,11 @@
 module Miau
   class Error < StandardError; end
 
-  class NotAuthorizedError < Error
-  end
+  class NotAuthorizedError < Error; end
 
-  class NotDefinedError < Error
-  end
+  class NotDefinedError < Error; end
 
-  class AuthorizationNotPerformedError < Error
-  end
+  class AuthorizationNotPerformedError < Error; end
 
-  class OverwriteError < Error
-  end
+  class OverwriteError < Error; end
 end

data/lib/miau/error.rb.bak

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Miau
+  class Error < StandardError; end
+
+  class NotAuthorizedError < Error; end
+  class NotDefinedError < Error; end
+  class AuthorizationNotPerformedError < Error; end
+  class OverwriteError < Error; end
+end

data/lib/miau/run.rb

@@ -7,7 +7,7 @@ module Miau
   class PolicyRun
     include Singleton
 
-    # return instance of policy (may be nil) and the method
+    # return method[s]
     # klass and action are symbols
     # Priority:
     #   - method of <klass>Policy
@@ -17,7 +17,7 @@ module Miau
     #   - nil
     # returns method_name[s]
 
-    def find_policy(policy, klass, action)
+    def find_methods(policy, klass, action)
       return action if policy.respond_to?(action)
 
       hsh = PolicyStorage.instance.policies[klass]
@@ -26,22 +26,23 @@ module Miau
       hsh[action]
     end
 
-    def run(klass, action, user, resource)
-      policy = PolicyStorage.instance.find_or_create_policy(klass)
-      meth = find_policy policy, klass, action if policy
-      meth ||= find_policy ApplicationPolicy, :application, action
+    def runs(policy, actions)
+      [actions].flatten.each { |action|
+        raise_undef(policy, action) unless policy&.respond_to?(action)
 
-      unless meth
-        msg = "class <#{klass}> action <#{action}>"
-        raise NotDefinedError, msg
-      end
-
-      policy.user = user
-      policy.resource = resource
-      [meth].flatten.each { |m|
-        return false unless policy.send(m)
+        return false unless policy.send(action)
       }
       true
     end
+
+    def raise_undef(policy, action)
+      msg = "policy <#{policy}> action <#{action}>"
+      raise NotDefinedError, msg
+    end
+
+    def raise_authorize(controller, action)
+      msg = "controller <#{controller}> action <#{action}>"
+      raise NotAuthorizedError, msg
+    end
   end
 end

data/lib/miau/storage.rb

@@ -18,7 +18,7 @@ module Miau
     #   }
     # }
     attr_reader :policies
-    attr_reader :instances # { posts: PostsPolicy.new }
+    attr_reader :instances # e.g. { posts: PostsPolicy.new }
 
     def initialize
       reset
@@ -38,7 +38,7 @@ module Miau
       end
 
       if meth.is_a?(Array)
-        meths = [meth].flatten.collect { |m| m.to_sym }
+        meths = [meth].flatten.collect(&:to_sym)
         @policies[kls][action] = meths
       else
         @policies[kls][action] = meth.to_sym

data/lib/miau/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Miau
-  VERSION = "1.1.1" # 2024-01-06
+  VERSION = "1.1.7" # 2024-04-24
+  # VERSION = "1.1.6" # 2024-01-13
+  # VERSION = "1.1.1" # 2024-01-06
   # VERSION = "1.1.0" # 2024-01-06
   # VERSION = "1.0.3" # 2023-12-13
   # VERSION = "1.0.2" # 2023-11-05

data/lib/miau/version.rb.bak

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Miau
+  VERSION = "1.1.6" # 2024-01-13
+  # VERSION = "1.1.1" # 2024-01-06
+  # VERSION = "1.1.0" # 2024-01-06
+  # VERSION = "1.0.3" # 2023-12-13
+  # VERSION = "1.0.2" # 2023-11-05
+  # VERSION = "1.0.1" # 2023-04-24
+  # VERSION = "1.0.0" # 2022-01-23
+  # VERSION = "0.1.2" # 2021-12-10
+  # VERSION = "0.1.1" # 2021-11-06
+  # VERSION = "0.1.0" # 2021-09-13
+  # VERSION = "0.0.2" # 2021-09-11
+  # VERSION = "0.0.1"
+end

data/lib/miau.rb

@@ -21,14 +21,41 @@ module Miau
     @_miau_authorization_performed = true
     return true if authorized?(resource, hsh)
 
-    klass, action = klass_action
-    msg = "class <#{klass} action <#{action}>"
-    raise NotAuthorizedError, msg
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    PolicyRun.instance.raise_authorize(controller, action)
   end
 
   def authorized?(resource = nil, hsh = {})
-    klass, action = klass_action
-    PolicyRun.instance.run(klass, action, miau_user, resource)
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    policy = PolicyStorage.instance.find_or_create_policy(controller)
+    PolicyRun.instance.raise_undef(policy, action) unless policy
+
+    policy.user = miau_user
+    policy.resource = resource
+    methods = PolicyRun.instance.find_methods(policy, controller, action)
+    PolicyRun.instance.raise_undef(policy, action) unless methods
+
+    PolicyRun.instance.runs(policy, methods)
+  end
+
+  def authorize_controller!
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    policy = PolicyStorage.instance.find_or_create_policy(controller)
+    unless policy
+      msg = "missing class #{controller.capitalize}Policy"
+      raise NotDefinedError, msg
+    end
+
+    policy.user = miau_user
+    policy.action = action
+
+    @_miau_authorization_performed = true
+    return true if PolicyRun.instance.runs(policy, :controller)
+
+    PolicyRun.instance.raise_authorize policy, action
   end
 
   def miau_user
@@ -42,18 +69,4 @@ module Miau
   def miau_authorization_performed?
     !!@_miau_authorization_performed
   end
-
-  def authorize_controller!
-    name = params[:controller].to_sym
-    policy = PolicyStorage.instance.find_or_create_policy(name)
-    raise NotDefinedError unless policy&.respond_to?(:controller)
-
-    policy.send(:controller)
-  end
-
-  private
-
-  def klass_action
-    [params[:controller].to_sym, params[:action].to_sym]
-  end
 end

data/lib/miau.rb.bak

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "miau/version"
+require "miau/error"
+require "miau/storage"
+require "miau/run"
+require "miau/application_policy"
+
+module Miau
+  extend ActiveSupport::Concern
+
+  included do
+    if respond_to?(:helper_method)
+      helper_method :authorized?
+      helper_method :miau_user
+    end
+  end
+
+  def authorize!(resource = nil, hsh = {})
+    @_miau_authorization_performed = true
+    return true if authorized?(resource, hsh)
+
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    PolicyRun.instance.raise_authorize(controller, action)
+  end
+
+  def authorized?(resource = nil, hsh = {})
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    policy = PolicyStorage.instance.find_or_create_policy(controller)
+    PolicyRun.instance.raise_undef(policy, action) unless policy
+
+    policy.user = miau_user
+    policy.resource = resource
+    methods = PolicyRun.instance.find_methods(policy, controller, action)
+    PolicyRun.instance.raise_undef(policy, action) unless methods
+
+    PolicyRun.instance.runs(policy, methods)
+  end
+
+  def authorize_controller!
+    controller = params[:controller].to_sym
+    action = params[:action].to_sym
+    policy = PolicyStorage.instance.find_or_create_policy(controller)
+p 22222
+    unless policy
+p 11111111111111
+#      msg = "undefined class #{controller.capitalize}Policy"
+#      raise NotDefinedError, msg
+    end
+
+    policy.user = miau_user
+    policy.action = action
+
+    @_miau_authorization_performed = true
+    return true if PolicyRun.instance.runs(policy, :controller)
+
+    PolicyRun.instance.raise_authorize policy, action
+  end
+
+  def miau_user
+    current_user
+  end
+
+  def verify_authorized
+    raise AuthorizationNotPerformedError unless miau_authorization_performed?
+  end
+
+  def miau_authorization_performed?
+    !!@_miau_authorization_performed
+  end
+end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: miau
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.7
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,36 +67,26 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  MIAU (MIcro AUthorization) provides a set of helpers which restricts what
-  resources a given user is allowed to access.
+  MIAU (MIcro AUthorization) provides some helpers which
+  raises an exception if a given user violates a policy.
 email: dittmar.krall@matiq.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
 files:
-- ".github/workflows/rake.yml"
-- ".gitignore"
-- ".ruby-gemset"
-- ".ruby-version"
-- Appraisals
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- MIT-LICENSE
 - README.md
-- Rakefile
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_6.1.gemfile.lock
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.0.gemfile.lock
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
 - lib/miau.rb
+- lib/miau.rb.bak
 - lib/miau/application_policy.rb
 - lib/miau/error.rb
+- lib/miau/error.rb.bak
 - lib/miau/run.rb
 - lib/miau/storage.rb
 - lib/miau/version.rb
-- miau.gemspec
+- lib/miau/version.rb.bak
 homepage: https://github.com/matique/miau
 licenses:
 - MIT
@@ -116,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Simple and lightweight authorization solution for Rails.

data/.github/workflows/rake.yml

@@ -1,27 +0,0 @@
-# see also https://github.com/whitequark/parser/blob/master/.github/workflows/test.yml
-name: Rake
-
-on: [push]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby_version: ["3.0", "3.2", head]
-        gemfile:
-          - Gemfile
-          - gemfiles/Gemfile.rails-7.1
-          - gemfiles/Gemfile.rails-7.0
-          - gemfiles/Gemfile.rails-6.1
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby_version }}
-          bundler-cache: true
-      - name: Build and test with Rake
-        run: bundle exec rake

data/.gitignore

@@ -1,7 +0,0 @@
-/.bundle/
-/Gemfile.lock
-/coverage/
-.watchr
-
-/doc/
-/tmp/

data/.ruby-gemset

@@ -1 +0,0 @@
-rails-7.1

data/.ruby-version

@@ -1 +0,0 @@
-ruby-3.3.0

data/Appraisals

@@ -1,13 +0,0 @@
-appraise "rails-7.1" do
-  gem "rails", "~> 7.1"
-end
-
-appraise "rails-7.0" do
-  gem "rails", "~> 7.0"
-  gem "dryer-config", "~> 7.0"
-end
-
-appraise "rails-6.1" do
-  gem "rails", "~> 6.1"
-  gem "dryer-config", "~> 6.0"
-end

data/Gemfile

@@ -1,10 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-group :test do
-  gem "observr"
-  gem "standard", require: false
-  gem "simplecov", require: false
-  gem "benchmark-ips"
-end

data/Gemfile.lock

@@ -1,107 +0,0 @@
-PATH
-  remote: .
-  specs:
-    miau (1.1.1)
-      activesupport
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.1.2)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    benchmark-ips (2.13.0)
-    bigdecimal (3.1.5)
-    concurrent-ruby (1.2.2)
-    connection_pool (2.4.1)
-    docile (1.4.0)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    minitest (5.20.0)
-    mutex_m (0.2.0)
-    observr (1.0.5)
-    parallel (1.24.0)
-    parser (3.3.0.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.8.3)
-    rexml (3.2.6)
-    ricecream (0.2.1)
-    rubocop (1.59.0)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    standard (1.33.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.59.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.1)
-    thor (1.3.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  ruby
-  x86_64-linux
-
-DEPENDENCIES
-  appraisal
-  benchmark-ips
-  miau!
-  minitest
-  observr
-  ricecream
-  simplecov
-  standard
-
-BUNDLED WITH
-   2.5.3

data/Rakefile

@@ -1,12 +0,0 @@
-require "rubygems"
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-desc "Run all tests"
-Rake::TestTask.new do |t|
-  t.libs.push "test"
-  t.pattern = "test/*_test.rb"
-end
-
-desc "Default: run unit tests."
-task default: :test

data/gemfiles/rails_6.1.gemfile

@@ -1,15 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 6.1"
-gem "dryer-config", "~> 6.0"
-
-group :test do
-  gem "observr"
-  gem "standard", require: false
-  gem "simplecov", require: false
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"