workos 2.3.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7abb4f1d075ea976bbc8577247d36ff763a21dd1b18335daac39a8c80d6acea
-  data.tar.gz: 4c8e6326e7b80773a292754a7030033773470dc12228571cad8b0198a3c8342b
+  metadata.gz: efe8fb9e00262c08d11cebcc39e65ad5728771bb1f132ea88302c78205134a3b
+  data.tar.gz: 1532164858cc02a9e46d9cb8ac0c10b0e5401812da204840cd3760342462bfb7
 SHA512:
-  metadata.gz: 7d4c51f21848cb44e0f0326deab050040989811f829b4bbf1c317aca9d08e113c47bd4dbd822faac3f195d8695204fd3acb9a797638a0d9c4f951100964a53e7
-  data.tar.gz: 2b25fd19c5008c27d03a9ab73f6dcb02ba2cd7f133d0726ce46ccadb4928e2805dca1f63dbefd9552ea7ee8ea9acf122a7641dabf48e5199f4f607dcb8754c46
+  metadata.gz: bd4c7ada118af7b5ee60d28db25844264bda9a8249b0b3d0a33c11696c77f57d020cfe6e7410d4661bb7c3832e0ec83af2acc0468b4dc4b21e633a5af12bec16
+  data.tar.gz: 8ecebf2811768a093ae87518124b4e1ff8bb3caefbc3ed1ff36ea0a81243030968bf204d535c63422e43718d811f13c682ad058c33e132977b283509457e30f3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.3.0)
+    workos (2.5.1)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -60,7 +60,7 @@ GEM
     simplecov_json_formatter (0.1.2)
     sorbet (0.5.6388)
       sorbet-static (= 0.5.6388)
-    sorbet-runtime (0.5.10090)
+    sorbet-runtime (0.5.10323)
     sorbet-static (0.5.6388-universal-darwin-14)
     sorbet-static (0.5.6388-universal-darwin-15)
     sorbet-static (0.5.6388-universal-darwin-16)

data/README.md

@@ -35,7 +35,10 @@ Or, you may set the key yourself, such as in an initializer in your application
 ```ruby
 # /config/initializers/workos.rb
 
-WorkOS.key = '[your api key]'
+WorkOS.configure do |config|
+  config.key = '[your api key]'
+  config.timeout = 120
+end
 ```
 
 ## SDK Versioning

data/lib/workos/audit_trail.rb

@@ -12,7 +12,6 @@ module WorkOS
   module AuditTrail
     class << self
       extend T::Sig
-      include Base
       include Client
 
       # Create an Audit Trail event.

data/lib/workos/client.rb

@@ -11,6 +11,9 @@ module WorkOS
     def client
       Net::HTTP.new(WorkOS::API_HOSTNAME, 443).tap do |http_client|
         http_client.use_ssl = true
+        http_client.open_timeout = WorkOS.config.timeout
+        http_client.read_timeout = WorkOS.config.timeout
+        http_client.write_timeout = WorkOS.config.timeout if RUBY_VERSION >= '2.6.0'
       end
     end
 
@@ -20,7 +23,13 @@ module WorkOS
       ).returns(::T.untyped)
     end
     def execute_request(request:)
-      response = client.request(request)
+      begin
+        response = client.request(request)
+      rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout
+        raise TimeoutError.new(
+          message: 'API Timeout Error',
+        )
+      end
 
       http_status = response.code.to_i
       handle_error_response(response: response) if http_status >= 400
@@ -45,7 +54,7 @@ module WorkOS
         'Content-Type' => 'application/json',
       )
 
-      request['Authorization'] = "Bearer #{access_token || WorkOS.key!}" if auth
+      request['Authorization'] = "Bearer #{access_token || WorkOS.config.key!}" if auth
       request['User-Agent'] = user_agent
       request
     end
@@ -61,7 +70,7 @@ module WorkOS
     def post_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Post.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{WorkOS.key!}" if auth
