forest_liana 5.3.3 → 5.4.0

data/spec/services/forest_liana/permissions_formatter_spec.rb

@@ -0,0 +1,222 @@
+module ForestLiana
+  describe PermissionsFormatter do
+    describe '#convert_to_new_format' do
+      let(:rendering_id) { 1 }
+      let(:old_format_collection_permissions) {
+        {
+          'list'=>true,
+          'show'=>false,
+          'create'=>true,
+          'update'=>false,
+          'delete'=>true,
+          'export'=>false,
+          'searchToEdit'=>false
+        }
+      }
+      let(:old_format_action_permissions) { { 'allowed' => true, 'users' => nil } }
+      let(:old_format_scope_permissions) { nil }
+      let(:old_format_permissions) {
+        {
+          'collection_1' => {
+            'collection' => old_format_collection_permissions,
+            'actions' => {
+              'action_1' => old_format_action_permissions
+            },
+            'scope' => old_format_scope_permissions
+          }
+        }
+      }
+
+      let(:converted_permission) { described_class.convert_to_new_format(old_format_permissions, rendering_id) }
+
+      describe 'collection permissions' do
+        subject { converted_permission['collections']['collection_1']['collection'] }
+
+        let(:expected_new_collection_permissions_format) {
+          {
+            'browseEnabled'=>true,
+            'readEnabled'=>false,
+            'addEnabled'=>true,
+            'editEnabled'=>false,
+            'deleteEnabled'=>true,
+            'exportEnabled'=>false
+          }
+        }
+
+        it 'should convert the old format to the new one' do
+          expect(subject).to eq expected_new_collection_permissions_format
+        end
+
+        describe 'with searchToEdit true and list false' do
+          let(:old_format_collection_permissions) {
+            {
+              'list'=>false,
+              'show'=>false,
+              'create'=>false,
+              'update'=>false,
+              'delete'=>false,
+              'export'=>false,
+              'searchToEdit'=>true
+            }
+          }
+
+          let(:expected_new_collection_permissions_format) {
+            {
+              'browseEnabled'=>true,
+              'readEnabled'=>false,
+              'addEnabled'=>false,
+              'editEnabled'=>false,
+              'deleteEnabled'=>false,
+              'exportEnabled'=>false
+            }
+          }
+
+          it 'should convert the old format to the new one with browseEnabled at true' do
+            expect(subject).to eq expected_new_collection_permissions_format
+          end
+        end
+
+        describe 'with searchToEdit false and list true' do
+          let(:old_format_collection_permissions) {
+            {
+              'list'=>true,
+              'show'=>false,
+              'create'=>false,
+              'update'=>false,
+              'delete'=>false,
+              'export'=>false,
+              'searchToEdit'=>false
+            }
+          }
+
+          let(:expected_new_collection_permissions_format) {
+            {
+              'browseEnabled'=>true,
+              'readEnabled'=>false,
+              'addEnabled'=>false,
+              'editEnabled'=>false,
+              'deleteEnabled'=>false,
+              'exportEnabled'=>false
+            }
+          }
+
+          it 'should convert the old format to the new one with browseEnabled at true' do
+            expect(subject).to eq expected_new_collection_permissions_format
+          end
+        end
+
+        describe 'with searchToEdit false and list false' do
+          let(:old_format_collection_permissions) {
+            {
+              'list'=>false,
+              'show'=>false,
+              'create'=>false,
+              'update'=>false,
+              'delete'=>false,
+              'export'=>false,
+              'searchToEdit'=>false
+            }
+          }
+
+          let(:expected_new_collection_permissions_format) {
+            {
+              'browseEnabled'=>false,
+              'readEnabled'=>false,
+              'addEnabled'=>false,
+              'editEnabled'=>false,
+              'deleteEnabled'=>false,
+              'exportEnabled'=>false
+            }
+          }
+
+          it 'should convert the old format to the new one with browseEnabled at false' do
+            expect(subject).to eq expected_new_collection_permissions_format
+          end
+        end
+      end
+
+      describe 'action permissions' do
+        subject { converted_permission['collections']['collection_1']['actions']['action_1'] }
+
+        context 'when allowed is true' do
+          context 'when users is nil' do
+            let(:old_format_action_permissions) { { 'allowed' => true, 'users' => nil } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => true } }
+
+            it 'expected action permission triggerEnabled field should be true' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+
+          context 'when users is an empty array' do
+            let(:old_format_action_permissions) { { 'allowed' => true, 'users' => [] } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => [] } }
+
+            it 'expected action permission triggerEnabled field should be an empty array' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+
+          context 'when users is NOT an empty array' do
+            let(:old_format_action_permissions) { { 'allowed' => true, 'users' => [2, 3] } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => [2, 3] } }
+
+            it 'expected action permission triggerEnabled field should be equal to the users array' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+        end
+
+        context 'when allowed is false' do
+          context 'when users is nil' do
+            let(:old_format_action_permissions) { { 'allowed' => false, 'users' => nil } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => false } }
+
+            it 'expected action permission triggerEnabled field should be false' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+
+          context 'when users is an empty array' do
+            let(:old_format_action_permissions) { { 'allowed' => false, 'users' => [] } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => false } }
+
+            it 'expected action permission triggerEnabled field should be false' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+
+          context 'when users is NOT an empty array' do
+            let(:old_format_action_permissions) { { 'allowed' => false, 'users' => [2, 3] } }
+            let(:expected_new_action_permissions_format) { { 'triggerEnabled' => false } }
+
+            it 'expected action permission triggerEnabled field should be false' do
+              expect(subject).to eq expected_new_action_permissions_format
+            end
+          end
+        end
+      end
+
+      describe 'scope permissions' do
+        subject { converted_permission['renderings'][rendering_id]['collection_1']['scope'] }
+        let(:expected_new_format_permissions) { old_format_scope_permissions }
+
+        context 'when scope permissions are set' do
+          let(:old_format_scope_permissions) { { 'dynamicScopesValues' => {}, 'filter' => { 'aggregator' => 'and', 'conditions' => [{ 'field' => 'field_1', 'operator' => 'equal', 'value' => true }] } } }
+
+          it 'expected scope permissions should be set' do
+            expect(subject).to eq expected_new_format_permissions
+          end
+        end
+
+        context 'when scope permissions are nil' do
+          let(:old_format_scope_permissions) { nil }
+
+          it 'expected scope permissions should be nil' do
+            expect(subject).to eq expected_new_format_permissions
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/forest_liana/permissions_getter_spec.rb

