descope 1.0.4 → 1.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yaml +15 -27
  3. data/.github/workflows/publish-gem.yaml +61 -0
  4. data/Gemfile +12 -14
  5. data/Gemfile.lock +46 -101
  6. data/README.md +56 -19
  7. data/descope.gemspec +25 -20
  8. data/examples/ruby/.ruby-version +1 -0
  9. data/examples/ruby/access_key_app.rb +7 -4
  10. data/examples/ruby/enchantedlink_app.rb +1 -0
  11. data/examples/ruby/magiclink_app.rb +1 -0
  12. data/examples/ruby/management/.ruby-version +1 -0
  13. data/examples/ruby/management/Gemfile +2 -2
  14. data/examples/ruby/management/Gemfile.lock +2 -2
  15. data/examples/ruby/management/access_key_app.rb +2 -0
  16. data/examples/ruby/management/audit_app.rb +32 -8
  17. data/examples/ruby/management/authz_app.rb +1 -0
  18. data/examples/ruby/management/flow_app.rb +1 -0
  19. data/examples/ruby/management/permission_app.rb +3 -2
  20. data/examples/ruby/management/role_app.rb +10 -4
  21. data/examples/ruby/management/tenant_app.rb +1 -0
  22. data/examples/ruby/management/user_app.rb +1 -0
  23. data/examples/ruby/oauth_app.rb +1 -0
  24. data/examples/ruby/otp_app.rb +38 -12
  25. data/examples/ruby/password_app.rb +8 -7
  26. data/examples/ruby/saml_app.rb +1 -0
  27. data/examples/ruby/version_check.rb +17 -0
  28. data/examples/ruby-on-rails-api/descope/.gitignore +58 -28
  29. data/examples/ruby-on-rails-api/descope/Gemfile +3 -1
  30. data/examples/ruby-on-rails-api/descope/Gemfile.lock +121 -90
  31. data/examples/ruby-on-rails-api/descope/README.md +18 -18
  32. data/examples/ruby-on-rails-api/descope/app/assets/builds/App.css +62 -0
  33. data/examples/ruby-on-rails-api/descope/app/assets/builds/App.css.map +7 -0
  34. data/examples/ruby-on-rails-api/descope/app/assets/builds/application.css +20131 -0
  35. data/examples/ruby-on-rails-api/descope/app/assets/builds/application.css.map +7 -0
  36. data/examples/ruby-on-rails-api/descope/app/assets/builds/application.js +40368 -0
  37. data/examples/ruby-on-rails-api/descope/app/assets/builds/application.js.map +7 -0
  38. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/App.css +62 -0
  39. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/App.css.map +7 -0
  40. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/App.js +27979 -0
  41. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/App.js.map +7 -0
  42. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Dashboard.css +62 -0
  43. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Dashboard.css.map +7 -0
  44. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Dashboard.js +27118 -0
  45. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Dashboard.js.map +7 -0
  46. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Home.css +62 -0
  47. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Home.css.map +7 -0
  48. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Home.js +27113 -0
  49. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Home.js.map +7 -0
  50. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Login.css +62 -0
  51. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Login.css.map +7 -0
  52. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Login.js +27131 -0
  53. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Login.js.map +7 -0
  54. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Profile.css +62 -0
  55. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Profile.css.map +7 -0
  56. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Profile.js +27168 -0
  57. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/Profile.js.map +7 -0
  58. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/index.css +62 -0
  59. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/index.css.map +7 -0
  60. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/index.js +28236 -0
  61. data/examples/ruby-on-rails-api/descope/app/assets/builds/components/index.js.map +7 -0
  62. data/examples/ruby-on-rails-api/descope/app/assets/builds/controllers/application.js +2456 -0
  63. data/examples/ruby-on-rails-api/descope/app/assets/builds/controllers/application.js.map +7 -0
  64. data/examples/ruby-on-rails-api/descope/app/assets/builds/controllers/index.js +2453 -0
  65. data/examples/ruby-on-rails-api/descope/app/assets/builds/controllers/index.js.map +7 -0
  66. data/examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.css +62 -0
  67. data/examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.css.map +7 -0
  68. data/examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.js +27973 -0
  69. data/examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.js.map +7 -0
  70. data/examples/ruby-on-rails-api/descope/package-lock.json +1021 -19307
  71. data/examples/ruby-on-rails-api/descope/package.json +8 -16
  72. data/examples/ruby-on-rails-api/descope/yarn.lock +459 -10641
  73. data/lib/descope/api/v1/auth/otp.rb +21 -14
  74. data/lib/descope/api/v1/auth.rb +37 -25
  75. data/lib/descope/api/v1/management/access_key.rb +5 -4
  76. data/lib/descope/api/v1/management/audit.rb +24 -0
  77. data/lib/descope/api/v1/management/common.rb +5 -1
  78. data/lib/descope/api/v1/management/role.rb +22 -6
  79. data/lib/descope/api/v1/management/user.rb +17 -0
  80. data/lib/descope/mixins/common.rb +6 -13
  81. data/lib/descope/mixins/http.rb +1 -1
  82. data/lib/descope/mixins/validation.rb +21 -6
  83. data/lib/descope/version.rb +1 -1
  84. data/spec/integration/lib.descope/api/v1/auth/enchantedlink_spec.rb +81 -0
  85. data/spec/integration/lib.descope/api/v1/auth/magiclink_spec.rb +49 -0
  86. data/spec/integration/lib.descope/api/v1/auth/otp_spec.rb +103 -0
  87. data/spec/integration/lib.descope/api/v1/auth/password_spec.rb +41 -0
  88. data/spec/integration/lib.descope/api/v1/auth/totp_spec.rb +76 -0
  89. data/spec/integration/lib.descope/api/v1/management/access_key_spec.rb +62 -0
  90. data/spec/integration/lib.descope/api/v1/management/audit_spec.rb +52 -0
  91. data/spec/integration/lib.descope/api/v1/management/authz_spec.rb +187 -0
  92. data/spec/integration/lib.descope/api/v1/management/flow_spec.rb +44 -0
  93. data/spec/integration/lib.descope/api/v1/management/permissions_spec.rb +27 -0
  94. data/spec/integration/lib.descope/api/v1/management/project_spec.rb +29 -0
  95. data/spec/integration/lib.descope/api/v1/management/roles_spec.rb +116 -0
  96. data/spec/integration/lib.descope/api/v1/management/user_spec.rb +262 -0
  97. data/spec/lib.descope/api/v1/auth/otp_spec.rb +176 -18
  98. data/spec/lib.descope/api/v1/auth_spec.rb +50 -1
  99. data/spec/lib.descope/api/v1/management/access_key_spec.rb +4 -2
  100. data/spec/lib.descope/api/v1/management/audit_spec.rb +92 -0
  101. data/spec/lib.descope/api/v1/management/role_spec.rb +35 -6
  102. data/spec/lib.descope/api/v1/management/user_spec.rb +40 -0
  103. data/spec/spec_helper.rb +9 -38
  104. data/spec/support/client_config.rb +5 -1
  105. data/spec/support/dummy_class.rb +15 -1
  106. data/spec/support/utils.rb +1 -1
  107. metadata +77 -133
  108. data/examples/ruby-on-rails-api/descope/tmp/pids/.keep +0 -0
  109. data/examples/ruby-on-rails-api/descope/tmp/storage/.keep +0 -0
