x-twitter-scraper 0.10.3 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 377c00b19b9d19ebb8a350b172937dc5805869f1e7d500da6ec4fec43996d659
-  data.tar.gz: e57a1128b31495941ff65b3418c059d64c2afb3d7ae69de55b1ce45937a73c59
+  metadata.gz: 43da66645ccb25ebf91b2fce7abd6f6e3c9ceaadf07a86086839fd29bb0e2b9f
+  data.tar.gz: 57f8e8b8924975b71f79ed2f7a25e5d6b9a42024a11b489a14ec1a2a0536a016
 SHA512:
-  metadata.gz: 81ef337f2a4176e1d855428f770bc6fd4f758f4512183c6284d8e07a2d44c2cd658c8b17e008c7f10bbf9dc56d3b4c224c518c91da46b2a7080fbab0a61ed6f7
-  data.tar.gz: 91c815184295402c9bb9a13317d7743942b8fcfa0c991324af1995064ed63748c9cb4cc052980fe479dda23591d21ee4c14fe21e9f351093a614b770ded2cf9d
+  metadata.gz: 32e8fbf3f54f3717f81c99b7551a44ed0d572ce900f9bae41d259ac8f4a30111f89cdd49d4355989d52a9a34ea4e3e05daa98686357b829eda37886217eb2da7
+  data.tar.gz: 71b43f3cfcc7a21d9c1999210eb0f283d273ff28664aeb2b2eb980c8509f49d618a1f06f91be66fc5d226c585f7ba700375618a98898483f1ca1a7bd7627668f

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 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)
+
+### Documentation
+
+* The README title is now "X API & Twitter API Ruby SDK by Xquik".
+* The README says near the top what Xquik is, how it bills and that it is not affiliated with X Corp.
+* Doc comments use the current price. An active monitor costs 30 credits per hour.
+* The gem page gains a description and links to the docs, the changelog and the issue tracker.
+
+## 0.10.4 (2026-08-21)
+
+Full Changelog: [v0.10.3...v0.10.4](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.3...v0.10.4)
+
+### Documentation
+
+* Remove repeated SDK copy and repair public links.
+
 ## 0.10.3 (2026-08-21)
 
 Full Changelog: [v0.10.2...v0.10.3](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.2...v0.10.3)
@@ -273,8 +292,6 @@ Full Changelog: [v0.1.0...v0.2.0](https://github.com/Xquik-dev/x-twitter-scraper
 
 ## 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))

data/README.md

@@ -1,14 +1,22 @@
-# Xquik Ruby SDK: Twitter Search, Followers & X Automation
+# X API & Twitter API Ruby SDK by Xquik
 
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13739/badge)](https://www.bestpractices.dev/projects/13739)
 
-Use the Xquik Ruby SDK for Twitter search, timelines, profiles & followers.
-Manage media, webhooks & X automation with typed requests.
-Use documented Xquik REST routes as a Twitter API alternative.
+Use this X API & Twitter API SDK to work with X from Ruby.
+It works as a Twitter scraper & tweet scraper for search, profiles & followers.
+Scrape Twitter timelines, lists, communities & trends into typed results.
+Manage media, webhooks, monitors & X automation with typed requests.
+It provides a Twitter API alternative through documented Xquik REST routes.
+
+Xquik is the world's fastest and cheapest X Twitter scraper service with the most complete X data.
+Xquik charges only for delivered, unique, filter-matching results and never pads rows.
+
+> 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)
 
-## Common Twitter & X Tasks
+## Common Twitter & X tasks
 
 | Task | REST Route | Usage |
 | --- | --- | --- |
@@ -24,12 +32,14 @@ Use documented Xquik REST routes as a Twitter API alternative.
 
 ## Installation
 
-Add the gem to your `Gemfile`:
+Requires Ruby 3.2.0 or higher.
+
+Add the gem to your `Gemfile`.
 
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.10.3"
+gem "x-twitter-scraper", "~> 0.10.5"
 ```
 
 <!-- x-release-please-end -->
@@ -41,7 +51,7 @@ 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
+  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)
@@ -49,9 +59,9 @@ response = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
 puts(response)
 ```
 
-### Handling Errors
+### Handling errors
 
-The SDK raises an `APIError` subclass for connection failures and non-2xx responses:
+The SDK raises an `APIError` subclass for connection failures and non-2xx responses.
 
 ```ruby
 begin
@@ -67,8 +77,6 @@ rescue XTwitterScraper::Errors::APIStatusError => e
 end
 ```
 
-The SDK uses these error classes:
-
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
 | HTTP 400         | `BadRequestError`          |
@@ -87,40 +95,37 @@ The SDK uses these error classes:
 
 The SDK retries connection errors, timeouts & HTTP 408, 409, 429, and 5xx responses.
 It uses exponential backoff with 2 retries by default.
