access-granted 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7691e3b04d61e828a960869add4c89b2fcbbb0ff61449ae9a722f1170c776775
-  data.tar.gz: 3d802b85887e1e23027819cf14b2bd4ebb9d9bc4aef62f294bd8dedc1dc98457
+  metadata.gz: 115b6ed416c4bfa4b6d94d53520388c382b65966aa8ce7c4072d9991a630d1d3
+  data.tar.gz: 0af1baa07da37953f292b4bb8d24680cbebdf70c1495203d7a4312d4735584bb
 SHA512:
-  metadata.gz: 929211bc395469276092ed2303d5d4bf117161e9df3602cfea3d4caf67ea29516fca0473eb24e8e5326921d042ab8d534eef7a27e9ccdd727b29fd129f7cc622
-  data.tar.gz: d60b8f9c3824c28952daf0a84ee4bd534ec44cc7ef6f183949eb83538b015b2a80b155ee8f91ba6484d620041c2143a4ca9ce7d46c7ef71280b56f25d744821d
+  metadata.gz: 6554c68a9ddd5f04866afef389d59d48ddbd63fc6173c6955b39075fb9f23ac5c8d1036f13cc8f7ac9fed997217d1d69b725c5f6e0dc83550a1e8eea293e6e6d
+  data.tar.gz: 162efc4e19ad3fa554778b00dfd46d28f951ac90a65d94c2f3037f554dc590f9822eb7db6a19c792f65eeaba78adcc77386f9956e88c7f00f9127a2a231141e9

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+# 1.3.3
+
+- Fix compatibility with Rails 6.0 and Zeitwerk ([PR #53](https://github.com/chaps-io/access-granted/pull/53)), thanks [jraqula](https://github.com/dmorehouse)!
+
+# 1.3.2
+
+- Expose `applicable_roles` method on the policy instance. This allows insight into what roles actually apply to a given user.
+
 # 1.3.1
 
-- Add information about action and subject when raising AccessDenied exception ([PR #45](https://github.com/chaps-io/access-granted/pull/46)), thanks [jraqula](https://github.com/jraqula)!
+- Add information about action and subject when raising AccessDenied exception ([PR #46](https://github.com/chaps-io/access-granted/pull/46)), thanks [jraqula](https://github.com/jraqula)!
 
 # 1.3.0
 

data/README.md

@@ -25,7 +25,7 @@ config.autoload_paths += %W(#{config.root}/app/policies #{config.root}/app/roles
 
 ### Supported Ruby versions
 
-Because it has **zero** runtime dependencies it is guaranteed to work on all major Ruby versions MRI 1.9.3-2.2, Rubinius >= 2.X and JRuby >= 1.7.
+Because it has **zero** runtime dependencies it is guaranteed to work on all major Ruby versions MRI `2.0` - `2.5`, Rubinius `>= 2.X` and JRuby `>= 1.7`.
 
 ## Summary
 
@@ -232,6 +232,21 @@ if you want to handle authorization errors differently for some cases:
   end
 ```
 
+You can also have a custom exception message while authorizing a request.
+This message will be associated with the exception object thrown.
+
+```ruby
+class PostsController
+  def show
+    @post = Post.find(params[:id])
+    authorize! :read, @post, 'You do not have access to this post'
+    render json: { post: @post }
+  rescue AccessGranted::AccessDenied => e
+    render json: { error: e.message }, status: :forbidden
+  end
+end
+```
+
 #### Checking permissions in controllers
 
 To check if the user has a permission to perform an action, use the `can?` and `cannot?` methods.

data/access-granted.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "access-granted"
-  spec.version       = "1.3.1"
+  spec.version       = "1.3.3"
   spec.authors       = ["Piotrek Okoński"]
   spec.email         = ["piotrek@okonski.org"]
   spec.description   = %q{Role based authorization gem}

data/lib/access-granted/exceptions.rb

@@ -4,10 +4,11 @@ module AccessGranted
   class DuplicatePermission < Error; end;
   class DuplicateRole < Error; end;
   class AccessDenied < Error
-    attr_reader :action, :subject
-    def initialize(action = nil, subject = nil)
+    attr_reader :action, :subject, :message
+    def initialize(action = nil, subject = nil, message = nil)
       @action = action
       @subject = subject
+      @message = message
     end
   end
 end

data/lib/access-granted/policy.rb

@@ -56,15 +56,13 @@ module AccessGranted
       !can?(*args)
     end
 
-    def authorize!(action, subject)
+    def authorize!(action, subject, message = 'Access Denied')
       if cannot?(action, subject)
-        raise AccessDenied.new(action, subject)
+        raise AccessDenied.new(action, subject, message)
       end
       subject
     end
 
-    private
-
     def applicable_roles
       @applicable_roles ||= roles.select do |role|
         role.applies_to?(user)

data/lib/access-granted/railtie.rb

@@ -3,15 +3,25 @@ require 'rails/railtie'
 module AccessGranted
   class Railtie < ::Rails::Railtie
     initializer :access_granted do
-      if defined? ActionController::Base
-        ActionController::Base.class_eval do
-          include AccessGranted::Rails::ControllerMethods
+      if ::Rails::VERSION::MAJOR >= 6
+        ActiveSupport.on_load(:action_controller_base) do |base|
+          base.include AccessGranted::Rails::ControllerMethods
+        end
+
+        ActiveSupport.on_load(:action_controller_api) do |base|
+          base.include AccessGranted::Rails::ControllerMethods
+        end
+      else
+        if defined? ActionController::Base
+          ActionController::Base.class_eval do
+            include AccessGranted::Rails::ControllerMethods
+          end
         end
-      end
 
-      if defined? ActionController::API
-        ActionController::API.class_eval do
-          include AccessGranted::Rails::ControllerMethods
+        if defined? ActionController::API
+          ActionController::API.class_eval do
+            include AccessGranted::Rails::ControllerMethods
+          end
         end
       end
     end

data/lib/access-granted/role.rb

@@ -69,11 +69,8 @@ module AccessGranted
     end
 
     def prepare_actions(action)
-      if action == :manage
-        actions = [:read, :create, :update, :destroy]
-      else
-        actions = Array(*[action])
-      end
+      actions = Array(*[action])
+      actions.flat_map { |a| a == :manage ? [:create, :read, :update, :destroy ] : [a] }
     end
   end
 end

data/spec/policy_spec.rb

@@ -143,6 +143,16 @@ describe AccessGranted::Policy do
         end
       end
 
+      it "raises AccessDenied with supplied message if action is not allowed" do
+        message = 'You are not allowed to create Integer'
+        expect { klass.new(@member).authorize!(:create, Integer, message) }.to raise_error do |err|
+          expect(err).to be_a(AccessGranted::AccessDenied)
+          expect(err.action).to eq(:create)
+          expect(err.subject).to eq(Integer)
+          expect(err.message).to eq(message)
+        end
+      end
+
       it "returns the subject if allowed" do
         expect(klass.new(@member).authorize!(:create, String)).to equal String
       end
@@ -188,8 +198,9 @@ describe AccessGranted::Policy do
     end
   end
 
-  describe "#matching_roles" do
+  describe "#applicable_roles" do
     let(:user) { double("User", is_moderator: true, is_admin: true) }
+    subject(:policy) { klass.new(user) }
 
     before do
       policy.role(:administrator, { is_admin:     true })
@@ -197,9 +208,17 @@ describe AccessGranted::Policy do
       policy.role(:member)
     end
 
-    shared_examples 'role matcher' do
+    context "user matches all roles" do
       it "returns all matching roles in the order of priority" do
-        expect(subject.map(&:name)).to eq([:administrator, :moderator, :member])
+        expect(policy.applicable_roles.map(&:name)).to eq([:administrator, :moderator, :member])
+      end
+    end
+
+    context "user is just an admin" do
+      let(:user) { double("User", is_moderator: false, is_admin: true) }
+
+      it 'returns array with admin and member roles' do
+        expect(policy.applicable_roles.map(&:name)).to eq([:administrator, :member])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: access-granted
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Piotrek Okoński
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Elegant whitelist and role based authorization with ability to prioritize