authorizy 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7006471814660a18a36666a304b2a8178d0e6c206c08b4c7d84f1bb0619214
-  data.tar.gz: 75484b0f5b9960632799937725244e38552e2ad90999ddb9390572cf1880f2e5
+  metadata.gz: 1bdbf8fe26ec2fa456858b922f21efa63830f329018f07d6c2bed196d7e5cd8a
+  data.tar.gz: 49ad3862405c7707a3ab83c458e8c950d4fcf8b3e6488d7edc6fa6416e912cd9
 SHA512:
-  metadata.gz: b2591d21df9e87ac0161c6a03327797350f93b9a230733a2597f9ec703cd853a7de62c3e0fc52c1f6e2fe16fbaabc2c1317ce3e93a5c83284283262b750be875
-  data.tar.gz: 4e2d661a5560bb7f2fd3aca9fb8846e147828bac74b3cea9bcfd803ac1a64a0a95de9d7b7a4a2019cc7ad31c41694ae73a21bd0fb770e9412f537dd406403816
+  metadata.gz: 88568952618d7984a5ec9b548a74adaa64a263d4bfecdae71ec5e28225df8a5a93d5febf6aedb5a27a87f22ced4c066da8b330a5e8c96bc77abc7cea71cbde20
+  data.tar.gz: 2be439b99e310b42fca0122ba1a2c7bdf79d932a38be47e09722f6308763f73f25f76ad3481874ac0f7bd3b3e6ea7f33728c1605d372aba71a15c6de8143ffc7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.3.0
+
+## Features
+
+- Added options `field` to customize how the authorizy field is fetched;
+
 # v0.2.2
 
 ## Fixes

data/README.md

