x-twitter-scraper 0.10.5 → 0.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43da66645ccb25ebf91b2fce7abd6f6e3c9ceaadf07a86086839fd29bb0e2b9f
-  data.tar.gz: 57f8e8b8924975b71f79ed2f7a25e5d6b9a42024a11b489a14ec1a2a0536a016
+  metadata.gz: 46ffcafe78f6098cd45fa1a0f213515a2fb7d789f27ced4809ac735108a33084
+  data.tar.gz: a69999072784ab52f468234a7bfe343ad687c34dec12c78d19ecfb90b26ddccb
 SHA512:
-  metadata.gz: 32e8fbf3f54f3717f81c99b7551a44ed0d572ce900f9bae41d259ac8f4a30111f89cdd49d4355989d52a9a34ea4e3e05daa98686357b829eda37886217eb2da7
-  data.tar.gz: 71b43f3cfcc7a21d9c1999210eb0f283d273ff28664aeb2b2eb980c8509f49d618a1f06f91be66fc5d226c585f7ba700375618a98898483f1ca1a7bd7627668f
+  metadata.gz: 41655fce506cc950e43ff05a0387836d0b6476ac218988637e99e4bd6069b5f9cd541a9819f6623e4e1b8f71c2ce91bb302aba829703a7a31f847b4a1a300315
+  data.tar.gz: 910c622be7636cf6fe992ac2851849a12cd6cdf191a8a57d27eadffe9829c63c80434189a7209c6745e15bf476c6cd6dc58705961c47d0848c3e5b9c314c3d25

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.10.6 (2026-10-14)
+
+[Full changelog from v0.10.5 to v0.10.6](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.5...v0.10.6)
+
+The API and its behavior are the same as in 0.10.5.
+
+### Documentation
+
+* The README uses sentence case headings, active voice and whole sentences. Its facts, links and legal lines stay the same.
+
+### Chores
+
+* 24 development and test gems move to their latest stable release. The 3 runtime dependencies stay the same.
+
 ## 0.10.5 (2026-10-13)
 
 [Full changelog from v0.10.4 to v0.10.5](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.4...v0.10.5)

data/README.md

@@ -14,11 +14,43 @@ Xquik charges only for delivered, unique, filter-matching results and never pads
 > Xquik is an independent third-party service. Not affiliated with X Corp.
 > "Twitter" and "X" are trademarks of X Corp.
 
