twingly-http 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 504e1df993b190cf3039e5b45b9586f2babaab2fe5e1a881a10dfc407fd21663
-  data.tar.gz: 6081a1578382fa683f5ae71f52749988b52346dfef87cbcc9295d3ac33453bb8
+  metadata.gz: 62b69e5cac842eeefbaad91288707eb474458da8df5074521652fccd486edc89
+  data.tar.gz: 33c81395fbfd3f1588452fb93b66a067c40521654042f0eb6f04acd8a362b0c9
 SHA512:
-  metadata.gz: 493b7190c970e227735c7ffa8e7377f243cec8c8e24778662b3f9e9f187f713e16f68404c0c9c6322ad002fd05f75e2088027471747b2d022fb204e5ca719729
-  data.tar.gz: 68baaace97462c88bbbd84a082848264ee5515fde8505cf3e0e3524912d0b4f3387aa9c3057b577a683dbcd6f39ffec9dbaeae65c2b4bd3a35c8e5892f2684b0
+  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/faraday/url_size_limit/middleware.rb

@@ -16,7 +16,7 @@ module Faraday
 
         if url_bytesize >= @max_size_bytes
           raise LimitExceededError,
-                "Expected URL below #{@max_size_bytes} bytes, "\
+                "Expected URL below #{@max_size_bytes} bytes, " \
                 "was #{url_bytesize} bytes"
         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
 
@@ -46,9 +50,10 @@ module Twingly
       attr_accessor :logger
       attr_accessor :retryable_exceptions
 
-      def initialize(base_user_agent:, logger: default_logger)
+      def initialize(base_user_agent:, logger: default_logger, user_agent: nil)
         @base_user_agent = base_user_agent
         @logger          = logger
+        @user_agent      = user_agent
 
         initialize_defaults
       end
@@ -80,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,
@@ -105,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:)
@@ -192,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,
@@ -232,7 +242,7 @@ module Twingly
       end
 
       def user_agent
-        format(
+        @user_agent || format(
           "%<base>s (Release/%<release>s; Commit/%<commit>s)",
           base: @base_user_agent,
           release: Heroku.release_version,

data/lib/twingly/version.rb

@@ -2,6 +2,6 @@
 
 module Twingly
   module HTTP
-    VERSION = "0.5.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.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,118 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-- !ruby/object:Gem::Dependency
-  name: toxiproxy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
 description: Robust HTTP client tailored by Twingly
 email:
 - support@twingly.com
@@ -168,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
@@ -177,7 +67,8 @@ files:
 homepage: http://github.com/twingly/twingly-http
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -193,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Robust HTTP client