x-twitter-scraper 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b484492b68eb864049194156f172bd54ce3c734dab416a379e89479c29975984
+  data.tar.gz: 8bb73e082d9e1c88738e49eb3b1ab6ee8612651459dda021addf4cc5c55f21d7
+SHA512:
+  metadata.gz: 141f2f77507134941baafee648e1f293f42267e7abf15d43d1df1f81bdfd77eb37a16426bfa32fae8158b736268dc583214bcab543f0a8e28d3cb236f88cacfb
+  data.tar.gz: be8cc2cc7b4cf9d9762d99cf896e1bcf05e33efb7601b13334e552e6979cf067d7a817234115de8c106366389a0395fe18e5993f8b960ebed97b68d3c8d2786d

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+## 0.3.0 (2026-04-01)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([f86e402](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/f86e4024943bd72605879352d377f1a9527ce8c6))
+
+## 0.2.0 (2026-04-01)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** api update ([4e8766f](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/4e8766f1c8edd3f7b904cb872cb9f64730a22bbb))
+* **api:** api update ([f369f70](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/f369f7059ec0bd763d044a04cce27151250824ff))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([d0e93ac](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/d0e93acfd96cb7047474040f98670748b5ff0b99))
+* variable name typo ([235ba6c](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/235ba6ca1454d0617616c3f173de819df657dd93))
+
+
+### Chores
+
+* update SDK settings ([323c79a](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/323c79ae37c1a89db3bcafdb703da447e8c3f9e1))
+
+## 0.1.0 (2026-03-30)
+
+Full Changelog: [v0.0.1...v0.1.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.0.1...v0.1.0)
+
+### Features
+
+* **api:** api update ([772ffdd](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/772ffdd682ee96f94334441b9fc5b1e109559993))
+* **api:** api update ([bce31f2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/bce31f2f5ed3a264a7047afc6ca7a64db6ab89ca))
+* **api:** api update ([5447472](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/5447472f851835b211ec00905aad03e1400a0992))
+
+
+### Chores
+
+* update SDK settings ([8aec940](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/8aec9408a6db6ec1ca72357e6102d8b85534fc41))

data/README.md

