workos 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e98cbe7f34c4d550972ac7b4dc734e17ed9b2390b08898d2b20fdf5e69da71ea
-  data.tar.gz: c998bf772be7cc75e1730debd7efefa764d87676c62b325daf45784846ce3a12
+  metadata.gz: f7abb4f1d075ea976bbc8577247d36ff763a21dd1b18335daac39a8c80d6acea
+  data.tar.gz: 4c8e6326e7b80773a292754a7030033773470dc12228571cad8b0198a3c8342b
 SHA512:
-  metadata.gz: 01d4bcee2864d6a8b58e8cd3ffef78d77e11028bfbcd9005c4a2cecafaabe0cec97856f94b70aa9391dee50d08502ed8d7afa9456763d16a44f0fcc78a912694
-  data.tar.gz: ae83d9e5e204771f3d261a2f3135e077cc8b19d700ccf7984447e5536297ba65fba3779c3988daf612ce2c9624c9a825b8dd9b0e633e47c8839f3466a6837440
+  metadata.gz: 7d4c51f21848cb44e0f0326deab050040989811f829b4bbf1c317aca9d08e113c47bd4dbd822faac3f195d8695204fd3acb9a797638a0d9c4f951100964a53e7
+  data.tar.gz: 2b25fd19c5008c27d03a9ab73f6dcb02ba2cd7f133d0726ce46ccadb4928e2805dca1f63dbefd9552ea7ee8ea9acf122a7641dabf48e5199f4f607dcb8754c46

data/.semaphore/semaphore.yml

@@ -31,45 +31,19 @@ blocks:
         - name: codecov-workos-ruby
       jobs:
         - name: Ruby 1.9.3
-          commands:
-            - checkout
-            - sem-version ruby 1.9.3-p551
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 2.0.0
-          commands:
-            - checkout
-            - sem-version ruby 2.0.0-p648
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 2.3.4
-          commands:
-            - checkout
-            - sem-version ruby 2.3.4
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 2.5.7
-          commands:
-            - checkout
-            - sem-version ruby 2.5.7
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 2.6.5
-          commands:
-            - checkout
-            - sem-version ruby 2.6.5
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 2.7.3
-          commands:
-            - checkout
-            - sem-version ruby 2.7.3
-            - bundle install
-            - bundle exec rspec
-        - name: Ruby 3.0.2
-          commands:
-            - checkout
-            - sem-version ruby 3.0.2
+          matrix:
+            - env_var: RUBY_VERSION
+              values:
+                - 1.9.3-p551
+                - 2.0.0-p648
+                - 2.3.4
+                - 2.5.7
+                - 2.6.5
+                - 2.7.3
+                - 3.0.2
+          commands:
+            - checkout
+            - sem-version ruby $RUBY_VERSION
             - bundle install
             - bundle exec rspec
 promotions:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.1.1)
+    workos (2.3.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.9528)
+    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/README.md

@@ -38,6 +38,10 @@ Or, you may set the key yourself, such as in an initializer in your application
 WorkOS.key = '[your api key]'
 ```
 
+## SDK Versioning
+
+For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
+
 ## More Information
 
 * [Single Sign-On Guide](https://workos.com/docs/sso/guide)

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# typed: false
+
+module WorkOS
+  # The Challnge 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 Challenge
+    include HashProvider
+    extend T::Sig
+
+    attr_accessor :id, :object, :expires_at, :code, :authentication_factor_id, :updated_at, :created_at
+
+    sig { params(json: String).void }
+    def initialize(json)
+      raw = parse_json(json)
+      @id = T.let(raw.id, String)
+      @object = T.let(raw.object, String)
+      @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)
+      @updated_at = T.let(raw.updated_at, String)
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        object: object,
+        expires_at: expires_at,
+        code: code,
+        authentication_factor_id: authentication_factor_id,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOS::Types::ChallengeStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::ChallengeStruct.new(
+        id: hash[:id],
+        object: hash[:object],
+        expires_at: hash[:expires_at],
+        code: hash[:code],
+        authentication_factor_id: hash[:authentication_factor_id],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+      )
+    end
+  end
+end

data/lib/workos/client.rb

@@ -144,6 +144,7 @@ module WorkOS
         )
       when 422
         message = json['message']
+        code = json['code']
         errors = extract_error(json['errors']) if json['errors']
         message += " (#{errors})" if errors
 
@@ -151,6 +152,7 @@ module WorkOS
           message: message,
           http_status: http_status,
           request_id: response['x-request-id'],
+          code: code,
         )
       end
     end

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,38 @@ 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
 
+    # 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)
+      @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,
+        idp_id: idp_id,
         name: name,
+        created_at: created_at,
+        updated_at: updated_at,
+        raw_attributes: raw_attributes,
       }
     end
 
@@ -37,7 +52,12 @@ module WorkOS
 
       WorkOS::Types::DirectoryGroupStruct.new(
         id: hash[:id],
+        directory_id: hash[:directory_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,10 +22,12 @@ 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
       #  before a provided Directory ID.
+      # @option options [String] organization_id The ID for an Organization configured on WorkOS.
       #
       # @return [Hash]
       sig do
@@ -90,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],
@@ -129,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],
@@ -164,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(
@@ -174,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(
@@ -191,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,7 +5,8 @@ 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,
@@ -26,6 +27,8 @@ 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
 
@@ -44,6 +47,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

data/lib/workos/errors.rb

@@ -17,14 +17,16 @@ module WorkOS
         error_description: T.nilable(String),
         http_status: T.nilable(Integer),
         request_id: T.nilable(String),
+        code: T.nilable(String),
       ).void
     end
-    def initialize(message: nil, error: nil, error_description: nil, http_status: nil, request_id: nil)
+    def initialize(message: nil, error: nil, error_description: nil, http_status: nil, request_id: nil, code: nil)
       @message = message
       @error = error
       @error_description = error_description
       @http_status = http_status
       @request_id = request_id
+      @code = code
     end
 
     sig { returns(String) }

data/lib/workos/factor.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+# typed: false
+
+module WorkOS
+  # The Factor 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 Factor
+    include HashProvider
+    extend T::Sig
+    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)
+      @object = T.let(raw.object, String)
+      @type = T.let(raw.type, String)
+      @created_at = T.let(raw.created_at, String)
+      @updated_at = T.let(raw.updated_at, String)
+      @totp = raw.totp
+      @sms = raw.sms
+    end
+
+    def to_json(*)
+      {
+        id: id,
+        object: object,
+        type: type,
+        totp: totp,
+        sms: sms,
+        created_at: created_at,
+        updated_at: updated_at,
+      }
+    end
+
+    private
+
+    sig { params(json_string: String).returns(WorkOS::Types::FactorStruct) }
+    def parse_json(json_string)
+      hash = JSON.parse(json_string, symbolize_names: true)
+
+      WorkOS::Types::FactorStruct.new(
+        id: hash[:id],
+        object: hash[:object],
+        type: hash[:type],
+        totp: hash[:totp],
+        sms: hash[:sms],
+        created_at: hash[:created_at],
+        updated_at: hash[:updated_at],
+      )
+    end
+  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