chore(internal): improve response envelope unwrap functionality

Author: stainless-app[bot]

lib/orb/internal/transport/base_client.rb

@@ -214,7 +214,7 @@ def initialize(
         #
         #   @option req [Object, nil] :body
         #
-        #   @option req [Symbol, nil] :unwrap
+        #   @option req [Symbol, Integer, Array<Symbol, Integer>, Proc, nil] :unwrap
         #
         #   @option req [Class<Orb::Internal::Type::BasePage>, nil] :page
         #
@@ -415,7 +415,7 @@ def initialize(
         #
         # @param body [Object, nil]
         #
-        # @param unwrap [Symbol, nil]
+        # @param unwrap [Symbol, Integer, Array<Symbol, Integer>, Proc, nil]
         #
         # @param page [Class<Orb::Internal::Type::BasePage>, nil]
         #

lib/orb/internal/util.rb

@@ -175,30 +175,31 @@ def deep_merge(*values, sentinel: nil, concat: false)
         # @api private
         #
         # @param data [Hash{Symbol=>Object}, Array<Object>, Object]
-        # @param pick [Symbol, Integer, Array<Symbol, Integer>, nil]
-        # @param sentinel [Object, nil]
+        # @param pick [Symbol, Integer, Array<Symbol, Integer>, Proc, nil]
         # @param blk [Proc, nil]
         #
         # @return [Object, nil]
-        def dig(data, pick, sentinel = nil, &blk)
-          case [data, pick, blk]
-          in [_, nil, nil]
+        def dig(data, pick, &blk)
+          case [data, pick]
+          in [_, nil]
             data
-          in [Hash, Symbol, _] | [Array, Integer, _]
-            blk.nil? ? data.fetch(pick, sentinel) : data.fetch(pick, &blk)
-          in [Hash | Array, Array, _]
+          in [Hash, Symbol] | [Array, Integer]
+            data.fetch(pick) { blk&.call }
+          in [Hash | Array, Array]
             pick.reduce(data) do |acc, key|
               case acc
               in Hash if acc.key?(key)
                 acc.fetch(key)
               in Array if key.is_a?(Integer) && key < acc.length
                 acc[key]
               else
-                return blk.nil? ? sentinel : blk.call
+                return blk&.call
               end
             end
-          in _
-            blk.nil? ? sentinel : blk.call
+          in [_, Proc]
+            pick.call(data)
+          else
+            blk&.call
           end
         end
       end

rbi/lib/orb/internal/transport/base_client.rbi

@@ -24,7 +24,14 @@ module Orb
                         )]
               ),
               body: T.nilable(T.anything),
-              unwrap: T.nilable(Symbol),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
               page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(Orb::Internal::Type::Converter::Input),
@@ -167,7 +174,14 @@ module Orb
                       )]
             ),
             body: T.nilable(T.anything),
-            unwrap: T.nilable(Symbol),
+            unwrap: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(Orb::Internal::Type::Converter::Input),

rbi/lib/orb/internal/util.rbi

@@ -68,13 +68,19 @@ module Orb
         sig do
           params(
             data: T.any(Orb::Internal::AnyHash, T::Array[T.anything], T.anything),
-            pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
-            sentinel: T.nilable(T.anything),
+            pick: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             blk: T.nilable(T.proc.returns(T.anything))
           )
             .returns(T.nilable(T.anything))
         end
-        def dig(data, pick, sentinel = nil, &blk); end
+        def dig(data, pick, &blk); end
       end
 
       class << self

sig/orb/internal/transport/base_client.rbs

@@ -11,7 +11,10 @@ module Orb
             | Integer
             | ::Array[(String | Integer)?])?]?,
             body: top?,
-            unwrap: Symbol?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
             page: Class?,
             stream: Class?,
             model: Orb::Internal::Type::Converter::input?,
@@ -96,7 +99,10 @@ module Orb
           | Integer
           | ::Array[(String | Integer)?])?]?,
           ?body: top?,
-          ?unwrap: Symbol?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
           ?page: Class?,
           ?stream: Class?,
           ?model: Orb::Internal::Type::Converter::input?,

sig/orb/internal/util.rbs

@@ -29,8 +29,10 @@ module Orb
 
       def self?.dig: (
         ::Hash[Symbol, top] | ::Array[top] | top data,
-        (Symbol | Integer | ::Array[(Symbol | Integer)])? pick,
-        ?top? sentinel
+        (Symbol
+        | Integer
+        | ::Array[(Symbol | Integer)]
+        | (^(top arg0) -> top))? pick
       ) {
         -> top?
       } -> top?

test/orb/internal/util_test.rb

@@ -87,8 +87,9 @@ def test_dig
       Orb::Internal::Util.dig([], 1.0) => nil
 
       Orb::Internal::Util.dig(Object, 1) => nil
-      Orb::Internal::Util.dig([], 1.0, 2) => 2
       Orb::Internal::Util.dig([], 1.0) { 2 } => 2
+      Orb::Internal::Util.dig([], ->(_) { 2 }) => 2
+      Orb::Internal::Util.dig([1], -> { _1 in [1] }) => true
     end
   end
 end
@@ -165,9 +166,9 @@ def test_json_content
       "application/vnd.github.v3+json" => true,
       "application/vnd.api+json" => true
     }
-    cases.each do |header, _verdict|
+    cases.each do |header, verdict|
       assert_pattern do
-        Orb::Internal::Util::JSON_CONTENT.match?(header) => verdict
+        Orb::Internal::Util::JSON_CONTENT.match?(header) => ^verdict
       end
     end
   end