feat: implement #hash for data containers

Author: stainless-app[bot]

lib/openai/internal/transport/pooled_net_requester.rb

@@ -57,15 +57,11 @@ def calibrate_socket_timeout(conn, deadline)
           # @return [Array(Net::HTTPGenericRequest, Proc)]
           def build_request(request, &blk)
             method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
-
-            # ensure we construct a URI class of the right scheme
-            url = URI(url.to_s)
-
             req = Net::HTTPGenericRequest.new(
               method.to_s.upcase,
               !body.nil?,
               method != :head,
-              url
+              URI(url.to_s) # ensure we construct a URI class of the right scheme
             )
 
             headers.each { req[_1] = _2 }

lib/openai/internal/type/array_of.rb

@@ -44,6 +44,9 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
         # @api private
         #
         # @param value [Array<Object>, Object]

lib/openai/internal/type/base_model.rb

@@ -4,14 +4,6 @@ module OpenAI
   module Internal
     module Type
       # @abstract
-      #
-      # @example
-      #   # `comparison_filter` is a `OpenAI::Models::ComparisonFilter`
-      #   comparison_filter => {
-      #     key: key,
-      #     type: type,
-      #     value: value
-      #   }
       class BaseModel
         extend OpenAI::Internal::Type::Converter
 
@@ -93,11 +85,13 @@ def fields
                   state: state
                 )
               end
-            rescue StandardError
+            rescue StandardError => e
               cls = self.class.name.split("::").last
-              # rubocop:disable Layout/LineLength
-              message = "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}. To get the unparsed API response, use #{cls}[:#{__method__}]."
-              # rubocop:enable Layout/LineLength
+              message = [
+                "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}.",
+                "To get the unparsed API response, use #{cls}[#{__method__.inspect}].",
+                "Cause: #{e.message}"
+              ].join(" ")
               raise OpenAI::Errors::ConversionError.new(message)
             end
           end
@@ -171,13 +165,19 @@ def optional(name_sym, type_info, spec = {})
           def ==(other)
             other.is_a?(Class) && other <= OpenAI::Internal::Type::BaseModel && other.fields == fields
           end
+
+          # @return [Integer]
+          def hash = fields.hash
         end
 
         # @param other [Object]
         #
         # @return [Boolean]
         def ==(other) = self.class == other.class && @data == other.to_h
 
+        # @return [Integer]
+        def hash = [self.class, @data].hash
+
         class << self
           # @api private
           #

lib/openai/internal/type/enum.rb

@@ -62,6 +62,9 @@ def ==(other)
           # rubocop:enable Style/CaseEquality
         end
 
+        # @return [Integer]
+        def hash = values.to_set.hash
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member

lib/openai/internal/type/hash_of.rb

@@ -59,6 +59,9 @@ def ==(other)
           # rubocop:enable Layout/LineLength
         end
 
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
         # @api private
         #
         # @param value [Hash{Object=>Object}, Object]

lib/openai/internal/type/union.rb

@@ -43,7 +43,7 @@ module Union
         #
         # @return [Array<Array(Symbol, Object)>]
         protected def derefed_variants
-          @known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
         end
 
         # All of the specified variants for this union.
@@ -128,6 +128,9 @@ def ==(other)
           OpenAI::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
+        # @return [Integer]
+        def hash = variants.hash
+
         # @api private
         #
         # @param value [Object]

rbi/lib/openai/internal/type/array_of.rbi

@@ -32,6 +32,9 @@ module OpenAI
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override

rbi/lib/openai/internal/type/base_model.rbi

@@ -111,11 +111,17 @@ module OpenAI
 
           sig { params(other: T.anything).returns(T::Boolean) }
           def ==(other); end
+
+          sig { returns(Integer) }
+          def hash; end
         end
 
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         class << self
           # @api private
           sig do

rbi/lib/openai/internal/type/enum.rbi

@@ -28,6 +28,9 @@ module OpenAI
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member

rbi/lib/openai/internal/type/hash_of.rbi

@@ -32,6 +32,9 @@ module OpenAI
         sig { params(other: T.anything).returns(T::Boolean) }
         def ==(other); end
 
+        sig { returns(Integer) }
+        def hash; end
+
         # @api private
         sig do
           override