Add hash support to all models that represent parsed objects (#152)

* add to_h method to each model that implements to_json

* fix linter issues

* move has_provider out of workos module

* include new file

* include hash_provider

* add a to_json definition

* include kernel to give sorbet access to raise

* update lint warnings

* move hash_provider to workos folder

Author: Alex Slepak

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

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

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,

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

lib/workos/directory_group.rb

@@ -6,6 +6,7 @@ module WorkOS
   # a WorkOS DirectoryGroup resource. This class is not meant to be instantiated
   # in user space, and is instantiated internally but exposed.
   class DirectoryGroup < DeprecatedHashWrapper
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :name, :custom_attributes, :raw_attributes
@@ -27,10 +28,6 @@ def to_json(*)
       }
     end
 
-    def to_h
-      to_json
-    end
-
     private
 
     sig do

lib/workos/directory_user.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 DirectoryUser < DeprecatedHashWrapper
+    include HashProvider
     extend T::Sig
 
     attr_accessor :id, :idp_id, :emails, :first_name, :last_name, :username, :state,
@@ -46,10 +47,6 @@ def to_json(*)
       }
     end
 
-    def to_h
-      to_json
-    end
-
     private
 
     sig do

lib/workos/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 Factor
+    include HashProvider
     # rubocop:disable Metrics/AbcSize
     extend T::Sig
     attr_accessor :id, :environment_id, :object, :type, :sms, :totp, :updated_at, :created_at

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

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

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) }