+      request['Authorization'] = "Bearer #{WorkOS.config.key!}" if auth
       request['Idempotency-Key'] = idempotency_key if idempotency_key
       request['User-Agent'] = user_agent
       request
@@ -83,7 +92,7 @@ module WorkOS
         'Content-Type' => 'application/json',
       )
 
-      request['Authorization'] = "Bearer #{WorkOS.key!}" if auth
+      request['Authorization'] = "Bearer #{WorkOS.config.key!}" if auth
       request['User-Agent'] = user_agent
       request
     end
@@ -99,7 +108,7 @@ module WorkOS
     def put_request(path:, auth: false, idempotency_key: nil, body: nil)
       request = Net::HTTP::Put.new(path, 'Content-Type' => 'application/json')
       request.body = body.to_json if body
-      request['Authorization'] = "Bearer #{WorkOS.key!}" if auth
+      request['Authorization'] = "Bearer #{WorkOS.config.key!}" if auth
       request['Idempotency-Key'] = idempotency_key if idempotency_key
       request['User-Agent'] = user_agent
       request

data/lib/workos/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # Configuration class sets config initializer
+  class Configuration
+    attr_accessor :timeout, :key
+
+    def initialize
+      @timeout = 60
+    end
+
+    def key!
+      key or raise '`WorkOS.config.key` not set'
+    end
+  end
+end

data/lib/workos/directory_group.rb

@@ -9,7 +9,8 @@ module WorkOS
     include HashProvider
     extend T::Sig
 
-    attr_accessor :id, :directory_id, :idp_id, :name, :created_at, :updated_at, :raw_attributes
+    attr_accessor :id, :directory_id, :idp_id, :name, :created_at, :updated_at,
+                  :raw_attributes, :organization_id
 
     # rubocop:disable Metrics/AbcSize
     sig { params(json: String).void }
@@ -18,6 +19,7 @@ module WorkOS
 
       @id = T.let(raw.id, String)
       @directory_id = T.let(raw.directory_id, String)
+      @organization_id = raw.organization_id
       @idp_id = T.let(raw.idp_id, String)
       @name = T.let(raw.name, String)
       @created_at = T.let(raw.created_at, String)
