x-twitter-scraper 0.10.4 → 0.10.6

data/lib/x_twitter_scraper/resources/x/tweets/retweet.rb

@@ -10,9 +10,6 @@ module XTwitterScraper
       class Tweets
         # X write actions (tweets, likes, follows, DMs)
         class Retweet
-          # Some parameter documentations has been truncated, see
-          # {XTwitterScraper::Models::X::Tweets::RetweetCreateParams} for more details.
-          #
           # Retweet
           #
           # @overload create(id, account:, idempotency_key:, request_options: {})
@@ -41,9 +38,6 @@ module XTwitterScraper
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {XTwitterScraper::Models::X::Tweets::RetweetDeleteParams} for more details.
-          #
           # Unretweet
           #
           # @overload delete(id, account:, idempotency_key:, request_options: {})

data/lib/x_twitter_scraper/resources/x/tweets.rb

@@ -16,9 +16,6 @@ module XTwitterScraper
         # @return [XTwitterScraper::Resources::X::Tweets::Retweet]
         attr_reader :retweet
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetCreateParams} for more details.
-        #
         # Create tweet
         #
         # @overload create(account:, idempotency_key:, community_id: nil, is_note_tweet: nil, media: nil, reply_to_tweet_id: nil, text: nil, request_options: {})
@@ -98,9 +95,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetDeleteParams} for more details.
-        #
         # Delete tweet
         #
         # @overload delete(id, account:, idempotency_key:, request_options: {})
@@ -129,9 +123,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetGetFavoritersParams} for more details.
-        #
         # Returns liker profiles that X makes visible for the post. X can withhold liker
         # identities even when the post reports likes. In that case this endpoint returns
         # 424 `favoriters_unavailable` instead of a misleading empty success.
@@ -205,9 +196,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetGetQuotesParams} for more details.
-        #
         # List quote tweets of a tweet
         #
         # @overload get_quotes(id, any_words: nil, blue_verified_only: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, include_replies: nil, in_reply_to_tweet_id: nil, language: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, since_time: nil, source: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
@@ -364,9 +352,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetGetRepliesParams} for more details.
-        #
         # Returns direct replies. Omit mode for automatic maximum coverage with resumable
         # pagination. Complete mode returns nested replies, diagnostics, and 424 when
         # direct coverage stays below 80%.
@@ -542,9 +527,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetGetRetweetersParams} for more details.
-        #
         # List users who retweeted a tweet
         #
         # @overload get_retweeters(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
@@ -616,9 +598,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetGetThreadParams} for more details.
-        #
         # Get full conversation thread for a tweet
         #
         # @overload get_thread(id, any_words: nil, blue_verified_only: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, max_faves: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, request_options: {})
@@ -736,9 +715,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::TweetSearchParams} for more details.
-        #
         # No-mode search maximizes coverage. New cursorless `Latest` sessions return rows
         # newest-first across cursor pages. Existing cursors preserve their established
         # ordering.

data/lib/x_twitter_scraper/resources/x/users/follow.rb

@@ -10,9 +10,6 @@ module XTwitterScraper
       class Users
         # X write actions (tweets, likes, follows, DMs)
         class Follow
-          # Some parameter documentations has been truncated, see
-          # {XTwitterScraper::Models::X::Users::FollowCreateParams} for more details.
-          #
           # Follow user
           #
           # @overload create(id, account:, idempotency_key:, request_options: {})
@@ -41,9 +38,6 @@ module XTwitterScraper
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {XTwitterScraper::Models::X::Users::FollowDeleteAllParams} for more details.
-          #
           # Unfollow user
           #
           # @overload delete_all(id, account:, idempotency_key:, request_options: {})

data/lib/x_twitter_scraper/resources/x/users.rb

@@ -32,9 +32,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRemoveFollowerParams} for more details.
-        #
         # Remove follower
         #
         # @overload remove_follower(id, account:, idempotency_key:, request_options: {})
@@ -63,9 +60,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveBatchParams} for more details.
-        #
         # Look up multiple users by IDs in one call
         #
         # @overload retrieve_batch(ids:, request_options: {})
@@ -89,9 +83,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveFollowersParams} for more details.
-        #
         # List followers of a user
         #
         # @overload retrieve_followers(id, after: nil, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, limit: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, mode: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
@@ -169,10 +160,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowParams} for more
-        # details.
-        #
         # List mutual followers between you and a user
         #
         # @overload retrieve_followers_you_know(id, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
@@ -244,9 +231,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveFollowingParams} for more details.
-        #
         # List accounts a user follows
         #
         # @overload retrieve_following(id, after: nil, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, limit: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, mode: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
