onebusaway-sdk 1.0.26 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6262f10891f1126c5fec67abc7cc2de9105e81ca044831b8d4f9d08d0f0a526e
-  data.tar.gz: 5dc020b9a27800684b045fd81a4378d53e0e9082084e524b0b43207017c91312
+  metadata.gz: 81703cc9f38a7f8d85444442242671b42af984bbb1c192b12c6be7c60ddb3b94
+  data.tar.gz: 2f1676cf664a872592322399f8db4ef24d9dab1ed4a4a16e5c68934fe27c8ba8
 SHA512:
-  metadata.gz: 281714ec535cce0bbbca565b7afa9dd6536edb7960869f5018f73516321bc23db144ca86e874fdca6b8f3577fc895c5ca37d4fda09e4957bb1c1d30e0af97ab6
-  data.tar.gz: f9980bc2450105d610a46ceecd81bb0d90d621f28a85696a1e5df89c85af3e42d0e707924e35a085f31788db9a1e992bcf733917b261492cd7cab286696bc5ce
+  metadata.gz: ba4e4a60e58466007ef416bbd15bbe6b35ee53394a8000be70d29c6e39c8b54810a685961fa2636b8b115ddb7fd256107656690f31d94f480dafdfc62ba3b94c
+  data.tar.gz: b7c41d6b86c849c1390adfe4b038df463c2698c2cc4c5b5b001a96fd71fafa7167683db05607738387b6326eebdb55cc9ac99f24bc97a89b7b3ff99e85c2f4d7

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.1.0 (2025-09-18)
+
+Full Changelog: [v1.0.26...v1.1.0](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.26...v1.1.0)
+
+### Features
+
+* expose response headers for both streams and errors ([f90702c](https://github.com/OneBusAway/ruby-sdk/commit/f90702cb380ac938d665758b110f7d89490db021))
+
 ## 1.0.26 (2025-08-25)
 
 Full Changelog: [v1.0.25...v1.0.26](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.25...v1.0.26)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "onebusaway-sdk", "~> 1.0.26"
+gem "onebusaway-sdk", "~> 1.1.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/onebusaway_sdk/errors.rb

@@ -40,6 +40,9 @@ module OnebusawaySDK
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module OnebusawaySDK
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module OnebusawaySDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module OnebusawaySDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module OnebusawaySDK
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module OnebusawaySDK
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module OnebusawaySDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module OnebusawaySDK
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/onebusaway_sdk/internal/transport/base_client.rb

@@ -47,7 +47,7 @@ module OnebusawaySDK
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module OnebusawaySDK
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -381,6 +381,7 @@ module OnebusawaySDK
           rescue OnebusawaySDK::Errors::APIConnectionError => e
             status = e
           end
+          headers = OnebusawaySDK::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -397,7 +398,7 @@ module OnebusawaySDK
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -406,9 +407,9 @@ module OnebusawaySDK
             )
           in OnebusawaySDK::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              OnebusawaySDK::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              OnebusawaySDK::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -416,6 +417,7 @@ module OnebusawaySDK
             raise OnebusawaySDK::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -492,19 +494,21 @@ module OnebusawaySDK
             send_retry_header: send_retry_header
           )
 
-          decoded = OnebusawaySDK::Internal::Util.decode_content(response, stream: stream)
+          headers = OnebusawaySDK::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = OnebusawaySDK::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = OnebusawaySDK::Internal::Util.dig(decoded, unwrap)
             OnebusawaySDK::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/onebusaway_sdk/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module OnebusawaySDK
         #
         # @param client [OnebusawaySDK::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/onebusaway_sdk/internal/util.rb

@@ -647,7 +647,7 @@ module OnebusawaySDK
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/onebusaway_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnebusawaySDK
-  VERSION = "1.0.26"
+  VERSION = "1.1.0"
 end

data/rbi/onebusaway_sdk/errors.rbi

@@ -33,6 +33,9 @@ module OnebusawaySDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :body
 
@@ -41,6 +44,7 @@ module OnebusawaySDK
         params(
           url: URI::Generic,
           status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
@@ -50,6 +54,7 @@ module OnebusawaySDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -70,6 +75,7 @@ module OnebusawaySDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -79,6 +85,7 @@ module OnebusawaySDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -93,6 +100,7 @@ module OnebusawaySDK
         params(
           url: URI::Generic,
           status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
           body: NilClass,
           request: NilClass,
           response: NilClass,
@@ -102,6 +110,7 @@ module OnebusawaySDK
       def self.new(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,13 +125,22 @@ module OnebusawaySDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil)
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
 
       sig { returns(Integer) }
@@ -133,13 +151,22 @@ module OnebusawaySDK
         params(
           url: URI::Generic,
           status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
           body: T.nilable(Object),
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil)
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
       end
     end
 

data/rbi/onebusaway_sdk/internal/transport/base_client.rbi

@@ -85,10 +85,9 @@ module OnebusawaySDK
 
           # @api private
           sig do
-            params(
-              status: Integer,
-              headers: T.any(T::Hash[String, String], Net::HTTPHeader)
-            ).returns(T::Boolean)
+            params(status: Integer, headers: T::Hash[String, String]).returns(
+              T::Boolean
+            )
           end
           def should_retry?(status, headers:)
           end
@@ -99,7 +98,7 @@ module OnebusawaySDK
               request:
                 OnebusawaySDK::Internal::Transport::BaseClient::RequestInput,
               status: Integer,
-              response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+              response_headers: T::Hash[String, String]
             ).returns(
               OnebusawaySDK::Internal::Transport::BaseClient::RequestInput
             )

data/rbi/onebusaway_sdk/internal/type/base_page.rbi

@@ -31,7 +31,7 @@ module OnebusawaySDK
             client: OnebusawaySDK::Internal::Transport::BaseClient,
             req:
               OnebusawaySDK::Internal::Transport::BaseClient::RequestComponents,
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             page_data: T.anything
           ).void
         end

data/rbi/onebusaway_sdk/internal/util.rbi

@@ -361,7 +361,7 @@ module OnebusawaySDK
         # Assumes each chunk in stream has `Encoding::BINARY`.
         sig do
           params(
-            headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+            headers: T::Hash[String, String],
             stream: T::Enumerable[String],
             suppress_error: T::Boolean
           ).returns(T.anything)

data/sig/onebusaway_sdk/errors.rbs

@@ -21,11 +21,14 @@ module OnebusawaySDK
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module OnebusawaySDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module OnebusawaySDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module OnebusawaySDK
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module OnebusawaySDK
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onebusaway-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.26
+  version: 1.1.0
 platform: ruby
 authors:
 - Onebusaway SDK
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-25 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool