descope 1.0.7 → 1.2.0

data/spec/integration/lib.descope/api/v1/management/user_spec.rb

@@ -102,7 +102,17 @@ describe Descope::Api::V1::Management::User do
     created_user = @client.create_user(**user)['user']
     loaded_user = @client.load_user(created_user['loginIds'][0])['user']
     expect(loaded_user['loginIds']).to eq(created_user['loginIds'])
-    sleep 10
+    
+    # Wait for user to be fully propagated before deletion
+    SpecUtils.wait_for_condition(max_wait: 15, interval: 2, description: 'user to be ready for deletion') do
+      begin
+        @client.load_user(created_user['loginIds'][0])
+        true
+      rescue StandardError => e
+        @client.logger.info("Waiting for user propagation: #{e.message}")
+        false
+      end
+    end
 
     @client.delete_user(created_user['loginIds'][0])
     begin
@@ -115,8 +125,10 @@ describe Descope::Api::V1::Management::User do
   it 'should search all users' do
     users = FactoryBot.build_list(:user, 5)
     @client.create_batch_users(users)
+    # Wait for batch creation to propagate
+    sleep 1.0
     all_users = @client.search_all_users
-    sdk_users = all_users['users'].select { |user| user['middleName'] == "#{SpecUtils.build_prefix}Ruby-SDK-User" }
+    sdk_users = all_users['users'].select { |user| user['middleName']&.include?('Ruby-SDK-User') }
     expect(sdk_users.length).to be >= 5
   end
 
@@ -128,7 +140,12 @@ describe Descope::Api::V1::Management::User do
     all_roles['roles'].each do |role|
       @client.delete_role(name: role['name']) if role['name'] == role_name
     end
-    sleep 5
+    
+    # Wait for role deletion to propagate
+    SpecUtils.wait_for_condition(max_wait: 10, interval: 1, description: 'role deletion to propagate') do
+      all_roles = @client.load_all_roles
+      all_roles['roles'].none? { |role| role['name'] == role_name }
+    end
 
     user_args = build(:user)
     test_user = @client.create_test_user(**user_args)['user']
@@ -225,7 +242,7 @@ describe Descope::Api::V1::Management::User do
     begin
       @client.expire_password(user['loginIds'][0])
       @client.password_sign_in(login_id: user['loginIds'][0], password:)
-    rescue Descope::ServerError => e
+    rescue Descope::Unauthorized => e
       expect(e.message).to match(/"errorCode":"E062909"/)
     end
   end

data/spec/lib.descope/api/v1/auth/enchantedlink_spec.rb

@@ -30,7 +30,7 @@ describe Descope::Api::V1::EnchantedLink do
       expect(@instance).to receive(:post).with(
         enchanted_link_compose_signin_url,
         request_params,
-        nil,
+        {},
         'refresh_token'
       )
 
@@ -60,6 +60,48 @@ describe Descope::Api::V1::EnchantedLink do
         @instance.send(:validate_refresh_token_provided, { mfa: true, stepup: true }, '')
       end.to raise_error(Descope::AuthException, 'Missing refresh token for stepup/mfa')
     end
+
+    it 'is expected to respond to sign in with phone' do
+      expect(@instance).to respond_to(:enchanted_link_sign_in_with_phone)
+    end
+
+    it 'is expected to sign in with enchanted link via sms' do
+      request_params = {
+        loginId: '+1234567890',
+        redirectUrl: 'https://some-uri/sms',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        },
+        providerId: 'provider-id',
+        templateId: 'template-id'
+      }
+
+      expect(@instance).to receive(:post).with(
+        '/v1/auth/enchantedlink/signin/sms',
+        request_params,
+        {},
+        'refresh_token'
+      ).and_return({ 'linkId' => '1', 'pendingRef' => 'ref', 'maskedPhone' => '+1******890' })
+
+      res = @instance.enchanted_link_sign_in_with_phone(
+        login_id: '+1234567890',
+        uri: 'https://some-uri/sms',
+        login_options: {
+          stepup: false,
+          custom_claims: { 'abc': '123' },
+          mfa: false,
+          sso_app_id: 'sso-id'
+        },
+        provider_id: 'provider-id',
+        template_id: 'template-id',
+        refresh_token: 'refresh_token'
+      )
+
+      expect(res['maskedPhone']).to eq('+1******890')
+    end
   end
 
   context '.sign_up' do
