workos 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 983d578de3e27144af8a7947eebfb770ad7ee640954511586617505c520ee657
-  data.tar.gz: 92cb0b75234f56a1e18c47d9cb339b2f389e17463798141bc7a3a2977f5f9372
+  metadata.gz: 3b8ce6f7bddb9f3bbee9713d7ec1674c487f1c9f963e7e57ee8e6b99b26e183a
+  data.tar.gz: de86e65fad32c780bc23ba9a2e2e7e611af89c2025f768d96ca51a59b5c23218
 SHA512:
-  metadata.gz: 1143a28ee95755c80fe36aa5fba02e069143ebdb96e67f909d566bbf091928176ac29f23ccfa7764da163a248268f7a882616e0db7bd73612eda060c78cf8515
-  data.tar.gz: a2e279f2f2427dd8089eddcc692e677d21978fdd16f3918ffe162822d116b7904f1dbc6826d151f583ba1c60cd5c0e8fbe8b825fb78212f772d7a1aa11faa6da
+  metadata.gz: 82b37f71d2b099ccfde1f6d47f5a43392f275e093d130156796079be0f2ada5f8e787143991aa9b2d65878c5cd4ab052b5c81f60fe43e46e59619714c17b08c4
+  data.tar.gz: f02fbd38fedce2ac51834fb10196b6c79a1ed29013afb7f681ec9329df0e571035330f2a6f52bdb0c963bb0be5ade92b389962609f2d87cba8fd83bbca471a60

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.2.0)
+    workos (2.4.0)
       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.9300)
+    sorbet-runtime (0.5.10090)
     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/lib/workos/audit_trail.rb

@@ -65,6 +65,7 @@ module WorkOS
       # @option options [String] before Event ID to look before
       # @option options [String] after Event ID to look after
       # @option options [Integer] limit Number of Events to return
+      # @option options [String] order The order in which to paginate records
       # @option options [Array<String>] group List of Groups to filter for
       # @option options [Array<String>] action List of Actions to filter for
       # @option options [Array<String>] action_type List of Action Types to

data/lib/workos/challenge.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS DirectoryUser resource. This class is not meant to be instantiated
   # in DirectoryUser space, and is instantiated internally but exposed.
   class Challenge
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :object, :expires_at, :code, :authentication_factor_id, :updated_at, :created_at
@@ -15,7 +16,7 @@ module WorkOS
       raw = parse_json(json)
       @id = T.let(raw.id, String)
       @object = T.let(raw.object, String)
-      @expires_at = raw.expires_at
+      @expires_at = T.let(raw.expires_at, String)
       @code = raw.code
       @authentication_factor_id = T.let(raw.authentication_factor_id, String)
       @created_at = T.let(raw.created_at, String)

data/lib/workos/connection.rb

@@ -7,6 +7,7 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   # Note: status is deprecated - use state instead
   class Connection
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :name, :connection_type, :domains, :organization_id,

