workos 2.16.0 → 3.0.0

data/lib/workos/user_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # The UserResponse class represents a User as well as an corresponding
+  # response data that can later be appended on.
+  class UserResponse
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :user
+
+    sig { params(user_response_json: String).void }
+    def initialize(user_response_json)
+      json = JSON.parse(user_response_json, symbolize_names: true)
+      @user = WorkOS::User.new(json[:user].to_json)
+    end
+
+    def to_json(*)
+      {
+        user: user.to_json,
+      }
+    end
+  end
+end

data/lib/workos/version.rb

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

data/lib/workos.rb

@@ -11,10 +11,25 @@ require 'workos/configuration'
 # requests to the WorkOS API. The gem will read
 # your API key automatically from the ENV var `WORKOS_API_KEY`.
 # Alternatively, you can set the key yourself with
-# `WorkOS.key = [your api key]` somewhere in the load path of
-# your application, such as an initializer.
+# `WorkOS.configure { |config| config.key = [your api key] }` somewhere
+# in the load path of your application, such as an initializer.
 module WorkOS
-  API_HOSTNAME = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
+  def self.default_config
+    Configuration.new.tap do |config|
+      config.api_hostname = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
+      # Remove WORKOS_KEY at some point in the future. Keeping it here now for
+      # backwards compatibility.
+      config.key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
+    end
+  end
+
+  def self.config
+    @config ||= default_config
+  end
+
+  def self.configure
+    yield(config)
+  end
 
   def self.key=(value)
     warn '`WorkOS.key=` is deprecated. Use `WorkOS.configure` instead.'
@@ -28,42 +43,39 @@ module WorkOS
     config.key
   end
 
-  def self.config
-    @config ||= Configuration.new
-  end
-
-  def self.configure
-    yield(config)
-  end
-
-  autoload :Types, 'workos/types'
-  autoload :Client, 'workos/client'
-  autoload :Configuration, 'workos/configuration'
   autoload :AuditLogExport, 'workos/audit_log_export'
+  autoload :AuthenticationFactorAndChallenge, 'workos/authentication_factor_and_challenge'
+  autoload :AuthenticationResponse, 'workos/authentication_response'
   autoload :AuditLogs, 'workos/audit_logs'
-  autoload :AuditTrail, 'workos/audit_trail'
+  autoload :Challenge, 'workos/challenge'
+  autoload :Client, 'workos/client'
   autoload :Connection, 'workos/connection'
-  autoload :DirectorySync, 'workos/directory_sync'
+  autoload :DeprecatedHashWrapper, 'workos/deprecated_hash_wrapper'
   autoload :Directory, 'workos/directory'
   autoload :DirectoryGroup, 'workos/directory_group'
+  autoload :DirectorySync, 'workos/directory_sync'
+  autoload :DirectoryUser, 'workos/directory_user'
   autoload :Event, 'workos/event'
   autoload :Events, 'workos/events'
+  autoload :Factor, 'workos/factor'
+  autoload :Invitation, 'workos/invitation'
+  autoload :MFA, 'workos/mfa'
   autoload :Organization, 'workos/organization'
   autoload :Organizations, 'workos/organizations'
+  autoload :OrganizationMembership, 'workos/organization_membership'
   autoload :Passwordless, 'workos/passwordless'
   autoload :Portal, 'workos/portal'
   autoload :Profile, 'workos/profile'
   autoload :ProfileAndToken, 'workos/profile_and_token'
   autoload :SSO, 'workos/sso'
-  autoload :DirectoryUser, 'workos/directory_user'
+  autoload :Types, 'workos/types'
+  autoload :User, 'workos/user'
+  autoload :UserAndToken, 'workos/user_and_token'
+  autoload :UserManagement, 'workos/user_management'
+  autoload :UserResponse, 'workos/user_response'
+  autoload :VerifyChallenge, 'workos/verify_challenge'
   autoload :Webhook, 'workos/webhook'
   autoload :Webhooks, 'workos/webhooks'
-  autoload :MFA, 'workos/mfa'
-  autoload :Factor, 'workos/factor'
-  autoload :Challenge, 'workos/challenge'
-  autoload :VerifyChallenge, 'workos/verify_challenge'
-  autoload :DeprecatedHashWrapper, 'workos/deprecated_hash_wrapper'
-
 
   # Errors
   autoload :APIError, 'workos/errors'
@@ -71,9 +83,4 @@ module WorkOS
   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']
-  config.key = key unless key.nil?
 end

data/spec/lib/workos/sso_spec.rb

@@ -26,7 +26,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -60,7 +60,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -94,7 +94,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -128,7 +128,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -163,7 +163,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -198,7 +198,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -232,7 +232,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -282,7 +282,7 @@ describe WorkOS::SSO do
           described_class.authorization_url(**args)
         end.to raise_error(
           ArgumentError,
-          'Okta is not a valid value. `provider` must be in ["GoogleOAuth", "MicrosoftOAuth"]',
+          'Okta is not a valid value. `provider` must be in ["GitHubOAuth", "GoogleOAuth", "MicrosoftOAuth"]',
         )
       end
     end