-Set `max_retries` to change or disable retries:
+Set `max_retries` to change or disable retries.
 
 ```ruby
-# Set the client default:
+# Change the client default.
 x_twitter_scraper = XTwitterScraper::Client.new(
-  max_retries: 0 # default is 2
+  max_retries: 0
 )
 
-# Override one request:
+# Override one request.
 x_twitter_scraper.account.retrieve(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
 
-Requests time out after 60 seconds. Set `timeout` to change or disable this limit:
+Requests time out after 60 seconds. Set `timeout` to change or disable this limit.
 
 ```ruby
-# Set the client default:
+# Change the client default.
 x_twitter_scraper = XTwitterScraper::Client.new(
-  timeout: nil # default is 60
+  timeout: nil
 )
 
-# Override one request:
+# Override one request.
 x_twitter_scraper.account.retrieve(request_options: {timeout: 5})
 ```
 
 Timeouts raise `XTwitterScraper::Errors::APITimeoutError` and follow the retry policy.
 
-## Advanced Concepts
-
-### BaseModel
+## BaseModel
 
-All parameter and response objects inherit from `XTwitterScraper::Internal::Type::BaseModel`.
-The base model provides these operations:
+All parameter and response objects inherit from `XTwitterScraper::Internal::Type::BaseModel` and support these operations.
 
 1. Access known and unknown fields with `obj[:prop]`.
 2. Destructure fields with `obj => {prop: prop}` or pattern matching.
@@ -128,7 +133,7 @@ The base model provides these operations:
 4. Print classes and instances in a readable format.
 5. Convert values with `#to_h`, `#deep_to_h`, `#to_json`, or `#to_yaml`.
 
-### Custom Requests
+## Custom requests
 
 Use `extra_query`, `extra_body`, or `extra_headers` under `request_options`.
 Matching `extra_` values override documented parameters.
