descope 1.0.4

data/release-please-config.json

@@ -0,0 +1,18 @@
+{
+  "packages": {
+    ".": {
+      "package-name": "descope",
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "ruby",
+      "bump-minor-pre-major": false,
+      "bump-patch-for-minor-pre-major": false,
+      "draft": false,
+      "prerelease": false,
+      "version-file": "lib/descope/version.rb",
+      "versioning": "always-bump-minor",
+      "pull-request-title-pattern": "chore: release ${version}",
+      "pull-request-header": "Descope Release: Merge this PR to release ${version}"
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>descope/renovate-config"
+  ]
+}

data/spec/factories/user.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+
+FactoryBot.define do
+  factory :user, class: Hash do
+    initialize_with { attributes }
+
+    login_id { Faker::Internet.username }
+    email { Faker::Internet.email }
+    phone { "+1#{Faker::Number.number(digits: 10)}" }
+    name { Faker::Name.name }
+    given_name { Faker::Name.first_name }
+    middle_name { 'Ruby SDK User' }
+    family_name { Faker::Name.last_name }
+  end
+end

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::EnchantedLink do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Session)
+    dummy_instance.extend(Descope::Api::V1::Auth::EnchantedLink)
+    dummy_instance.extend(Descope::Api::V1::Management::User)
+    @instance = dummy_instance
+  end
+
+  context '.sign_in' do
+    it 'is expected to respond to sign in' do
+      expect(@instance).to respond_to(:enchanted_link_sign_in)
+    end
+
+    it 'is expected to sign in with enchanted link' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+      expect(@instance).to receive(:post).with(
+        enchanted_link_compose_signin_url,
+        request_params,
+        nil,
+        'refresh_token'
+      )
+
+      expect do
+        @instance.enchanted_link_sign_in(
+          login_id: 'test',
+          uri: 'https://some-uri/email',
+          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 validate refresh token and not raise an error with refresh token and valid login options' do
+      expect do
+        @instance.send(:validate_refresh_token_provided, { mfa: true, stepup: true },  'some-token')
+      end.not_to raise_error
+    end
+
+    it 'is expected to validate refresh token and raise an error with refresh token and invalid login options' do
+      expect do
+        @instance.send(:validate_refresh_token_provided, { mfa: true, stepup: true }, '')
+      end.to raise_error(Descope::AuthException, 'Missing refresh token for stepup/mfa')
+    end
+  end
+
+  context '.sign_up' do
+    it 'is expected to respond to sign up' do
+      expect(@instance).to respond_to(:enchanted_link_sign_up)
+    end
+
+    it 'is expected to sign up with enchanted link' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        user: { loginId: 'user1', email: 'dummy@dummy.com' },
+        email: 'dummy@dummy.com'
+      }
+
+      expect(@instance).to receive(:post).with(
+        enchanted_link_compose_signup_url,
+        request_params
+      )
+
+      expect do
+        @instance.enchanted_link_sign_up(
+          login_id: 'test',
+          uri: 'https://some-uri/email',
+          user: { login_id: 'user1', email: 'dummy@dummy.com' }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.sign_up_or_in' do
+    it 'is expected to respond to sign up' do
+      expect(@instance).to respond_to(:enchanted_link_sign_up_or_in)
+    end
+
+    it 'is expected to sign up with enchanted link' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+
+      expect(@instance).to receive(:post).with(
+        enchanted_link_compose_sign_up_or_in_url,
+        request_params
+      )
+
+      expect do
+        @instance.enchanted_link_sign_up_or_in(
+          login_id: 'test',
+          uri: 'https://some-uri/email',
+          login_options: {
+            stepup: false,
+            custom_claims: { 'abc': '123' },
+            mfa: false,
+            sso_app_id: 'sso-id'
+          }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.enchanted_link_verify_token' do
+    it 'is expected to respond to enchanted_link_verify_token' do
+      expect(@instance).to respond_to(:enchanted_link_verify_token)
+    end
+
+    it 'is expected to verify token with enchanted link' do
+      expect(@instance).to receive(:post).with(
+        VERIFY_ENCHANTEDLINK_AUTH_PATH,
+        { token: 'token' }
+      )
+
+      expect { @instance.enchanted_link_verify_token('token') }.not_to raise_error
+    end
+  end
+
+  context '.get_session' do
+    it 'is expected to respond to get_session' do
+      expect(@instance).to respond_to(:enchanted_link_get_session)
+    end
+
+    it 'is expected to get session by pending ref with enchanted link' do
+      jwt_response = { 'fake': 'response' }
+      allow(@instance).to receive(:generate_jwt_response).and_return(jwt_response)
+
+      expect do
+        @instance.enchanted_link_get_session('pendingRef')
+      end.not_to raise_error
+    end
+  end
+end

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

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::MagicLink do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Session)
+    dummy_instance.extend(Descope::Api::V1::Auth::MagicLink)
+    dummy_instance.extend(Descope::Api::V1::Management::User)
+    @instance = dummy_instance
+  end
+
+  context '.sign_in' do
+    it 'is expected to respond to sign in' do
+      expect(@instance).to respond_to(:magiclink_sign_in)
+    end
+
+    it 'is expected to sign in with magic link email' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+      expect(@instance).to receive(:post).with(
+        magiclink_compose_signin_url,
+        request_params,
+        {},
+        'refresh_token'
+      )
+
+      allow_any_instance_of(Descope::Api::V1::Auth::MagicLink).to receive(:extract_masked_address).and_return({})
+
+      expect do
+        @instance.magiclink_sign_in(
+          method: DeliveryMethod::EMAIL,
+          login_id: 'test',
+          uri: 'https://some-uri/email',
+          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 magic link phone' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/sms',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+      expect(@instance).to receive(:post).with(
+        magiclink_compose_signin_url(DeliveryMethod::SMS),
+        request_params,
+        {},
+        'refresh_token'
+      )
+
+      allow_any_instance_of(Descope::Api::V1::Auth::MagicLink).to receive(:extract_masked_address).and_return(
+        {
+          'maskedPhone' => '+1******890'
+        }
+      )
+
+      expect do
+        @instance.magiclink_sign_in(
+          method: DeliveryMethod::SMS,
+          login_id: 'test',
+          uri: 'https://some-uri/sms',
+          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
+  end
+
+  context '.sign_up' do
+    it 'is expected to respond to magic link email sign up' do
+      expect(@instance).to respond_to(:magiclink_sign_up)
+    end
+
+    it 'is expected to sign up with magic link via email' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        user: { loginId: 'user1', email: 'dummy@dummy.com' },
+        email: 'dummy@dummy.com'
+      }
+
+      expect(@instance).to receive(:post).with(
+        magiclink_compose_signup_url,
+        request_params
+      ).and_return({ 'maskedEmail' => 'd****@d****.com' })
+
+      expect do
+        @instance.magiclink_sign_up(
+          login_id: 'test',
+          method: DeliveryMethod::EMAIL,
+          uri: 'https://some-uri/email',
+          user: { login_id: 'user1', email: 'dummy@dummy.com' }
+        )
+      end.not_to raise_error
+    end
+
+    it 'is expected to sign up with magic link via phone' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/sms',
+        user: { loginId: 'user1', phone: '+1234567890' },
+        phone: '+1234567890'
+      }
+
+      expect(@instance).to receive(:post).with(
+        magiclink_compose_signup_url(DeliveryMethod::SMS),
+        request_params
+      ).and_return({ 'maskedPhone' => '+1******890' })
+
+      expect do
+        @instance.magiclink_sign_up(
+          login_id: 'test',
+          method: DeliveryMethod::SMS,
+          uri: 'https://some-uri/sms',
+          user: { login_id: 'user1', phone: '+1234567890' }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.sign_up_or_in' do
+    it 'is expected to respond to sign up' do
+      expect(@instance).to respond_to(:magiclink_sign_up_or_in)
+    end
+
+    it 'is expected to sign up or in with magic link' do
+      request_params = {
+        loginId: 'test',
+        redirectUrl: 'https://some-uri/email',
+        loginOptions: {
+          stepup: false,
+          customClaims: { 'abc': '123' },
+          mfa: false,
+          ssoAppId: 'sso-id'
+        }
+      }
+
+      expect(@instance).to receive(:post).with(
+        magiclink_compose_sign_up_or_in_url,
+        request_params
+      ).and_return({ 'maskedEmail' => 'd****@d****.com' })
+
+      expect do
+        @instance.magiclink_sign_up_or_in(
+          method: DeliveryMethod::EMAIL,
+          login_id: 'test',
+          uri: 'https://some-uri/email',
+          login_options: {
+            stepup: false,
+            custom_claims: { 'abc': '123' },
+            mfa: false,
+            sso_app_id: 'sso-id'
+          }
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.magiclink_verify_token' do
+    it 'is expected to respond to magiclink_email_verify_token' do
+      expect(@instance).to respond_to(:magiclink_verify_token)
+    end
+
+    it 'is expected to verify token with enchanted link' do
+      jwt_response = { 'fake': 'response' }
+      allow(@instance).to receive(:generate_jwt_response).and_return(jwt_response)
+
+      expect(@instance).to receive(:post).with(
+        VERIFY_MAGICLINK_AUTH_PATH,
+        { token: 'token' }
+      ).and_return(jwt_response)
+
+      expect { @instance.magiclink_verify_token('token') }.not_to raise_error
+    end
+  end
+
+  context '.magiclink_update_email' do
+    it 'is expected to respond to magiclink_email_update_user_email' do
+      expect(@instance).to respond_to(:magiclink_update_user_email)
+    end
+
+    it 'is expected to update email with enchanted link' do
+      request_params = {
+        loginId: 'test',
+        email: 'dummy@dummy.com',
+        addToLoginIDs: true,
+        onMergeUseExisting: true,
+        redirectUrl: 'https://some-uri/email'
+      }
+
+      expect(@instance).to receive(:post).with(
+        UPDATE_USER_EMAIL_MAGICLINK_PATH,
+        request_params,
+        {},
+        'token'
+      ).and_return({ 'maskedEmail' => 'd****@d****.com' })
+
+      expect do
+        @instance.magiclink_update_user_email(
+          login_id: 'test',
+          email: 'dummy@dummy.com',
+          add_to_login_ids: true,
+          on_merge_use_existing: true,
+          refresh_token: 'token',
+          uri: 'https://some-uri/email'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.magiclink_update_phone' do
+    it 'is expected to respond to magiclink_email_update_user_phone' do
+      expect(@instance).to respond_to(:magiclink_update_user_phone)
+    end
+
+    it 'is expected to update phone with enchanted link' do
+      request_params = {
+        loginId: 'test',
+        phone: '+1234567890',
+        addToLoginIDs: true,
+        onMergeUseExisting: true,
+        providerId: 'provider-id',
+        templateId: 'template-id',
+        templateOptions: {
+          'abc': '123'
+        },
+        redirectUrl: 'https://some-uri/sms'
+      }
+
+      expect(@instance).to receive(:post).with(
+        UPDATE_USER_PHONE_MAGICLINK_PATH,
+        request_params,
+        {},
+        'token'
+      ).and_return({ 'maskedPhone' => '+1******890' })
+
+      expect do
+        @instance.magiclink_update_user_phone(
+          login_id: 'test',
+          phone: '+1234567890',
+          add_to_login_ids: true,
+          on_merge_use_existing: true,
+          refresh_token: 'token',
+          method: DeliveryMethod::SMS,
+          provider_id: 'provider-id',
+          template_id: 'template-id',
+          template_options: {
+            'abc': '123'
+          },
+          uri: 'https://some-uri/sms'
+        )
+      end.not_to raise_error
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Descope::Api::V1::OAuth do
+  before(:all) do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Descope::Api::V1::Session)
+    dummy_instance.extend(Descope::Api::V1::Auth::OAuth)
+    @instance = dummy_instance
+  end
+
+  context '.oauth_start' do
+    it 'is expected to respond to oauth start' do
+      expect(@instance).to respond_to(:oauth_start)
+    end
+
+    it 'is expected to start oauth' do
+      request_params = {
+        stepup: false,
+        customClaims: { 'abc': '123' },
+        mfa: false,
+        ssoAppId: 'sso-id'
+      }
+      url = "#{OAUTH_START_PATH}?provider=github"
+      url += "&redirectUrl=#{CGI.escape('https://some-uri/email')}"
+      url += "&prompt=#{CGI.escape('hello and welcome')}"
+
+      expect(@instance).to receive(:post).with(
+        url,
+        request_params,
+        {},
+        'refresh_token'
+      )
+
+      expect do
+        @instance.oauth_start(
+          provider: 'github',
+          return_url: 'https://some-uri/email',
+          prompt: 'hello and welcome',
+          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
+  end
+
+  context '.oauth_exchange_token' do
+    it 'is expected to respond to oauth exchange token' do
+      expect(@instance).to respond_to(:oauth_exchange_token)
+    end
+
+    it 'is expected to exchange token' do
+      request_params = { code: 'some-code' }
+      jwt_response = { 'fake': 'response' }
+      expect(@instance).to receive(:post).with(OAUTH_EXCHANGE_TOKEN_PATH, request_params).and_return(jwt_response)
+      allow(@instance).to receive(:generate_jwt_response).and_return(jwt_response)
+      expect { @instance.oauth_exchange_token('some-code') }.not_to raise_error
+    end
+  end
+
+  context '.oauth_create_redirect_url_for_sign_in_request' do
+    it 'is expected to respond to oauth create redirect url for sign in request' do
+      expect(@instance).to respond_to(:oauth_create_redirect_url_for_sign_in_request)
+    end
+
+    it 'is expected to create redirect url for sign in request' do
+      request_params = {
+        stepup: true,
+        customClaims: { 'abc': '123' },
+        mfa: false,
+        ssoAppId: 'sso-id'
+      }
+      expect(@instance).to receive(:post).with(
+        OAUTH_CREATE_REDIRECT_URL_FOR_SIGN_IN_REQUEST_PATH,
+        request_params
+      )
+      expect do
+        @instance.oauth_create_redirect_url_for_sign_in_request(
+          stepup: true,
+          custom_claims: { 'abc': '123' },
+          sso_app_id: 'sso-id'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.oauth_create_redirect_url_for_sign_in_request' do
+    it 'is expected to respond to oauth create redirect url for sign in request' do
+      expect(@instance).to respond_to(:oauth_create_redirect_url_for_sign_in_request)
+    end
+
+    it 'is expected to create redirect url for sign up request' do
+      request_params = {
+        stepup: false,
+        customClaims: { 'abc': '123' },
+        mfa: false,
+        ssoAppId: 'sso-id'
+      }
+      expect(@instance).to receive(:post).with(
+        OAUTH_CREATE_REDIRECT_URL_FOR_SIGN_UP_REQUEST_PATH,
+        request_params
+      )
+      expect do
+        @instance.oauth_create_redirect_url_for_sign_up_request(
+          custom_claims: { 'abc': '123' },
+          sso_app_id: 'sso-id'
+        )
+      end.not_to raise_error
+    end
+  end
+end