@@ -88,6 +130,36 @@ describe Descope::Api::V1::EnchantedLink do
         )
       end.not_to raise_error
     end
+
+    it 'is expected to respond to sign up with phone' do
+      expect(@instance).to respond_to(:enchanted_link_sign_up_with_phone)
+    end
+
+    it 'is expected to sign up with enchanted link via sms' do
+      request_params = {
+        loginId: '+1234567890',
+        redirectUrl: 'https://some-uri/sms',
+        user: { loginId: 'user1', phone: '+1234567890' },
+        phone: '+1234567890',
+        providerId: 'provider-id',
+        templateId: 'template-id'
+      }
+
+      expect(@instance).to receive(:post).with(
+        '/v1/auth/enchantedlink/signup/sms',
+        request_params
+      ).and_return({ 'linkId' => '1', 'pendingRef' => 'ref', 'maskedPhone' => '+1******890' })
+
+      res = @instance.enchanted_link_sign_up_with_phone(
+        login_id: '+1234567890',
+        uri: 'https://some-uri/sms',
+        user: { login_id: 'user1', phone: '+1234567890' },
+        provider_id: 'provider-id',
+        template_id: 'template-id'
+      )
+
+      expect(res['maskedPhone']).to eq('+1******890')
+    end
   end
 
   context '.sign_up_or_in' do
@@ -125,6 +197,96 @@ describe Descope::Api::V1::EnchantedLink do
         )
       end.not_to raise_error
     end
+
+    it 'is expected to respond to sign up or in with phone' do
+      expect(@instance).to respond_to(:enchanted_link_sign_up_or_in_with_phone)
+    end
+
+    it 'is expected to sign up or in with enchanted link via sms' do
+      request_params = {
+        loginId: '+1234567890',
+        redirectUrl: 'https://some-uri/sms',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        },
+        providerId: 'provider-id',
+        templateId: 'template-id'
+      }
+
+      expect(@instance).to receive(:post).with(
+        '/v1/auth/enchantedlink/signup-in/sms',
+        request_params
+      ).and_return({ 'linkId' => '1', 'pendingRef' => 'ref', 'maskedPhone' => '+1******890' })
+
+      res = @instance.enchanted_link_sign_up_or_in_with_phone(
+        login_id: '+1234567890',
+        uri: 'https://some-uri/sms',
+        login_options: {
+          stepup: false,
+          custom_claims: { 'abc': '123' },
+          mfa: false,
+          sso_app_id: 'sso-id'
+        },
+        provider_id: 'provider-id',
+        template_id: 'template-id'
+      )
+
+      expect(res['maskedPhone']).to eq('+1******890')
+    end
+  end
+
+  context '.update_user_phone' do
+    it 'is expected to respond to update user phone' do
+      expect(@instance).to respond_to(:enchanted_link_update_user_phone)
+    end
+
+    it 'is expected to update user phone with enchanted link via sms' do
+      request_params = {
+        loginId: 'test',
+        phone: '+1234567890',
+        addToLoginIDs: true,
+        onMergeUseExisting: true,
+        redirectUrl: 'https://some-uri/sms',
+        providerId: 'provider-id',
+        templateId: 'template-id',
+        templateOptions: { 'abc': '123' }
+      }
+
+      expect(@instance).to receive(:post).with(
+        '/v1/auth/enchantedlink/update/phone/sms',
+        request_params,
+        {},
+        'refresh_token'
+      ).and_return({ 'linkId' => '1', 'pendingRef' => 'ref', 'maskedPhone' => '+1******890' })
+
+      res = @instance.enchanted_link_update_user_phone(
+        login_id: 'test',
+        phone: '+1234567890',
+        uri: 'https://some-uri/sms',
+        add_to_login_ids: true,
+        on_merge_use_existing: true,
+        provider_id: 'provider-id',
+        template_id: 'template-id',
+        template_options: { 'abc': '123' },
+        refresh_token: 'refresh_token'
+      )
+
+      expect(res['maskedPhone']).to eq('+1******890')
+    end
+
+    it 'is expected to raise an error on an invalid phone number' do
+      expect do
+        @instance.enchanted_link_update_user_phone(
+          login_id: 'test',
+          phone: 'not-a-phone',
+          uri: 'https://some-uri/sms',
+          refresh_token: 'refresh_token'
+        )
+      end.to raise_error(Descope::AuthException)
+    end
   end
 
   context '.enchanted_link_verify_token' do

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