@@ -146,7 +151,7 @@ account =
 puts(account[:my_undocumented_property])
 ```
 
-Use `client.request` for undocumented endpoints while retaining authentication and retries:
+Use `client.request` for undocumented endpoints while retaining authentication and retries.
 
 ```ruby
 response = client.request(
@@ -158,7 +163,7 @@ response = client.request(
 )
 ```
 
-### Concurrency & Connection Pooling
+## Concurrency & connection pooling
 
 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.
@@ -170,7 +175,7 @@ Other SDK classes do not lock their data.
 
 The gem ships [RBI](https://sorbet.org/docs/rbi) definitions without `sorbet-runtime`.
 
-Pass request hashes or typed parameter objects:
+Pass request hashes or typed parameter objects.
 
 ```ruby
 # Hashes work without type safety:
@@ -183,7 +188,7 @@ x_twitter_scraper.x.tweets.search(**params)
 
 ### Enums
 
-Tagged symbols replace [`T::Enum`](https://sorbet.org/docs/tenum) and remain runtime primitives:
+Tagged symbols replace [`T::Enum`](https://sorbet.org/docs/tenum) and remain runtime primitives.
 
 ```ruby
 # :en
@@ -193,7 +198,7 @@ puts(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
 T.reveal_type(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
 ```
 
-Enum parameters accept constants or literal values:
+Enum parameters accept constants or literal values.
 
 ```ruby
 # Enum constants preserve tagged type information:
@@ -215,17 +220,10 @@ This package follows [SemVer](https://semver.org/spec/v2.0.0.html). Version `0`
 
 Changes to non-runtime `*.rbi` and `*.rbs` definitions remain non-breaking.
 
-## Requirements
-
-Ruby 3.2.0 or higher.
-
-## Security & Support
+## Help & contributing
 
 - Report vulnerabilities through the [security policy](SECURITY.md).
 - Ask usage questions through the [organization support policy](https://github.com/Xquik-dev/.github/blob/main/SUPPORT.md).
-
-## Contributing
-
-Read the [contribution guide](CONTRIBUTING.md).
+- Read the [contribution guide](CONTRIBUTING.md).
 
 Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

data/SECURITY.md

@@ -1,10 +1,10 @@
-# Security Policy
+# Security policy
 
-## Supported Versions
+## Supported versions
 
 Security fixes target the latest published release.
 
-## Reporting A Vulnerability
+## Reporting a vulnerability
 
 Report vulnerabilities privately through
 [support@xquik.com](mailto:support@xquik.com).

data/lib/x_twitter_scraper/internal/type/base_model.rb

@@ -403,8 +403,8 @@ module XTwitterScraper
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
         # returned.
         #
-        # It is valid to lookup keys that are not in the API spec, for example to access
-        # undocumented features. This method does not parse response data into
+        # You may look up keys absent from the API spec, such as undocumented response fields.
+        # This method does not parse response data into
         # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         #
         # @param key [Symbol]

data/lib/x_twitter_scraper/internal/type/enum.rb

@@ -78,8 +78,7 @@ module XTwitterScraper
 
         # @api private
         #
-        # Unlike with primitives, `Enum` additionally validates that the value is a member
-        # of the enum.
+        # Unlike primitives, `Enum` validates membership.
         #
         # @param value [String, Symbol, Object]
         #

data/lib/x_twitter_scraper/request_options.rb

@@ -37,16 +37,14 @@ module XTwitterScraper
     optional :idempotency_key, String
 
     # @!attribute extra_query
-    #   Extra query params to send with the request. These are `.merge`’d into any
-    #   `query` given at the client level.
+    #   Extra query params merge into any `query` given at the client level.
     #
     #   @return [Hash{String=>Array<String>, String, nil}, nil]
     optional :extra_query,
              XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::ArrayOf[String]]
 
     # @!attribute extra_headers
-    #   Extra headers to send with the request. These are `.merged`’d into any
-    #   `extra_headers` given at the client level.
+    #   Extra headers merge into any `extra_headers` given at the client level.
     #
     #   @return [Hash{String=>String, nil}, nil]
     optional :extra_headers, XTwitterScraper::Internal::Type::HashOf[String, nil?: true]

data/lib/x_twitter_scraper/resources/monitors/keywords.rb

@@ -10,7 +10,7 @@ module XTwitterScraper
       # X account monitoring with 1-second checks
       class Keywords
         # Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
-        # every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+        # every 1 second and cost 30 credits per hour. Events and webhook deliveries are
         # included. Creation requires available credits for the first hourly charge.
         #
         # @overload create(event_types:, query:, request_options: {})

data/lib/x_twitter_scraper/resources/monitors.rb

@@ -13,7 +13,7 @@ module XTwitterScraper
       attr_reader :keywords
 
       # Creates an account monitor. Monitors are unlimited. Active monitors check every
-      # 1 second and cost 21 credits per hour. Events and webhook deliveries are
+      # 1 second and cost 30 credits per hour. Events and webhook deliveries are
       # included. Creation requires available credits for the first hourly charge and
       # username lookup.
       #

data/lib/x_twitter_scraper/version.rb

@@ -5,5 +5,5 @@
 # frozen_string_literal: true
 
 module XTwitterScraper
-  VERSION = "0.10.3"
+  VERSION = "0.10.5"
 end

data/rbi/x_twitter_scraper/request_options.rbi

@@ -29,8 +29,7 @@ module XTwitterScraper
     sig { returns(T.nilable(String)) }
     attr_accessor :idempotency_key
 
-    # Extra query params to send with the request. These are `.merge`’d into any
-    # `query` given at the client level.
+    # Extra query params merge into any `query` given at the client level.
     sig do
       returns(
         T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
@@ -38,8 +37,7 @@ module XTwitterScraper
     end
     attr_accessor :extra_query
 
-    # Extra headers to send with the request. These are `.merged`’d into any
-    # `extra_headers` given at the client level.
+    # Extra headers merge into any `extra_headers` given at the client level.
     sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
     attr_accessor :extra_headers
 

data/rbi/x_twitter_scraper/resources/monitors/keywords.rbi

@@ -10,7 +10,7 @@ module XTwitterScraper
       # X account monitoring with 1-second checks
       class Keywords
         # Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
-        # every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+        # every 1 second and cost 30 credits per hour. Events and webhook deliveries are
         # included. Creation requires available credits for the first hourly charge.
         sig do
           params(

data/rbi/x_twitter_scraper/resources/monitors.rbi

@@ -13,7 +13,7 @@ module XTwitterScraper
       attr_reader :keywords
 
       # Creates an account monitor. Monitors are unlimited. Active monitors check every
-      # 1 second and cost 21 credits per hour. Events and webhook deliveries are
+      # 1 second and cost 30 credits per hour. Events and webhook deliveries are
       # included. Creation requires available credits for the first hourly charge and
       # username lookup.
       sig do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: x-twitter-scraper
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.5
 platform: ruby
 authors:
 - Xquik
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -51,6 +51,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description: X API & Twitter API SDK for Ruby by Xquik. Scrape Twitter search, timelines,
+  profiles & followers as a typed Twitter scraper & tweet scraper. Manage media, webhooks,
+  monitors & X automation through documented Xquik REST routes. Xquik is the world's
+  fastest and cheapest X Twitter scraper service with the most complete X data. Not
+  affiliated with X Corp.
 email: support@xquik.com
 executables: []
 extensions: []
@@ -955,6 +960,9 @@ licenses:
 metadata:
   homepage_uri: https://docs.xquik.com/sdks/ruby
   source_code_uri: https://github.com/Xquik-dev/x-twitter-scraper-ruby
+  documentation_uri: https://docs.xquik.com/api-reference/overview
+  changelog_uri: https://github.com/Xquik-dev/x-twitter-scraper-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/Xquik-dev/x-twitter-scraper-ruby/issues
   rubygems_mfa_required: 'false'
 rdoc_options: []
 require_paths:
@@ -970,8 +978,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.11
 specification_version: 4
-summary: Ruby SDK for Twitter search, followers, webhooks & X automation. Not affiliated
-  with X Corp.
+summary: X API & Twitter API SDK for Ruby. Scrape Twitter search, profiles & followers
+  as a Twitter scraper & tweet scraper. Not affiliated with X Corp.
 test_files: []