forest_liana 7.8.0 → 8.0.0.beta.2

data/spec/services/forest_liana/ability/permission_spec.rb

@@ -0,0 +1,332 @@
+module ForestLiana
+  module Ability
+    describe Ability do
+      let(:dummy_class) { Class.new { extend ForestLiana::Ability } }
+      let(:user) { { 'id' => 1, 'roleId' => 1, 'rendering_id' => '1' } }
+      let(:permission) {
+        {
+          'Island' => {
+            'browse' => [1],
+            'read' => [1],
+            'edit' => [1],
+            'add' => [1],
+            'delete' => [1],
+            'export' => [1],
+            :actions => {
+                'my_action' => {
+                    'triggerEnabled' => [1],
+                    'triggerConditions' => [],
+                    'approvalRequired' => [],
+                    'approvalRequiredConditions' => [
+                        { 'filter' =>
+                            { 'aggregator' => 'and',
+                              'conditions' =>
+                                [
+                                  { 'field' => 'price',
+                                    'value' => '1',
+                                    'source' => 'data',
+                                    'operator' => 'greater_than' }
+                                ]
+                            },
+                          'roleId' => 10
+                        }
+                    ],
+                    'userApprovalEnabled' => [1],
+                    'userApprovalConditions' =>
+                      [
+                        { 'filter' =>
+                            { 'aggregator' => 'and',
+                              'conditions' =>
+                                [
+                                  { 'field' => 'price',
+                                    'value' => '1',
+                                    'source' => 'data',
+                                    'operator' => 'greater_than'
+                                  }
+                                ]
+                            },
+                          'roleId' => 11 }
+                      ],
+                    'selfApprovalEnabled' => [1]
+                  }
+            }
+          }
+        }
+      }
+
+      before do
+        Rails.cache.clear
+        Rails.cache.write('forest.users', {'1' => user})
+        Rails.cache.write('forest.has_permission', true)
+        Rails.cache.write('forest.collections',permission)
+        Rails.cache.write('forest.stats', ['Leaderboard:b47e6fea7f7b9e2c7496d0c9399591f289552de6', 'Objective:fb40159a0cf0025de5fddf9a565e7ba2fef2c2b5', 'Value:b9a64a2ce88cb59ab5e2d5f5b25c6cfe35bf9350'])
+        Island.create!(name: "L'île de la muerta")
+      end
+
+      describe 'is_crud_authorized' do
+        it 'should return true when has_permission is false' do
+          Rails.cache.clear
+          allow_any_instance_of(ForestLiana::Ability::Fetch)
+            .to receive(:get_permissions)
+            .and_return(true)
+
+          expect(dummy_class.is_crud_authorized?('browse', user, Island.first)).to equal true
+        end
+
+        it 'should return true when the action is in [browse read edit add delete export] list' do
+          %w[browse read edit add delete export].each do |action|
+            expect(dummy_class.is_crud_authorized?(action, user, Island)).to equal true
+          end
+        end
+
+        it 'should throw an exception when the collection doesn\'t exist' do
+            expect {dummy_class.is_crud_authorized?('browse', user, String)}.to raise_error(ForestLiana::Errors::ExpectedError, 'The collection String doesn\'t exist')
+        end
+
+        it 'should re-fetch the permission once when user permission is not allowed' do
+          Rails.cache.write(
+            'forest.collections',
+            {
+              'Island' => {
+                'browse' => [2],
+                'read' => [1],
+                'edit' => [1],
+                'add' => [1],
+                'delete' => [1],
+                'export' => [1],
+                'actions' =>
+                  {
+                    'Mark as Live' => { 'triggerEnabled' => [10, 8, 9],
+                                        'triggerConditions' => [],
+                                        'approvalRequired' => [10, 8],
+                                        'approvalRequiredConditions' =>
+                                          [
+                                            { 'filter' =>
+                                                { 'aggregator' => 'and',
+                                                  'conditions' =>
+                                                    [
+                                                      { 'field' => 'price',
+                                                        'value' => 1,
+                                                        'source' => 'data',
+                                                        'operator' => 'greater_than'
+                                                      }
+                                                    ]
+                                                },
+                                              'roleId' => 10
+                                            }
+                                          ],
+                                        'userApprovalEnabled' => [10, 8, 11],
+                                        'userApprovalConditions' =>
+                                          [
+                                            { 'filter' =>
+                                                { 'aggregator' => 'and',
+                                                  'conditions' =>
+                                                    [
+                                                      { 'field' => 'price',
+                                                        'value' => 1,
+                                                        'source' => 'data',
+                                                        'operator' => 'greater_than'
+                                                      }
+                                                    ]
+                                                },
+                                              'roleId' => 11 }
+                                          ],
+                                        'selfApprovalEnabled' => [8]
+                    }
+                  }
+              }
+            }
+          )
+
+          allow_any_instance_of(ForestLiana::Ability::Fetch)
+            .to receive(:get_permissions)
+            .and_return(
+              {
+                "collections" => {
+                    "Island" => {
+                        "collection" => {
+                            "browseEnabled" => { "roles" => [1] },
+                            "readEnabled" => { "roles" => [1] },
+                            "editEnabled" => { "roles" => [1] },
+                            "addEnabled" => { "roles" => [1] },
+                            "deleteEnabled" => { "roles" => [1] },
+                            "exportEnabled" => { "roles" => [1] }
+                          },
+                        "actions" => {
+
+                        }
+                      }
+                  }
+              }
+            )
+
+          expect(dummy_class.is_crud_authorized?('browse', user, Island)).to equal true
+        end
+
+        it 'should return false when user permission is not allowed' do
+          Rails.cache.delete('forest.users')
+
+          allow_any_instance_of(ForestLiana::Ability::Fetch)
+            .to receive(:get_permissions)
+            .with('/liana/v4/permissions/users')
+            .and_return(
+              [
+                {"id"=>1, "firstName"=>"John", "lastName"=>"Doe", "email"=>"jd@forestadmin.com", "tags"=>{}, "roleId"=>'2', "permissionLevel"=>"admin"}
+              ]
+            )
+
+          allow_any_instance_of(ForestLiana::Ability::Fetch)
+            .to receive(:get_permissions)
+            .with('/liana/v4/permissions/environment')
+            .and_return(
+              {
+                "collections" => {
+                  "Island" => {
+                    "collection" => {
+                      "browseEnabled" => { "roles" => [1] },
+                      "readEnabled" => { "roles" => [1] },
+                      "editEnabled" => { "roles" => [1] },
+                      "addEnabled" => { "roles" => [1] },
+                      "deleteEnabled" => { "roles" => [1] },
+                      "exportEnabled" => { "roles" => [1] }
+                    },
+                    "actions"=>
+                      {
+                        "Mark as Live"=>
+                          {
+                            "triggerEnabled" => {"roles"=>[1]},
+                            "triggerConditions" => [],
+                            "approvalRequired" => {"roles" => [1]},
+                            "approvalRequiredConditions" => [],
+                            "userApprovalEnabled" => {"roles" => [1]},
+                            "userApprovalConditions" => [],
+                            "selfApprovalEnabled" => {"roles" => [1]}
+                          }
+                      }
+                  }
+                }
+              }
+            )
+
+          expect(dummy_class.is_crud_authorized?('browse', user, Island)).to be false
+        end
+      end
+
+      describe 'is_chart_authorized?' do
+        it 'should return true when sha1 of parameters exist in the list of sha1 of forest.stats cache' do
+          parameters = ActionController::Parameters.new(
+            type: 'Objective',
+            sourceCollectionName: 'Customer',
+            aggregateFieldName: 'id',
+            aggregator: 'Sum',
+            objective: 20,
+            filter: nil,
+            contextVariables: ActionController::Parameters.new,
+            timezone: 'Europe/Paris',
+            controller: 'forest_liana/stats',
+            action: 'get',
+            collection: 'Customer'
+          ).permit!
+
+          expect(dummy_class.is_chart_authorized?(user, parameters)).to equal true
+        end
+
+        it 'should return false when sha1 of parameters doesn\'t exist in the list of sha1 of forest.stats cache' do
+          parameters = ActionController::Parameters.new(
+            type: 'Objective',
+            sourceCollectionName: 'Product',
+            aggregateFieldName: 'id',
+            aggregator: 'Sum',
+            objective: 20,
+            filter: nil,
+            contextVariables: ActionController::Parameters.new,
+            timezone: 'Europe/Berlin',
+            controller: 'forest_liana/stats',
+            action: 'get',
+            collection: 'Customer'
+          ).permit!
+
+          allow_any_instance_of(ForestLiana::Ability::Fetch)
+            .to receive(:get_permissions)
+            .and_return(
+              {
+                "stats" => [{
+                  "type" => "Leaderboard",
+                  "limit" => '1',
+                  "aggregator" => "Count",
+                  "labelFieldName" => "label",
+                  "aggregateFieldName" => nil,
+                  "relationshipFieldName" => "orders",
+                  "sourceCollectionName" => "Product"
+                }, {
+                  "type" => "Objective",
+                  "filter" => nil,
+                  "objective" => '20',
+                  "aggregator" => "Sum",
+                  "aggregateFieldName" => "id",
+                  "sourceCollectionName" => "Customer"
+                }, {
+                  "type" => "Value",
+                  "filter" => {
+                    "aggregator" => "and",
+                    "conditions" => [{
+                                       "field" => "price",
+                                       "operator" => "greater_than",
+                                       "value" => "{{dropdown1.selectedValue}}"
+                                     }]
+                  },
+                  "aggregator" => "Count",
+                  "aggregateFieldName" => nil,
+                  "sourceCollectionName" => "Product"
+                }],
+              }
+            )
+
+          expect(dummy_class.is_chart_authorized?(user, parameters)).to equal false
+        end
+      end
+
+      describe 'is_smart_action_authorized?' do
+        let(:parameters)  {
+            ActionController::Parameters.new(
+              {
+                "data": {
+                  "attributes": {
+                    "values": {},
+                    "ids": [
+                      "1"
+                    ],
+                    "collection_name": "Island",
+                    "parent_collection_name": nil,
+                    "parent_collection_id": nil,
+                    "parent_association_name": nil,
+                    "all_records": false,
+                    "all_records_subset_query": {
+                      "fields[Island]": "id,name",
+                      "fields[file_attachment]": "name",
+                      "fields[file_blob]": "id",
+                      "page[number]": 1,
+                      "page[size]": 15,
+                      "sort": "-id",
+                      "timezone": "Europe/Paris"
+                    },
+                    "all_records_ids_excluded": ["3", "2"],
+                    "smart_action_id": "my_action",
+                    "signed_approval_request": nil
+                  }
+                }
+              }
+          ).permit!
+        }
+
+        it 'should return true' do
+          expect(dummy_class.is_smart_action_authorized?(user, Island,  parameters, '/forest/actions/my_action', 'POST')).to equal true
+        end
+
+        it 'should throw an exception when the collection doesn\'t exist' do
+          expect {dummy_class.is_smart_action_authorized?(user, String, parameters, '/forest/actions/my_action', 'POST')}.to raise_error(ForestLiana::Errors::ExpectedError, 'The collection String doesn\'t exist')
+        end
+      end
+    end
+  end
+end

