descope 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec3cb315d2015591a727a55440f878d49df010ad72f31522eb93bf927bc1cf8
-  data.tar.gz: e207e1b64908011868e269257d2879d2ebc112025e56cea97a15aed0eefc8dbc
+  metadata.gz: c34965cb6d8afe8eef75358f8a2bfe51a4c85732b7a6704352d67429be4ef2a1
+  data.tar.gz: d683b72349fe21ad68c8eb5ba3f5efc630f6d064d725200d874b0b1a07fda450
 SHA512:
-  metadata.gz: 46585ad1d53f2383c9458d310ae8e41a13bb3da9c72479b5ebd4e91f73544f8d4cb7dca8e3e2b4704e87f4532046a014bb4b5f3c7206d53a1a37da1634e152e9
-  data.tar.gz: 47383953f8613b0ae07e3ced035d5f06392faeec4b7cb0756bdc2dc7793c75c607f99b54bd46ea292cfb62ce55767e0b364ba04c39a46718e3507693262e0599
+  metadata.gz: aed5e37a77c61eca6ee2e52cef996ebc5088b57dd78ed566cb2c4e21b7b939ddd5779712de35fdba59e13990872757dc8fb3a84a6c05b4bf8d169fefa281dcc9
+  data.tar.gz: 6cca87aa406e2eda34f7d38ad02178422c5b37262d0c4d5195f582ab7b4eabffe4c5508a06c10615f165de612e0a2b6caf5d14d7c19157b245354746f582810a

data/.github/workflows/publish-gem.yaml

@@ -4,17 +4,16 @@ on:
   release:
     types: [published]
 
-permissions:
-  contents: read
-  pull-requests: read # to detect changes files
-
 jobs:
-  publish-gem:
+  release:
     name: Publish Ruby Gem
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -24,6 +23,32 @@ jobs:
       - name: Install dependencies
         run: bundle install
 
+      - name: Bump version
+        run: |
+          NEW_VERSION=$(echo ${{ github.event.release.tag_name }} | sed 's/^v//') # strip the 'v' from the tag if present
+          sed -i "s/^  VERSION = '.*'/  VERSION = '${NEW_VERSION}'/g" lib/descope/version.rb
+          echo -e "Updated version file:\n $(cat lib/descope/version.rb)"
+
+      - name: Commit changes
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email 'github-actions@github.com'
+          git checkout main
+          git add ./lib/descope/version.rb
+          git commit -m "Bump version to $NEW_VERSION"
+          git push origin main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Repoint the tag to latest commit
+        run: |
+          git tag -d ${{ github.event.release.tag_name }}
+          git tag ${{ github.event.release.tag_name }} -m "Release $NEW_VERSION"
+          git push origin :${{ github.event.release.tag_name }}
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Publish to RubyGems
         run: |
           mkdir -p $HOME/.gem

data/Gemfile

@@ -4,8 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rubocop', '1.60.2', require: false
-  gem 'rubocop-rails', '2.23.1', require: false
+  gem 'rubocop', '1.63.2', require: false
+  gem 'rubocop-rails', '2.24.1', require: false
 end
 
 group :test do
@@ -14,7 +14,7 @@ group :test do
   gem 'rack-test', '2.1.0', require: false
   gem 'rotp', '6.3.0', require: false
   gem 'rspec', '3.13.0', require: false
-  gem 'selenium-webdriver', '4.17.0', require: false
+  gem 'selenium-webdriver', '4.19.0', require: false
   gem 'simplecov', '0.22.0', require: false
   gem 'super_diff', '0.11.0', require: false
 end

data/Gemfile.lock

@@ -35,17 +35,14 @@ GEM
     drb (2.2.1)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    faker (3.2.3)
+    faker (3.3.1)
       i18n (>= 1.8.11, < 2)
-    fuubar (2.5.1)
-      rspec-core (~> 3.0)
-      ruby-progressbar (~> 1.4)
     http-accept (1.7.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     jwt (2.8.1)
       base64
     language_server-protocol (3.17.0.3)
@@ -62,13 +59,12 @@ GEM
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
-    rack (3.0.9.1)
+    rack (3.0.10)
     rack-test (2.1.0)
       rack (>= 1.3)
     rainbow (3.1.1)
-    rake (13.1.0)
     regexp_parser (2.9.0)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -91,7 +87,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.60.2)