@@ -32,6 +34,7 @@ module WorkOS
       {
         id: id,
         directory_id: directory_id,
+        organization_id: organization_id,
         idp_id: idp_id,
         name: name,
         created_at: created_at,
@@ -53,6 +56,7 @@ module WorkOS
       WorkOS::Types::DirectoryGroupStruct.new(
         id: hash[:id],
         directory_id: hash[:directory_id],
+        organization_id: hash[:organization_id],
         idp_id: hash[:idp_id],
         name: hash[:name],
         created_at: hash[:created_at],

data/lib/workos/directory_sync.rb

@@ -12,7 +12,6 @@ module WorkOS
   module DirectorySync
     class << self
       extend T::Sig
-      include Base
       include Client
 
       # Retrieve directories.

data/lib/workos/directory_user.rb

@@ -10,7 +10,7 @@ module WorkOS
     extend T::Sig
 
     attr_accessor :id, :idp_id, :emails, :first_name, :last_name, :username, :state,
-                  :groups, :custom_attributes, :raw_attributes
+                  :groups, :custom_attributes, :raw_attributes, :directory_id, :organization_id
 
     # rubocop:disable Metrics/AbcSize
     sig { params(json: String).void }
@@ -18,6 +18,8 @@ module WorkOS
       raw = parse_json(json)
 
       @id = T.let(raw.id, String)
+      @directory_id = T.let(raw.directory_id, String)
+      @organization_id = raw.organization_id
       @idp_id = T.let(raw.idp_id, String)
       @emails = T.let(raw.emails, Array)
       @first_name = raw.first_name
@@ -35,6 +37,8 @@ module WorkOS
     def to_json(*)
       {
         id: id,
+        directory_id: directory_id,
+        organization_id: organization_id,
         idp_id: idp_id,
         emails: emails,
         first_name: first_name,
@@ -64,6 +68,8 @@ module WorkOS
 
       WorkOS::Types::DirectoryUserStruct.new(
         id: hash[:id],
+        directory_id: hash[:directory_id],
+        organization_id: hash[:organization_id],
         idp_id: hash[:idp_id],
         emails: hash[:emails],
         first_name: hash[:first_name],

data/lib/workos/errors.rb

@@ -61,4 +61,7 @@ module WorkOS
   # SignatureVerificationError is raised when the signature verification for a
   # webhook fails
   class SignatureVerificationError < WorkOSError; end
+
+  # TimeoutError is raised when the HTTP request to the API times out
+  class TimeoutError < WorkOSError; end
 end

data/lib/workos/mfa.rb

@@ -11,7 +11,6 @@ module WorkOS
   module MFA
     class << self
       extend T::Sig
-      include Base
       include Client
       sig { params(id: String).returns(T::Boolean) }
       def delete_factor(id:)
@@ -122,9 +121,8 @@ module WorkOS
           auth: true,
           body: {
             sms_template: sms_template,
-            authentication_factor_id: authentication_factor_id,
           },
-          path: '/auth/factors/challenge',
+          path: "/auth/factors/#{authentication_factor_id}/challenge",
         )
 
         response = execute_request(request: request)
@@ -135,30 +133,47 @@ module WorkOS
         params(
           authentication_challenge_id: T.nilable(String),
           code: T.nilable(String),
-        ).returns(WorkOS::VerifyFactor)
+        ).returns(WorkOS::VerifyChallenge)
       end
       def verify_factor(
         authentication_challenge_id: nil,
         code: nil
       )
+        warn '[DEPRECATION] `verify_factor` is deprecated. Please use `verify_challenge` instead.'
+
+        verify_challenge(
+          authentication_challenge_id: authentication_challenge_id,
+          code: code,
+        )
+      end
+
+      sig do
+        params(
+          authentication_challenge_id: T.nilable(String),
+          code: T.nilable(String),
+        ).returns(WorkOS::VerifyChallenge)
+      end
+      def verify_challenge(
+        authentication_challenge_id: nil,
+        code: nil
+      )
 
         if authentication_challenge_id.nil? || code.nil?
           raise ArgumentError, "Incomplete arguments: 'authentication_challenge_id' and 'code' are required arguments"
         end
 
         options = {
-          "authentication_challenge_id": authentication_challenge_id,
           "code": code,
         }
 
         response = execute_request(
           request: post_request(
-            path: '/auth/factors/verify',
+            path: "/auth/challenges/#{authentication_challenge_id}/verify",
             auth: true,
             body: options,
           ),
         )
-        WorkOS::VerifyFactor.new(response.body)
+        WorkOS::VerifyChallenge.new(response.body)
       end
     end
   end

data/lib/workos/organizations.rb

@@ -8,7 +8,6 @@ module WorkOS
   module Organizations
     class << self
       extend T::Sig
-      include Base
       include Client
 
       # Retrieve a list of organizations that have connections configured

data/lib/workos/passwordless.rb

@@ -12,7 +12,6 @@ module WorkOS
   module Passwordless
     class << self
       extend T::Sig
-      include Base
       include Client
 
       # Create a Passwordless Session.

data/lib/workos/portal.rb

@@ -9,7 +9,6 @@ module WorkOS
   module Portal
     class << self
       extend T::Sig
-      include Base
       include Client
 
       GENERATE_LINK_INTENTS = WorkOS::Types::Intent.values.map(&:serialize).

data/lib/workos/sso.rb

@@ -13,7 +13,6 @@ module WorkOS
   module SSO
     class << self
       extend T::Sig
-      include Base
       include Client
 
       PROVIDERS = WorkOS::Types::Provider.values.map(&:serialize).freeze
@@ -142,7 +141,7 @@ module WorkOS
       def profile_and_token(code:, client_id: nil)
         body = {
           client_id: client_id,
-          client_secret: WorkOS.key!,
+          client_secret: WorkOS.config.key!,
           grant_type: 'authorization_code',
           code: code,
         }

data/lib/workos/types/directory_group_struct.rb

@@ -8,6 +8,7 @@ module WorkOS
     class DirectoryGroupStruct < T::Struct
       const :id, String
       const :directory_id, String
+      const :organization_id, T.nilable(String)
       const :idp_id, String
       const :name, String
       const :created_at, String

data/lib/workos/types/directory_user_struct.rb

@@ -7,6 +7,8 @@ module WorkOS
     # for the DirectoryUser class
     class DirectoryUserStruct < T::Struct
       const :id, String
+      const :directory_id, String
+      const :organization_id, T.nilable(String)
       const :idp_id, String
       const :emails, T::Array[T.untyped]
       const :first_name, T.nilable(String)

data/lib/workos/types/{verify_factor_struct.rb → verify_challenge_struct.rb}

@@ -3,9 +3,9 @@
 
 module WorkOS
   module Types
-    # This VerifyFactorStruct acts as a typed interface
-    # for the Factor class
-    class VerifyFactorStruct < T::Struct
+    # This VerifyChallengeStruct acts as a typed interface
+    # for the VerifyChallenge class
+    class VerifyChallengeStruct < T::Struct
       const :challenge, T.nilable(T::Hash[Symbol, Object])
       const :valid, T::Boolean
     end

data/lib/workos/types.rb

@@ -18,6 +18,6 @@ module WorkOS
     require_relative 'types/webhook_struct'
     require_relative 'types/factor_struct'
     require_relative 'types/challenge_struct'
-    require_relative 'types/verify_factor_struct'
+    require_relative 'types/verify_challenge_struct'
   end
 end

data/lib/workos/{verify_factor.rb → verify_challenge.rb}

@@ -2,10 +2,9 @@
 # typed: false
 
 module WorkOS
-  # The VerifyFactor class provides a lightweight wrapper around
-  # a WorkOS DirectoryUser resource. This class is not meant to be instantiated
-  # in DirectoryUser space, and is instantiated internally but exposed.
-  class VerifyFactor
+  # The VerifyChallenge class provides a lightweight wrapper around
+  # a WorkOS Authentication Challenge resource.
+  class VerifyChallenge
     include HashProvider
     extend T::Sig
 
@@ -27,11 +26,11 @@ module WorkOS
 
     private
 
-    sig { params(json_string: String).returns(WorkOS::Types::VerifyFactorStruct) }
+    sig { params(json_string: String).returns(WorkOS::Types::VerifyChallengeStruct) }
     def parse_json(json_string)
       hash = JSON.parse(json_string, symbolize_names: true)
 
-      WorkOS::Types::VerifyFactorStruct.new(
+      WorkOS::Types::VerifyChallengeStruct.new(
         challenge: hash[:challenge],
         valid: hash[:valid],
       )

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '2.3.0'
+  VERSION = '2.5.1'
 end

data/lib/workos.rb

@@ -5,6 +5,7 @@ require 'workos/version'
 require 'sorbet-runtime'
 require 'json'
 require 'workos/hash_provider'
+require 'workos/configuration'
 
 # Use the WorkOS module to authenticate your
 # requests to the WorkOS API. The gem will read
@@ -16,20 +17,28 @@ module WorkOS
   API_HOSTNAME = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
 
   def self.key=(value)
-    Base.key = value
+    warn '`WorkOS.key=` is deprecated. Use `WorkOS.configure` instead.'
+
+    config.key = value
   end
 
   def self.key
-    Base.key
+    warn '`WorkOS.key` is deprecated. Use `WorkOS.configure` instead.'
+
+    config.key
+  end
+
+  def self.config
+    @config ||= Configuration.new
   end
 
-  def self.key!
-    key || raise('WorkOS.key not set')
+  def self.configure
+    yield(config)
   end
 
   autoload :Types, 'workos/types'
-  autoload :Base, 'workos/base'
   autoload :Client, 'workos/client'
+  autoload :Configuration, 'workos/configuration'
   autoload :AuditTrail, 'workos/audit_trail'
   autoload :Connection, 'workos/connection'
   autoload :DirectorySync, 'workos/directory_sync'
@@ -48,7 +57,7 @@ module WorkOS
   autoload :MFA, 'workos/mfa'
   autoload :Factor, 'workos/factor'
   autoload :Challenge, 'workos/challenge'
-  autoload :VerifyFactor, 'workos/verify_factor'
+  autoload :VerifyChallenge, 'workos/verify_challenge'
   autoload :DeprecatedHashWrapper, 'workos/deprecated_hash_wrapper'
 
 
@@ -57,9 +66,10 @@ module WorkOS
   autoload :AuthenticationError, 'workos/errors'
   autoload :InvalidRequestError, 'workos/errors'
   autoload :SignatureVerificationError, 'workos/errors'
+  autoload :TimeoutError, 'workos/errors'
 
   # Remove WORKOS_KEY at some point in the future. Keeping it here now for
   # backwards compatibility.
   key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
-  WorkOS.key = key unless key.nil?
+  config.key = key unless key.nil?
 end

data/spec/lib/workos/configuration_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS do
+  describe '.configure' do
+    context 'with key and no timeout' do
+      before do
+        WorkOS.configure do |config|
+          config.key = 'example_api_key'
+        end
+      end
+
+      it 'sets the key and default timeout configuration' do
+        expect(WorkOS.config.key).to eq('example_api_key')
+        expect(WorkOS.config.timeout).to eq(60)
+      end
+    end
+
+    context 'with key and timeout' do
+      before do
+        WorkOS.configure do |config|
+          config.key = 'example_api_key'
+          config.timeout = 120
+        end
+      end
+
+      it 'sets the key and timeout configuration' do
+        expect(WorkOS.config.key).to eq('example_api_key')
+        expect(WorkOS.config.timeout).to eq(120)
+      end
+    end
+  end
+end
+
+describe WorkOS::Configuration do
+  describe '.key!' do
+    context 'with key set' do
+      before do
+        WorkOS.config.key = 'example_api_key'
+      end
+
+      it 'returns the key' do
+        expect(WorkOS.config.key!).to eq('example_api_key')
+      end
+    end
+
+    context 'with key not set' do
+      before do
+        WorkOS.config.key = nil
+      end
+
+      it 'throws an error' do
+        expect do
+          WorkOS.config.key!
+        end.to raise_error(
+          '`WorkOS.config.key` not set',
+        )
+      end
+    end
+  end
+end

data/spec/lib/workos/directory_sync_spec.rb

@@ -442,11 +442,12 @@ describe WorkOS::DirectorySync do
           )
 
           expect(group['directory_id']).to eq('directory_01G2Z8ADK5NPMVTWF48MVVE4HT')
+          expect(group['organization_id']).to eq('org_01EGS4P7QR31EZ4YWD1Z1XA176')
           expect(group['idp_id']).to eq('01jlao4614two3d')
           expect(group['name']).to eq('Sales')
           expect(group.name).to eq('Sales')
           expect(group['created_at']).to eq('2022-05-13T17:45:31.732Z')
-          expect(group['updated_at']).to eq('2022-06-07T17:45:35.739Z')
+          expect(group['updated_at']).to eq('2022-07-13T17:45:42.618Z')
         end
       end
     end
@@ -471,6 +472,8 @@ describe WorkOS::DirectorySync do
           )
 
           expect(user['first_name']).to eq('Logan')
+          expect(user.directory_id).to eq('directory_01FAZYMST676QMTFN1DDJZZX87')
+          expect(user.organization_id).to eq('org_01FAZWCWR03DVWA83NCJYKKD54')
           expect(user.first_name).to eq('Logan')
         end
       end