data/spec/services/forest_liana/filters_parser_spec.rb

@@ -28,18 +28,6 @@ module ForestLiana
       Island.destroy_all
     }
 
-    describe 'initialization' do
-      context 'badly formated filters' do
-        let(:filter_parser) { described_class.new('{ toto: 1', resource, timezone) }
-
-        it {
-          expect {
-            described_class.new('{ toto: 1', resource, timezone)
-          }.to raise_error(ForestLiana::Errors::HTTP422Error, 'Invalid filters JSON format')
-        }
-      end
-    end
-
     describe 'apply_filters' do
       let(:parsed_filters) { filter_parser.apply_filters }
 

data/spec/services/forest_liana/line_stat_getter_spec.rb

@@ -7,7 +7,6 @@ module ForestLiana
     before(:each) do
       ForestLiana::ScopeManager.invalidate_scope_cache(rendering_id)
       allow(ForestLiana::ScopeManager).to receive(:fetch_scopes).and_return(scopes)
-      Owner.delete_all
     end
 
     describe 'Check client_timezone function' do
@@ -15,7 +14,7 @@ module ForestLiana
         it 'should return false' do
           expect(LineStatGetter.new(Owner, {
             timezone: "Europe/Paris",
-            aggregate: "Count",
+            aggregator: "Count",
           }, user).client_timezone).to eq(false)
         end
       end
