descope 1.0.7 → 1.2.0

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::Project do
     end
 
     it 'is expected to rename the current project' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         PROJECT_UPDATE_NAME, { name: 'test' }
       )
       expect { @instance.rename_project('test') }.not_to raise_error
@@ -28,7 +28,7 @@ describe Descope::Api::V1::Management::Project do
     end
 
     it 'is expected to export the current project' do
-      expect(@instance).to receive(:post).with(PROJECT_EXPORT_PATH)
+      expect(@instance).to receive(:mgmt_post).with(PROJECT_EXPORT_PATH)
       expect do
         @instance.export_project
       end.not_to raise_error
@@ -41,7 +41,7 @@ describe Descope::Api::V1::Management::Project do
     end
 
     it 'is expected to import a project' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         PROJECT_IMPORT_PATH, { files: 'files' }
       )
       expect do
@@ -56,7 +56,7 @@ describe Descope::Api::V1::Management::Project do
     end
 
     it 'is expected to clone the current project' do
-      expect(@instance).to receive(:post).with(PROJECT_CLONE, { name: 'test', tag: 'test' })
+      expect(@instance).to receive(:mgmt_post).with(PROJECT_CLONE, { name: 'test', tag: 'test' })
       expect { @instance.clone_project(name: 'test', tag: 'test') }.not_to raise_error
     end
   end

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::Role do
     end
 
     it 'is expected to create a new role' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ROLE_CREATE_PATH, {
           name: 'test',
           description: 'test',
@@ -40,7 +40,7 @@ describe Descope::Api::V1::Management::Role do
     end
 
     it 'is expected to update a role' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ROLE_UPDATE_PATH, {
           name: 'test',
           newName: 'production',
@@ -67,7 +67,7 @@ describe Descope::Api::V1::Management::Role do
     end
 
     it 'is expected to delete a role' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ROLE_DELETE_PATH, { name: 'test', tenantId: 'test' }
       )
       expect do
@@ -82,7 +82,7 @@ describe Descope::Api::V1::Management::Role do
     end
 
     it 'is expected to delete a role' do
-      expect(@instance).to receive(:get).with(ROLE_LOAD_ALL_PATH)
+      expect(@instance).to receive(:mgmt_get).with(ROLE_LOAD_ALL_PATH)
       expect { @instance.load_all_roles }.not_to raise_error
     end
   end
@@ -93,7 +93,7 @@ describe Descope::Api::V1::Management::Role do
     end
 
     it 'is expected to search roles' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ROLE_SEARCH_PATH, {
           roleNames: %w[tester test2],
           tenantIds: %w[t1 t2],

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

@@ -24,7 +24,7 @@ describe Descope::Api::V1::Management::SCIM do
                            start_index,
                            count,
                            excluded_attributes)
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect do
         @instance.scim_search_groups(filter:, start_index:, count:, excluded_attributes:)
       end.not_to raise_error
@@ -48,7 +48,7 @@ describe Descope::Api::V1::Management::SCIM do
                             members,
                             external_id,
                             excluded_attributes)
-      expect(@instance).to receive(:post).with(Descope::Api::V1::Management::Common::SCIM_GROUPS_PATH, body)
+      expect(@instance).to receive(:mgmt_post).with(Descope::Api::V1::Management::Common::SCIM_GROUPS_PATH, body)
       expect do
         @instance.scim_create_group(group_id:,
                                     display_name:,
@@ -73,7 +73,7 @@ describe Descope::Api::V1::Management::SCIM do
         :compose_scim_create_group_url,
         group_id, display_name, external_id, excluded_attributes
       )
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect do
         @instance.scim_load_group(group_id:, display_name:, external_id:, excluded_attributes:)
       end.not_to raise_error
@@ -96,7 +96,7 @@ describe Descope::Api::V1::Management::SCIM do
         group_id, display_name, members, external_id, excluded_attributes
       )
       url = "#{SCIM_GROUPS_PATH}/#{group_id}"
