descope 1.0.5 → 1.0.6

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

@@ -11,14 +11,15 @@ describe Descope::Api::V1::OTP do
     @instance = dummy_instance
   end
 
+  # Sign In methods
   context '.sign_in' do
     it 'is expected to respond to sign in using otp' do
       expect(@instance).to respond_to(:otp_sign_in)
     end
 
-    it 'is expected to sign in with otp' do
+    it 'is expected to sign in with otp with email' do
       request_params = {
-        loginId: 'test',
+        loginId: 'dummy@dummy.com',
         loginOptions: {
           stepup: false,
           customClaims: { 'abc': '123' },
@@ -38,7 +39,7 @@ describe Descope::Api::V1::OTP do
       expect do
         @instance.otp_sign_in(
           method: DeliveryMethod::EMAIL,
-          login_id: 'test',
+          login_id: 'dummy@dummy.com',
           login_options: {
             stepup: false,
             custom_claims: { 'abc': '123' },
@@ -50,15 +51,15 @@ describe Descope::Api::V1::OTP do
       end.not_to raise_error
     end
 
-    it 'is expected to sign in with otp phone' do
+    it 'is expected to sign in with otp phone SMS' do
       request_params = {
-        loginId: 'test',
+        loginId: '+12122242225',
         loginOptions: {
           stepup: false,
           customClaims: { 'abc': '123' },
           mfa: false,
           ssoAppId: 'sso-id'
-        },
+        }
       }
       expect(@instance).to receive(:post).with(
         otp_compose_signin_url(DeliveryMethod::SMS),
@@ -76,7 +77,45 @@ describe Descope::Api::V1::OTP do
       expect do
         @instance.otp_sign_in(
           method: DeliveryMethod::SMS,
-          login_id: 'test',
+          login_id: '+12122242225',
+          login_options: {
+            stepup: false,
+            custom_claims: { 'abc': '123' },
+            mfa: false,
+            sso_app_id: 'sso-id'
+          },
+          refresh_token: 'refresh_token'
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to sign in with otp Voice' do
+      request_params = {
+        loginId: '+12122242225',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+      expect(@instance).to receive(:post).with(
+        otp_compose_signin_url(DeliveryMethod::VOICE),
+        request_params,
+        {},
+        'refresh_token'
+      )
+
+      allow_any_instance_of(Descope::Api::V1::Auth::OTP).to receive(:extract_masked_address).and_return(
+        {
+          'maskedPhone' => '+1******890'
+        }
+      )
+
+      expect do
+        @instance.otp_sign_in(
+          method: DeliveryMethod::VOICE,
+          login_id: '+12122242225',
           login_options: {
             stepup: false,
             custom_claims: { 'abc': '123' },
@@ -89,6 +128,7 @@ describe Descope::Api::V1::OTP do
     end
   end
 
+  # Sign Up methods
   context '.sign_up' do
     it 'is expected to respond to otp email sign up' do
       expect(@instance).to respond_to(:otp_sign_up)
@@ -96,7 +136,7 @@ describe Descope::Api::V1::OTP do
 
     it 'is expected to sign up with otp via email' do
       request_params = {
-        loginId: 'test',
+        loginId: 'user1',
         user: { loginId: 'user1', email: 'dummy@dummy.com' },
         email: 'dummy@dummy.com'
       }
@@ -110,18 +150,18 @@ describe Descope::Api::V1::OTP do
 
       expect do
         @instance.otp_sign_up(
-          login_id: 'test',
+          login_id: 'user1',
           method: DeliveryMethod::EMAIL,
           user: { login_id: 'user1', email: 'dummy@dummy.com' }
         )
       end.not_to raise_error
     end
 
-    it 'is expected to sign up with otp via phone' do
+    it 'is expected to sign up with otp via SMS' do
       request_params = {
-        loginId: 'test',
-        user: { loginId: 'user1', phone: '+1234567890' },
-        phone: '+1234567890'
+        loginId: '+1234567890',
+        user: { loginId: '+1234567890' },
+        phone: ''
       }
 
       expect(@instance).to receive(:post).with(
@@ -133,22 +173,46 @@ describe Descope::Api::V1::OTP do
 
       expect do
         @instance.otp_sign_up(
-          login_id: 'test',
+          login_id: '+1234567890',
           method: DeliveryMethod::SMS,
-          user: { login_id: 'user1', phone: '+1234567890' }
+          user: { login_id: '+1234567890' }
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to sign up with otp via Voice' do
+      request_params = {
+        loginId: '+1234567890',
+        user: { loginId: '+1234567890', phone: '+1234567890' },
+        phone: '+1234567890'
+      }
+
+      expect(@instance).to receive(:post).with(
+        otp_compose_signup_url(DeliveryMethod::VOICE),
+        request_params
+      ).and_return({ 'maskedPhone' => '+1******890' })
+
+      allow_any_instance_of(Descope::Api::V1::Auth).to receive(:extract_masked_address).and_return({})
+
+      expect do
+        @instance.otp_sign_up(
+          login_id: '+1234567890',
+          method: DeliveryMethod::VOICE,
+          user: { login_id: '+1234567890', phone: '+1234567890' }
         )
       end.not_to raise_error
     end
   end
 
+  # Sign Up or In methods
   context '.sign_up_or_in' do
     it 'is expected to respond to sign up' do
       expect(@instance).to respond_to(:otp_sign_up_or_in)
     end
 
-    it 'is expected to sign up or in with otp' do
+    it 'is expected to sign up or in with otp via email' do
       request_params = {
-        loginId: 'test',
+        loginId: 'dummy@dummy.com',
         loginOptions: {
           stepup: false,
           customClaims: { 'abc': '123' },
@@ -168,7 +232,79 @@ describe Descope::Api::V1::OTP do
       expect do
         @instance.otp_sign_up_or_in(
           method: DeliveryMethod::EMAIL,
-          login_id: 'test',
+          login_id: 'dummy@dummy.com',
+          login_options: {
+            stepup: false,
+            custom_claims: { 'abc': '123' },
+            mfa: false,
+            sso_app_id: 'sso-id'
+          },
+          provider_id: 'provider-id',
+          template_id: 'template-id',
+          sso_app_id: 'sso-id'
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to sign up or in with otp via SMS' do
+      request_params = {
+        loginId: '+12122242225',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        },
+        providerId: 'provider-id',
+        templateId: 'template-id',
+        ssoAppId: 'sso-id'
+      }
+
+      expect(@instance).to receive(:post).with(
+        otp_compose_sign_up_or_in_url(DeliveryMethod::SMS),
+        request_params
+      ).and_return({ 'maskedPhone' => '+1******890' })
+
+      expect do
+        @instance.otp_sign_up_or_in(
+          method: DeliveryMethod::SMS,
+          login_id: '+12122242225',
+          login_options: {
+            stepup: false,
+            custom_claims: { 'abc': '123' },
+            mfa: false,
+            sso_app_id: 'sso-id'
+          },
+          provider_id: 'provider-id',
+          template_id: 'template-id',
+          sso_app_id: 'sso-id'
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to sign up or in with otp via Voice' do
+      request_params = {
+        loginId: '+12122242225',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        },
+        providerId: 'provider-id',
+        templateId: 'template-id',
+        ssoAppId: 'sso-id'
+      }
+
+      expect(@instance).to receive(:post).with(
+        otp_compose_sign_up_or_in_url(DeliveryMethod::VOICE),
+        request_params
+      ).and_return({ 'maskedPhone' => '+1******890' })
+
+      expect do
+        @instance.otp_sign_up_or_in(
+          method: DeliveryMethod::VOICE,
+          login_id: '+12122242225',
           login_options: {
             stepup: false,
             custom_claims: { 'abc': '123' },
@@ -215,6 +351,28 @@ describe Descope::Api::V1::OTP do
       expect(@instance).to respond_to(:otp_update_user_email)
     end
 
+    it 'raises a validation error' do
+      expect { OTP.otp_update_user_phone(login_id: nil) }
+        .to raise_error('login_id cannot be empty')
+    end
+
+    it 'raises a validation error' do
+      expect { OTP.otp_update_user_phone(login_id: 'someone', phone: nil) }
+        .to raise_error('Phone number cannot be empty')
+    end
+
+    it 'raises a delivery method error with invalid method' do
+      expect do
+        OTP.otp_update_user_phone(login_id: 'abc', phone: '+12124332222', method: 0)
+      end.to raise_error(Descope::AuthException, /Delivery method should be one of the following/)
+    end
+
+    it 'raises a validation error when phone number doesnt match pattern' do
+      expect do
+        OTP.otp_update_user_phone(login_id: 'abc', phone: '-1212a$', method: DeliveryMethod::SMS)
+      end.to raise_error(Descope::AuthException, /Invalid pattern for phone number/)
+    end
+
     it 'is expected to update email with otp' do
       request_params = {
         loginId: 'test',

data/spec/lib.descope/api/v1/auth_spec.rb

@@ -181,7 +181,7 @@ describe Descope::Api::V1::Auth do
 
       expect do
         exp_in_seconds = 20
-        puts "Sleeping for #{exp_in_seconds} seconds to test token expiration. Please wait..."
+        puts "\nAuthSpec.validate_token::Sleeping for #{exp_in_seconds} seconds to test token expiration. Please wait...\n"
         sleep(exp_in_seconds)
         @instance.send(:validate_token, token)
       end.to raise_error(

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

@@ -75,4 +75,96 @@ describe Descope::Api::V1::Management::Audit do
       expect(res['audits'][0]['projectId']).to eq('abc')
     end
   end
+
+  context '.create_event' do
+    it 'should respond to .audit_create_event' do
+      expect(@instance).to respond_to :audit_create_event
+    end
+
+    it 'should raise an error if type is not info, warn or error' do
+      expect do
+        @instance.audit_create_event(
+          action: 'get',
+          type: 'debug',
+          data: { key: 'value' },
+          user_id: 'user_id',
+          actor_id: 'actor_id',
+          tenant_id: 'tenant_id'
+        )
+      end.to raise_error(Descope::AuthException, 'type must be either info, warn or error')
+    end
+
+    it 'should raise an error if data is not a hash' do
+      expect do
+        @instance.audit_create_event(
+          action: 'get',
+          type: 'info',
+          data: 'data',
+          user_id: 'user_id',
+          actor_id: 'actor_id',
+          tenant_id: 'tenant_id'
+        )
+      end.to raise_error(Descope::AuthException, 'data must be provided as a key, value Hash')
+    end
+
+    it 'should raise an error if action is not provided' do
+      expect do
+        @instance.audit_create_event(
+          type: 'info',
+          data: { key: 'value' },
+          user_id: 'user_id',
+          actor_id: 'actor_id',
+          tenant_id: 'tenant_id'
+        )
+      end.to raise_error(Descope::AuthException, 'action must be provided')
+    end
+
+    it 'should raise an error if actor is not provided' do
+      expect do
+        @instance.audit_create_event(
+          action: 'get',
+          type: 'info',
+          data: { key: 'value' },
+          user_id: 'user_id',
+          tenant_id: 'tenant_id'
+        )
+      end.to raise_error(Descope::AuthException, 'actor_id must be provided')
+    end
+
+    it 'should raise an error if tenant_id is not provided' do
+      expect do
+        @instance.audit_create_event(
+          action: 'get',
+          type: 'info',
+          data: { key: 'value' },
+          user_id: 'user_id',
+          actor_id: 'actor_id'
+        )
+      end.to raise_error(Descope::AuthException, 'tenant_id must be provided')
+    end
+
+    it 'is expected to create an audit event' do
+      expect(@instance).to receive(:post).with(
+        '/v1/mgmt/audit/event',
+        {
+          action: 'get',
+          type: 'info',
+          actorId: 'actor_id',
+          data: { key: 'value' },
+          tenantId: 'tenant_id',
+          userId: 'user_id'
+        }
+      )
+      expect do
+        @instance.audit_create_event(
+          action: 'get',
+          type: 'info',
+          data: { key: 'value' },
+          user_id: 'user_id',
+          actor_id: 'actor_id',
+          tenant_id: 'tenant_id'
+        )
+      end.not_to raise_error
+    end
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: descope
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
-- Descope
+- Descope Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: zache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: addressable
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: retryable
   requirement: !ruby/object:Gem::Requirement
@@ -81,120 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: fuubar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: super_diff
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: zache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
+        version: '0.12'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.12'
 description: Ruby API Client for Descope API https://descope.com
-email:
-- support@descope.com
+email: support@descope.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -259,8 +146,6 @@ files:
 - examples/ruby-on-rails-api/descope/app/assets/builds/controllers/application.js.map
 - examples/ruby-on-rails-api/descope/app/assets/builds/controllers/index.js
 - examples/ruby-on-rails-api/descope/app/assets/builds/controllers/index.js.map
-- examples/ruby-on-rails-api/descope/app/assets/builds/reportWebVitals.js
-- examples/ruby-on-rails-api/descope/app/assets/builds/reportWebVitals.js.map
 - examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.css
 - examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.css.map
 - examples/ruby-on-rails-api/descope/app/assets/builds/routes/index.js
@@ -348,11 +233,13 @@ files:
 - examples/ruby-on-rails-api/descope/tmp/.keep
 - examples/ruby-on-rails-api/descope/vendor/.keep
 - examples/ruby-on-rails-api/descope/yarn.lock
+- examples/ruby/.ruby-version
 - examples/ruby/Gemfile
 - examples/ruby/Gemfile.lock
 - examples/ruby/access_key_app.rb
 - examples/ruby/enchantedlink_app.rb
 - examples/ruby/magiclink_app.rb
+- examples/ruby/management/.ruby-version
 - examples/ruby/management/Gemfile
 - examples/ruby/management/Gemfile.lock
 - examples/ruby/management/access_key_app.rb
@@ -368,6 +255,7 @@ files:
 - examples/ruby/otp_app.rb
 - examples/ruby/password_app.rb
 - examples/ruby/saml_app.rb
+- examples/ruby/version_check.rb
 - lib/descope.rb
 - lib/descope/api/v1.rb
 - lib/descope/api/v1/auth.rb
@@ -449,7 +337,11 @@ files:
 homepage: https://github.com/descope/descope-ruby-sdk
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/descope/descope-ruby-sdk/issues
+  changelog_uri: https://github.com/descope/descope-ruby-sdk/releases/tag/1.0.6
+  documentation_uri: https://docs.descope.com
+  source_code_uri: https://github.com/descope/descope-ruby-sdk/tree/1.0.6
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -458,15 +350,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.5'
 requirements: []
 rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: Descope API Client
+summary: Descope Ruby API Client
 test_files: []