@@ -0,0 +1,82 @@
+module ForestLiana
+  describe PermissionsGetter do
+    describe '#get_permissions_api_route' do
+      it 'should respond with the v3 permissions route' do
+        expect(described_class.get_permissions_api_route).to eq '/liana/v3/permissions'
+      end
+    end
+
+    describe '#get_permissions_for_rendering' do
+      let(:rendering_id) { 34 }
+      let(:liana_permissions_url) { 'https://api.forestadmin.com/liana/v3/permissions' }
+      let(:liana_permissions_api_call_response) { instance_double(HTTParty::Response) }
+      let(:expected_request_parameters) {
+        {
+          :headers => {
+            "Content-Type" => "application/json",
+            "forest-secret-key" => "env_secret_test"
+          },
+          :query => expected_query_parameters
+        }
+      }
+
+      before do
+        allow(HTTParty).to receive(:get).and_return(liana_permissions_api_call_response)
+        allow(liana_permissions_api_call_response).to receive(:response).and_return(liana_permissions_api_call_response_content)
+        allow(liana_permissions_api_call_response_content).to receive(:body).and_return(liana_permissions_api_call_response_content_body)
+      end
+
+      describe 'when the API returns a success' do
+        let(:liana_permissions_api_call_response_content) { Net::HTTPOK.new({}, 200, liana_permissions_api_call_response_content_body) }
+        let(:liana_permissions_api_call_response_content_body) { '{"test": true}' }
+        let(:expected_parsed_result) { { "test" => true } }
+
+        describe 'when NOT calling for rendering specific only' do
+          let(:expected_query_parameters) { { "renderingId" => rendering_id } }
+
+          it 'should call the API with correct URL' do
+            described_class.get_permissions_for_rendering(rendering_id)
+            expect(HTTParty).to have_received(:get).with(liana_permissions_url, expected_request_parameters)
+          end
+
+          it 'should return the expected JSON body' do
+            expect(described_class.get_permissions_for_rendering(rendering_id)).to eq expected_parsed_result
+          end
+        end
+
+        describe 'when calling for rendering specific only' do
+          let(:expected_query_parameters) { { "renderingId" => rendering_id, 'renderingSpecificOnly' => true } }
+
+          it 'should call the API with correct URL and parameters' do
+            described_class.get_permissions_for_rendering(rendering_id, rendering_specific_only: true)
+            expect(HTTParty).to have_received(:get).with(liana_permissions_url, expected_request_parameters)
+          end
+
+          it 'should return the expected JSON body' do
+            expect(described_class.get_permissions_for_rendering(rendering_id, rendering_specific_only: true)).to eq expected_parsed_result
+          end
+        end
+      end
+
+      describe 'when the API returns a not found error' do
+        let(:liana_permissions_api_call_response_content) { Net::HTTPNotFound.new({}, 404, liana_permissions_api_call_response_content_body) }
+        let(:liana_permissions_api_call_response_content_body) { 'Not Found' }
+
+        before do
+          allow(FOREST_LOGGER).to receive(:error)
+        end
+
+        it 'should return nil' do
+          expect(described_class.get_permissions_for_rendering(rendering_id)).to eq nil
+        end
+
+        it 'should log the not found error' do
+          described_class.get_permissions_for_rendering(rendering_id)
+          expect(FOREST_LOGGER).to have_received(:error).with('Cannot retrieve the permissions from the Forest server.')
+          expect(FOREST_LOGGER).to have_received(:error).with('Which was caused by:')
+          expect(FOREST_LOGGER).to have_received(:error).with(' Forest API returned an HTTP error 404')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start 'rails'
+
 # 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`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forest_liana
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 5.4.0
 platform: ruby
 authors:
 - Sandro Munda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -255,6 +255,7 @@ files:
 - app/services/forest_liana/objective_stat_getter.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