@@ -0,0 +1,259 @@
+# X Twitter Scraper Ruby API library
+
+The X Twitter Scraper Ruby library provides convenient access to the X Twitter Scraper REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Xquik-dev/x-twitter-scraper-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/x-twitter-scraper).
+
+The REST API documentation can be found on [xquik.com](https://xquik.com).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "x-twitter-scraper", "~> 0.3.0"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "x_twitter_scraper"
+
+x_twitter_scraper = XTwitterScraper::Client.new(
+  api_key: ENV["X_TWITTER_SCRAPER_API_KEY"] # This is the default and can be omitted
+)
+
+response = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+
+puts(response.has_next_page)
+```
+
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
+
+```ruby
+require "pathname"
+
+# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
+response = x_twitter_scraper.x.media.upload(file: Pathname("/path/to/file"))
+
+# Alternatively, pass file contents or a `StringIO` directly:
+response = x_twitter_scraper.x.media.upload(file: File.read("/path/to/file"))
+
+# Or, to control the filename and/or content type:
+file =
+  XTwitterScraper::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
+response = x_twitter_scraper.x.media.upload(file: file)
+
+puts(response.mediaId)
+```
+
+Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `XTwitterScraper::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  tweet = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+rescue XTwitterScraper::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue XTwitterScraper::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue XTwitterScraper::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+x_twitter_scraper = XTwitterScraper::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10, request_options: {max_retries: 5})
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+x_twitter_scraper = XTwitterScraper::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10, request_options: {timeout: 5})
+```
+
+On timeout, `XTwitterScraper::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `XTwitterScraper::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+response =
+  x_twitter_scraper.x.tweets.search(
+    q: "from:elonmusk",
+    limit: 10,
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(response[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `XTwitterScraper::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `XTwitterScraper::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+
+# You can also splat a full Params class:
+params = XTwitterScraper::X::TweetSearchParams.new(q: "from:elonmusk", limit: 10)
+x_twitter_scraper.x.tweets.search(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :en
+puts(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
+
+# Revealed type: `T.all(XTwitterScraper::AccountUpdateLocaleParams::Locale, Symbol)`
+T.reveal_type(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+x_twitter_scraper.account.update_locale(
+  locale: XTwitterScraper::AccountUpdateLocaleParams::Locale::EN,
+  # …
+)
+
+# Literal values are also permissible:
+x_twitter_scraper.account.update_locale(
+  locale: :en,
+  # …
+)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/Xquik-dev/x-twitter-scraper-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by X Twitter Scraper, please follow the respective company's security reporting guidelines.
+
+### X Twitter Scraper Terms and Policies
+
+Please contact support@xquik.com for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/x_twitter_scraper/client.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  class Client < XTwitterScraper::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String, nil]
+    attr_reader :api_key
+
+    # OAuth 2.1 access token
+    # @return [String, nil]
+    attr_reader :bearer_token
+
+    # Account info & settings
+    # @return [XTwitterScraper::Resources::Account]
+    attr_reader :account
+
+    # API key management (session auth only)
+    # @return [XTwitterScraper::Resources::APIKeys]
+    attr_reader :api_keys
+
+    # Subscription & billing
+    # @return [XTwitterScraper::Resources::Subscribe]
+    attr_reader :subscribe
+
+    # Tweet composition, drafts, writing styles & radar
+    # @return [XTwitterScraper::Resources::Compose]
+    attr_reader :compose
+
+    # Tweet composition, drafts, writing styles & radar
+    # @return [XTwitterScraper::Resources::Drafts]
+    attr_reader :drafts
+
+    # Tweet composition, drafts, writing styles & radar
+    # @return [XTwitterScraper::Resources::Styles]
+    attr_reader :styles
+
+    # Tweet composition, drafts, writing styles & radar
+    # @return [XTwitterScraper::Resources::Radar]
+    attr_reader :radar
+
+    # Real-time X account monitoring
+    # @return [XTwitterScraper::Resources::Monitors]
+    attr_reader :monitors
+
+    # Activity events from monitored accounts
+    # @return [XTwitterScraper::Resources::Events]
+    attr_reader :events
+
+    # Bulk data extraction (20 tool types)
+    # @return [XTwitterScraper::Resources::Extractions]
+    attr_reader :extractions
+
+    # Giveaway draws from tweet replies
+    # @return [XTwitterScraper::Resources::Draws]
+    attr_reader :draws
+
+    # Webhook endpoint management & delivery
+    # @return [XTwitterScraper::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # Push notification integrations (Telegram)
+    # @return [XTwitterScraper::Resources::Integrations]
+    attr_reader :integrations
+
+    # X data lookups (subscription required)
+    # @return [XTwitterScraper::Resources::X]
+    attr_reader :x
+
+    # Trending topics by region
+    # @return [XTwitterScraper::Resources::Trends]
+    attr_reader :trends
+
+    # @return [XTwitterScraper::Resources::Bot]
+    attr_reader :bot
+
+    # @return [XTwitterScraper::Resources::Support]
+    attr_reader :support
+
+    # Subscription & billing
+    # @return [XTwitterScraper::Resources::Credits]
+    attr_reader :credits
+
+    # @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"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["X_TWITTER_SCRAPER_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["X_TWITTER_SCRAPER_API_KEY"],
+      bearer_token: ENV["X_TWITTER_SCRAPER_BEARER_TOKEN"],
+      base_url: ENV["X_TWITTER_SCRAPER_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://xquik.com/api/v1"
+
+      @api_key = api_key&.to_s
+      @bearer_token = bearer_token&.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @account = XTwitterScraper::Resources::Account.new(client: self)
+      @api_keys = XTwitterScraper::Resources::APIKeys.new(client: self)
+      @subscribe = XTwitterScraper::Resources::Subscribe.new(client: self)
+      @compose = XTwitterScraper::Resources::Compose.new(client: self)
+      @drafts = XTwitterScraper::Resources::Drafts.new(client: self)
+      @styles = XTwitterScraper::Resources::Styles.new(client: self)
+      @radar = XTwitterScraper::Resources::Radar.new(client: self)
+      @monitors = XTwitterScraper::Resources::Monitors.new(client: self)
+      @events = XTwitterScraper::Resources::Events.new(client: self)
+      @extractions = XTwitterScraper::Resources::Extractions.new(client: self)
+      @draws = XTwitterScraper::Resources::Draws.new(client: self)
+      @webhooks = XTwitterScraper::Resources::Webhooks.new(client: self)
+      @integrations = XTwitterScraper::Resources::Integrations.new(client: self)
+      @x = XTwitterScraper::Resources::X.new(client: self)
+      @trends = XTwitterScraper::Resources::Trends.new(client: self)
+      @bot = XTwitterScraper::Resources::Bot.new(client: self)
+      @support = XTwitterScraper::Resources::Support.new(client: self)
+      @credits = XTwitterScraper::Resources::Credits.new(client: self)
+    end
+  end
+end