@@ -84,25 +84,6 @@ Authorizy.configure do |config|
 end
 ```
 
-### Dependencies
-
-You can allow access to one or more controllers and actions based on your permissions. It'll consider not only the `action`, like [aliases](#aliases) but the controller either.
-
-```ruby
-Authorizy.configure do |config|
-  config.dependencies = {
-    payments: {
-      index: [
-        ['system/users', :index],
-        ['system/enrollments', :index],
-      ]
-    }
-  }
-end
-```
-
-So now if a have the permission `payments#index` I'll receive more two permissions: `users#index` and `enrollments#index`.
-
 ### Cop
 
 Sometimes we need to allow access in runtime because the permission will depend on the request data and/or some dynamic logic. For this you can create a *Cop* class, that inherits from `Authorizy::BaseCop`, to allow it based on logic. It works like a [Interceptor](https://en.wikipedia.org/wiki/Interceptor_pattern).
@@ -161,6 +142,35 @@ Authorizy.configure do |config|
 end
 ```
 
+### Dependencies
+
+You can allow access to one or more controllers and actions based on your permissions. It'll consider not only the `action`, like [aliases](#aliases) but the controller either.
+
+```ruby
+Authorizy.configure do |config|
+  config.dependencies = {
+    payments: {
+      index: [
+        ['system/users', :index],
+        ['system/enrollments', :index],
+      ]
+    }
+  }
+end
+```
+
+So now if a have the permission `payments#index` I'll receive more two permissions: `users#index` and `enrollments#index`.
+
+### Field
+
+By default the permissions are located inside the field called `authorizy` in the configured `current_user`. You can change how this field is fetched:
+
+```ruby
+Authorizy.configure do |config|
+  @field = ->(current_user) { current_user.profile.authorizy }
+end
+```
+
 ### Redirect URL
 
 When authorization fails and the request is not a XHR request a redirect happens to `/` path. You can change it:

data/lib/authorizy/config.rb

@@ -2,13 +2,14 @@
 
 module Authorizy
   class Config
-    attr_accessor :aliases, :dependencies, :cop, :current_user, :redirect_url
+    attr_accessor :aliases, :cop, :current_user, :dependencies, :field, :redirect_url
 
     def initialize
       @aliases      = {}
       @cop          = Authorizy::BaseCop
       @current_user = ->(context) { context.respond_to?(:current_user) ? context.current_user : nil }
       @dependencies = {}
+      @field        = ->(current_user) { current_user.respond_to?(:authorizy) ? current_user.authorizy : {} }
       @redirect_url = ->(context) { context.respond_to?(:root_url) ? context.root_url : '/' }
     end
   end

data/lib/authorizy/core.rb

@@ -50,7 +50,7 @@ module Authorizy
     end
 
     def user_permissions
-      expand(@user.authorizy.try(:[], 'permissions'))
+      expand(Authorizy.config.field.call(@user).try(:[], 'permissions'))
     end
   end
 end

data/lib/authorizy/extension.rb

@@ -8,38 +8,30 @@ module Authorizy
       helper_method(:authorizy?)
 
       def authorizy
-        return if authorizy_core.new(authorizy_user, params, session, cop: authorizy_cop).access?
+        return if Authorizy::Core.new(authorizy_user, params, session, cop: authorizy_cop).access?
 
         info = I18n.t('authorizy.denied', controller: params[:controller], action: params[:action])
 
         return render(json: { message: info }, status: 401) if request.xhr?
 
-        redirect_to authorizy_config.redirect_url.call(self), info: info
+        redirect_to Authorizy.config.redirect_url.call(self), info: info
       end
 
       def authorizy?(controller, action)
         params['controller'] = controller
         params['action'] = action
 
-        authorizy_core.new(authorizy_user, params, session, cop: authorizy_cop).access?
+        Authorizy::Core.new(authorizy_user, params, session, cop: authorizy_cop).access?
       end
 
       private
 
-      def authorizy_core
-        Authorizy::Core
-      end
-
       def authorizy_user
-        authorizy_config.current_user.call(self)
-      end
-
-      def authorizy_config
-        Authorizy.config
+        Authorizy.config.current_user.call(self)
       end
 
       def authorizy_cop
-        authorizy_config.cop.new(authorizy_user, params, session)
+        Authorizy.config.cop.new(authorizy_user, params, session)
       end
     end
   end

data/lib/authorizy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Authorizy
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/spec/authorizy/config/current_user_spec.rb

@@ -15,9 +15,7 @@ RSpec.describe Authorizy::Config, '#current_user' do
     context 'when context does not respond to current_user' do
       let!(:context) { 'context' }
 
-      it 'returns nil' do
-        expect(config.current_user.call(context)).to be(nil)
-      end
+      it { expect(config.current_user.call(context)).to be(nil) }
     end
   end
 

data/spec/authorizy/config/field_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.describe Authorizy::Config, '#field' do
+  let!(:config) { described_class.new }
+
+  context 'when uses default value' do
+    context 'when current_user responds to authorizy' do
+      let!(:current_user) { OpenStruct.new(authorizy: { permissions: [%i[users index]] }) }
+
+      it 'is called' do
+        expect(config.field.call(current_user)).to eq(permissions: [%i[users index]])
+      end
+    end
+
+    context 'when current_user does not respond to field' do
+      let!(:current_user) { nil }
+
+      it { expect(config.field.call(current_user)).to eq({}) }
+    end
+  end
+
+  context 'when uses custom value' do
+    it 'executes what you want' do
+      config.field = ->(current_user) { current_user[:value] }
+
+      expect(config.field.call({ value: 'value' })).to eq('value')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authorizy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,7 @@ files:
 - spec/authorizy/config/cop_spec.rb
 - spec/authorizy/config/current_user_spec.rb
 - spec/authorizy/config/dependencies_spec.rb
+- spec/authorizy/config/field_spec.rb
 - spec/authorizy/config/initialize_spec.rb
 - spec/authorizy/config/redirect_url_spec.rb
 - spec/authorizy/cop/controller_spec.rb
@@ -217,6 +218,7 @@ test_files:
 - spec/authorizy/config/cop_spec.rb
 - spec/authorizy/config/current_user_spec.rb
 - spec/authorizy/config/dependencies_spec.rb
+- spec/authorizy/config/field_spec.rb
 - spec/authorizy/config/initialize_spec.rb
 - spec/authorizy/config/redirect_url_spec.rb
 - spec/authorizy/cop/controller_spec.rb