+    rubocop (1.63.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -99,19 +95,19 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
-    rubocop-rails (2.23.1)
+    rubocop-rails (2.24.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
     rubyzip (2.3.2)
-    selenium-webdriver (4.17.0)
+    selenium-webdriver (4.19.0)
       base64 (~> 0.2)
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
@@ -137,19 +133,15 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  bundler
-  concurrent-ruby (~> 1.1)
   descope!
   factory_bot (= 6.4.6)
   faker
-  fuubar (~> 2.0)
   rack-test (= 2.1.0)
-  rake (~> 13.0)
   rotp (= 6.3.0)
   rspec (= 3.13.0)
-  rubocop (= 1.60.2)
-  rubocop-rails (= 2.23.1)
-  selenium-webdriver (= 4.17.0)
+  rubocop (= 1.63.2)
+  rubocop-rails (= 2.24.1)
+  selenium-webdriver (= 4.19.0)
   simplecov (= 0.22.0)
   super_diff (= 0.11.0)
 

data/README.md

@@ -67,7 +67,7 @@ These sections show how to use the SDK to perform permission and user management
 8. [Manage Flows](#manage-flows-and-theme)
 9. [Manage JWTs](#manage-jwts)
 10. [Embedded links](#embedded-links)
-11. [Search Audit](#search-audit)
+11. [Audit](#audit)
 12. [Manage ReBAC Authz](#manage-rebac-authz)
 13. [Manage Project](#manage-project)
 
@@ -79,7 +79,7 @@ For rate limiting information, please confer to the [API Rate Limits](#api-rate-
 
 ### OTP Authentication
 
-Send a user a one-time password (OTP) using your preferred delivery method (email/SMS). An email address or phone number must be provided accordingly.
+Send a user a one-time password (OTP) using your preferred delivery method (email/SMS/Voice call). An email address or phone number must be provided accordingly.
 
 The user can either `sign up`, `sign in` or `sign up or in`
 
@@ -871,7 +871,7 @@ This token can then be verified using the magic link 'verify' function, either d
 token = descope_client.generate_embedded_link(login_id: 'desmond@descope.com', custom_claims: {'key1':'value1'})
 ```
 
-### Search Audit
+### Audit
 
 You can perform an audit search for either specific values or full-text across the fields. Audit search is limited to the last 30 days.
 Below are some examples. For a full list of available search criteria options, see the function documentation.
@@ -898,6 +898,21 @@ audits = descope_client.audit_search(
 audits = descope_client.audit_search(actions: ['LoginSucceed'])
 ```
 
+You can also create audit event with data
+
+```ruby
+descope_client.audit_create_event(
+  actor_id: "UXXX", # required, for example a user ID
+  tenant_id: "tenant-id", # required
+  action: "pencil.created", # required
+  type: "info", # either: info/warn/error # required
+  data: {
+        pencil_id: "PXXX",
+        pencil_name: "Pencil Name"
+  } # optional
+)
+```
+
 ### Manage ReBAC Authz
 
 Descope supports full relation based access control (ReBAC) using a [Google Zanzibar](https://research.google/pubs/pub48190/) like schema and operations.

data/descope.gemspec

@@ -1,34 +1,39 @@
 # -*- encoding: utf-8 -*-
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'descope/version'
+version = Descope::VERSION
 
 Gem::Specification.new do |s|
-  s.name        = 'descope'
-  s.version     = Descope::VERSION
-  s.authors     = ['Descope']
-  s.email       = ['support@descope.com']
-  s.homepage    = 'https://github.com/descope/descope-ruby-sdk'
-  s.summary     = 'Descope API Client'
-  s.description = 'Ruby API Client for Descope API https://descope.com'
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "descope"
+  s.version     = version
+  s.summary     = "Descope Ruby API Client"
+  s.description = "Ruby API Client for Descope API https://descope.com"
+
+  s.required_ruby_version     = ">= 3.3.0"
+  s.required_rubygems_version = ">= 3.5"
+
+  s.author      = "Descope Inc."
+  s.email       = "support@descope.com"
+  s.homepage    = "https://github.com/descope/descope-ruby-sdk"
+
+  s.license = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'rest-client', '~> 2.1'
-  s.add_runtime_dependency 'jwt', '~> 2.7'
-  s.add_runtime_dependency 'zache', '~> 0.12'
+  s.metadata = {
+    "bug_tracker_uri"   => "https://github.com/descope/descope-ruby-sdk/issues",
+    "changelog_uri"     => "https://github.com/descope/descope-ruby-sdk/releases/tag/#{version}",
+    "documentation_uri" => "https://docs.descope.com",
+    "source_code_uri" => "https://github.com/descope/descope-ruby-sdk/tree/#{version}",
+  }
+
   s.add_runtime_dependency 'addressable', '~> 2.8'
+  s.add_runtime_dependency 'jwt', '~> 2.7'
+  s.add_runtime_dependency 'rest-client', '~> 2.1'
   s.add_runtime_dependency 'retryable', '~> 3.0'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'fuubar', '~> 2.0'
-  s.add_development_dependency 'rspec', '~> 3.11'
-  s.add_development_dependency 'simplecov', '~> 0.9'
-  s.add_development_dependency 'faker', '~> 2.0'
-  s.add_development_dependency "super_diff", "~> 1.0"
-  s.add_development_dependency 'concurrent-ruby', '~> 1.1'
-  s.license = 'MIT'
+  s.add_runtime_dependency 'zache', '~> 0.12'
 end

data/examples/ruby/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/examples/ruby/access_key_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)
@@ -25,17 +26,17 @@ begin
     login_options = {
       customClaims: { "k1": 'v1' }
     }
-    jwt_response = @client.exchange_access_key(access_key:, login_options:)
+    jwt_response = @client.exchange_access_key(access_key: access_key, login_options: login_options)
     @logger.info('exchange access key successfully')
     @logger.info("jwt_response: #{jwt_response}")
 
     permission_name = 'TestPermission'
     permission_presented = @client.validate_permissions(
-      jwt_response:, permissions: [permission_name]
+      jwt_response: jwt_response, permissions: [permission_name]
     )
     @logger.info("#{permission_name} presented on the jwt: [#{permission_presented}]")
     role_name = 'TestRole'
-    role_presented = @client.validate_roles(jwt_response:, roles: [role_name])
+    role_presented = @client.validate_roles(jwt_response: jwt_response, roles: [role_name])
     @logger.info("#{role_name} presented on the jwt: [#{role_presented}]")
   rescue Descope::AuthException => e
     @logger.error("Failed to exchange access key #{e}")

data/examples/ruby/enchantedlink_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/magiclink_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 
 # include Descope::Mixin::Common

data/examples/ruby/management/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/examples/ruby/management/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # A sample Gemfile
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'descope'
+gem 'descope'

data/examples/ruby/management/access_key_app.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/management/audit_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)
@@ -13,13 +14,36 @@ require 'descope'
 @client = Descope::Client.new({ project_id: @project_id, management_key: @management_key })
 
 begin
-  @logger.info('Going to search audit')
-  text = nil
-  text = ARGV[0] if ARGV.length > 1
-  from_ts = nil
-  from_ts = DateTime.iso8601(ARGV[1]) if ARGV.length > 2
-  res = @client.audit_search(text:, from_ts:)
-  @logger.info("Audit search result: #{res}")
+  @logger.info('Do you want to to create a new audit event? [y/n] ')
+  create_audit = gets.chomp
+  if create_audit == 'y'
+    @logger.info('Enter the action for the audit event: ')
+    action = gets.chomp
+    @logger.info('Enter the type for the audit event: [info/warn/error] ')
+    type = gets.chomp
+    @logger.info('Enter the actorId for the audit event: ')
+    actor_id = gets.chomp
+    @logger.info('Enter the tenantId for the audit event: ')
+    tenant_id = gets.chomp
+    res = @client.audit_create_event(
+      action: action,
+      type: type,
+      actor_id: actor_id,
+      tenant_id: tenant_id
+    )
+    @logger.info("Audit event created successfully: #{res}")
+  end
+
+  @logger.info('Do you want to search the audit trail? [y/n] ')
+  search_audit = gets.chomp
+  if search_audit == 'y'
+    @logger.info('Enter the text to search: ')
+    text = gets.chomp
+    @logger.info('Enter the from_ts in ISO8601 format (2024-01-01 15:00:00.000) to search: ')
+    from_ts = gets.chomp
+    res = @client.audit_search(text: text, from_ts: from_ts)
+    @logger.info("Audit search result: #{res}")
+  end
 rescue Descope::AuthException => e
-  @logger.error("Audit search failed #{e}")
+  @logger.error("Audit action failed #{e}")
 end

data/examples/ruby/management/authz_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/management/flow_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/management/permission_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)
@@ -15,7 +16,7 @@ require 'descope'
 begin
   @logger.info('Going to create a new permission')
   name = 'My Permission'
-  @client.create_permission(name:, description: 'Allowed to test')
+  @client.create_permission(name: name, description: 'Allowed to test')
 
 rescue Descope::AuthException => e
   @logger.info("Permission creation failed #{e}")
@@ -39,7 +40,7 @@ begin
   # we mean to update.
   name = 'My Permission'
   @client.update_permission(
-    name:, new_name: 'My Updated Permission', description: 'New Description'
+    name: name, new_name: 'My Updated Permission', description: 'New Description'
   )
 
 rescue Descope::AuthException => e

data/examples/ruby/management/role_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)
@@ -21,7 +22,7 @@ begin
   tenant = @client.create_tenant(name: tenant_name)
   @logger.info('Going to create a new role')
   @client.create_role(
-    name:, description: 'Allowed to test :)', permission_names: ['SSO Admin'], tenant_id: tenant['id']
+    name: name, description: 'Allowed to test :)', permission_names: ['SSO Admin'], tenant_id: tenant['id']
   )
 rescue Descope::AuthException => e
   @logger.info("Role creation failed #{e}")
@@ -42,7 +43,7 @@ end
 begin
   @logger.info('Updating newly created role')
   @client.update_role(
-    name:,
+    name: name,
     new_name: 'My Updated Role',
     description: 'New Description',
     permission_names: ['User Admin'],

data/examples/ruby/management/tenant_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/management/user_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative '../version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/oauth_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 require 'launchy'
 

data/examples/ruby/otp_app.rb

@@ -7,25 +7,51 @@ require 'descope'
 
 @project_id = ENV['DESCOPE_PROJECT_ID']
 @management_key = ENV['DESCOPE_MANAGEMENT_KEY']
-
-@logger.info("Initializing Descope API with project_id: #{@project_id} and base_uri: #{@base_uri}")
-
 @client = Descope::Client.new({ project_id: @project_id, management_key: @management_key })
+@logger.info("Initializing Descope API with project_id: #{@project_id} and base_uri: #{@client.base_uri}")
 
 begin
   @logger.info('Going to signup or in using OTP...')
-  puts 'Please insert email to signup or in:\n'
-  email = gets.chomp
-  masked_email = @client.otp_sign_up_or_in(
-    method: Descope::Mixins::Common::DeliveryMethod::EMAIL, login_id: email
-  )
 
-  puts "Please insert the code you received by email to #{masked_email}:\n"
+  puts "Please select OTP method: [email, sms, voice]:\n"
+  method = gets.chomp
+
+  case method
+  when 'email'
+    requested_method = Descope::Mixins::Common::DeliveryMethod::EMAIL
+    puts "Please insert the email address you want to use:\n"
+    email = gets.chomp
+    requested_params = { login_id: email }
+  when 'sms'
+    requested_method = Descope::Mixins::Common::DeliveryMethod::SMS
+    @logger.info('Once signed up, we will use the update phone number')
+    puts "Please insert the phone number you want to use:\n"
+    phone = gets.chomp
+    requested_params = { login_id: phone }
+  when 'voice'
+    requested_method = Descope::Mixins::Common::DeliveryMethod::VOICE
+    @logger.info('Once signed up, we will use the update phone number')
+    puts "Please insert the phone number you want to use:\n"
+    phone = gets.chomp
+    requested_params = { login_id: phone }
+  else
+    raise 'Invalid method'
+  end
+
+  @logger.info("Signing up using OTP with #{method}...")
+  if method == 'email'
+    user = { login_id: email, name: 'John Doe', email: email, phone: phone }
+    login_id = email
+    masked_method = @client.otp_sign_up(method: requested_method, user: user, login_id: email, phone: phone)
+  else
+    login_id = phone
+    masked_method = @client.otp_sign_up_or_in(method: requested_method, login_id: phone)
+  end
+
+  puts "Please insert the code you received by #{method} to #{masked_method}:\n"
   value = gets.chomp
 
-  jwt_response = @client.otp_verify_code(
-    method: Descope::Mixins::Common::DeliveryMethod::EMAIL, login_id: email, code: value
-  )
+  jwt_response = @client.otp_verify_code(method: requested_method, login_id: login_id, code: value)
   @logger.info('Code is valid')
   puts "jwt_response: #{jwt_response}"
   session_token = jwt_response[Descope::Mixins::Common::SESSION_TOKEN_NAME].fetch('jwt')

data/examples/ruby/password_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)
@@ -20,19 +21,19 @@ begin
   puts 'Please insert password to signup with:\n'
   password = gets.chomp
 
-  jwt_response = @client.password_sign_up(login_id: email, password:)
+  jwt_response = @client.password_sign_up(login_id: email, password: password)
   @logger.info("Signup successful! jwt_response: #{jwt_response}")
   puts "=> #{Descope::Mixins::Common::SESSION_TOKEN_NAME}"
   session_token = jwt_response[Descope::Mixins::Common::SESSION_TOKEN_NAME].fetch('jwt')
   refresh_token = jwt_response[Descope::Mixins::Common::REFRESH_SESSION_TOKEN_NAME].fetch('jwt')
 
   @logger.info('Validating email address...')
-  @client.magiclink_update_user_email(login_id: email, email:, refresh_token:)
+  @client.magiclink_update_user_email(login_id: email, email: email, refresh_token: refresh_token)
 
   puts "Validation email send, please paste the token you received by email:\n"
   token = gets.chomp
   jwt_response = @client.magiclink_verify_token(token)
-  @logger.info('Token verified successfully! #{jwt_response}')
+  @logger.info("Token verified successfully! #{jwt_response}")
   session_token = jwt_response[Descope::Mixins::Common::SESSION_TOKEN_NAME].fetch('jwt')
   refresh_token = jwt_response[Descope::Mixins::Common::REFRESH_SESSION_TOKEN_NAME].fetch('jwt')
 
@@ -48,7 +49,7 @@ begin
 
   puts "Please insert new password:\n"
   new_password = gets.chomp
-  @client.password_update(login_id: email, new_password:, refresh_token:)
+  @client.password_update(login_id: email, new_password: new_password, refresh_token: refresh_token)
   @logger.info('Attempting to sign in with new password...')
   jwt_response = @client.password_sign_in(login_id: email, password: new_password)
   session_token = jwt_response[Descope::Mixins::Common::SESSION_TOKEN_NAME].fetch('jwt')
@@ -56,15 +57,15 @@ begin
   @logger.info("jwt_response: #{jwt_response}")
 
   @logger.info('going to validate session...')
-  @client.validate_session(session_token:)
+  @client.validate_session(session_token: session_token)
   @logger.info('Session validated successfully and all is OK!')
 
   @logger.info('refreshing the session token...')
-  claims = @client.refresh_session(refresh_token:)
+  claims = @client.refresh_session(refresh_token: refresh_token)
   @logger.info('going to revalidate the session with the newly refreshed token...')
 
   new_session_token = claims[Descope::Mixins::Common::SESSION_TOKEN_NAME].fetch('jwt')
-  @client.validate_and_refresh_session(session_token: new_session_token, refresh_token:)
+  @client.validate_and_refresh_session(session_token: new_session_token, refresh_token: refresh_token)
   @logger.info('Session is also valid for the refreshed token.')
 
   @logger.info('going to sign out...')

data/examples/ruby/saml_app.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require_relative './version_check'
 require 'descope'
 
 @logger = Logger.new($stdout)

data/examples/ruby/version_check.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+required_version = File.read('.ruby-version').strip
+
+begin
+  # Check the Ruby version using RUBY_VERSION constant
+  current_version = RUBY_VERSION
+
+  # Compare major, minor and patch versions
+  if current_version.split('.').map(&:to_i) != required_version.split('.').map(&:to_i)
+    raise StandardError, "Script requires Ruby version #{required_version} but found #{current_version}"
+  end
+rescue StandardError => e
+  puts "Error: #{e}"
+  puts "Script cannot run with incompatible Ruby version. Please install version #{required_version}."
+  exit(1) # Exit with an error code
+end