-[Ruby SDK Guide](https://docs.xquik.com/sdks/ruby) | [REST API](https://docs.xquik.com/api-reference/overview) | [RubyDoc](https://gemdocs.org/gems/x-twitter-scraper) | [Webhooks](https://docs.xquik.com/api-reference/webhooks/create)
+[Ruby SDK guide](https://docs.xquik.com/sdks/ruby) | [REST API](https://docs.xquik.com/api-reference/overview) | [RubyDoc](https://gemdocs.org/gems/x-twitter-scraper) | [Webhooks](https://docs.xquik.com/api-reference/webhooks/create)
+
+<!-- trust:start -->
+
+## Trust & usage
+
+[![Twitter API package downloads](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fdownloads.json)](https://xquik.com/trust#downloads)
+[![Twitter scraper users on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-users.json)](https://apify.com/xquik)
+[![Twitter scraper runs on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-runs.json)](https://apify.com/xquik)
+[![Tweet scraper rating on Apify](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fapify-rating.json)](https://apify.com/xquik/x-tweet-scraper/reviews)
+[![Xquik Twitter API accounts](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Faccounts.json)](https://xquik.com/trust#accounts)
+[![Twitter Skill installs](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fskill-installs.json)](https://xquik.com/trust#skill-installs)
+[![Xquik verified revenue on TrustMRR](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Frevenue.json)](https://trustmrr.com/startup/xquik)
+[![Twitter API median response time](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Frest-p50.json)](https://xquik.com/trust#speed)
+[![Xquik GitHub stars](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Fgithub-stars.json)](https://github.com/Xquik-dev)
+[![x-twitter-scraper downloads on RubyGems](https://img.shields.io/endpoint?url=https%3A%2F%2Fxquik.com%2Fbadges%2Frubygems-x-twitter-scraper.json)](https://rubygems.org/gems/x-twitter-scraper)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13739/badge)](https://www.bestpractices.dev/projects/13739)
+
+- 51,000+ downloads of Xquik's Twitter API packages on npm, PyPI, RubyGems, NuGet, Packagist & Terraform ([source](https://xquik.com/trust#downloads)) <!-- trust:downloads 51020 -->
+- 7,800+ users of Xquik's Twitter scraper Actors on Apify ([source](https://apify.com/xquik)) <!-- trust:apify-users 7800 -->
+- 5,700,000+ runs of Xquik's Twitter scraper Actors on Apify ([source](https://apify.com/xquik)) <!-- trust:apify-runs 5704701 -->
+- 4.66 of 5 for the X Tweet Scraper from 16 Apify reviews ([source](https://apify.com/xquik/x-tweet-scraper/reviews)) <!-- trust:apify-rating 4.66 16 -->
+- 3,900+ accounts on xquik.com ([source](https://xquik.com/trust#accounts)) <!-- trust:accounts 3924 -->
+- 1,600+ installs of Xquik's Twitter Skills on skills.sh ([source](https://xquik.com/trust#skill-installs)) <!-- trust:skill-installs 1612 -->
+- $38,000+ in revenue verified by TrustMRR ([source](https://trustmrr.com/startup/xquik)) <!-- trust:revenue 38115 -->
+- 501 ms median REST API read time over the last 7 days ([source](https://xquik.com/trust#speed)) <!-- trust:rest-p50 501 -->
+- 370+ GitHub stars across Xquik's repos ([source](https://github.com/Xquik-dev)) <!-- trust:github-stars 374 -->
+- 9,900+ downloads of x-twitter-scraper on RubyGems ([source](https://rubygems.org/gems/x-twitter-scraper)) <!-- trust:rubygems-x-twitter-scraper 9982 -->
+- This repo meets the OpenSSF Best Practices passing criteria ([source](https://www.bestpractices.dev/projects/13739)) <!-- trust:openssf-x-twitter-scraper-ruby 1 -->
+
+Checked on 2026-10-15. See each number with its date & source on [xquik.com/trust](https://xquik.com/trust) or as [JSON](https://xquik.com/trust.json).
+
+<!-- trust:end -->
 
 ## Common Twitter & X tasks
 
-| Task | REST Route | Usage |
+| Task | REST route | Usage |
 | --- | --- | --- |
 | Search tweets without the X API | `GET /x/tweets/search` | Use keyword or advanced operator queries. |
 | Read an X profile timeline | `GET /x/users/{id}/tweets` | Paginate bounded results. |
@@ -32,18 +64,14 @@ Xquik charges only for delivered, unique, filter-matching results and never pads
 
 ## Installation
 
-Requires Ruby 3.2.0 or higher.
+The SDK requires Ruby 3.2.0 or later.
 
 Add the gem to your `Gemfile`.
 
-<!-- x-release-please-start-version -->
-
 ```ruby
-gem "x-twitter-scraper", "~> 0.10.5"
+gem "x-twitter-scraper", "~> 0.10.6"
 ```
 
-<!-- x-release-please-end -->
-
 ## Usage
 
 ```ruby
@@ -51,7 +79,7 @@ require "bundler/setup"
 require "x_twitter_scraper"
 
 x_twitter_scraper = XTwitterScraper::Client.new(
-  api_key: ENV["X_TWITTER_SCRAPER_API_KEY"] # Optional; the client reads this variable.
+  api_key: ENV["X_TWITTER_SCRAPER_API_KEY"] # Optional. The client reads this variable.
 )
 
 response = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
@@ -77,7 +105,7 @@ rescue XTwitterScraper::Errors::APIStatusError => e
 end
 ```
 
-| Cause            | Error Type                 |
+| Cause            | Error type                 |
 | ---------------- | -------------------------- |
 | HTTP 400         | `BadRequestError`          |
 | HTTP 401         | `AuthenticationError`      |
@@ -151,7 +179,7 @@ account =
 puts(account[:my_undocumented_property])
 ```
 
-Use `client.request` for undocumented endpoints while retaining authentication and retries.
+Use `client.request` for undocumented endpoints. It keeps authentication and retries.
 
 ```ruby
 response = client.request(
@@ -167,7 +195,7 @@ response = client.request(
 
 Clients are thread-safe. Fork them only when no HTTP requests are in flight.
 Each client has an HTTP connection pool with a default size of 99.
-Reuse one client per application in most cases.
+Reuse 1 client per application in most cases.
 Requests wait when every connection is busy. This wait counts toward the request timeout.
 Other SDK classes do not lock their data.
 
@@ -178,10 +206,8 @@ The gem ships [RBI](https://sorbet.org/docs/rbi) definitions without `sorbet-run
 Pass request hashes or typed parameter objects.
 
 ```ruby
-# Hashes work without type safety:
 x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
 
-# Splat a complete Params object:
 params = XTwitterScraper::X::TweetSearchParams.new(q: "from:elonmusk", limit: 10)
 x_twitter_scraper.x.tweets.search(**params)
 ```
@@ -201,13 +227,11 @@ T.reveal_type(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
 Enum parameters accept constants or literal values.
 
 ```ruby
-# Enum constants preserve tagged type information:
 x_twitter_scraper.account.update_locale(
   locale: XTwitterScraper::AccountUpdateLocaleParams::Locale::EN,
   # …
 )
 
-# Literal values also work:
 x_twitter_scraper.account.update_locale(
   locale: :en,
   # …
@@ -218,7 +242,15 @@ x_twitter_scraper.account.update_locale(
 
 This package follows [SemVer](https://semver.org/spec/v2.0.0.html). Version `0` releases may change APIs.
 
-Changes to non-runtime `*.rbi` and `*.rbs` definitions remain non-breaking.
+Changes to non-runtime `*.rbi` and `*.rbs` definitions are non-breaking.
+
+## More Xquik tools
+
+- [X (Twitter) scraper API & Twitter MCP server](https://github.com/Xquik-dev/x-twitter-scraper) with REST, MCP & Skill setup.
+- Twitter API SDKs for [TypeScript](https://github.com/Xquik-dev/x-twitter-scraper-typescript), [Python](https://github.com/Xquik-dev/x-twitter-scraper-python), [Go](https://github.com/Xquik-dev/x-twitter-scraper-go), [Java](https://github.com/Xquik-dev/x-twitter-scraper-java), [Kotlin](https://github.com/Xquik-dev/x-twitter-scraper-kotlin), [C#](https://github.com/Xquik-dev/x-twitter-scraper-csharp) & [PHP](https://github.com/Xquik-dev/x-twitter-scraper-php).
+- [Twitter CLI & X CLI](https://github.com/Xquik-dev/x-twitter-scraper-cli) for terminal workflows.
+- [Twitter advanced search operators](https://github.com/Xquik-dev/x-twitter-advanced-search) with tested examples.
+- [Xquik X API & Twitter scraper](https://xquik.com) and the [Twitter API documentation](https://docs.xquik.com/api-reference/overview).
 
 ## Help & contributing
 

data/lib/x_twitter_scraper/client.rb

@@ -88,33 +88,20 @@ module XTwitterScraper
     # @return [XTwitterScraper::Resources::GuestWallets]
     attr_reader :guest_wallets
 
-    # @api private
-    #
-    # @param security [Hash{Symbol=>Boolean}]
-    #
-    # @return [Hash{String=>String}]
     private def auth_headers(security:)
       {auth_api_key:, oauth_bearer:}.slice(*security.keys).values.reduce({}, :merge)
     end
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
     private def auth_api_key
       {"x-api-key" => @api_key}
     end
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
     private def oauth_bearer
       return {} if @bearer_token.nil?
 
       {"authorization" => "Bearer #{@bearer_token}"}
     end
 
-    # Creates and returns a new client for interacting with the API.
-    #
     # @param api_key [String, nil] Defaults to `ENV["X_TWITTER_SCRAPER_API_KEY"]`
     #
     # @param bearer_token [String, nil] OAuth 2.1 access token Defaults to `ENV["X_TWITTER_SCRAPER_BEARER_TOKEN"]`

data/lib/x_twitter_scraper/file_part.rb

@@ -15,9 +15,6 @@ module XTwitterScraper
     # @return [String, nil]
     attr_reader :filename
 
-    # @api private
-    #
-    # @return [String]
     private def read
       case content
       in Pathname

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

@@ -7,16 +7,12 @@
 module XTwitterScraper
   module Internal
     module Transport
-      # @api private
-      #
-      # @abstract
       class BaseClient
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # from whatwg fetch spec
         MAX_REDIRECTS = 20
 
-        # rubocop:disable Style/MutableConstant
+        # rubocop:disable-next Style/MutableConstant
         PLATFORM_HEADERS =
           {
             "x-stainless-arch" => XTwitterScraper::Internal::Util.arch,
@@ -26,14 +22,8 @@ module XTwitterScraper
             "x-stainless-runtime" => ::RUBY_ENGINE,
             "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
           }
-        # rubocop:enable Style/MutableConstant
 
         class << self
-          # @api private
-          #
-          # @param req [Hash{Symbol=>Object}]
-          #
-          # @raise [ArgumentError]
           def validate!(req)
             keys = [
               :method,
@@ -60,50 +50,18 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param status [Integer]
-          # @param headers [Hash{String=>String}]
-          #
-          # @return [Boolean]
           def should_retry?(status, headers:)
             coerced = XTwitterScraper::Internal::Util.coerce_boolean(headers["x-should-retry"])
             case [coerced, status]
             in [true | false, _]
               coerced
             in [_, 408 | 409 | 429 | (500..)]
-              # retry on:
-              # 408: timeouts
-              # 409: locks
-              # 429: rate limits
-              # 500+: unknown errors
               true
             else
               false
             end
           end
 
-          # @api private
-          #
-          # @param request [Hash{Symbol=>Object}] .
-          #
-          #   @option request [Symbol] :method
-          #
-          #   @option request [URI::Generic] :url
-          #
-          #   @option request [Hash{String=>String}] :headers
-          #
-          #   @option request [Object] :body
-          #
-          #   @option request [Integer] :max_retries
-          #
-          #   @option request [Float] :timeout
-          #
-          # @param status [Integer]
-          #
-          # @param response_headers [Hash{String=>String}]
-          #
-          # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
             method, url, headers = request.fetch_values(:method, :url, :headers)
             location =
@@ -132,7 +90,6 @@ module XTwitterScraper
               nil
             end
 
-            # from whatwg fetch spec
             case [status, method]
             in [301 | 302, :post] | [303, _]
               drop = %w[content-encoding content-language content-length content-location content-type]
@@ -145,7 +102,6 @@ module XTwitterScraper
             else
             end
 
-            # from undici
             if XTwitterScraper::Internal::Util.uri_origin(url) != XTwitterScraper::Internal::Util.uri_origin(location)
               drop = %w[authorization cookie host proxy-authorization]
               request = {**request, headers: request.fetch(:headers).except(*drop)}
@@ -154,10 +110,6 @@ module XTwitterScraper
             request
           end
 
-          # @api private
-          #
-          # @param status [Integer, XTwitterScraper::Errors::APIConnectionError]
-          # @param stream [Enumerable<String>, nil]
           def reap_connection!(status, stream:)
             case status
             in (..199) | (300..499)
@@ -169,40 +121,8 @@ module XTwitterScraper
           end
         end
 
-        # @return [URI::Generic]
-        attr_reader :base_url
+        attr_reader :base_url, :timeout, :max_retries, :initial_retry_delay, :max_retry_delay, :headers, :idempotency_header, :requester
 
-        # @return [Float]
-        attr_reader :timeout
-
-        # @return [Integer]
-        attr_reader :max_retries
-
-        # @return [Float]
-        attr_reader :initial_retry_delay
-
-        # @return [Float]
-        attr_reader :max_retry_delay
-
-        # @return [Hash{String=>String}]
-        attr_reader :headers
-
-        # @return [String, nil]
-        attr_reader :idempotency_header
-
-        # @api private
-        # @return [XTwitterScraper::Internal::Transport::PooledNetRequester]
-        attr_reader :requester
-
-        # @api private
-        #
-        # @param base_url [String]
-        # @param timeout [Float]
-        # @param max_retries [Integer]
-        # @param initial_retry_delay [Float]
-        # @param max_retry_delay [Float]
-        # @param headers [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}]
-        # @param idempotency_header [String, nil]
         def initialize(
           base_url:,
           timeout: 0.0,
@@ -231,60 +151,12 @@ module XTwitterScraper
           @max_retry_delay = max_retry_delay
         end
 
-        # @api private
-        #
-        # @return [Hash{String=>String}]
         private def auth_headers = {}
 
-        # @api private
-        #
-        # @return [String]
         private def user_agent = "#{self.class.name}/Ruby #{XTwitterScraper::VERSION}"
 
-        # @api private
-        #
-        # @return [String]
         private def generate_idempotency_key = "stainless-ruby-retry-#{SecureRandom.uuid}"
 
-        # @api private
-        #
-        # @param req [Hash{Symbol=>Object}] .
-        #
-        #   @option req [Symbol] :method
-        #
-        #   @option req [String, Array<String>] :path
-        #
-        #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
-        #
-        #   @option req [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil] :headers
-        #
-        #   @option req [Object, nil] :body
-        #
-        #   @option req [Symbol, Integer, Array<Symbol, Integer>, Proc, nil] :unwrap
-        #
-        #   @option req [Class<XTwitterScraper::Internal::Type::BasePage>, nil] :page
-        #
-        #   @option req [Class<XTwitterScraper::Internal::Type::BaseStream>, nil] :stream
-        #
-        #   @option req [XTwitterScraper::Internal::Type::Converter, Class, nil] :model
-        #
-        #   @option req [Hash{Symbol=>Boolean}, nil] :security
-        #
-        # @param opts [Hash{Symbol=>Object}] .
-        #
-        #   @option opts [String, nil] :idempotency_key
-        #
-        #   @option opts [Hash{String=>Array<String>, String, nil}, nil] :extra_query
-        #
-        #   @option opts [Hash{String=>String, nil}, nil] :extra_headers
-        #
-        #   @option opts [Object, nil] :extra_body
-        #
-        #   @option opts [Integer, nil] :max_retries
-        #
-        #   @option opts [Float, nil] :timeout
-        #
-        # @return [Hash{Symbol=>Object}]
         private def build_request(req, opts)
           method, uninterpolated_path = req.fetch_values(:method, :path)
 
@@ -328,9 +200,6 @@ module XTwitterScraper
               XTwitterScraper::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
-          # Generated methods always pass `req[:body]` for operations that define a
-          # request body, so only elide the content-type header when the operation
-          # has no body at all, not when an optional body param was omitted.
           headers.delete("content-type") if body.nil? && !req.key?(:body)
 
           url = XTwitterScraper::Internal::Util.join_parsed_uri(
@@ -348,14 +217,7 @@ module XTwitterScraper
           }
         end
 
-        # @api private
-        #
-        # @param headers [Hash{String=>String}]
-        # @param retry_count [Integer]
-        #
-        # @return [Float]
         private def retry_delay(headers, retry_count:)
-          # Non-standard extension
           span = Float(headers["retry-after-ms"], exception: false)&.then { _1 / 1000 }
           return span if span
 
@@ -374,30 +236,6 @@ module XTwitterScraper
           (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay)
         end
 
-        # @api private
-        #
-        # @param request [Hash{Symbol=>Object}] .
-        #
-        #   @option request [Symbol] :method
-        #
-        #   @option request [URI::Generic] :url
-        #
-        #   @option request [Hash{String=>String}] :headers
-        #
-        #   @option request [Object] :body
-        #
-        #   @option request [Integer] :max_retries
-        #
-        #   @option request [Float] :timeout
-        #
-        # @param redirect_count [Integer]
-        #
-        # @param retry_count [Integer]
-        #
-        # @param send_retry_header [Boolean]
-        #
-        # @raise [XTwitterScraper::Errors::APIError]
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: XTwitterScraper::Internal::Util.monotonic_secs + timeout}
@@ -467,47 +305,6 @@ module XTwitterScraper
           end
         end
 
-        # Execute the request specified by `req`. This is the method that all resource
-        # methods call into.
-        #
-        # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: XTwitterScraper::Internal::Type::Unknown, security: {auth_api_key: true, oauth_bearer: true}, options: {})
-        #
-        # @param method [Symbol]
-        #
-        # @param path [String, Array<String>]
-        #
-        # @param query [Hash{String=>Array<String>, String, nil}, nil]
-        #
-        # @param headers [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil]
-        #
-        # @param body [Object, nil]
-        #
-        # @param unwrap [Symbol, Integer, Array<Symbol, Integer>, Proc, nil]
-        #
-        # @param page [Class<XTwitterScraper::Internal::Type::BasePage>, nil]
-        #
-        # @param stream [Class<XTwitterScraper::Internal::Type::BaseStream>, nil]
-        #
-        # @param model [XTwitterScraper::Internal::Type::Converter, Class, nil]
-        #
-        # @param security [Hash{Symbol=>Boolean}, nil]
-        #
-        # @param options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}, nil] .
-        #
-        #   @option options [String, nil] :idempotency_key
-        #
-        #   @option options [Hash{String=>Array<String>, String, nil}, nil] :extra_query
-        #
-        #   @option options [Hash{String=>String, nil}, nil] :extra_headers
-        #
-        #   @option options [Object, nil] :extra_body
-        #
-        #   @option options [Integer, nil] :max_retries
-        #
-        #   @option options [Float, nil] :timeout
-        #
-        # @raise [XTwitterScraper::Errors::APIError]
-        # @return [Object]
         def request(req)
           self.class.validate!(req)
           model = req.fetch(:model) { XTwitterScraper::Internal::Type::Unknown }
@@ -517,7 +314,6 @@ module XTwitterScraper
           request = build_request(req.except(:options), opts)
           url = request.fetch(:url)
 
-          # Don't send the current retry count in the headers if the caller modified the header defaults.
           send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
           status, response, stream = send_request(
             request,
@@ -547,13 +343,9 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @return [String]
         def inspect
-          # rubocop:disable Layout/LineLength
+          # rubocop:disable-next Layout/LineLength
           "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{@base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
-          # rubocop:enable Layout/LineLength
         end
 
         define_sorbet_constant!(:RequestComponents) do

data/lib/x_twitter_scraper/internal/transport/pooled_net_requester.rb

@@ -7,23 +7,14 @@
 module XTwitterScraper
   module Internal
     module Transport
-      # @api private
       class PooledNetRequester
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
-        # from the golang stdlib
-        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         DEFAULT_MAX_CONNECTIONS = [Etc.nprocessors, 99].max
 
         class << self
-          # @api private
-          #
-          # @param cert_store [OpenSSL::X509::Store]
-          # @param url [URI::Generic]
-          #
-          # @return [Net::HTTP]
           def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
@@ -43,36 +34,18 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param conn [Net::HTTP]
-          # @param deadline [Float]
           def calibrate_socket_timeout(conn, deadline)
             timeout = deadline - XTwitterScraper::Internal::Util.monotonic_secs
             conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout
           end
 
-          # @api private
-          #
-          # @param request [Hash{Symbol=>Object}] .
-          #
-          #   @option request [Symbol] :method
-          #
-          #   @option request [URI::Generic] :url
-          #
-          #   @option request [Hash{String=>String}] :headers
-          #
-          # @param blk [Proc]
-          #
-          # @yieldparam [String]
-          # @return [Array(Net::HTTPGenericRequest, Proc)]
           def build_request(request, &blk)
             method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
             req = Net::HTTPGenericRequest.new(
               method.to_s.upcase,
               !body.nil?,
               method != :head,
-              URI(url.to_s) # ensure we construct a URI class of the right scheme
+              URI(url.to_s)
             )
 
             headers.each { req[_1] = _2 }
@@ -95,14 +68,6 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @param url [URI::Generic]
-        # @param deadline [Float]
-        # @param blk [Proc]
-        #
-        # @raise [Timeout::Error]
-        # @yieldparam [Net::HTTP]
         private def with_pool(url, deadline:, &blk)
           origin = XTwitterScraper::Internal::Util.uri_origin(url)
           timeout = deadline - XTwitterScraper::Internal::Util.monotonic_secs
@@ -116,28 +81,13 @@ module XTwitterScraper
           pool.with(timeout: timeout, &blk)
         end
 
-        # @api private
-        #
-        # @param request [Hash{Symbol=>Object}] .
-        #
-        #   @option request [Symbol] :method
-        #
-        #   @option request [URI::Generic] :url
-        #
-        #   @option request [Hash{String=>String}] :headers
-        #
-        #   @option request [Object] :body
-        #
-        #   @option request [Float] :deadline
-        #
-        # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
         def execute(request)
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
           finished = false
 
-          # rubocop:disable Metrics/BlockLength
+          # rubocop:disable-next Metrics/BlockLength
           enum = Enumerator.new do |y|
             next if finished
 
@@ -185,7 +135,6 @@ module XTwitterScraper
           rescue StandardError
             raise XTwitterScraper::Errors::APIConnectionError.new(url: url, request: req)
           end
-          # rubocop:enable Metrics/BlockLength
 
           _, response = enum.next
           body = XTwitterScraper::Internal::Util.fused_enum(enum, external: true) do
@@ -195,9 +144,6 @@ module XTwitterScraper
           [Integer(response.code), response, body]
         end
 
-        # @api private
-        #
-        # @param size [Integer]
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size