-      expect(@instance).to receive(:patch).with(url, body)
+      expect(@instance).to receive(:mgmt_patch).with(url, body)
       expect do
         @instance.scim_update_group(group_id:, display_name:, members:, external_id:, excluded_attributes:)
       end.not_to raise_error
@@ -111,7 +111,7 @@ describe Descope::Api::V1::Management::SCIM do
     it 'is expected to delete scim group' do
       group_id = 'G123'
       url = "#{SCIM_GROUPS_PATH}/#{group_id}"
-      expect(@instance).to receive(:delete).with(url)
+      expect(@instance).to receive(:mgmt_delete).with(url)
       expect { @instance.scim_delete_group(group_id) }.not_to raise_error
     end
   end
@@ -142,7 +142,7 @@ describe Descope::Api::V1::Management::SCIM do
 
       url = @instance.send(:compose_scim_patch_group_url, group_id, user_id, operations)
 
-      expect(@instance).to receive(:patch).with(url)
+      expect(@instance).to receive(:mgmt_patch).with(url)
       expect do
         @instance.scim_patch_group(group_id:, user_id:, operations:)
       end.not_to raise_error
@@ -156,7 +156,7 @@ describe Descope::Api::V1::Management::SCIM do
 
     it 'is expected to load scim resource types' do
       url = "#{SCIM_RESOURCE_TYPES_PATH}"
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect { @instance.scim_load_resource_types }.not_to raise_error
     end
   end
@@ -168,7 +168,7 @@ describe Descope::Api::V1::Management::SCIM do
 
     it 'is expected to load scim service provider config' do
       url = "#{SCIM_SERVICE_PROVIDER_CONFIG_PATH}"
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect { @instance.scim_load_service_provider_config }.not_to raise_error
     end
   end
@@ -186,7 +186,7 @@ describe Descope::Api::V1::Management::SCIM do
                            filter,
                            start_index,
                            count)
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect do
         @instance.scim_search_users(filter:, start_index:, count:)
       end.not_to raise_error
@@ -219,7 +219,7 @@ describe Descope::Api::V1::Management::SCIM do
                             active,
                             name,
                             user_name)