data/lib/workos/deprecated_hash_wrapper.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module WorkOS
+  # A Temporary wrapper class for a Hash, currently the base class for
+  # WorOS::DirectoryGroup and WorkOS::DirectoryUser. Makes all the Hash
+  # methods available to those classes, but will also emit a deprecation
+  # warning whenever any of them are used.
+  #
+  # Once we deprecate Hash compatibility, this model can be deleted.
+  class DeprecatedHashWrapper < Hash
+    (public_instance_methods - Object.methods).each do |method_name|
+      define_method method_name do |*args, &block|
+        print_deprecation_warning(method_name)
+        super(*args, &block)
+      end
+    end
+
+    # call the original implementation of :replace in Hash,
+    # so we don't show the deprecation warning
+    def replace_without_warning(new_hash)
+      method(:replace).super_method&.call(new_hash)
+    end
+
+    def [](attribute_name)
+      usage = "#{object_name}.#{attribute_name}"
+      warning_message = "WARNING: The Hash style access for #{class_name} attributes is deprecated
+and will be removed in a future version. Please use `#{usage}` or equivalent accessor.\n"
+
+      print_deprecation_warning('[]', warning_message)
+
+      super(attribute_name.to_sym)
+    end
+
+    private
+
+    def deprecation_warning(method_name)
+      usage = "#{object_name}.to_h.#{method_name}"
+
+      "WARNING: Hash compatibility for #{class_name} is deprecated and will be removed
+in a future version. Please use `#{usage}` to access methods on the attribute Hash object.\n"
+    end
+
+    def print_deprecation_warning(method_name, warning_message = deprecation_warning(method_name))
+      if RUBY_VERSION > '3'
+        warn warning_message, category: :deprecated
+      else
+        warn warning_message
+      end
+    end
+
+    def class_name
+      self.class.name
+    end
+
+    # We want to do class_name.demodulize.underscore here, but that's not available in Ruby 1.9, so
+    # implementing the demodulize and underscore methods here.
+    def object_name
+      i = class_name.rindex('::')
+      object_name = i ? class_name[(i + 2)..-1] : class_name
+      underscore(object_name)
+    end
+
+    def underscore(camel_cased_word)
+      return camel_cased_word.to_s unless /[A-Z-]|::/.match?(camel_cased_word)
+
+      word = camel_cased_word.to_s.gsub('::', '/')
+      word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)((?=a)b)(?=\b|[^a-z])/) do
+        "#{Regexp.last_match(1) && '_'}#{Regexp.last_match(2).downcase}"
+      end
+      word.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) { (Regexp.last_match(1) || Regexp.last_match(2)) << '_' }
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/workos/directory.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS Directory resource. This class is not meant to be instantiated
   # in user space, and is instantiated internally but exposed.
   class Directory
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :domain, :name, :type, :state, :organization_id, :created_at, :updated_at

data/lib/workos/directory_group.rb

@@ -5,23 +5,41 @@ module WorkOS
   # The DirectoryGroup class provides a lightweight wrapper around
   # a WorkOS DirectoryGroup resource. This class is not meant to be instantiated
   # in user space, and is instantiated internally but exposed.
-  class DirectoryGroup
+  class DirectoryGroup < DeprecatedHashWrapper
+    include HashProvider
     extend T::Sig
 
-    attr_accessor :id, :name
+    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 }
     def initialize(json)
       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)
       @name = T.let(raw.name, String)
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+      @raw_attributes = raw.raw_attributes
+
+      replace_without_warning(to_json)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
         id: id,
+        directory_id: directory_id,
+        organization_id: organization_id,
+        idp_id: idp_id,
         name: name,
+        created_at: created_at,
+        updated_at: updated_at,
+        raw_attributes: raw_attributes,
       }
     end
 
@@ -37,7 +55,13 @@ 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],
+        updated_at: hash[:updated_at],
+        raw_attributes: hash[:raw_attributes],
       )
     end
   end

data/lib/workos/directory_sync.rb

@@ -22,6 +22,7 @@ module WorkOS
       #  retrieved.
       # @option options [String] search A search term for direcory names.
       # @option options [String] limit Maximum number of records to return.
+      # @option options [String] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory ID.
       # @option options [String] after Pagination cursor to receive records
@@ -91,12 +92,13 @@ module WorkOS
       # @option options [String] user The ID of the directory user whose
       #  directory groups will be retrieved.
       # @option options [String] limit Maximum number of records to return.
+      # @option options [String] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory Group ID.
       # @option options [String] after Pagination cursor to receive records
       #  before a provided Directory Group ID.
       #