@@ -28,7 +27,7 @@ module ForestLiana
         it 'should return the timezone' do
           expect(LineStatGetter.new(Owner, {
             timezone: "Europe/Paris",
-            aggregate: "Count",
+            aggregator: "Count",
           }, user).client_timezone).to eq('Europe/Paris')
         end
       end
@@ -40,6 +39,7 @@ module ForestLiana
           it 'should return consistent data based on monday as week_start ' do
             # Week should start on monday
             # 08-05-2021 was a Saturday
+            Owner.delete_all
             Owner.create(name: 'Michel', hired_at: Date.parse('08-05-2021'));
             Owner.create(name: 'Robert', hired_at: Date.parse('09-05-2021'));
             Owner.create(name: 'José', hired_at: Date.parse('10-05-2021'));
@@ -47,9 +47,9 @@ module ForestLiana
 
             stat = LineStatGetter.new(Owner, {
               timezone: "Europe/Paris",
-              aggregate: "Count",
-              time_range: "Week",
-              group_by_date_field: "hired_at",
+              aggregator: "Count",
+              timeRange: "Week",
+              groupByFieldName: "hired_at",
             }, user).perform
 
             expect(stat.value.find { |item| item[:label] == "W18-2021" }[:values][:value]).to eq(2)
@@ -65,9 +65,9 @@ module ForestLiana
           Owner.create(name: 'Shuri', hired_at: Date.parse('09-11-2022'));
           stat = LineStatGetter.new(Owner, {
             timezone: "Europe/Paris",
-            aggregate: "Count",
-            time_range: "Day",
-            group_by_date_field: "hired_at",
+            aggregator: "Count",
+            timeRange: "Day",
+            groupByFieldName: "hired_at",
           }, user)
 
           expect(stat.get_resource.where(name: "Shuri").to_sql.downcase.exclude? "order by").to be true

