descope 1.0.4 → 1.0.6

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/Gemfile.lock

@@ -3,7 +3,7 @@ GEM
   specs:
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
-    descope (1.0.0)
+    descope (1.0.4)
       addressable (~> 2.8)
       jwt (~> 2.7)
       rest-client (~> 2.1)
@@ -16,7 +16,7 @@ GEM
     jwt (2.7.1)
     mime-types (3.5.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.1205)
+    mime-types-data (3.2024.0206)
     netrc (0.11.0)
     public_suffix (5.0.4)
     rest-client (2.1.0)

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)
@@ -15,9 +16,13 @@ require 'descope'
 name = 'My Role'
 
 begin
+  @logger.info('Creating a new tenant')
+  puts 'Please insert a new tenant name'
+  tenant_name = gets.chomp
+  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']
+    name: name, description: 'Allowed to test :)', permission_names: ['SSO Admin'], tenant_id: tenant['id']
   )
 rescue Descope::AuthException => e
   @logger.info("Role creation failed #{e}")
@@ -38,10 +43,11 @@ 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']
+    permission_names: ['User Admin'],
+    tenant_id: tenant['id']
   )
 
 rescue Descope::AuthException => e
@@ -50,7 +56,7 @@ end
 
 begin
   @logger.info('Deleting newly created role')
-  @client.delete_role('My Updated Role')
+  @client.delete_role(name: 'My Updated Role', tenant_id: tenant['id'])
 
 rescue Descope::AuthException => e
   @logger.error("Role deletion failed #{e}")

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/.gitignore

@@ -1,15 +1,15 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore all environment files (except templates).
-/.env*
-!/.env*.erb
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-[0-9]*
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
 
 # Ignore all logfiles and tempfiles.
 /log/*
@@ -17,24 +17,54 @@
 !/log/.keep
 !/tmp/.keep
 
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
 
-# Ignore storage (uploaded files in development and any SQLite databases).
-/storage/*
-!/storage/.keep
-/tmp/storage/*
-!/tmp/storage/
-!/tmp/storage/.keep
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
 
-/public/assets
+# dotenv, dotenv-rails
+# TODO Comment out these rules if environment variables can be committed
+.env
+.env*.local
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
 
-# Ignore master key for decrypting credentials and more.
-/config/master.key
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
 
-/app/assets/builds/*
-!/app/assets/builds/.keep
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
 
-/node_modules
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+/public/uploads
+/node_modules/

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

@@ -3,7 +3,7 @@ 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.2"
 
 gem 'descope', path: '../../../..'
 
@@ -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.24.1', require: false
+  gem "rdoc", ">= 6.6.3.1", require: false
 end