descope 1.0.5 → 1.0.7

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

data/examples/ruby-on-rails-api/descope/Gemfile

@@ -3,12 +3,12 @@ source "https://rubygems.org"
 ruby "3.3.0"
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", "~> 7.1.3"
+gem "rails", "~> 7.1.3.3"
 
 gem 'descope', path: '../../../..'
 
 # The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
-gem "sprockets-rails"
+gem "sprockets-rails", ">= 3.5.0"
 
 # Use sqlite3 as the database for Active Record
 gem "sqlite3", "~> 1.4"
@@ -17,19 +17,19 @@ gem "sqlite3", "~> 1.4"
 gem "puma", ">= 5.0"
 
 # Bundle and transpile JavaScript [https://github.com/rails/jsbundling-rails]
-gem "jsbundling-rails"
+gem "jsbundling-rails", ">= 1.3.1"
 
 # Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
-gem "turbo-rails"
+gem "turbo-rails", ">= 2.0.6"
 
 # Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
-gem "stimulus-rails"
+gem "stimulus-rails", ">= 1.3.4"
 
 # Bundle and process CSS [https://github.com/rails/cssbundling-rails]
-gem "cssbundling-rails"
+gem "cssbundling-rails", ">= 1.4.1"
 
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
-gem "jbuilder"
+gem "jbuilder", ">= 2.12.0"
 
 # Use Redis adapter to run Action Cable in production
 # gem "redis", ">= 4.0.1"
@@ -63,5 +63,7 @@ group :development do
 
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
+  gem 'rubocop-rails', '2.25.0', require: false
+  gem "rdoc", ">= 6.6.3.1", require: false
 end