@@ -279,6 +280,7 @@ files:
 - app/services/forest_liana/stripe_subscriptions_getter.rb
 - app/services/forest_liana/two_factor_registration_confirmer.rb
 - app/services/forest_liana/user_secret_creator.rb
+- app/services/forest_liana/utils/beta_schema_utils.rb
 - app/services/forest_liana/value_stat_getter.rb
 - app/views/layouts/forest_liana/application.html.erb
 - config/initializers/arel-helpers.rb
@@ -347,6 +349,10 @@ files:
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_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_formatter_spec.rb
+- spec/services/forest_liana/permissions_getter_spec.rb
 - spec/services/forest_liana/schema_adapter_spec.rb
 - spec/spec_helper.rb
 - test/dummy/README.rdoc
@@ -555,10 +561,14 @@ test_files:
 - test/dummy/config/database.yml
 - test/forest_liana_test.rb
 - test/routing/route_test.rb
+- spec/services/forest_liana/permissions_formatter_spec.rb
+- spec/services/forest_liana/permissions_checker_acl_disabled_spec.rb
 - spec/services/forest_liana/ip_whitelist_checker_spec.rb
+- spec/services/forest_liana/permissions_checker_acl_enabled_spec.rb
 - spec/services/forest_liana/schema_adapter_spec.rb
 - spec/services/forest_liana/apimap_sorter_spec.rb
 - spec/services/forest_liana/filters_parser_spec.rb
+- spec/services/forest_liana/permissions_getter_spec.rb
 - spec/spec_helper.rb
 - spec/requests/actions_controller_spec.rb
 - spec/requests/resources_spec.rb