@@ -15,7 +15,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to create access key' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEY_CREATE_PATH, {
           name: 'test',
           expireTime: 0,
@@ -46,7 +46,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to load an access key' do
-      expect(@instance).to receive(:get).with(
+      expect(@instance).to receive(:mgmt_get).with(
         ACCESS_KEY_LOAD_PATH, { id: '123' }
       )
       expect { @instance.load_access_key('123') }.not_to raise_error
@@ -59,7 +59,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to search all access keys' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEYS_SEARCH_PATH, { tenantIds: %w[123 456] }
       )
       expect { @instance.search_all_access_keys(%w[123 456]) }.not_to raise_error
@@ -72,7 +72,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to update an access keys' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEY_UPDATE_PATH, { id: '123', name: 'test1' }
       )
       expect { @instance.update_access_key(id: '123', name: 'test1') }.not_to raise_error
@@ -85,7 +85,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to deactivate an access keys' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEY_DEACTIVATE_PATH, { id: '123' }
       )
       expect { @instance.deactivate_access_key('123') }.not_to raise_error
@@ -98,7 +98,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to activate an access keys' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEY_ACTIVATE_PATH, { id: '123' }
       )
       expect { @instance.activate_access_key('123') }.not_to raise_error
@@ -111,7 +111,7 @@ describe Descope::Api::V1::Management::AccessKey do
     end
 
     it 'is expected to delete an access keys' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         ACCESS_KEY_DELETE_PATH, { id: '123' }
       )
       expect { @instance.delete_access_key('123') }.not_to raise_error

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Analytics do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Management::Analytics)
+    @instance = dummy_instance
+  end
+
+  context '.search' do
+    let(:mock_response) do
+      {
+        'analytics' => [
+          {
+            'projectId' => 'abc',
+            'action' => 'get',
+            'created' => '1234567000',
+            'device' => 'mobile',
+            'method' => 'post',
+            'geo' => 'US',
+            'tenant' => 'tenant1',
+            'referrer' => 'referrer1',
+            'cnt' => '5'
+          }
+        ]
+      }
+    end
+
+    before do
+      allow(@instance).to receive(:mgmt_post).with(
+        ANALYTICS_SEARCH_PATH,
+        {
+          from: 1_234_567_000,
+          to: 123_456_789_000,
+          groupByAction: true,
+          groupByDevice: true,
+          groupByMethod: true,
+          groupByGeo: true,
+          groupByTenant: true,
+          groupByReferrer: true,
+          groupByCreated: true,
+          actions: %w[action1 action2],
+          excludedActions: %w[exclude1 exclude2],
+          devices: %w[Bot Mobile Desktop Tablet Unknown],
+          methods: %w[otp totp magiclink oauth saml password],
+          geos: %w[US IL],
+          tenants: %w[tenant1 tenant2]
+        }
+      ).and_return(mock_response)
+    end
+
+    it 'should respond to .analytics_search' do
+      expect(@instance).to respond_to :analytics_search
+    end
+
+    it 'is expected to search analytics and get records' do
+      res = nil # define res outside the block
+      expect do
+        res = @instance.analytics_search(
+          from_ts: 1_234_567_000,
+          to_ts: 123_456_789_000,
+          group_by_action: true,
+          group_by_device: true,
+          group_by_method: true,
+          group_by_geo: true,
+          group_by_tenant: true,
+          group_by_referrer: true,
+          group_by_created: true,
+          actions: %w[action1 action2],
+          excluded_actions: %w[exclude1 exclude2],
+          devices: %w[Bot Mobile Desktop Tablet Unknown],
+          methods: %w[otp totp magiclink oauth saml password],
+          geos: %w[US IL],
+          tenants: %w[tenant1 tenant2]
+        )
+      end.not_to raise_error
+      expect(res['analytics'][0]['projectId']).to eq('abc')
+    end
+  end
+end

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

@@ -31,7 +31,7 @@ describe Descope::Api::V1::Management::Audit do
     end
 
     before do
-      allow(@instance).to receive(:post).twice.with(
+      allow(@instance).to receive(:mgmt_post).twice.with(
         AUDIT_SEARCH,
         {
           noTenants: true,
@@ -144,7 +144,7 @@ describe Descope::Api::V1::Management::Audit do
     end
 
     it 'is expected to create an audit event' do
-      expect(@instance).to receive(:post).with(
+      expect(@instance).to receive(:mgmt_post).with(
         '/v1/mgmt/audit/event',
         {
           action: 'get',

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