descope 1.1.0 → 1.2.0

data/spec/lib.descope/api/v1/management/authz_spec.rb

@@ -34,7 +34,7 @@ describe Descope::Api::V1::Management::Authz do
           }
         ]
       }
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_SCHEMA_SAVE,
         {
           schema: schema,
@@ -53,7 +53,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to delete the schema for the project which will also delete all relations' do
-      expect(@instance).to receive(:post).with(AUTHZ_SCHEMA_DELETE)
+      expect(@instance).to receive(:mgmt_post).with(AUTHZ_SCHEMA_DELETE)
       expect do
         @instance.authz_delete_schema
       end.not_to raise_error
@@ -66,7 +66,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to load the schema for the project' do
-      expect(@instance).to receive(:post).with(AUTHZ_SCHEMA_LOAD)
+      expect(@instance).to receive(:mgmt_post).with(AUTHZ_SCHEMA_LOAD)
       expect do
         @instance.authz_load_schema
       end.not_to raise_error
@@ -79,7 +79,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to create or update the given namespace' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_NS_SAVE,
         {
           namespace: 'test-namespace',
@@ -99,7 +99,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to delete the given namespace' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_NS_DELETE,
         {
           name: 'test-namespace',
@@ -118,7 +118,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to create or update the given relation definition' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RD_SAVE,
         {
           relationDefinition: 'test-relation-definition',
@@ -144,7 +144,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to delete the given relation definition' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RD_DELETE,
         {
           name: 'test-relation-definition',
@@ -168,7 +168,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to create the given relation' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_CREATE,
         {
           relations: 'test-relations'
@@ -186,7 +186,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to delete the given relation' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_DELETE,
         { relations: [{ resource: 'some-note', relationDefinition: 'owner', namespace: 'note', target: 'some-user' }] }
       )
@@ -204,7 +204,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to delete the given relations for resources' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_DELETE_RESOURCES,
         {
           resources: 'test-resources'
@@ -222,7 +222,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to return true if the given resource has relations' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_HAS_RELATIONS,
         {
           relationQueries: ['some-query']
@@ -240,7 +240,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to return the list of targets who can access the given resource with the given RD' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_WHO,
         {
           resource: 'test-resource',
@@ -261,7 +261,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to return the list of relations for the given resources' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_RESOURCE,
         {
           resources: ['test-resources']
@@ -279,7 +279,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to return the list of relations for the given targets' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_TARGETS,
         {
           targets: ['test-targets']
@@ -306,7 +306,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     before do
-      allow(@instance).to receive(:post).with(
+      allow(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_TARGET_ALL,
         {
           target: 'test-target'
@@ -319,7 +319,7 @@ describe Descope::Api::V1::Management::Authz do
     end
 
     it 'is expected to return the list of relations for the given target' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         AUTHZ_RE_TARGET_ALL,
         {
           target: 'test-target'

data/spec/lib.descope/api/v1/management/descoper_spec.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Descoper do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::Descoper)
+    @instance = dummy_instance
+  end
+
+  context '.create_descoper' do
+    it 'should respond to .create_descoper' do
+      expect(@instance).to respond_to :create_descoper
+    end
+
+    it 'is expected to create the given descopers' do
+      expect(@instance).to receive(:mgmt_put).with(
+        DESCOPER_CREATE_PATH,
+        {
+          descopers: [{ name: 'test-descoper' }]
+        }
+      )
+      expect do
+        @instance.create_descoper([{ name: 'test-descoper' }])
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_descoper' do
+    it 'should respond to .update_descoper' do
+      expect(@instance).to respond_to :update_descoper
+    end
+
+    it 'is expected to update the given descoper' do
+      expect(@instance).to receive(:mgmt_patch).with(
+        DESCOPER_UPDATE_PATH,
+        {
+          id: 'test-id',
+          attributes: { key: 'value' },
+          rbac: { roles: ['admin'] }
+        }
+      )
+      expect do
+        @instance.update_descoper(id: 'test-id', attributes: { key: 'value' }, rbac: { roles: ['admin'] })
+      end.not_to raise_error
+    end
+  end
+
+  context '.get_descoper' do
+    it 'should respond to .get_descoper' do
+      expect(@instance).to respond_to :get_descoper
+    end
+
+    it 'is expected to get the given descoper by id' do
+      expect(@instance).to receive(:mgmt_get).with(
+        DESCOPER_GET_PATH,
+        {
+          id: 'test-id'
+        }
+      )
+      expect do
+        @instance.get_descoper(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_descoper' do
+    it 'should respond to .delete_descoper' do
+      expect(@instance).to respond_to :delete_descoper
+    end
+
+    it 'is expected to delete the given descoper by id' do
+      expect(@instance).to receive(:mgmt_delete).with(
+        DESCOPER_DELETE_PATH,
+        {
+          id: 'test-id'
+        }
+      )
+      expect do
+        @instance.delete_descoper(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.search_descopers' do
+    it 'should respond to .search_descopers' do
+      expect(@instance).to respond_to :search_descopers
+    end
+
+    it 'is expected to search (list) all descopers' do
+      expect(@instance).to receive(:mgmt_post).with(
+        DESCOPER_SEARCH_PATH,
+        {}
+      )
+      expect do
+        @instance.search_descopers
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib.descope/api/v1/management/engine_spec.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Engine do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::Engine)
+    @instance = dummy_instance
+  end
+
+  context '.create_engine' do
+    it 'should respond to .create_engine' do
+      expect(@instance).to respond_to :create_engine
+    end
+
+    it 'is expected to create a new engine' do
+      expect(@instance).to receive(:mgmt_post).with(
+        ENGINE_CREATE_PATH,
+        {
+          name: 'test-engine'
+        }
+      )
+      expect do
+        @instance.create_engine(name: 'test-engine')
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_engine' do
+    it 'should respond to .update_engine' do
+      expect(@instance).to respond_to :update_engine
+    end
+
+    it 'is expected to update an existing engine' do
+      expect(@instance).to receive(:mgmt_post).with(
+        ENGINE_UPDATE_PATH,
+        {
+          id: 'test-id',
+          name: 'test-engine'
+        }
+      )
+      expect do
+        @instance.update_engine(id: 'test-id', name: 'test-engine')
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_engine' do
+    it 'should respond to .delete_engine' do
+      expect(@instance).to respond_to :delete_engine
+    end
+
+    it 'is expected to delete an existing engine' do
+      expect(@instance).to receive(:mgmt_post).with(
+        ENGINE_DELETE_PATH,
+        {
+          id: 'test-id'
+        }
+      )
+      expect do
+        @instance.delete_engine(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_engine' do
+    it 'should respond to .load_engine' do
+      expect(@instance).to respond_to :load_engine
+    end
+
+    it 'is expected to load an engine by id' do
+      expect(@instance).to receive(:mgmt_get).with(
+        ENGINE_LOAD_PATH,
+        {
+          id: 'test-id'
+        }
+      )
+      expect do
+        @instance.load_engine(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_all_engines' do
+    it 'should respond to .load_all_engines' do
+      expect(@instance).to respond_to :load_all_engines
+    end
+
+    it 'is expected to load all engines' do
+      expect(@instance).to receive(:mgmt_get).with(ENGINE_LOAD_ALL_PATH)
+      expect do
+        @instance.load_all_engines
+      end.not_to raise_error
+    end
+  end
+
+  context '.rotate_engine_secret' do
+    it 'should respond to .rotate_engine_secret' do
+      expect(@instance).to respond_to :rotate_engine_secret
+    end
+
+    it 'is expected to rotate the secret for an engine' do
+      expect(@instance).to receive(:mgmt_post).with(
+        ENGINE_ROTATE_SECRET_PATH,
+        {
+          id: 'test-id'
+        }
+      )
+      expect do
+        @instance.rotate_engine_secret(id: 'test-id')
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib.descope/api/v1/management/fga_spec.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::FGA do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::FGA)
+    @instance = dummy_instance
+  end
+
+  context '.fga_save_schema' do
+    it 'should respond to .fga_save_schema' do
+      expect(@instance).to respond_to :fga_save_schema
+    end
+
+    it 'is expected to save the FGA schema' do
+      schema = 'model AuthZ 1.0\ntype user\ntype doc\n  relation owner: user'
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_SAVE_SCHEMA_PATH,
+        { dsl: schema }
+      )
+      expect do
+        @instance.fga_save_schema(schema: schema)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_load_schema' do
+    it 'should respond to .fga_load_schema' do
+      expect(@instance).to respond_to :fga_load_schema
+    end
+
+    it 'is expected to load the FGA schema' do
+      expect(@instance).to receive(:mgmt_get).with(FGA_LOAD_SCHEMA_PATH)
+      expect do
+        @instance.fga_load_schema
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_create_relations' do
+    it 'should respond to .fga_create_relations' do
+      expect(@instance).to respond_to :fga_create_relations
+    end
+
+    it 'is expected to create the given relations' do
+      tuples = [{ resource: 'doc1', relation: 'owner', target: 'user1' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_CREATE_RELATIONS_PATH,
+        { tuples: tuples }
+      )
+      expect do
+        @instance.fga_create_relations(tuples: tuples)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_delete_relations' do
+    it 'should respond to .fga_delete_relations' do
+      expect(@instance).to respond_to :fga_delete_relations
+    end
+
+    it 'is expected to delete the given relations' do
+      tuples = [{ resource: 'doc1', relation: 'owner', target: 'user1' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_DELETE_RELATIONS_PATH,
+        { tuples: tuples }
+      )
+      expect do
+        @instance.fga_delete_relations(tuples: tuples)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_check' do
+    it 'should respond to .fga_check' do
+      expect(@instance).to respond_to :fga_check
+    end
+
+    it 'is expected to check the given relations' do
+      tuples = [{ resource: 'doc1', relation: 'owner', target: 'user1' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_CHECK_PATH,
+        { tuples: tuples }
+      )
+      expect do
+        @instance.fga_check(tuples: tuples)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_load_mappable_schema' do
+    it 'should respond to .fga_load_mappable_schema' do
+      expect(@instance).to respond_to :fga_load_mappable_schema
+    end
+
+    it 'is expected to load the mappable schema for the given tenant' do
+      expect(@instance).to receive(:mgmt_get).with(
+        FGA_LOAD_MAPPABLE_SCHEMA_PATH,
+        { tenantId: 'tenant-1' }
+      )
+      expect do
+        @instance.fga_load_mappable_schema(tenant_id: 'tenant-1')
+      end.not_to raise_error
+    end
+
+    it 'is expected to include resourcesLimit when options are given' do
+      expect(@instance).to receive(:mgmt_get).with(
+        FGA_LOAD_MAPPABLE_SCHEMA_PATH,
+        { tenantId: 'tenant-1', resourcesLimit: 10 }
+      )
+      expect do
+        @instance.fga_load_mappable_schema(tenant_id: 'tenant-1', options: { resourcesLimit: 10 })
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_search_mappable_resources' do
+    it 'should respond to .fga_search_mappable_resources' do
+      expect(@instance).to respond_to :fga_search_mappable_resources
+    end
+
+    it 'is expected to search for mappable resources for the given tenant' do
+      resources_queries = [{ resourceType: 'doc' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_SEARCH_MAPPABLE_RESOURCES_PATH,
+        { tenantId: 'tenant-1', resourcesQueries: resources_queries }
+      )
+      expect do
+        @instance.fga_search_mappable_resources(tenant_id: 'tenant-1', resources_queries: resources_queries)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_load_resources_details' do
+    it 'should respond to .fga_load_resources_details' do
+      expect(@instance).to respond_to :fga_load_resources_details
+    end
+
+    it 'is expected to load the details of the given resource identifiers' do
+      resource_identifiers = [{ resourceId: 'doc1', resourceType: 'doc' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_RESOURCES_LOAD_PATH,
+        { resourceIdentifiers: resource_identifiers }
+      )
+      expect do
+        @instance.fga_load_resources_details(resource_identifiers: resource_identifiers)
+      end.not_to raise_error
+    end
+  end
+
+  context '.fga_save_resources_details' do
+    it 'should respond to .fga_save_resources_details' do
+      expect(@instance).to respond_to :fga_save_resources_details
+    end
+
+    it 'is expected to save the details of the given resources' do
+      resources_details = [{ resourceId: 'doc1', resourceType: 'doc', displayName: 'Document 1' }]
+      expect(@instance).to receive(:mgmt_post).with(
+        FGA_RESOURCES_SAVE_PATH,
+        { resourcesDetails: resources_details }
+      )
+      expect do
+        @instance.fga_save_resources_details(resources_details: resources_details)
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib.descope/api/v1/management/flow_spec.rb

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::Flow do
     end
 
     it 'is expected to get flows' do
-      expect(@instance).to receive(:post).with(FLOW_LIST_PATH, { ids: %w[123 456] })
+      expect(@instance).to receive(:mgmt_post).with(FLOW_LIST_PATH, { ids: %w[123 456] })
       expect { @instance.list_or_search_flows(%w[123 456]) }.not_to raise_error
     end
   end
@@ -26,7 +26,7 @@ describe Descope::Api::V1::Management::Flow do
     end
 
     it 'is expected to export flow' do
-      expect(@instance).to receive(:post).with(FLOW_EXPORT_PATH, { flowId: '123' })
+      expect(@instance).to receive(:mgmt_post).with(FLOW_EXPORT_PATH, { flowId: '123' })
       expect { @instance.export_flow('123') }.not_to raise_error
     end
   end
@@ -37,7 +37,7 @@ describe Descope::Api::V1::Management::Flow do
     end
 
     it 'is expected to import flow' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         FLOW_IMPORT_PATH, {
           flowId: '123',
           flow: 'flow',
@@ -60,7 +60,7 @@ describe Descope::Api::V1::Management::Flow do
     end
 
     it 'is expected to export theme' do
-      expect(@instance).to receive(:post).with(THEME_EXPORT_PATH)
+      expect(@instance).to receive(:mgmt_post).with(THEME_EXPORT_PATH)
       expect { @instance.export_theme }.not_to raise_error
     end
   end
@@ -71,7 +71,7 @@ describe Descope::Api::V1::Management::Flow do
     end
 
     it 'is expected to import theme' do
-      expect(@instance).to receive(:post).with(THEME_IMPORT_PATH, { theme: 'theme123' })
+      expect(@instance).to receive(:mgmt_post).with(THEME_IMPORT_PATH, { theme: 'theme123' })
       expect { @instance.import_theme('theme123') }.not_to raise_error
     end
   end

data/spec/lib.descope/api/v1/management/group_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Group do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::Group)
+    @instance = dummy_instance
+  end
+
+  context '.load_all_groups' do
+    it 'should respond to .load_all_groups' do
+      expect(@instance).to respond_to :load_all_groups
+    end
+
+    it 'is expected to load all groups for a given tenant id' do
+      expect(@instance).to receive(:mgmt_post).with(
+        GROUP_LOAD_ALL_PATH,
+        {
+          tenantId: 'tenant-id'
+        }
+      )
+      expect do
+        @instance.load_all_groups(tenant_id: 'tenant-id')
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_all_groups_for_members' do
+    it 'should respond to .load_all_groups_for_members' do
+      expect(@instance).to respond_to :load_all_groups_for_members
+    end
+
+    it 'is expected to load all groups for the given user and login ids' do
+      expect(@instance).to receive(:mgmt_post).with(
+        GROUP_LOAD_ALL_FOR_MEMBER_PATH,
+        {
+          tenantId: 'tenant-id',
+          loginIds: ['login-id'],
+          userIds: ['user-id']
+        }
+      )
+      expect do
+        @instance.load_all_groups_for_members(
+          tenant_id: 'tenant-id',
+          user_ids: ['user-id'],
+          login_ids: ['login-id']
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.load_all_group_members' do
+    it 'should respond to .load_all_group_members' do
+      expect(@instance).to respond_to :load_all_group_members
+    end
+
+    it 'is expected to load all members of the given group id' do
+      expect(@instance).to receive(:mgmt_post).with(
+        GROUP_LOAD_ALL_GROUP_MEMBERS_PATH,
+        {
+          tenantId: 'tenant-id',
+          groupId: 'group-id'
+        }
+      )
+      expect do
+        @instance.load_all_group_members(tenant_id: 'tenant-id', group_id: 'group-id')
+      end.not_to raise_error
+    end
+  end
+end