@@ -0,0 +1,116 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'spec_helper'
4
+
5
+ describe Descope::Api::V1::Management::Role do
6
+ before(:all) do
7
+ @client = DescopeClient.new(Configuration.config)
8
+ @client.logger.info('Staring cleanup before tests...')
9
+ @client.logger.info('Deleting all permissions for Ruby SDK...')
10
+ @client.load_all_permissions['permissions'].each do |perm|
11
+ if perm['description'] =~ /Ruby SDK/
12
+ @client.logger.info("Deleting permission: #{perm['name']}")
13
+ @client.delete_permission(perm['name'])
14
+ end
15
+ end
16
+
17
+ @client.logger.info('Deleting all roles for Ruby SDK...')
18
+ @client.load_all_roles['roles'].each do |role|
19
+ puts "got role: #{role}"
20
+ if role['description'] == 'Ruby SDK'
21
+ @client.logger.info("Deleting role: #{role['name']}")
22
+ @client.delete_role(name: role['name'], tenant_id: role['tenantId'])
23
+ end
24
+ end
25
+
26
+ @client.logger.info('Deleting all tenants for Ruby SDK...')
27
+ @client.search_all_tenants(names: ['Ruby-SDK-test'])['tenants'].each do |tenant|
28
+ @client.logger.info("Deleting tenant: #{tenant['name']}")
29
+ @client.delete_tenant(tenant['id'])
30
+ end
31
+ @client.logger.info('Cleanup completed. Starting tests...')
32
+ end
33
+
34
+ it 'should create update and delete a role' do
35
+ @client.logger.info('Testing role creation, update, deletion and search...')
36
+
37
+ # Create permissions
38
+ @client.logger.info('creating viewer permission for role')
39
+ @client.create_permission(name: 'viewer', description: 'Viewer Permission Ruby SDK')
40
+
41
+ @client.logger.info('creating editor permission for role')
42
+ @client.create_permission(name: 'editor', description: 'Editor Permission Ruby SDK')
43
+
44
+ @client.logger.info('creating admin permission for role')
45
+ @client.create_permission(name: 'admin', description: 'Admin Permission Ruby SDK')
46
+
47
+ # Create tenants
48
+ @client.logger.info('creating Ruby-SDK-test tenant')
49
+ tenant_id = @client.create_tenant(name: 'Ruby-SDK-test')['id']
50
+
51
+ # Create roles
52
+ @client.logger.info('creating Ruby-SDK-test role')
53
+ @client.create_role(name: 'Ruby-SDK-test-viewer', description: 'Ruby SDK', permission_names: ['viewer'])
54
+ @client.logger.info('creating Ruby-SDK-test-admin role')
55
+ @client.create_role(name: 'Ruby-SDK-test-admin', description: 'Ruby SDK', permission_names: ['admin'], tenant_id:)
56
+
57
+ # check all roles matching the correct permission
58
+ @client.logger.info('check all roles matching the correct permission (load roles)')
59
+ roles = @client.load_all_roles['roles']
60
+ roles.each do |role|
61
+ expect(role['permissionNames']).to include('viewer') if role['name'] == 'Ruby-SDK-test-viewer'
62
+ expect(role['permissionNames']).to include('admin') if role['name'] == 'Ruby-SDK-test-admin'
63
+ end
64
+
65
+ @client.logger.info('updating role')
66
+ @client.update_role(
67
+ name: 'Ruby-SDK-test-viewer',
68
+ new_name: 'Ruby-SDK-test-editor',
69
+ description: 'Ruby SDK',
70
+ permission_names: ['editor']
71
+ )
72
+
73
+ @client.logger.info('searching for roles by role names...')
74
+ all_roles = @client.search_roles(role_names: %w[Ruby-SDK-test-admin Ruby-SDK-test-editor])['roles']
75
+ expected_roles = %w[Ruby-SDK-test-editor Ruby-SDK-test-admin]
76
+ role_count = 0
77
+ expected_roles.each do |expected_role|
78
+ expect(all_roles.map { |role| role['name'] }).to include(expected_role)
79
+ role_count += 1
80
+ end
81
+ expect(role_count).to eq(2)
82
+
83
+ @client.logger.info('searching for roles with role name like...')
84
+ all_roles = @client.search_roles(role_name_like: 'Ruby-SDK-test')['roles']
85
+ expected_roles = %w[Ruby-SDK-test-editor Ruby-SDK-test-admin]
86
+ role_count = 0
87
+ expected_roles.each do |expected_role|
88
+ expect(all_roles.map { |role| role['name'] }).to include(expected_role)
89
+ role_count += 1
90
+ end
91
+
92
+ expect(role_count).to eq(2)
93
+
94
+ @client.logger.info('searching for roles with permission names...')
95
+ all_roles = @client.search_roles(permission_names: %w[admin])['roles']
96
+ expect(all_roles.map { |role| role['name'] }).to include('Ruby-SDK-test-admin')
97
+
98
+ @client.logger.info('searching for roles with tenant ids...')
99
+ all_roles = @client.search_roles(role_name_like: 'Ruby-SDK-test', tenant_ids: [tenant_id])['roles']
100
+ expect(all_roles.map { |role| role['name'] }).to include('Ruby-SDK-test-admin')
101
+
102
+ @client.logger.info('deleting permission')
103
+
104
+ @client.delete_permission('editor')
105
+ @client.delete_permission('admin')
106
+
107
+ @client.logger.info('deleting editor role')
108
+ @client.delete_role(name: 'Ruby-SDK-test-editor')
109
+
110
+ @client.logger.info('deleting admin role')
111
+ @client.delete_role(name: 'Ruby-SDK-test-admin', tenant_id:)
112
+
113
+ @client.logger.info('deleting tenant')
114
+ @client.delete_tenant(tenant_id)
115
+ end
116
+ end
@@ -0,0 +1,262 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'spec_helper'
4
+
5
+ describe Descope::Api::V1::Management::User do
6
+ before(:all) do
7
+ @password = SpecUtils.generate_password
8
+ @new_password = SpecUtils.generate_password
9
+ @user = build(:user)
10
+ @client = DescopeClient.new(Configuration.config)
11
+ include Descope::Mixins::Common::DeliveryMethod
12
+ end
13
+
14
+ after(:all) do
15
+ all_users = @client.search_all_users
16
+ all_users['users'].each do |user|
17
+ if user['middleName'] == 'Ruby SDK User'
18
+ puts "Deleting ruby spec test user #{user['loginIds'][0]}"
19
+ @client.delete_user(user['loginIds'][0])
20
+ end
21
+ end
22
+ end
23
+
24
+ it 'should create a user' do
25
+ user = build(:user)
26
+ created_user = @client.create_user(**user)['user']
27
+
28
+ loaded_user = @client.load_user(created_user['loginIds'][0])['user']
29
+
30
+ expect(loaded_user['loginIds']).to eq(created_user['loginIds'])
31
+ expect(loaded_user['email']).to eq(created_user['email'])
32
+ expect(loaded_user['phone']).to eq(created_user['phone'])
33
+ expect(loaded_user['display_name']).to eq(created_user['display_name'])
34
+ expect(loaded_user['given_name']).to eq(created_user['given_name'])
35
+ expect(loaded_user['middle_name']).to eq(created_user['middle_name'])
36
+ expect(loaded_user['family_name']).to eq(created_user['family_name'])
37
+ expect(loaded_user['picture']).to eq(created_user['picture'])
38
+ end
39
+
40
+ it 'should create batch users' do
41
+ users = FactoryBot.build_list(:user, 5)
42
+ batch_res = @client.create_batch_users(users)
43
+ created_users = batch_res['createdUsers']
44
+
45
+ created_users.each do |user|
46
+ expect(user['status']).to eq('invited')
47
+ end
48
+
49
+ expect(batch_res['failedUsers']).to eq([])
50
+ end
51
+
52
+ it 'should update a user' do
53
+ user = build(:user)
54
+ created_user = @client.create_user(**user)['user']
55
+ updated_first_name = 'new name'
56
+ updated_user = @client.update_user(**user, given_name: updated_first_name)['user']
57
+
58
+ expect(updated_user['first_name']).to eq(created_user[updated_first_name])
59
+ end
60
+
61
+ it 'should delete a user' do
62
+ user = build(:user)
63
+ created_user = @client.create_user(**user)['user']
64
+ loaded_user = @client.load_user(created_user['loginIds'][0])['user']
65
+ expect(loaded_user['loginIds']).to eq(created_user['loginIds'])
66
+ sleep 10
67
+
68
+ @client.delete_user(created_user['loginIds'][0])
69
+ begin
70
+ @client.load_user(created_user['loginIds'][0])
71
+ rescue Descope::NotFound => e
72
+ expect(e.message).to match(/"errorCode":"E112102"/)
73
+ end
74
+ end
75
+
76
+ it 'should search all users' do
77
+ users = FactoryBot.build_list(:user, 5)
78
+ @client.create_batch_users(users)
79
+ all_users = @client.search_all_users
80
+ sdk_users = all_users['users'].select { |user| user['middleName'] == 'Ruby SDK User' }
81
+ expect(sdk_users.length).to be >= 5
82
+ end
83
+
84
+ it 'should create a test user' do
85
+ @client.delete_all_test_users
86
+ sleep 5
87
+ user_args = build(:user)
88
+ test_user = @client.create_test_user(**user_args)['user']
89
+ test_users = @client.search_all_users(test_users_only: true)['users']
90
+ expect(test_users.length).to be >= 1
91
+ expect(test_users[0]['loginIds'][0]).to eq(test_user['loginIds'][0])
92
+ end
93
+
94
+ it 'should update user status' do
95
+ user_args = build(:user)
96
+ user = @client.create_user(**user_args)['user']
97
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
98
+ expect(loaded_user['status']).to eq('invited')
99
+ @client.activate(user['loginIds'][0])
100
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
101
+ expect(loaded_user['status']).to eq('enabled')
102
+ @client.deactivate(user['loginIds'][0])
103
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
104
+ expect(loaded_user['status']).to eq('disabled')
105
+ end
106
+
107
+ it 'should update user email' do
108
+ user_args = build(:user)
109
+ user = @client.create_user(**user_args)['user']
110
+ email = Faker::Internet.email
111
+ @client.update_email(login_id: user['loginIds'][0], email:)
112
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
113
+ puts "loaded_user #{loaded_user}"
114
+ expect(loaded_user['email']).to eq(email)
115
+ end
116
+
117
+ it 'should update user phone' do
118
+ user_args = build(:user)
119
+ user = @client.create_user(**user_args)['user']
120
+ phone = "+1#{Faker::Number.number(digits: 10)}"
121
+ @client.update_phone(login_id: user['loginIds'][0], phone:)
122
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
123
+ expect(loaded_user['phone']).to eq(phone)
124
+ end
125
+
126
+ it 'should update user picture' do
127
+ user_args = build(:user)
128
+ user = @client.create_user(**user_args)['user']
129
+ picture = Faker::Internet.url
130
+ @client.update_picture(login_id: user['loginIds'][0], picture:)
131
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
132
+ expect(loaded_user['picture']).to eq(picture)
133
+ end
134
+
135
+ it 'should update user custom attributes' do
136
+ user_args = build(:user)
137
+ user = @client.create_user(**user_args, custom_attributes: { newUser: false })['user']
138
+ puts "user## #{user}"
139
+ @client.update_custom_attribute(login_id: user['loginIds'][0], attribute_key: 'newUser', attribute_value: true)
140
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
141
+ puts "loaded_user #{loaded_user}"
142
+ expect(loaded_user['customAttributes']).to eq({ 'newUser' => true })
143
+ end
144
+
145
+ it 'should update display name' do
146
+ user_args = build(:user)
147
+ user = @client.create_user(**user_args)['user']
148
+ name = Faker::Name.name
149
+ @client.update_display_name(login_id: user['loginIds'][0], name:)
150
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
151
+ expect(loaded_user['name']).to eq(name)
152
+ end
153
+
154
+ it 'should update user JWT and custom claims' do
155
+ user_args = build(:user)
156
+ password = SpecUtils.generate_password
157
+ custom_claims = { "custom-key1": 'custom-value1', "custom-key2": 'custom-value2' }
158
+ user = @client.create_user(**user_args, password:)['user']
159
+ jwt = @client.password_sign_in(login_id: user['loginIds'][0], password:)['refreshSessionToken']['jwt']
160
+ jwt_res = @client.update_jwt(jwt:, custom_claims:)
161
+ decoded_jwt = @client.validate_token(jwt_res['jwt'])
162
+
163
+ # check if all keys and values from custom_claims are present in decoded_jwt
164
+ claims_in_jwt = custom_claims.all? do |k, v|
165
+ decoded_jwt[k.to_s] == v
166
+ end
167
+
168
+ expect(claims_in_jwt).to be true
169
+ end
170
+
171
+ it 'should expire user password' do
172
+ user_args = build(:user)
173
+ password = SpecUtils.generate_password
174
+ user = @client.create_user(**user_args, password:)['user']
175
+ @client.password_sign_in(login_id: user['loginIds'][0], password:)
176
+ begin
177
+ @client.expire_password(user['loginIds'][0])
178
+ @client.password_sign_in(login_id: user['loginIds'][0], password:)
179
+ rescue Descope::ServerError => e
180
+ expect(e.message).to match(/"errorCode":"E062909"/)
181
+ end
182
+ end
183
+
184
+ it 'should set user password' do
185
+ user_args = build(:user)
186
+ password = SpecUtils.generate_password
187
+ user = @client.create_user(**user_args, password:)['user']
188
+ @client.password_sign_in(login_id: user['loginIds'][0], password:)
189
+
190
+ begin
191
+ new_password = SpecUtils.generate_password
192
+ @client.set_password(login_id: user['loginIds'][0], password: new_password)
193
+ @client.password_sign_in(login_id: user['loginIds'][0], password:)
194
+ rescue Descope::ServerError => e
195
+ expect(e.message).to match(/"errorCode":"E062909"/)
196
+ end
197
+ end
198
+
199
+ it 'should update create tenant, add to user, remove from user and delete tenant' do
200
+ res = @client.search_all_tenants(names: ['some-new-tenant'])
201
+ puts "res #{res}"
202
+ res['tenants'].each do |tenant|
203
+ puts "Deleting tenant #{tenant['id']}"
204
+ @client.delete_tenant(tenant['id'])
205
+ end
206
+ tenant_id = @client.create_tenant(name: 'some-new-tenant')['id']
207
+ user_args = build(:user)
208
+ user = @client.create_user(**user_args)['user']
209
+ @client.user_add_tenant(login_id: user['loginIds'][0], tenant_id:)
210
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
211
+ expect(loaded_user['userTenants'][0]['tenantId']).to eq(tenant_id)
212
+ @client.user_remove_tenant(login_id: user['loginIds'][0], tenant_id:)
213
+ @client.delete_tenant(tenant_id)
214
+ end
215
+
216
+ it 'should add and remove role from user create and delete role' do
217
+ role_name = 'some-new-role'
218
+
219
+ # ensure no roles exist with that name
220
+ all_roles = @client.load_all_roles
221
+ all_roles['roles'].each do |role|
222
+ @client.delete_role(name: role['name']) if role['name'] == role_name
223
+ end
224
+
225
+ @client.create_role(name: role_name)
226
+ user_args = build(:user)
227
+ user = @client.create_user(**user_args)['user']
228
+ @client.user_add_roles(login_id: user['loginIds'][0], role_names: ['some-new-role'])
229
+ loaded_user = @client.load_user(user['loginIds'][0])['user']
230
+ expect(loaded_user['roleNames'][0]).to eq(role_name)
231
+ @client.user_remove_roles(login_id: user['loginIds'][0], role_names: [role_name])
232
+ @client.delete_role(name: role_name)
233
+ end
234
+
235
+
236
+ it 'should logout user of all sessions' do
237
+ user_args = build(:user)
238
+ password = SpecUtils.generate_password
239
+ user = @client.create_user(**user_args, password:)['user']
240
+ session_token = @client.password_sign_in(login_id: user['loginIds'][0], password:)['refreshSessionToken']['jwt']
241
+ @client.logout_user(user['loginIds'][0])
242
+ @client.validate_and_refresh_session(session_token:)
243
+ end
244
+
245
+ it 'should generate login methods for test user' do
246
+ @client.delete_all_test_users
247
+ user_args = build(:user)
248
+ user = @client.create_test_user(**user_args)['user']
249
+ login_info = @client.generate_otp_for_test_user(method: Descope::Mixins::Common::DeliveryMethod::EMAIL, login_id: user['loginIds'][0])
250
+ expect(login_info['loginId']).to eq(user['loginIds'][0])
251
+ expect(login_info['code']).to_not be_nil
252
+
253
+ login_info = @client.generate_enchanted_link_for_test_user(login_id: user['loginIds'][0], uri: 'http://localhost:3001/verify')
254
+ expect(login_info['loginId']).to eq(user['loginIds'][0])
255
+ expect(login_info['link']).to start_with('http://localhost:3001/verify?t=')
256
+ expect(login_info['pendingRef']).to_not be_nil
257
+
258
+ 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')
259
+ expect(login_info['loginId']).to eq(user['loginIds'][0])
260
+ expect(login_info['link']).to start_with('http://localhost:3001/verify?t=')
261
+ end
262
+ end
@@ -11,14 +11,15 @@ describe Descope::Api::V1::OTP do
11
11
  @instance = dummy_instance