@@ -324,9 +308,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveLikesParams} for more details.
-        #
         # List tweets liked by a user
         #
         # @overload retrieve_likes(id, any_words: nil, blue_verified_only: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, source: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
@@ -474,9 +455,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveMediaParams} for more details.
-        #
         # List media tweets posted by a user
         #
         # @overload retrieve_media(id, any_words: nil, blue_verified_only: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, source: nil, to_user: nil, until_date: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
@@ -624,9 +602,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveMentionsParams} for more details.
-        #
         # List tweets mentioning a user
         #
         # @overload retrieve_mentions(id, any_words: nil, blue_verified_only: nil, card_name: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_source: nil, exclude_words: nil, from_user: nil, geocode: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, max_faves: nil, max_id: nil, max_quotes: nil, max_replies: nil, max_retweets: nil, media_type: nil, mentioning: nil, min_bookmarks: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, min_views: nil, native_retweets: nil, near: nil, news: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, safe: nil, since_date: nil, since_id: nil, since_time: nil, source: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, within: nil, within_time: nil, request_options: {})
@@ -780,9 +755,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveRepliesParams} for more details.
-        #
         # Returns target-authored posts and replies. Omit mode for automatic maximum
         # coverage. Pass next_cursor unchanged. Unprefixed cursors stay legacy. Excludes
         # other-author context.
@@ -935,9 +907,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveSearchParams} for more details.
-        #
         # Search users by name or username
         #
         # @overload retrieve_search(q:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
@@ -1006,9 +975,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveTweetsParams} for more details.
-        #
         # Omit mode for automatic maximum coverage. Pass next_cursor unchanged. Unprefixed
         # cursors use legacy pagination. Shape and billing stay the same.
         #
@@ -1163,10 +1129,6 @@ module XTwitterScraper
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {XTwitterScraper::Models::X::UserRetrieveVerifiedFollowersParams} for more
-        # details.
-        #
         # List verified followers of a user
         #
         # @overload retrieve_verified_followers(id, after: nil, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, limit: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, mode: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})

data/lib/x_twitter_scraper/resources/x.rb

@@ -54,9 +54,6 @@ module XTwitterScraper
       # @return [XTwitterScraper::Resources::X::Lists]
       attr_reader :lists
 
-      # Some parameter documentations has been truncated, see
-      # {XTwitterScraper::Models::XGetArticleParams} for more details.
-      #
       # Retrieve the full content of an X Article (long-form post) by numeric tweet ID.
       # Returns article_not_found when the tweet is valid but is not an X Article.
       #

data/lib/x_twitter_scraper/version.rb

@@ -5,5 +5,5 @@
 # frozen_string_literal: true
 
 module XTwitterScraper
-  VERSION = "0.10.4"
+  VERSION = "0.10.6"
 end

data/lib/x_twitter_scraper.rb

@@ -4,7 +4,6 @@
 
 # frozen_string_literal: true
 
-# Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "base64"
@@ -24,18 +23,14 @@ require "time"
 require "uri"
 # rubocop:enable Lint/RedundantRequireStatement
 
-# We already ship the preferred sorbet manifests in the package itself.
-# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
 if Object.const_defined?(:Tapioca) &&
    caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
    ARGV.none?(/dsl/)
   return
 end
 
-# Gems.
 require "connection_pool"
 
-# Package files.
 require_relative "x_twitter_scraper/version"
 require_relative "x_twitter_scraper/internal/util"
 require_relative "x_twitter_scraper/internal/type/converter"

data/rbi/x_twitter_scraper/client.rbi

@@ -83,7 +83,6 @@ module XTwitterScraper
     sig { returns(XTwitterScraper::Resources::GuestWallets) }
     attr_reader :guest_wallets
 
