twingly-http 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd022cb30b4e6aea665f8e8bc569a7fa7023c78f1a0cc88b18c4f00793b23ac
-  data.tar.gz: 498f19467946922913480c55637baea6871d6895ab2a51ed82d7e6cd6fd4b60c
+  metadata.gz: 62b69e5cac842eeefbaad91288707eb474458da8df5074521652fccd486edc89
+  data.tar.gz: 33c81395fbfd3f1588452fb93b66a067c40521654042f0eb6f04acd8a362b0c9
 SHA512:
-  metadata.gz: 8658da71b5b0a3d327f81cf8f4c29014606ca3336b2ed3848b234498511fde9152953e841ca920818b2a1daae9024912ce5987b518b0be7204bdf61071a8b115
-  data.tar.gz: a397277ad9301bae0b25589e0aeea82beaa11e57a8c228a6d3d8bcc276010b181721b184c230d29fbb41a592c74905a411be68d717ee04e5049a8cd4e6534097
+  metadata.gz: 3a95ad89c7bf1af645cb000bb739e8100048a268185e88d75ac307581f0832e85586f34fa1a4bc9f1f7291ca2147a2b9f61d032d562662a3f5a84aaca8750f3e
+  data.tar.gz: 4b79a8ea8a109fe5cbf0e57c0591e4a5382b10ba5bb5a05ada0ca96ed0197488fcf1e9bce47d0e1f61eb8d1ec016d5f1afec1338131a3b7b84388e85f35d2bf7

data/lib/faraday/response_body_size_limit/middleware.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Faraday
+  module ResponseBodySizeLimit
+    class LimitExceededError < StandardError; end
+
+    class Middleware < Faraday::Middleware
+      def initialize(app, max_size_bytes:)
+        super(app)
+
+        @max_size_bytes = max_size_bytes
+      end
+
+      def call(env) # rubocop:disable Metrics/MethodLength
+        response_body_size = 0
+        accumulated_body   = + ""
+
+        env.request.on_data = proc do |chunk, _|
+          response_body_size += chunk.bytesize
+          accumulated_body   << chunk
+
+          if response_body_size > @max_size_bytes
+            raise LimitExceededError,
+                  "Response body too large, exceeced the configured max size of #{@max_size_bytes} bytes."
+          end
+        end
+
+        @app.call(env).on_complete do |response_env|
+          response_env.body = accumulated_body
+        end
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(
+  response_body_size_limit: Faraday::ResponseBodySizeLimit::Middleware
+)

data/lib/faraday/response_body_size_limit.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "response_body_size_limit/middleware"
+
+module Faraday
+  module ResponseBodySizeLimit
+  end
+end

data/lib/twingly/http.rb

@@ -7,6 +7,7 @@ require "faraday_middleware"
 
 require_relative "../faraday/logfmt_logger"
 require_relative "../faraday/url_size_limit"
+require_relative "../faraday/response_body_size_limit"
 require_relative "heroku"
 require_relative "string_utilities"
 
@@ -15,6 +16,7 @@ module Twingly
     class ConnectionError < StandardError; end
     class UrlSizeLimitExceededError < StandardError; end
     class RedirectLimitReachedError < StandardError; end
+    class ResponseBodySizeLimitExceededError < StandardError; end
     class Client # rubocop:disable Metrics/ClassLength
       DEFAULT_RETRYABLE_EXCEPTIONS = [
         Faraday::ConnectionFailed,
@@ -31,6 +33,7 @@ module Twingly
       DEFAULT_NUMBER_OF_RETRIES = 0
       DEFAULT_RETRY_INTERVAL = 1
       DEFAULT_MAX_URL_SIZE_BYTES = Float::INFINITY
+      DEFAULT_MAX_RESPONSE_BODY_SIZE_BYTES = Float::INFINITY
       DEFAULT_FOLLOW_REDIRECTS_LIMIT = 3
 
       attr_writer :http_timeout
@@ -39,6 +42,7 @@ module Twingly
       attr_writer :retry_interval
       attr_writer :on_retry_callback
       attr_writer :max_url_size_bytes
+      attr_writer :max_response_body_size_bytes
       attr_writer :request_id
       attr_writer :follow_redirects
 
@@ -81,19 +85,20 @@ module Twingly
       end
 
       def initialize_defaults
-        @request_id             = nil
-        @http_timeout           = DEFAULT_HTTP_TIMEOUT
-        @http_open_timeout      = DEFAULT_HTTP_OPEN_TIMEOUT
-        @retryable_exceptions   = DEFAULT_RETRYABLE_EXCEPTIONS
-        @number_of_retries      = DEFAULT_NUMBER_OF_RETRIES
-        @retry_interval         = DEFAULT_RETRY_INTERVAL
-        @on_retry_callback      = nil
-        @follow_redirects       = false
-        @follow_redirects_limit = DEFAULT_FOLLOW_REDIRECTS_LIMIT
-        @max_url_size_bytes     = DEFAULT_MAX_URL_SIZE_BYTES
+        @request_id                   = nil
+        @http_timeout                 = DEFAULT_HTTP_TIMEOUT
+        @http_open_timeout            = DEFAULT_HTTP_OPEN_TIMEOUT
+        @retryable_exceptions         = DEFAULT_RETRYABLE_EXCEPTIONS
+        @number_of_retries            = DEFAULT_NUMBER_OF_RETRIES
+        @retry_interval               = DEFAULT_RETRY_INTERVAL
+        @on_retry_callback            = nil
+        @follow_redirects             = false
+        @follow_redirects_limit       = DEFAULT_FOLLOW_REDIRECTS_LIMIT
+        @max_url_size_bytes           = DEFAULT_MAX_URL_SIZE_BYTES
+        @max_response_body_size_bytes = DEFAULT_MAX_RESPONSE_BODY_SIZE_BYTES
       end
 
-      def http_response_for(method, **args)
+      def http_response_for(method, **args) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         response = send("http_#{method}_response", **args)
 
         Response.new(headers: response.headers.to_h,
@@ -106,6 +111,8 @@ module Twingly
         raise UrlSizeLimitExceededError, error.message
       rescue FaradayMiddleware::RedirectLimitReached => error
         raise RedirectLimitReachedError, error.message
+      rescue Faraday::ResponseBodySizeLimit::LimitExceededError => error
+        raise ResponseBodySizeLimitExceededError, error.message
       end
 
       def http_get_response(url:, params:, headers:)
@@ -193,6 +200,8 @@ module Twingly
                           exceptions: @retryable_exceptions,
                           methods: [], # empty [] forces Faraday to run retry_if
                           retry_if: retry_if
+          faraday.request :response_body_size_limit,
+                          max_size_bytes: @max_response_body_size_bytes
           faraday.response :logfmt_logger, @logger.dup,
                            headers: true,
                            bodies: true,

data/lib/twingly/version.rb

@@ -2,6 +2,6 @@
 
 module Twingly
   module HTTP
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-http
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,6 +56,8 @@ files:
 - lib/faraday/logfmt_logger.rb
 - lib/faraday/logfmt_logger/LICENSE.md
 - lib/faraday/logfmt_logger/middleware.rb
+- lib/faraday/response_body_size_limit.rb
+- lib/faraday/response_body_size_limit/middleware.rb
 - lib/faraday/url_size_limit.rb
 - lib/faraday/url_size_limit/middleware.rb
 - lib/twingly/heroku.rb
@@ -82,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Robust HTTP client