data/spec/services/forest_liana/pie_stat_getter_spec.rb

@@ -28,10 +28,10 @@ module ForestLiana
     let(:params) {
       {
         type: 'Pie',
-        collection: collection,
+        sourceCollectionName: collection,
         timezone: 'Europe/Paris',
-        aggregate: 'Count',
-        group_by_field: group_by_field
+        aggregator: 'Count',
+        groupByFieldName: groupByFieldName
       }
     }
 
@@ -41,7 +41,7 @@ module ForestLiana
       let(:scopes) { { } }
 
       describe 'with an aggregate on the name field' do
-        let(:group_by_field) { 'name' }
+        let(:groupByFieldName) { 'name' }
 
         it 'should be as many categories as records count' do
           subject.perform
@@ -60,7 +60,7 @@ module ForestLiana
       end
 
       describe 'with an aggregate on the age field' do
-        let(:group_by_field) { 'age' }
+        let(:groupByFieldName) { 'age' }
 
         it 'should be as many categories as different ages among records' do
           subject.perform
@@ -87,7 +87,7 @@ module ForestLiana
       }
 
       describe 'with an aggregate on the name field' do
-        let(:group_by_field) { 'name' }
+        let(:groupByFieldName) { 'name' }
 
         it 'should be as many categories as records inside the scope' do
           subject.perform
@@ -102,7 +102,7 @@ module ForestLiana
       end
 
       describe 'with an aggregate on the age field' do
-        let(:group_by_field) { 'age' }
+        let(:groupByFieldName) { 'age' }
 
         it 'should be only one category' do
           subject.perform

data/spec/services/forest_liana/value_stat_getter_spec.rb

@@ -18,10 +18,10 @@ module ForestLiana
     let(:params) {
       {
         type: "Value",
-        collection: collection,
+        sourceCollectionName: sourceCollectionName,
         timezone: "Europe/Paris",
-        aggregate: "Count",
-        filters: filters
+        aggregator: "Count",
+        filter: filter
       }
     }
 
@@ -32,8 +32,8 @@ module ForestLiana
 
       describe 'with a simple filter matching no entries' do
         let(:model) { User }
-        let(:collection) { 'users' }
-        let(:filters) { { field: 'name', operator: 'in', value: ['Merry', 'Pippin'] }.to_json }
+        let(:sourceCollectionName) { 'users' }
+        let(:filter) { { field: 'name', operator: 'in', value: ['Merry', 'Pippin'] }.to_json }
 
         it 'should have a countCurrent of 0' do
           subject.perform
@@ -43,8 +43,8 @@ module ForestLiana
 
       describe 'with a filter on a belongs_to string field' do
         let(:model) { Tree }
-        let(:collection) { 'trees' }
-        let(:filters) { { field: 'owner:name', operator: 'equal', value: 'Aragorn' }.to_json }
+        let(:sourceCollectionName) { 'trees' }
+        let(:filter) { { field: 'owner:name', operator: 'equal', value: 'Aragorn' }.to_json }
 
         it 'should have a countCurrent of 2' do
           subject.perform
@@ -54,8 +54,8 @@ module ForestLiana
 
       describe 'with a filter on a belongs_to enum field' do
         let(:model) { Tree }
-        let(:collection) { 'trees' }
-        let(:filters) { { field: 'owner:title', operator: 'equal', value: 'villager' }.to_json }
+        let(:sourceCollectionName) { 'trees' }
+        let(:filter) { { field: 'owner:title', operator: 'equal', value: 'villager' }.to_json }
 
         it 'should have a countCurrent of 1' do
           subject.perform
@@ -83,8 +83,8 @@ module ForestLiana
 
       describe 'with a filter on a belongs_to enum field' do
         let(:model) { User }
-        let(:collection) { 'users' }
-        let(:filters) { { field: 'title', operator: 'equal', value: 'villager' }.to_json }
+        let(:sourceCollectionName) { 'users' }
+        let(:filter) { { field: 'title', operator: 'equal', value: 'villager' }.to_json }
 
         it 'should have a countCurrent of 0' do
           subject.perform

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'simplecov'
 SimpleCov.start 'rails'
+SimpleCov.add_filter ['app/services/forest_liana/ability/fetch.rb', 'lib/forest_liana/version.rb']
 
 # This file was generated by the `rails generate rspec:install` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 7.8.0
+  version: 8.0.0.beta.2
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -192,6 +192,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: deepsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Forest is a modern admin interface that works on all major web frameworks.
   forest_liana is the gem that makes Forest admin work on any Rails application (Rails
   >= 4.0).
@@ -244,6 +258,15 @@ files:
 - app/serializers/forest_liana/stripe_invoice_serializer.rb
 - app/serializers/forest_liana/stripe_payment_serializer.rb
 - app/serializers/forest_liana/stripe_subscription_serializer.rb
+- app/services/forest_liana/ability.rb
+- app/services/forest_liana/ability/exceptions/access_denied.rb
+- app/services/forest_liana/ability/exceptions/action_condition_error.rb
+- app/services/forest_liana/ability/exceptions/require_approval.rb
+- app/services/forest_liana/ability/exceptions/trigger_forbidden.rb
+- app/services/forest_liana/ability/fetch.rb
+- app/services/forest_liana/ability/permission.rb
+- app/services/forest_liana/ability/permission/request_permission.rb
+- app/services/forest_liana/ability/permission/smart_action_checker.rb
 - app/services/forest_liana/apimap_sorter.rb
 - app/services/forest_liana/authentication.rb
 - app/services/forest_liana/authorization_getter.rb
@@ -270,9 +293,6 @@ files:
 - app/services/forest_liana/oidc_configuration_retriever.rb
 - app/services/forest_liana/oidc_dynamic_client_registrator.rb
 - app/services/forest_liana/operator_date_interval_parser.rb
-- app/services/forest_liana/permissions_checker.rb
-- app/services/forest_liana/permissions_formatter.rb
-- app/services/forest_liana/permissions_getter.rb
 - app/services/forest_liana/pie_stat_getter.rb
 - app/services/forest_liana/query_stat_getter.rb
 - app/services/forest_liana/resource_creator.rb
@@ -401,16 +421,14 @@ files:
 - spec/requests/stats_spec.rb
 - spec/requests/test.ru
 - spec/routing/routes_spec.rb
+- spec/services/forest_liana/ability/ability_spec.rb
+- spec/services/forest_liana/ability/permission/smart_action_checker_spec.rb
+- spec/services/forest_liana/ability/permission_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
 - spec/services/forest_liana/has_many_getter_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_spec.rb
 - spec/services/forest_liana/line_stat_getter_spec.rb
-- spec/services/forest_liana/permissions_checker_acl_disabled_spec.rb
-- spec/services/forest_liana/permissions_checker_acl_enabled_spec.rb
-- spec/services/forest_liana/permissions_checker_live_queries_spec.rb
-- spec/services/forest_liana/permissions_formatter_spec.rb
-- spec/services/forest_liana/permissions_getter_spec.rb
 - spec/services/forest_liana/pie_stat_getter_spec.rb
 - spec/services/forest_liana/resource_updater_spec.rb
 - spec/services/forest_liana/resources_getter_spec.rb
@@ -521,9 +539,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.5
 signing_key: 
@@ -699,16 +717,14 @@ test_files:
 - spec/requests/stats_spec.rb
 - spec/requests/test.ru
 - spec/routing/routes_spec.rb
+- spec/services/forest_liana/ability/ability_spec.rb
+- spec/services/forest_liana/ability/permission/smart_action_checker_spec.rb
+- spec/services/forest_liana/ability/permission_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
 - spec/services/forest_liana/has_many_getter_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_spec.rb
 - spec/services/forest_liana/line_stat_getter_spec.rb
-- spec/services/forest_liana/permissions_checker_acl_disabled_spec.rb
-- spec/services/forest_liana/permissions_checker_acl_enabled_spec.rb
-- spec/services/forest_liana/permissions_checker_live_queries_spec.rb
-- spec/services/forest_liana/permissions_formatter_spec.rb
-- spec/services/forest_liana/permissions_getter_spec.rb
 - spec/services/forest_liana/pie_stat_getter_spec.rb
 - spec/services/forest_liana/resource_updater_spec.rb
 - spec/services/forest_liana/resources_getter_spec.rb