-    # @api private
     sig do
       override
         .params(
@@ -97,17 +96,14 @@ module XTwitterScraper
     private def auth_headers(security:)
     end
 
-    # @api private
     sig { returns(T::Hash[String, String]) }
     private def auth_api_key
     end
 
-    # @api private
     sig { returns(T::Hash[String, String]) }
     private def oauth_bearer
     end
 
-    # Creates and returns a new client for interacting with the API.
     sig do
       params(
         api_key: T.nilable(String),

data/rbi/x_twitter_scraper/file_part.rbi

@@ -15,7 +15,6 @@ module XTwitterScraper
     sig { returns(T.nilable(String)) }
     attr_reader :filename
 
-    # @api private
     sig { returns(String) }
     private def read
     end

data/rbi/x_twitter_scraper/internal/transport/base_client.rbi

@@ -7,7 +7,6 @@
 module XTwitterScraper
   module Internal
     module Transport
-      # @api private
       class BaseClient
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
@@ -76,13 +75,11 @@ module XTwitterScraper
             }
           end
 
-        # from whatwg fetch spec
         MAX_REDIRECTS = 20
 
         PLATFORM_HEADERS = T::Hash[String, String]
 
         class << self
-          # @api private
           sig do
             params(
               req:
@@ -92,7 +89,6 @@ module XTwitterScraper
           def validate!(req)
           end
 
-          # @api private
           sig do
             params(status: Integer, headers: T::Hash[String, String]).returns(
               T::Boolean
@@ -101,7 +97,6 @@ module XTwitterScraper
           def should_retry?(status, headers:)
           end
 
-          # @api private
           sig do
             params(
               request:
@@ -115,7 +110,6 @@ module XTwitterScraper
           def follow_redirect(request, status:, response_headers:)
           end
 
-          # @api private
           sig do
             params(
               status:
@@ -148,13 +142,11 @@ module XTwitterScraper
         sig { returns(T.nilable(String)) }
         attr_reader :idempotency_header
 
-        # @api private
         sig do
           returns(XTwitterScraper::Internal::Transport::PooledNetRequester)
         end
         attr_reader :requester
 
-        # @api private
         sig do
           params(
             base_url: String,
@@ -187,22 +179,18 @@ module XTwitterScraper
         )
         end
 
-        # @api private
         sig { overridable.returns(T::Hash[String, String]) }
         private def auth_headers
         end
 
-        # @api private
         sig { returns(String) }
         private def user_agent
         end
 
-        # @api private
         sig { returns(String) }
         private def generate_idempotency_key
         end
 
-        # @api private
         sig do
           overridable
             .params(
@@ -217,7 +205,6 @@ module XTwitterScraper
         private def build_request(req, opts)
         end
 
-        # @api private
         sig do
           params(
             headers: T::Hash[String, String],
@@ -227,7 +214,6 @@ module XTwitterScraper
         private def retry_delay(headers, retry_count:)
         end
 
-        # @api private
         sig do
           params(
             request:
@@ -245,10 +231,6 @@ module XTwitterScraper
         )
         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: {})
         sig do
           params(
             method: Symbol,
@@ -310,7 +292,6 @@ module XTwitterScraper
         )
         end
 
-        # @api private
         sig { returns(String) }
         def inspect
         end

data/rbi/x_twitter_scraper/internal/transport/pooled_net_requester.rbi

@@ -7,7 +7,6 @@
 module XTwitterScraper
   module Internal
     module Transport
-      # @api private
       class PooledNetRequester
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
@@ -22,14 +21,11 @@ module XTwitterScraper
             }
           end
 
-        # from the golang stdlib
-        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         DEFAULT_MAX_CONNECTIONS = T.let(T.unsafe(nil), Integer)
 
         class << self
-          # @api private
           sig do
             params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
               Net::HTTP
@@ -38,12 +34,10 @@ module XTwitterScraper
           def connect(cert_store:, url:)
           end
 
-          # @api private
           sig { params(conn: Net::HTTP, deadline: Float).void }
           def calibrate_socket_timeout(conn, deadline)
           end
 
-          # @api private
           sig do
             params(
               request:
@@ -55,7 +49,6 @@ module XTwitterScraper
           end
         end
 
-        # @api private
         sig do
           params(
             url: URI::Generic,
@@ -66,7 +59,6 @@ module XTwitterScraper
         private def with_pool(url, deadline:, &blk)
         end
 
-        # @api private
         sig do
           params(
             request:
@@ -76,7 +68,6 @@ module XTwitterScraper
         def execute(request)
         end
 
-        # @api private
         sig { params(size: Integer).returns(T.attached_class) }
         def self.new(
           size: XTwitterScraper::Internal::Transport::PooledNetRequester::DEFAULT_MAX_CONNECTIONS

data/rbi/x_twitter_scraper/internal/type/array_of.rbi

@@ -7,9 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # Array of items of a given type.
       class ArrayOf
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
@@ -46,7 +43,6 @@ module XTwitterScraper
         def hash
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -58,7 +54,6 @@ module XTwitterScraper
         def coerce(value, state:)
         end
 
-        # @api private
         sig do
           override
             .params(
@@ -70,22 +65,18 @@ module XTwitterScraper
         def dump(value, state:)
         end
 
-        # @api private
         sig { returns(T.anything) }
         def to_sorbet_type
         end
 
-        # @api private
         sig { returns(Elem) }
         protected def item_type
         end
 
-        # @api private
         sig { returns(T::Boolean) }
         protected def nilable?
         end
 
-        # @api private
         sig do
           params(
             type_info:
@@ -102,7 +93,6 @@ module XTwitterScraper
         def initialize(type_info, spec = {})
         end
 
-        # @api private
         sig { params(depth: Integer).returns(String) }
         def inspect(depth: 0)
         end