-      expect(@instance).to receive(:post).with(SCIM_USERS_PATH, body)
+      expect(@instance).to receive(:mgmt_post).with(SCIM_USERS_PATH, body)
       expect do
         @instance.scim_create_user(
           user_id:,
@@ -242,7 +242,7 @@ describe Descope::Api::V1::Management::SCIM do
     it 'is expected to load scim user' do
       user_id = 'U123'
       url = "#{SCIM_USERS_PATH}/#{user_id}"
-      expect(@instance).to receive(:get).with(url)
+      expect(@instance).to receive(:mgmt_get).with(url)
       expect do
         @instance.scim_load_user(user_id)
       end.not_to raise_error
@@ -257,7 +257,7 @@ describe Descope::Api::V1::Management::SCIM do
     it 'is expected to load scim user' do
       user_id = 'U123'
       url = "#{SCIM_USERS_PATH}/#{user_id}"
-      expect(@instance).to receive(:patch).with(url)
+      expect(@instance).to receive(:mgmt_patch).with(url)
       expect do
         @instance.scim_update_user(user_id)
       end.not_to raise_error
@@ -272,7 +272,7 @@ describe Descope::Api::V1::Management::SCIM do
     it 'is expected to delete scim user' do
       user_id = 'U123'
       url = "#{SCIM_USERS_PATH}/#{user_id}"
-      expect(@instance).to receive(:delete).with(url)
+      expect(@instance).to receive(:mgmt_delete).with(url)
       expect { @instance.scim_delete_user(user_id) }.not_to raise_error
     end
   end
@@ -303,7 +303,7 @@ describe Descope::Api::V1::Management::SCIM do
 
       body = @instance.send(:compose_scim_patch_user_body, user_id, group_id, operations)
 
-      expect(@instance).to receive(:patch).with(SCIM_USERS_PATH, body)
+      expect(@instance).to receive(:mgmt_patch).with(SCIM_USERS_PATH, body)
       expect do
         @instance.scim_patch_user(user_id:, group_id:, operations:)
       end.not_to raise_error

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::ScopeClaimMapping do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::ScopeClaimMapping)
+    @instance = dummy_instance
+  end
+
+  context '.get_scope_claim_mapping' do
+    it 'should respond to .get_scope_claim_mapping' do
+      expect(@instance).to respond_to :get_scope_claim_mapping
+    end
+
+    it 'is expected to get the project-wide OIDC scope-to-claim mappings' do
+      expect(@instance).to receive(:mgmt_post).with(SCOPE_CLAIM_MAPPING_GET_PATH)
+      expect do
+        @instance.get_scope_claim_mapping
+      end.not_to raise_error
+    end
+  end
+
+  context '.set_scope_claim_mapping' do
+    it 'should respond to .set_scope_claim_mapping' do
+      expect(@instance).to respond_to :set_scope_claim_mapping
+    end
+
+    it 'is expected to set the project-wide OIDC scope-to-claim mappings' do
+      mappings = [
+        {
+          scope: 'name-of-scope',
+          claims: %w[claim1 claim2]
+        }
+      ]
+      expect(@instance).to receive(:mgmt_post).with(
+        SCOPE_CLAIM_MAPPING_SET_PATH,
+        { mappings: mappings }
+      )
+      expect do
+        @instance.set_scope_claim_mapping(mappings: mappings)
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_scope_claim_mapping' do
+    it 'should respond to .delete_scope_claim_mapping' do
+      expect(@instance).to respond_to :delete_scope_claim_mapping
+    end
+
+    it 'is expected to delete the project-wide OIDC scope-to-claim mappings' do
+      expect(@instance).to receive(:mgmt_post).with(SCOPE_CLAIM_MAPPING_DELETE_PATH)
+      expect do
+        @instance.delete_scope_claim_mapping
+      end.not_to raise_error
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::SSOApplication do
     end
 
     it 'is expected to create SAML application' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         SSO_APPLICATION_OIDC_CREATE_PATH, {
           id: 'tenant1',
           name: 'test',
@@ -44,7 +44,7 @@ describe Descope::Api::V1::Management::SSOApplication do
     end
 
     it 'is expected to create SAML application' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         SSO_APPLICATION_SAML_CREATE_PATH, {
           name: 'test',
           description: 'awesome tenant',
@@ -172,7 +172,7 @@ describe Descope::Api::V1::Management::SSOApplication do
   end
 
   it 'is expected to update sso oidc application' do
-    expect(@instance).to receive(:post).with(
+    expect(@instance).to receive(:mgmt_post).with(
       SSO_APPLICATION_OIDC_UPDATE_PATH, {
         id: 'tenant1',
         name: 'test',
@@ -195,21 +195,21 @@ describe Descope::Api::V1::Management::SSOApplication do
   end
 
   it 'is expected to delete sso app' do
-    expect(@instance).to receive(:delete).with(
+    expect(@instance).to receive(:mgmt_delete).with(
       SSO_APPLICATION_DELETE_PATH, { id: 'tenant1' }
     )
     expect { @instance.delete_sso_app('tenant1') }.not_to raise_error
   end
 
   it 'is expected to load sso app' do
-    expect(@instance).to receive(:get).with(
+    expect(@instance).to receive(:mgmt_get).with(
       SSO_APPLICATION_LOAD_PATH, { id: 'tenant1' }
     )
     expect { @instance.load_sso_app('tenant1') }.not_to raise_error
   end
 
   it 'is expected to load all sso apps' do
-    expect(@instance).to receive(:get).with(
+    expect(@instance).to receive(:mgmt_get).with(
       SSO_APPLICATION_LOAD_ALL_PATH, {}
     )
     expect { @instance.load_all_sso_apps }.not_to raise_error

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::SSOSettings do
     end
 
     it 'is expected to get SSO settings' do
-      expect(@instance).to receive(:get).with(
+      expect(@instance).to receive(:mgmt_get).with(
         SSO_SETTINGS_PATH, { tenantId: '123' }
       )
       expect { @instance.get_sso_settings('123') }.not_to raise_error
@@ -28,7 +28,7 @@ describe Descope::Api::V1::Management::SSOSettings do
     end
 
     it 'is expected to delete SSO settings' do
-      expect(@instance).to receive(:delete).with(
+      expect(@instance).to receive(:mgmt_delete).with(
         SSO_SETTINGS_PATH, { tenantId: '123' }
       )
       expect { @instance.delete_sso_settings('123') }.not_to raise_error
@@ -40,7 +40,7 @@ describe Descope::Api::V1::Management::SSOSettings do
       end
 
       it 'is expected to configure SSO settings' do
-        expect(@instance).to receive(:post).with(
+        expect(@instance).to receive(:mgmt_post).with(
           SSO_OIDC_PATH, {
             tenantId: '123',
             settings: {
@@ -86,7 +86,7 @@ describe Descope::Api::V1::Management::SSOSettings do
     end
 
     it 'is expected to configure SSO settings' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         SSO_SETTINGS_PATH, {
           tenantId: '123',
           settings: {
@@ -131,7 +131,7 @@ describe Descope::Api::V1::Management::SSOSettings do
     end
 
     it 'is expected to configure SAML metadata' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         SSO_METADATA_PATH, {
           tenantId: '123',
           settings: {

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to create a new tenant' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         TENANT_CREATE_PATH, {
           name: 'test',
           id: 'test',
@@ -46,7 +46,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to update a tenant' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         TENANT_UPDATE_PATH, {
           name: 'test',
           id: 'test',
@@ -77,7 +77,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to delete a tenant' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         TENANT_DELETE_PATH, { id: 'test' }
       )
       expect { @instance.delete_tenant('test') }.not_to raise_error
@@ -90,7 +90,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to load a tenant' do
-      expect(@instance).to receive(:get).with(
+      expect(@instance).to receive(:mgmt_get).with(
         TENANT_LOAD_PATH, { id: 'test' }
       )
       expect { @instance.load_tenant('test') }.not_to raise_error
@@ -103,7 +103,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to load all tenants' do
-      expect(@instance).to receive(:get).with(TENANT_LOAD_ALL_PATH)
+      expect(@instance).to receive(:mgmt_get).with(TENANT_LOAD_ALL_PATH)
       expect { @instance.load_all_tenants }.not_to raise_error
     end
   end
@@ -114,7 +114,7 @@ describe Descope::Api::V1::Management::Tenant do
     end
 
     it 'is expected to search all tenants' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         TENANT_SEARCH_ALL_PATH, {
           ids: %w[test1 test2],
           names: %w[test1 test2],

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

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::ThirdPartyApplication do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::ThirdPartyApplication)
+    @instance = dummy_instance
+  end
+
+  context('.create_application') do
+    it 'should respond to .create_application' do
+      expect(@instance).to respond_to :create_application
+    end
+
+    it 'is expected to create a third party application' do
+      expect(@instance).to receive(:mgmt_post).with(
+        THIRD_PARTY_APP_CREATE_PATH, {
+          id: 'app1',
+          name: 'test',
+          description: 'awesome app',
+          logo: 'https://logo.com',
+          loginPageUrl: 'https://dummy.com/login',
+          approvedCallbackUrls: ['https://dummy.com/callback'],
+          permissionsScopes: [{ name: 'read' }],
+          attributesScopes: [{ name: 'email' }],
+          jwtBearerSettings: [{ tenantId: 'tenant1' }],
+          customAttributes: { key: 'value' },
+          forcePkce: true,
+          defaultAudience: 'aud1'
+        }
+      )
+      expect do
+        @instance.create_application(
+          id: 'app1',
+          name: 'test',
+          description: 'awesome app',
+          logo: 'https://logo.com',
+          login_page_url: 'https://dummy.com/login',
+          approved_callback_urls: ['https://dummy.com/callback'],
+          permissions_scopes: [{ name: 'read' }],
+          attributes_scopes: [{ name: 'email' }],
+          jwt_bearer_settings: [{ tenantId: 'tenant1' }],
+          custom_attributes: { key: 'value' },
+          force_pkce: true,
+          default_audience: 'aud1'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context('.update_application') do
+    it 'should respond to .update_application' do
+      expect(@instance).to respond_to :update_application
+    end
+
+    it 'is expected to update a third party application' do
+      expect(@instance).to receive(:mgmt_post).with(
+        THIRD_PARTY_APP_UPDATE_PATH, {
+          id: 'app1',
+          name: 'test',
+          description: 'awesome app',
+          logo: 'https://logo.com',
+          loginPageUrl: 'https://dummy.com/login'
+        }
+      )
+      expect do
+        @instance.update_application(
+          id: 'app1',
+          name: 'test',
+          description: 'awesome app',
+          logo: 'https://logo.com',
+          login_page_url: 'https://dummy.com/login'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context('.patch_application') do
+    it 'should respond to .patch_application' do
+      expect(@instance).to respond_to :patch_application
+    end
+
+    it 'is expected to patch a third party application' do
+      expect(@instance).to receive(:mgmt_post).with(
+        THIRD_PARTY_APP_PATCH_PATH, {
+          id: 'app1',
+          name: 'test'
+        }
+      )
+      expect do
+        @instance.patch_application(
+          id: 'app1',
+          name: 'test'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  it 'is expected to delete a third party application' do
+    expect(@instance).to receive(:mgmt_post).with(
+      THIRD_PARTY_APP_DELETE_PATH, { id: 'app1' }
+    )
+    expect { @instance.delete_application('app1') }.not_to raise_error
+  end
+
+  it 'is expected to load a third party application' do
+    expect(@instance).to receive(:mgmt_get).with(
+      THIRD_PARTY_APP_LOAD_PATH, { id: 'app1' }
+    )
+    expect { @instance.load_application('app1') }.not_to raise_error
+  end
+
+  it 'is expected to load all third party applications' do
+    expect(@instance).to receive(:mgmt_get).with(
+      THIRD_PARTY_APP_LOAD_ALL_PATH, {}
+    )
+    expect { @instance.load_all_applications }.not_to raise_error
+  end
+
+  it 'is expected to get a third party application secret' do
+    expect(@instance).to receive(:mgmt_get).with(
+      THIRD_PARTY_APP_SECRET_PATH, { id: 'app1' }
+    )
+    expect { @instance.get_application_secret('app1') }.not_to raise_error
+  end
+
+  it 'is expected to rotate a third party application secret' do
+    expect(@instance).to receive(:mgmt_post).with(
+      THIRD_PARTY_APP_ROTATE_PATH, { id: 'app1' }
+    )
+    expect { @instance.rotate_application_secret('app1') }.not_to raise_error
+  end
+
+  it 'is expected to delete consents' do
+    expect(@instance).to receive(:mgmt_post).with(
+      THIRD_PARTY_APP_DELETE_CONSENTS_PATH, {
+        consentIds: %w[consent1 consent2],
+        appId: 'app1',
+        userIds: %w[user1 user2],
+        tenantId: 'tenant1'
+      }
+    )
+    expect do
+      @instance.delete_consents(
+        app_id: 'app1',
+        consent_ids: %w[consent1 consent2],
+        user_ids: %w[user1 user2],
+        tenant_id: 'tenant1'
+      )
+    end.not_to raise_error
+  end
+
+  it 'is expected to delete tenant consents' do
+    expect(@instance).to receive(:mgmt_post).with(
+      THIRD_PARTY_APP_DELETE_TENANT_CONSENTS_PATH, {
+        consentIds: %w[consent1 consent2],
+        appId: 'app1',
+        tenantId: 'tenant1'
+      }
+    )
+    expect do
+      @instance.delete_tenant_consents(
+        app_id: 'app1',
+        consent_ids: %w[consent1 consent2],
+        tenant_id: 'tenant1'
+      )
+    end.not_to raise_error
+  end
+end