-      # @return [Hash]
+      # @return [WorkOS::DirectoryGroup]
       sig do
         params(
           options: T::Hash[Symbol, String],
@@ -130,12 +132,13 @@ module WorkOS
       # @option options [String] user The ID of the directory group whose
       #  directory users will be retrieved.
       # @option options [String] limit Maximum number of records to return.
+      # @option options [String] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Directory User ID.
       # @option options [String] after Pagination cursor to receive records
       #  before a provided Directory User ID.
       #
-      # @return [Hash]
+      # @return [WorkOS::DirectoryUser]
       sig do
         params(
           options: T::Hash[Symbol, String],
@@ -165,8 +168,8 @@ module WorkOS
       #
       # @param [String] id The ID of the directory group.
       #
-      # @return Hash
-      sig { params(id: String).returns(T::Hash[String, T.untyped]) }
+      # @return WorkOS::DirectoryGroup
+      sig { params(id: String).returns(WorkOS::DirectoryGroup) }
       def get_group(id)
         response = execute_request(
           request: get_request(
@@ -175,15 +178,15 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)
+        ::WorkOS::DirectoryGroup.new(response.body)
       end
 
       # Retrieve the directory user with the given ID.
       #
       # @param [String] id The ID of the directory user.
       #
-      # @return Hash
-      sig { params(id: String).returns(T::Hash[String, T.untyped]) }
+      # @return WorkOS::DirectoryUser
+      sig { params(id: String).returns(WorkOS::DirectoryUser) }
       def get_user(id)
         response = execute_request(
           request: get_request(
@@ -192,7 +195,7 @@ module WorkOS
           ),
         )
 
-        JSON.parse(response.body)
+        ::WorkOS::DirectoryUser.new(response.body)
       end
 
       # Delete the directory with the given ID.

data/lib/workos/directory_user.rb

@@ -5,11 +5,12 @@ module WorkOS
   # The DirectoryUser 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 DirectoryUser
+  class DirectoryUser < DeprecatedHashWrapper
+    include HashProvider
     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 }
@@ -17,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
@@ -26,12 +29,16 @@ module WorkOS
       @groups = T.let(raw.groups, Array)
       @custom_attributes = raw.custom_attributes
       @raw_attributes = raw.raw_attributes
+
+      replace_without_warning(to_json)
     end
     # rubocop:enable Metrics/AbcSize
 
     def to_json(*)
       {
         id: id,
+        directory_id: directory_id,
+        organization_id: organization_id,
         idp_id: idp_id,
         emails: emails,
         first_name: first_name,
@@ -44,6 +51,11 @@ module WorkOS
       }
     end
 
+    def primary_email
+      primary_email = (emails || []).find { |email| email[:primary] }
+      return primary_email[:value] if primary_email
+    end
+
     private
 
     sig do
@@ -56,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/factor.rb

@@ -6,15 +6,14 @@ module WorkOS
   # a WorkOS DirectoryUser resource. This class is not meant to be instantiated
   # in DirectoryUser space, and is instantiated internally but exposed.
   class Factor
-    # rubocop:disable Metrics/AbcSize
+    include HashProvider
     extend T::Sig
-    attr_accessor :id, :environment_id, :object, :type, :sms, :totp, :updated_at, :created_at
+    attr_accessor :id, :object, :type, :sms, :totp, :updated_at, :created_at
 
     sig { params(json: String).void }
     def initialize(json)
       raw = parse_json(json)
       @id = T.let(raw.id, String)
-      @environment_id = T.let(raw.environment_id, String)
       @object = T.let(raw.object, String)
       @type = T.let(raw.type, String)
       @created_at = T.let(raw.created_at, String)
@@ -26,7 +25,6 @@ module WorkOS
     def to_json(*)
       {
         id: id,
-        environment_id: environment_id,
         object: object,
         type: type,
         totp: totp,
@@ -44,7 +42,6 @@ module WorkOS
 
       WorkOS::Types::FactorStruct.new(
         id: hash[:id],
-        environment_id: hash[:environment_id],
         object: hash[:object],
         type: hash[:type],
         totp: hash[:totp],
@@ -53,6 +50,5 @@ module WorkOS
         updated_at: hash[:updated_at],
       )
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/workos/hash_provider.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# typed: true
+
+module WorkOS
+  # Module to include an explicit method for converting a model into a Hash containing
+  # its attributes. Default implementation will simply call to_json. Individual classes
+  # may override.
+  module HashProvider
+    include Kernel
+
+    def to_json(*)
+      raise 'Must be implemented by including class.'
+    end
+
+    def to_h
+      to_json
+    end
+  end
+end

data/lib/workos/organization.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS Organization resource. This class is not meant to be instantiated
   # in user space, and is instantiated internally but exposed.
   class Organization
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :domains, :name, :allow_profiles_outside_organization, :created_at, :updated_at

data/lib/workos/organizations.rb

@@ -21,6 +21,7 @@ module WorkOS
       # @param [String] after A pagination argument used to request
       #  organizations after the provided Organization ID.
       # @param [Integer] limit A pagination argument used to limit the number
+      # @param [String] order The order in which to paginate records
       #  of listed Organizations that are returned.
       sig do
         params(

data/lib/workos/profile.rb

@@ -8,6 +8,7 @@ module WorkOS
   # is not meant to be instantiated in user space, and
   # is instantiated internally but exposed.
   class Profile
+    include HashProvider
     extend T::Sig
 
     sig { returns(String) }

data/lib/workos/profile_and_token.rb

@@ -6,6 +6,7 @@ module WorkOS
   # Access Token. This class is not meant to be instantiated in user space, and
   # is instantiated internally but exposed.
   class ProfileAndToken
+    include HashProvider
     extend T::Sig
 
     attr_accessor :access_token, :profile

data/lib/workos/sso.rb

@@ -163,6 +163,7 @@ module WorkOS
       # @option options [String] organization_id The id of the organization
       #  of the connections to be retrieved.
       # @option options [String] limit Maximum number of records to return.
+      # @option options [String] order The order in which to paginate records
       # @option options [String] before Pagination cursor to receive records
       #  before a provided Connection ID.
       # @option options [String] after Pagination cursor to receive records

data/lib/workos/types/challenge_struct.rb

@@ -8,7 +8,7 @@ module WorkOS
     class ChallengeStruct < T::Struct
       const :id, String
       const :object, String
-      const :expires_at, T.nilable(String)
+      const :expires_at, String
       const :code, T.nilable(String)
       const :authentication_factor_id, String
       const :created_at, String

data/lib/workos/types/directory_group_struct.rb

@@ -7,7 +7,13 @@ module WorkOS
     # for the DirectoryGroup class
     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
+      const :updated_at, String
+      const :raw_attributes, T::Hash[Symbol, Object]
     end
   end
 end

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/factor_struct.rb

@@ -7,7 +7,6 @@ module WorkOS
     # for the Factor class
     class FactorStruct < T::Struct
       const :id, String
-      const :environment_id, String
       const :object, String
       const :type, String
       const :totp, T.nilable(T::Hash[Symbol, Object])

data/lib/workos/types/passwordless_session_struct.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # typed: strict
 
+require 'date'
+
 module WorkOS
   module Types
     # This PasswordlessSessionStruct acts as a typed interface

data/lib/workos/types/verify_factor_struct.rb

@@ -7,9 +7,7 @@ module WorkOS
     # for the Factor class
     class VerifyFactorStruct < T::Struct
       const :challenge, T.nilable(T::Hash[Symbol, Object])
-      const :valid, T.nilable(TrueClass)
-      const :code, T.nilable(String)
-      const :message, T.nilable(String)
+      const :valid, T::Boolean
     end
   end
 end

data/lib/workos/verify_factor.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS DirectoryUser resource. This class is not meant to be instantiated
   # in DirectoryUser space, and is instantiated internally but exposed.
   class VerifyFactor
+    include HashProvider
     extend T::Sig
 
     attr_accessor :challenge, :valid

data/lib/workos/version.rb

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

data/lib/workos/webhook.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS Webhook resource. This class is not meant to be instantiated
   # in user space, and is instantiated internally but exposed.
   class Webhook
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :event, :data

data/lib/workos.rb

@@ -4,6 +4,7 @@
 require 'workos/version'
 require 'sorbet-runtime'
 require 'json'
+require 'workos/hash_provider'
 
 # Use the WorkOS module to authenticate your
 # requests to the WorkOS API. The gem will read
@@ -48,6 +49,7 @@ module WorkOS
   autoload :Factor, 'workos/factor'
   autoload :Challenge, 'workos/challenge'
   autoload :VerifyFactor, 'workos/verify_factor'
+  autoload :DeprecatedHashWrapper, 'workos/deprecated_hash_wrapper'
 
 
   # Errors