12
12
  end
13
13
 
14
+ # Sign In methods
14
15
  context '.sign_in' do
15
16
  it 'is expected to respond to sign in using otp' do
16
17
  expect(@instance).to respond_to(:otp_sign_in)
17
18
  end
18
19
 
19
- it 'is expected to sign in with otp' do
20
+ it 'is expected to sign in with otp with email' do
20
21
  request_params = {
21
- loginId: 'test',
22
+ loginId: 'dummy@dummy.com',
22
23
  loginOptions: {
23
24
  stepup: false,
24
25
  customClaims: { 'abc': '123' },
@@ -38,7 +39,7 @@ describe Descope::Api::V1::OTP do
38
39
  expect do
39
40
  @instance.otp_sign_in(
40
41
  method: DeliveryMethod::EMAIL,
41
- login_id: 'test',
42
+ login_id: 'dummy@dummy.com',
42
43
  login_options: {
43
44
  stepup: false,
44
45
  custom_claims: { 'abc': '123' },
@@ -50,15 +51,15 @@ describe Descope::Api::V1::OTP do
50
51
  end.not_to raise_error
51
52
  end
52
53
 
53
- it 'is expected to sign in with otp phone' do
54
+ it 'is expected to sign in with otp phone SMS' do
54
55
  request_params = {
55
- loginId: 'test',
56
+ loginId: '+12122242225',
56
57
  loginOptions: {
57
58
  stepup: false,
58
59
  customClaims: { 'abc': '123' },
59
60
  mfa: false,
60
61
  ssoAppId: 'sso-id'
61
- },
62
+ }
62
63
  }
63
64
  expect(@instance).to receive(:post).with(
64
65
  otp_compose_signin_url(DeliveryMethod::SMS),
@@ -76,7 +77,45 @@ describe Descope::Api::V1::OTP do
76
77
  expect do
77
78
  @instance.otp_sign_in(
78
79
  method: DeliveryMethod::SMS,
79
- login_id: 'test',
80
+ login_id: '+12122242225',
81
+ login_options: {
82
+ stepup: false,
83
+ custom_claims: { 'abc': '123' },
84
+ mfa: false,
85
+ sso_app_id: 'sso-id'
86
+ },
87
+ refresh_token: 'refresh_token'
88
+ )
89
+ end.not_to raise_error
90
+ end
91
+
92
+ it 'is expected to sign in with otp Voice' do
93
+ request_params = {
94
+ loginId: '+12122242225',
95
+ loginOptions: {
96
+ stepup: false,
97
+ customClaims: { 'abc': '123' },
98
+ mfa: false,
99
+ ssoAppId: 'sso-id'
100
+ }
101
+ }
102
+ expect(@instance).to receive(:post).with(
103
+ otp_compose_signin_url(DeliveryMethod::VOICE),
104
+ request_params,
105
+ {},
106
+ 'refresh_token'
107
+ )
108
+
109
+ allow_any_instance_of(Descope::Api::V1::Auth::OTP).to receive(:extract_masked_address).and_return(
110
+ {
111
+ 'maskedPhone' => '+1******890'
112
+ }
113
+ )
114
+
115
+ expect do
116
+ @instance.otp_sign_in(
117
+ method: DeliveryMethod::VOICE,
118
+ login_id: '+12122242225',
80
119
  login_options: {
81
120
  stepup: false,
82
121
  custom_claims: { 'abc': '123' },
@@ -89,6 +128,7 @@ describe Descope::Api::V1::OTP do
89
128
  end
90
129
  end
91
130
 
131
+ # Sign Up methods
92
132
  context '.sign_up' do
93
133
  it 'is expected to respond to otp email sign up' do
94
134
  expect(@instance).to respond_to(:otp_sign_up)
@@ -96,7 +136,7 @@ describe Descope::Api::V1::OTP do
96
136
 
97
137
  it 'is expected to sign up with otp via email' do
98
138
  request_params = {
99
- loginId: 'test',
139
+ loginId: 'user1',
100
140
  user: { loginId: 'user1', email: 'dummy@dummy.com' },
101
141
  email: 'dummy@dummy.com'
102
142
  }
@@ -110,18 +150,18 @@ describe Descope::Api::V1::OTP do
110
150
 
111
151
  expect do
112
152
  @instance.otp_sign_up(
113
- login_id: 'test',
153
+ login_id: 'user1',
114
154
  method: DeliveryMethod::EMAIL,
115
155
  user: { login_id: 'user1', email: 'dummy@dummy.com' }
116
156
  )
117
157
  end.not_to raise_error
118
158
  end
119
159
 
120
- it 'is expected to sign up with otp via phone' do
160
+ it 'is expected to sign up with otp via SMS' do
121
161
  request_params = {
122
- loginId: 'test',
123
- user: { loginId: 'user1', phone: '+1234567890' },
124
- phone: '+1234567890'
162
+ loginId: '+1234567890',
163
+ user: { loginId: '+1234567890' },
164
+ phone: ''
125
165
  }
126
166
 
127
167
  expect(@instance).to receive(:post).with(
@@ -133,22 +173,46 @@ describe Descope::Api::V1::OTP do
133
173
 
134
174
  expect do
135
175
  @instance.otp_sign_up(
136
- login_id: 'test',
176
+ login_id: '+1234567890',
137
177
  method: DeliveryMethod::SMS,
138
- user: { login_id: 'user1', phone: '+1234567890' }
178
+ user: { login_id: '+1234567890' }
179
+ )
180
+ end.not_to raise_error
181
+ end
182
+
183
+ it 'is expected to sign up with otp via Voice' do
184
+ request_params = {
185
+ loginId: '+1234567890',
186
+ user: { loginId: '+1234567890', phone: '+1234567890' },
187
+ phone: '+1234567890'
188
+ }
189
+
190
+ expect(@instance).to receive(:post).with(
191
+ otp_compose_signup_url(DeliveryMethod::VOICE),
192
+ request_params
193
+ ).and_return({ 'maskedPhone' => '+1******890' })
194
+
195
+ allow_any_instance_of(Descope::Api::V1::Auth).to receive(:extract_masked_address).and_return({})
196
+
197
+ expect do
198
+ @instance.otp_sign_up(
199
+ login_id: '+1234567890',
200
+ method: DeliveryMethod::VOICE,
201
+ user: { login_id: '+1234567890', phone: '+1234567890' }
139
202
  )
140
203
  end.not_to raise_error
141
204
  end
142
205
  end
143
206
 
207
+ # Sign Up or In methods
144
208
  context '.sign_up_or_in' do
145
209
  it 'is expected to respond to sign up' do
146
210
  expect(@instance).to respond_to(:otp_sign_up_or_in)
147
211
  end
148
212
 
149
- it 'is expected to sign up or in with otp' do
213
+ it 'is expected to sign up or in with otp via email' do
150
214
  request_params = {
151
- loginId: 'test',
215
+ loginId: 'dummy@dummy.com',
152
216
  loginOptions: {
153
217
  stepup: false,
154
218
  customClaims: { 'abc': '123' },
@@ -168,7 +232,79 @@ describe Descope::Api::V1::OTP do
168
232
  expect do
169
233
  @instance.otp_sign_up_or_in(
170
234
  method: DeliveryMethod::EMAIL,
171
- login_id: 'test',
235
+ login_id: 'dummy@dummy.com',
236
+ login_options: {
237
+ stepup: false,
238
+ custom_claims: { 'abc': '123' },
239
+ mfa: false,
240
+ sso_app_id: 'sso-id'
241
+ },
242
+ provider_id: 'provider-id',
243
+ template_id: 'template-id',
244
+ sso_app_id: 'sso-id'
245
+ )
246
+ end.not_to raise_error
247
+ end
248
+
249
+ it 'is expected to sign up or in with otp via SMS' do
250
+ request_params = {
251
+ loginId: '+12122242225',
252
+ loginOptions: {
253
+ stepup: false,
254
+ customClaims: { 'abc': '123' },
255
+ mfa: false,
256
+ ssoAppId: 'sso-id'
257
+ },
258
+ providerId: 'provider-id',
259
+ templateId: 'template-id',
260
+ ssoAppId: 'sso-id'
261
+ }
262
+
263
+ expect(@instance).to receive(:post).with(
264
+ otp_compose_sign_up_or_in_url(DeliveryMethod::SMS),
265
+ request_params
266
+ ).and_return({ 'maskedPhone' => '+1******890' })
267
+
268
+ expect do
269
+ @instance.otp_sign_up_or_in(
270
+ method: DeliveryMethod::SMS,
271
+ login_id: '+12122242225',
272
+ login_options: {
273
+ stepup: false,
274
+ custom_claims: { 'abc': '123' },
275
+ mfa: false,
276
+ sso_app_id: 'sso-id'
277
+ },
278
+ provider_id: 'provider-id',
279
+ template_id: 'template-id',
280
+ sso_app_id: 'sso-id'
281
+ )
282
+ end.not_to raise_error
283
+ end
284
+
285
+ it 'is expected to sign up or in with otp via Voice' do
286
+ request_params = {
287
+ loginId: '+12122242225',
288
+ loginOptions: {
289
+ stepup: false,
290
+ customClaims: { 'abc': '123' },
291
+ mfa: false,
292
+ ssoAppId: 'sso-id'
293
+ },
294
+ providerId: 'provider-id',
295
+ templateId: 'template-id',
296
+ ssoAppId: 'sso-id'
297
+ }
298
+
299
+ expect(@instance).to receive(:post).with(
300
+ otp_compose_sign_up_or_in_url(DeliveryMethod::VOICE),
301
+ request_params
302
+ ).and_return({ 'maskedPhone' => '+1******890' })
303
+
304
+ expect do
305
+ @instance.otp_sign_up_or_in(
306
+ method: DeliveryMethod::VOICE,
307
+ login_id: '+12122242225',
172
308
  login_options: {
173
309
  stepup: false,
174
310
  custom_claims: { 'abc': '123' },
@@ -215,6 +351,28 @@ describe Descope::Api::V1::OTP do
215
351
  expect(@instance).to respond_to(:otp_update_user_email)
216
352
  end
217
353
 
354
+ it 'raises a validation error' do
355
+ expect { OTP.otp_update_user_phone(login_id: nil) }
356
+ .to raise_error('login_id cannot be empty')
357
+ end
358
+
359
+ it 'raises a validation error' do
360
+ expect { OTP.otp_update_user_phone(login_id: 'someone', phone: nil) }
361
+ .to raise_error('Phone number cannot be empty')
362
+ end
363
+
364
+ it 'raises a delivery method error with invalid method' do
365
+ expect do
366
+ OTP.otp_update_user_phone(login_id: 'abc', phone: '+12124332222', method: 0)
367
+ end.to raise_error(Descope::AuthException, /Delivery method should be one of the following/)
368
+ end
369
+
370
+ it 'raises a validation error when phone number doesnt match pattern' do
371
+ expect do
372
+ OTP.otp_update_user_phone(login_id: 'abc', phone: '-1212a$', method: DeliveryMethod::SMS)
373
+ end.to raise_error(Descope::AuthException, /Invalid pattern for phone number/)
374
+ end
375
+
218
376
  it 'is expected to update email with otp' do
219
377
  request_params = {
220
378
  loginId: 'test',