descope 1.0.4 → 1.0.5

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

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Authz do
+  before(:all) do
+    @client = DescopeClient.new(Configuration.config)
+    puts 'authz schema delete'
+  end
+
+  context 'authz ops' do
+    before(:all) do
+      @client.authz_delete_schema
+    end
+
+    it 'should create a new schema' do
+      puts 'Creating the ReBAC schema...'
+      schema = {
+        name: '1.0',
+        namespaces: [
+          {
+            name: 'group',
+            relationDefinitions: [
+              {
+                name: 'member'
+              },
+              {
+                name: 'owner'
+              }
+            ]
+          },
+          {
+            name: 'note',
+            relationDefinitions: [
+              {
+                name: 'owner'
+              },
+              {
+                name: 'editor',
+                complexDefinition: {
+                  nType: 'union',
+                  children: [
+                    {
+                      nType: 'child',
+                      expression: {
+                        neType: 'self'
+                      }
+                    },
+                    {
+                      nType: 'child',
+                      expression: {
+                        neType: 'targetSet',
+                        targetRelationDefinition: 'owner',
+                        targetRelationDefinitionNamespace: 'note'
+                      }
+                    }
+                  ]
+                }
+              },
+              {
+                name: 'viewer',
+                complexDefinition: {
+                  nType: 'union',
+                  children: [
+                    {
+                      nType: 'child',
+                      expression: {
+                        neType: 'self'
+                      }
+                    },
+                    {
+                      nType: 'child',
+                      expression: {
+                        neType: 'targetSet',
+                        targetRelationDefinition: 'editor',
+                        targetRelationDefinitionNamespace: 'note'
+                      }
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        ]
+      }
+      @client.authz_save_schema(schema:, upgrade: true)
+    end
+
+    it 'should create relation definition' do
+      @client.authz_save_relation_definition(
+        relation_definition: {
+          name: 'owner'
+        },
+        namespace: 'group'
+      )
+      @client.authz_save_relation_definition(
+        relation_definition: {
+          name: 'member'
+        },
+        namespace: 'group'
+      )
+      @client.authz_save_relation_definition(
+        relation_definition: {
+          name: 'owner'
+        },
+        namespace: 'note'
+      )
+      @client.authz_save_relation_definition(
+        relation_definition: {
+          name: 'editor',
+          complexDefinition: {
+            nType: 'union',
+            children: [
+              {
+                nType: 'child',
+                expression: {
+                  neType: 'self'
+                }
+              },
+              {
+                nType: 'child',
+                expression: {
+                  neType: 'targetSet',
+                  targetRelationDefinition: 'owner',
+                  targetRelationDefinitionNamespace: 'note'
+                }
+              }
+            ]
+          }
+        },
+        namespace: 'note'
+      )
+      @client.authz_save_relation_definition(
+        relation_definition: {
+          name: 'viewer',
+          complexDefinition: {
+            nType: 'union',
+            children: [
+              {
+                nType: 'child',
+                expression: {
+                  neType: 'self'
+                }
+              },
+              {
+                nType: 'child',
+                expression: {
+                  neType: 'targetSet',
+                  targetRelationDefinition: 'editor',
+                  targetRelationDefinitionNamespace: 'note'
+                }
+              }
+            ]
+          }
+        },
+        namespace: 'note'
+      )
+    end
+
+    it 'should create a relation between a resource and user' do
+      @client.authz_create_relations(
+        [
+          {
+            "resource": 'some-doc',
+            "relationDefinition": 'owner',
+            "namespace": 'note',
+            "target": 'user1'
+          }
+        ]
+      )
+
+      # Check if target has the relevant relation
+      # The answer should be true because an owner is also a viewer
+      relations = @client.authz_has_relations?(
+        [
+          {
+            "resource": 'some-doc',
+            "relationDefinition": 'viewer',
+            "namespace": 'note',
+            "target": 'user1'
+          }
+        ]
+      )
+      expect(relations['relationQueries'][0]['hasRelation']).to be_truthy
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Flow do
+  before(:all) do
+    @client = DescopeClient.new(Configuration.config)
+  end
+
+  it 'should return a list of flows' do
+    flows = @client.list_or_search_flows['flows']
+    expect(flows.length).to be > 5
+  end
+
+  it 'should search for the sign-up-or-in flow' do
+    flows = @client.list_or_search_flows(['sign-up-or-in'])['flows']
+    expect(flows.length).to eq(1)
+    expect(flows[0]['name']).to eq('Sign Up or In')
+  end
+
+  it 'should export the sign-up-or-in flow' do
+    export = @client.export_flow('sign-up-or-in')
+    expect(export['flow']['name']).to eq('Sign Up or In')
+    expect(export['screens'].length).to be > 1
+  end
+
+  it 'should import the sign-up-or-in flow' do
+    flow = @client.export_flow('sign-up-or-in')
+    imported_flow = @client.import_flow(flow_id: 'sign-up-or-in', flow: flow['flow'], screens: flow['screens'])
+    expect(imported_flow).not_to be_nil
+  end
+
+  it 'should export the current project theme' do
+    theme = @client.export_theme
+    expect(theme['theme']['cssTemplate']).not_to be_empty
+  end
+
+  it 'should import the current project theme' do
+    export_theme = @client.export_theme
+    export_theme_current_version = export_theme['theme']['version']
+    imported_theme = @client.import_theme(export_theme)
+    expect(imported_theme['theme']['version']).to be(export_theme_current_version + 1)
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Permission do
+  before(:all) do
+    @client = DescopeClient.new(Configuration.config)
+    @client.load_all_permissions['permissions'].each do |perm|
+      if perm['description'] == 'Ruby SDK'
+        puts "Deleting permission: #{perm['name']}"
+        @client.delete_permission(perm['name'])
+      end
+    end
+  end
+
+  it 'should create update and delete a permission' do
+    @client.create_permission(name: 'test_permission', description: 'Ruby SDK')
+    all_permissions = @client.load_all_permissions['permissions']
+    expect(all_permissions.any? { |perm| perm['name'] == 'test_permission' }).to eq(true)
+    @client.update_permission(name: 'test_permission', new_name: 'test_permission_2')
+    all_permissions = @client.load_all_permissions['permissions']
+    expect(all_permissions.any? { |perm| perm['name'] == 'test_permission_2' }).to eq(true)
+    @client.delete_permission('test_permission_2')
+    all_permissions = @client.load_all_permissions['permissions']
+    expect(all_permissions.any? { |perm| perm['name'] == 'test_permission_2' }).to eq(false)
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Project do
+  before(:all) do
+    @client = DescopeClient.new(Configuration.config)
+    @export_output = @client.export_project
+  end
+
+  context 'Test project methods' do
+    after(:all) do
+      @client.rename_project('Ruby-SDK-Prod')
+    end
+
+    it 'should rename a project' do
+      @client.rename_project('TEST-Ruby-SDK-Prod')
+    end
+
+    it 'should export a project' do
+      expect(@export_output).to_not be_empty
+      expect(@export_output).to be_a(Hash)
+    end
+
+    it 'should import a project' do
+      @client.import_project(files: @export_output['files'])
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::Role do
+  before(:all) do
+    @client = DescopeClient.new(Configuration.config)
+    @client.logger.info('Staring cleanup before tests...')
+    @client.logger.info('Deleting all permissions for Ruby SDK...')
+    @client.load_all_permissions['permissions'].each do |perm|
+      if perm['description'] =~ /Ruby SDK/
+        @client.logger.info("Deleting permission: #{perm['name']}")
+        @client.delete_permission(perm['name'])
+      end
+    end
+
+    @client.logger.info('Deleting all roles for Ruby SDK...')
+    @client.load_all_roles['roles'].each do |role|
+      puts "got role: #{role}"
+      if role['description'] == 'Ruby SDK'
+        @client.logger.info("Deleting role: #{role['name']}")
+        @client.delete_role(name: role['name'], tenant_id: role['tenantId'])
+      end
+    end
+
+    @client.logger.info('Deleting all tenants for Ruby SDK...')
+    @client.search_all_tenants(names: ['Ruby-SDK-test'])['tenants'].each do |tenant|
+      @client.logger.info("Deleting tenant: #{tenant['name']}")
+      @client.delete_tenant(tenant['id'])
+    end
+    @client.logger.info('Cleanup completed. Starting tests...')
+  end
+
+  it 'should create update and delete a role' do
+    @client.logger.info('Testing role creation, update, deletion and search...')
+
+    # Create permissions
+    @client.logger.info('creating viewer permission for role')
+    @client.create_permission(name: 'viewer', description: 'Viewer Permission Ruby SDK')
+
+    @client.logger.info('creating editor permission for role')
+    @client.create_permission(name: 'editor', description: 'Editor Permission Ruby SDK')
+
+    @client.logger.info('creating admin permission for role')
+    @client.create_permission(name: 'admin', description: 'Admin Permission Ruby SDK')
+
+    # Create tenants
+    @client.logger.info('creating Ruby-SDK-test tenant')
+    tenant_id = @client.create_tenant(name: 'Ruby-SDK-test')['id']
+
+    # Create roles
+    @client.logger.info('creating Ruby-SDK-test role')
+    @client.create_role(name: 'Ruby-SDK-test-viewer', description: 'Ruby SDK', permission_names: ['viewer'])
+    @client.logger.info('creating Ruby-SDK-test-admin role')
+    @client.create_role(name: 'Ruby-SDK-test-admin', description: 'Ruby SDK', permission_names: ['admin'], tenant_id:)
+
+    # check all roles matching the correct permission
+    @client.logger.info('check all roles matching the correct permission (load roles)')
+    roles = @client.load_all_roles['roles']
+    roles.each do |role|
+      expect(role['permissionNames']).to include('viewer') if role['name'] == 'Ruby-SDK-test-viewer'
+      expect(role['permissionNames']).to include('admin') if role['name'] == 'Ruby-SDK-test-admin'
+    end
+
+    @client.logger.info('updating role')
+    @client.update_role(
+      name: 'Ruby-SDK-test-viewer',
+      new_name: 'Ruby-SDK-test-editor',
+      description: 'Ruby SDK',
+      permission_names: ['editor']
+    )
+
+    @client.logger.info('searching for roles by role names...')
+    all_roles = @client.search_roles(role_names: %w[Ruby-SDK-test-admin Ruby-SDK-test-editor])['roles']
+    expected_roles = %w[Ruby-SDK-test-editor Ruby-SDK-test-admin]
+    role_count = 0
+    expected_roles.each do |expected_role|
+      expect(all_roles.map { |role| role['name'] }).to include(expected_role)
+      role_count += 1
+    end
+    expect(role_count).to eq(2)
+
+    @client.logger.info('searching for roles with role name like...')
+    all_roles = @client.search_roles(role_name_like: 'Ruby-SDK-test')['roles']
+    expected_roles = %w[Ruby-SDK-test-editor Ruby-SDK-test-admin]
+    role_count = 0
+    expected_roles.each do |expected_role|
+      expect(all_roles.map { |role| role['name'] }).to include(expected_role)
+      role_count += 1
+    end
+
+    expect(role_count).to eq(2)
+
+    @client.logger.info('searching for roles with permission names...')
+    all_roles = @client.search_roles(permission_names: %w[admin])['roles']
+    expect(all_roles.map { |role| role['name'] }).to include('Ruby-SDK-test-admin')
+
+    @client.logger.info('searching for roles with tenant ids...')
+    all_roles = @client.search_roles(tenant_ids: %w[Ruby-SDK-test])['roles']
+    expect(all_roles.map { |role| role['name'] }).to include('Ruby-SDK-test-admin')
+
+    @client.logger.info('deleting permission')
+
+    @client.delete_permission('editor')
+    @client.delete_permission('admin')
+
+    @client.logger.info('deleting editor role')
+    @client.delete_role(name: 'Ruby-SDK-test-editor')
+
+    @client.logger.info('deleting admin role')
+    @client.delete_role(name: 'Ruby-SDK-test-admin', tenant_id:)
+
+    @client.logger.info('deleting tenant')
+    @client.delete_tenant(tenant_id)
+  end
+end

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

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::Management::User do
+  before(:all) do
+    @password = SpecUtils.generate_password
+    @new_password = SpecUtils.generate_password
+    @user = build(:user)
+    @client = DescopeClient.new(Configuration.config)
+    include Descope::Mixins::Common::DeliveryMethod
+  end
+
+  after(:all) do
+    all_users = @client.search_all_users
+    all_users['users'].each do |user|
+      if user['middleName'] == 'Ruby SDK User'
+        puts "Deleting ruby spec test user #{user['loginIds'][0]}"
+        @client.delete_user(user['loginIds'][0])
+      end
+    end
+  end
+
+  it 'should create a user' do
+    user = build(:user)
+    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'])
+    expect(loaded_user['email']).to eq(created_user['email'])
+    expect(loaded_user['phone']).to eq(created_user['phone'])
+    expect(loaded_user['display_name']).to eq(created_user['display_name'])
+    expect(loaded_user['given_name']).to eq(created_user['given_name'])
+    expect(loaded_user['middle_name']).to eq(created_user['middle_name'])
+    expect(loaded_user['family_name']).to eq(created_user['family_name'])
+    expect(loaded_user['picture']).to eq(created_user['picture'])
+  end
+
+  it 'should create batch users' do
+    users = FactoryBot.build_list(:user, 5)
+    batch_res = @client.create_batch_users(users)
+    created_users = batch_res['createdUsers']
+
+    created_users.each do |user|
+      expect(user['status']).to eq('invited')
+    end
+
+    expect(batch_res['failedUsers']).to eq([])
+  end
+
+  it 'should update a user' do
+    user = build(:user)
+    created_user = @client.create_user(**user)['user']
+    updated_first_name = 'new name'
+    updated_user = @client.update_user(**user, given_name: updated_first_name)['user']
+
+    expect(updated_user['first_name']).to eq(created_user[updated_first_name])
+  end
+
+  it 'should delete a user' do
+    user = build(:user)
+    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
+
+    @client.delete_user(created_user['loginIds'][0])
+    begin
+      @client.load_user(created_user['loginIds'][0])
+    rescue Descope::NotFound => e
+      expect(e.message).to match(/"errorCode":"E112102"/)
+    end
+  end
+
+  it 'should search all users' do
+    users = FactoryBot.build_list(:user, 5)
+    @client.create_batch_users(users)
+    all_users = @client.search_all_users
+    sdk_users = all_users['users'].select { |user| user['middleName'] == 'Ruby SDK User' }
+    expect(sdk_users.length).to be >= 5
+  end
+
+  it 'should create a test user' do
+    @client.delete_all_test_users
+    sleep 5
+    user_args = build(:user)
+    test_user = @client.create_test_user(**user_args)['user']
+    test_users = @client.search_all_users(test_users_only: true)['users']
+    expect(test_users.length).to be >= 1
+    expect(test_users[0]['loginIds'][0]).to eq(test_user['loginIds'][0])
+  end
+
+  it 'should update user status' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['status']).to eq('invited')
+    @client.activate(user['loginIds'][0])
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['status']).to eq('enabled')
+    @client.deactivate(user['loginIds'][0])
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['status']).to eq('disabled')
+  end
+
+  it 'should update user email' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    email = Faker::Internet.email
+    @client.update_email(login_id: user['loginIds'][0], email:)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    puts "loaded_user #{loaded_user}"
+    expect(loaded_user['email']).to eq(email)
+  end
+
+  it 'should update user phone' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    phone = "+1#{Faker::Number.number(digits: 10)}"
+    @client.update_phone(login_id: user['loginIds'][0], phone:)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['phone']).to eq(phone)
+  end
+
+  it 'should update user picture' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    picture = Faker::Internet.url
+    @client.update_picture(login_id: user['loginIds'][0], picture:)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['picture']).to eq(picture)
+  end
+
+  it 'should update user custom attributes' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args, custom_attributes: { newUser: false })['user']
+    puts "user## #{user}"
+    @client.update_custom_attribute(login_id: user['loginIds'][0], attribute_key: 'newUser', attribute_value: true)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    puts "loaded_user #{loaded_user}"
+    expect(loaded_user['customAttributes']).to eq({ 'newUser' => true })
+  end
+
+  it 'should update display name' do
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    name = Faker::Name.name
+    @client.update_display_name(login_id: user['loginIds'][0], name:)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['name']).to eq(name)
+  end
+
+  it 'should update user JWT and custom claims' do
+    user_args = build(:user)
+    password = SpecUtils.generate_password
+    custom_claims = { "custom-key1": 'custom-value1', "custom-key2": 'custom-value2' }
+    user = @client.create_user(**user_args, password:)['user']
+    jwt = @client.password_sign_in(login_id: user['loginIds'][0], password:)['refreshSessionToken']['jwt']
+    jwt_res = @client.update_jwt(jwt:, custom_claims:)
+    decoded_jwt = @client.validate_token(jwt_res['jwt'])
+
+    # check if all keys and values from custom_claims are present in decoded_jwt
+    claims_in_jwt = custom_claims.all? do |k, v|
+      decoded_jwt[k.to_s] == v
+    end
+
+    expect(claims_in_jwt).to be true
+  end
+
+  it 'should expire user password' do
+    user_args = build(:user)
+    password = SpecUtils.generate_password
+    user = @client.create_user(**user_args, password:)['user']
+    @client.password_sign_in(login_id: user['loginIds'][0], password:)
+    begin
+      @client.expire_password(user['loginIds'][0])
+      @client.password_sign_in(login_id: user['loginIds'][0], password:)
+    rescue Descope::ServerError => e
+      expect(e.message).to match(/"errorCode":"E062909"/)
+    end
+  end
+
+  it 'should set user password' do
+    user_args = build(:user)
+    password = SpecUtils.generate_password
+    user = @client.create_user(**user_args, password:)['user']
+    @client.password_sign_in(login_id: user['loginIds'][0], password:)
+
+    begin
+      new_password = SpecUtils.generate_password
+      @client.set_password(login_id: user['loginIds'][0], password: new_password)
+      @client.password_sign_in(login_id: user['loginIds'][0], password:)
+    rescue Descope::ServerError => e
+      expect(e.message).to match(/"errorCode":"E062909"/)
+    end
+  end
+
+  it 'should update create tenant, add to user, remove from user and delete tenant' do
+    res = @client.search_all_tenants(names: ['some-new-tenant'])
+    puts "res #{res}"
+    res['tenants'].each do |tenant|
+      puts "Deleting tenant #{tenant['id']}"
+      @client.delete_tenant(tenant['id'])
+    end
+    tenant_id = @client.create_tenant(name: 'some-new-tenant')['id']
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    @client.user_add_tenant(login_id: user['loginIds'][0], tenant_id:)
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['userTenants'][0]['tenantId']).to eq(tenant_id)
+    @client.user_remove_tenant(login_id: user['loginIds'][0], tenant_id:)
+    @client.delete_tenant(tenant_id)
+  end
+
+  it 'should add and remove role from user create and delete role' do
+    role_name = 'some-new-role'
+
+    # ensure no roles exist with that name
+    all_roles = @client.load_all_roles
+    all_roles['roles'].each do |role|
+      @client.delete_role(name: role['name']) if role['name'] == role_name
+    end
+
+    @client.create_role(name: role_name)
+    user_args = build(:user)
+    user = @client.create_user(**user_args)['user']
+    @client.user_add_roles(login_id: user['loginIds'][0], role_names: ['some-new-role'])
+    loaded_user = @client.load_user(user['loginIds'][0])['user']
+    expect(loaded_user['roleNames'][0]).to eq(role_name)
+    @client.user_remove_roles(login_id: user['loginIds'][0], role_names: [role_name])
+    @client.delete_role(name: role_name)
+  end
+
+
+  it 'should logout user of all sessions' do
+    user_args = build(:user)
+    password = SpecUtils.generate_password
+    user = @client.create_user(**user_args, password:)['user']
+    session_token = @client.password_sign_in(login_id: user['loginIds'][0], password:)['refreshSessionToken']['jwt']
+    @client.logout_user(user['loginIds'][0])
+    @client.validate_and_refresh_session(session_token:)
+  end
+
+  it 'should generate login methods for test user' do
+    @client.delete_all_test_users
+    user_args = build(:user)
+    user = @client.create_test_user(**user_args)['user']
+    login_info = @client.generate_otp_for_test_user(method: Descope::Mixins::Common::DeliveryMethod::EMAIL, login_id: user['loginIds'][0])
+    expect(login_info['loginId']).to eq(user['loginIds'][0])
+    expect(login_info['code']).to_not be_nil
+
+    login_info = @client.generate_enchanted_link_for_test_user(login_id: user['loginIds'][0], uri: 'http://localhost:3001/verify')
+    expect(login_info['loginId']).to eq(user['loginIds'][0])
+    expect(login_info['link']).to start_with('http://localhost:3001/verify?t=')
+    expect(login_info['pendingRef']).to_not be_nil
+
+    login_info = @client.generate_magic_link_for_test_user(method: Descope::Mixins::Common::DeliveryMethod::EMAIL, login_id: user['loginIds'][0], uri: 'http://localhost:3001/verify')
+    expect(login_info['loginId']).to eq(user['loginIds'][0])
+    expect(login_info['link']).to start_with('http://localhost:3001/verify?t=')
+  end
+end