x-twitter-scraper 0.10.1 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ed3b8240c037a3f99aca376db32637542303f31d4aa2e1ab3cbbd45e94e595
-  data.tar.gz: 3a04bda0ac118544b66225dd59839060d7032a159cbc0a80ea91bacc506c51c2
+  metadata.gz: 377c00b19b9d19ebb8a350b172937dc5805869f1e7d500da6ec4fec43996d659
+  data.tar.gz: e57a1128b31495941ff65b3418c059d64c2afb3d7ae69de55b1ce45937a73c59
 SHA512:
-  metadata.gz: 34ffbe878b79d348581e1b993c3e0745869e2dc3a629fd1519bdda9ab14874af696c74fac495d460813f27fe918b7aae50bd58bf8cc242989dbd05a09d1b55c1
-  data.tar.gz: c5286cb6368825d7a98c4bd48e50ac08c4f506898a991a3f6080ae1b1cd8d6c82fa38d0243716bdbfb86546ff22e1366273176d184e16b0b75a3bd3a6279d272
+  metadata.gz: 81ef337f2a4176e1d855428f770bc6fd4f758f4512183c6284d8e07a2d44c2cd658c8b17e008c7f10bbf9dc56d3b4c224c518c91da46b2a7080fbab0a61ed6f7
+  data.tar.gz: 91c815184295402c9bb9a13317d7743942b8fcfa0c991324af1995064ed63748c9cb4cc052980fe479dda23591d21ee4c14fe21e9f351093a614b770ded2cf9d

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 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)
+
+### Documentation
+
+* tighten SDK and contribution guidance
+
+### Chores
+
+* simplify repository comments and formatter output
+
+## 0.10.2 (2026-08-20)
+
+Full Changelog: [v0.10.1...v0.10.2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.1...v0.10.2)
+
+### Documentation
+
+* refine public Ruby SDK text ([#49](https://github.com/Xquik-dev/x-twitter-scraper-ruby/issues/49)) ([3d79615](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/3d79615cf4c1acc0ec8a6272d684302fe43e60dc))
+
 ## 0.10.1 (2026-08-18)
 
 Full Changelog: [v0.10.0...v0.10.1](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.0...v0.10.1)

data/README.md

@@ -1,32 +1,26 @@
-# X (Twitter) Scraper Ruby SDK: Tweet Search, Timelines, Followers & Posting
+# Xquik Ruby SDK: Twitter Search, Followers & X Automation
 
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13739/badge)](https://www.bestpractices.dev/projects/13739)
 
-Use Xquik's typed Ruby client for X data and confirmed actions.
+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.
 
-## Documentation
+[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)
 
-Read the [Ruby SDK guide](https://docs.xquik.com/sdks/ruby), [API guide](https://docs.xquik.com/api-reference/overview), or [RubyDoc reference](https://gemdocs.org/gems/x-twitter-scraper).
+## Common Twitter & X Tasks
 
-## Choose the Ruby SDK
-
-Choose this gem for Ruby services using typed request objects and Sorbet.
-Reuse one client for connection pooling in threaded applications.
-Use the SDK guide for generated method names.
-
-## Common X Data Tasks
-
-Use the linked Ruby reference for typed method names.
-
-| Customer Question | REST Route | Workflow Note |
+| Task | REST Route | Usage |
 | --- | --- | --- |
-| How do I search tweets? | `GET /x/tweets/search` | Use keyword or advanced operator queries. |
-| How do I read a profile timeline? | `GET /x/users/{id}/tweets` | Paginate bounded results. |
-| How do I scrape followers? | `GET /x/users/{id}/followers` | Use an extraction for complete datasets. |
-| How do I scrape following accounts? | `GET /x/users/{id}/following` | Use an extraction for complete datasets. |
-| How do I read my home timeline? | `GET /x/timeline` | Approve this private read. |
-| How do I monitor an account? | `POST /monitors` | Deliver events through HMAC webhooks. |
-| How do I post or reply? | `POST /x/tweets` | Confirm the account and payload. |
+| 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. |
+| Scrape Twitter followers | `GET /x/users/{id}/followers` | Use an extraction for complete datasets. |
+| Scrape following accounts | `GET /x/users/{id}/following` | Use an extraction for complete datasets. |
+| Read a home timeline | `GET /x/timeline` | Approve this private read. |
+| Export large X datasets | `POST /extractions` | Poll status, then download results. |
+| Download or upload media | `/x/media/*` | Use typed file helpers. |
+| Monitor an account | `POST /monitors` | Deliver events through HMAC webhooks. |
+| Post or reply | `POST /x/tweets` | Confirm the account and payload. |
 
 ## Installation
 
@@ -35,7 +29,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.10.1"
+gem "x-twitter-scraper", "~> 0.10.3"
 ```
 
 <!-- x-release-please-end -->
@@ -55,25 +49,25 @@ response = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
 puts(response)
 ```
 
-### Handling errors
+### 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:
+The SDK raises an `APIError` subclass for connection failures and non-2xx responses:
 
 ```ruby
 begin
   account = x_twitter_scraper.account.retrieve
 rescue XTwitterScraper::Errors::APIConnectionError => e
-  puts("The server could not be reached")
-  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+  puts("Could not reach the server. Check the connection.")
+  puts(e.cause)  # Underlying net/http exception.
 rescue XTwitterScraper::Errors::RateLimitError => e
-  puts("A 429 status code was received; we should back off a bit.")
+  puts("Rate limited. Retry later.")
 rescue XTwitterScraper::Errors::APIStatusError => e
-  puts("Another non-200-range status code was received")
+  puts("Request failed. Inspect the returned HTTP status.")
   puts(e.status)
 end
 ```
 
-Error codes are as follows:
+The SDK uses these error classes:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -91,61 +85,53 @@ Error codes are as follows:
 
 ### 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:
+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:
 
 ```ruby
-# Configure the default for all requests:
+# Set the client default:
 x_twitter_scraper = XTwitterScraper::Client.new(
   max_retries: 0 # default is 2
 )
 
-# Or, configure per-request:
+# Override one request:
 x_twitter_scraper.account.retrieve(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:
+Requests time out after 60 seconds. Set `timeout` to change or disable this limit:
 
 ```ruby
-# Configure the default for all requests:
+# Set the client default:
 x_twitter_scraper = XTwitterScraper::Client.new(
   timeout: nil # default is 60
 )
 
-# Or, configure per-request:
+# Override one request:
 x_twitter_scraper.account.retrieve(request_options: {timeout: 5})
 ```
 
-On timeout, `XTwitterScraper::Errors::APITimeoutError` is raised.
+Timeouts raise `XTwitterScraper::Errors::APITimeoutError` and follow the retry policy.
 
-Note that requests that time out are retried by default.
-
-## Advanced concepts
+## 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
+All parameter and response objects inherit from `XTwitterScraper::Internal::Type::BaseModel`.
+The base model provides these operations:
 
-#### Undocumented properties
+1. Access known and unknown fields with `obj[:prop]`.
+2. Destructure fields with `obj => {prop: prop}` or pattern matching.
+3. Compare objects by their field values with `==`.
+4. Print classes and instances in a readable format.
+5. Convert values with `#to_h`, `#deep_to_h`, `#to_json`, or `#to_yaml`.
 
-You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+### Custom Requests
 
-Note: the `extra_` parameters of the same name overrides the documented parameters.
+Use `extra_query`, `extra_body`, or `extra_headers` under `request_options`.
+Matching `extra_` values override documented parameters.
 
 ```ruby
 account =
@@ -160,13 +146,7 @@ account =
 puts(account[: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:
+Use `client.request` for undocumented endpoints while retaining authentication and retries:
 
 ```ruby
 response = client.request(
@@ -178,40 +158,32 @@ response = client.request(
 )
 ```
 
-### 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.
+### Concurrency & Connection Pooling
 
-Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+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.
+Requests wait when every connection is busy. This wait counts toward the request timeout.
+Other SDK classes do not lock their data.
 
 ## Sorbet
 
-The SDK includes [RBI](https://sorbet.org/docs/rbi) definitions. It does not depend on `sorbet-runtime`.
-
-You can provide typesafe request parameters like so:
-
-```ruby
-x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
-```
+The gem ships [RBI](https://sorbet.org/docs/rbi) definitions without `sorbet-runtime`.
 
-Or, equivalently:
+Pass request hashes or typed parameter objects:
 
 ```ruby
-# Hashes work, but are not typesafe:
+# Hashes work without type safety:
 x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
 
-# You can also splat a full Params class:
+# Splat a complete Params object:
 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:
+Tagged symbols replace [`T::Enum`](https://sorbet.org/docs/tenum) and remain runtime primitives:
 
 ```ruby
 # :en
@@ -221,16 +193,16 @@ puts(XTwitterScraper::AccountUpdateLocaleParams::Locale::EN)
 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:
+Enum parameters accept constants or literal values:
 
 ```ruby
-# Using the enum constants preserves the tagged type information:
+# Enum constants preserve tagged type information:
 x_twitter_scraper.account.update_locale(
   locale: XTwitterScraper::AccountUpdateLocaleParams::Locale::EN,
   # …
 )
 
-# Literal values are also permissible:
+# Literal values also work:
 x_twitter_scraper.account.update_locale(
   locale: :en,
   # …
@@ -239,9 +211,9 @@ x_twitter_scraper.account.update_locale(
 
 ## 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 follows [SemVer](https://semver.org/spec/v2.0.0.html). Version `0` releases may change APIs.
 
-This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+Changes to non-runtime `*.rbi` and `*.rbs` definitions remain non-breaking.
 
 ## Requirements
 
@@ -254,6 +226,6 @@ Ruby 3.2.0 or higher.
 
 ## Contributing
 
-See [the contributing documentation](https://github.com/Xquik-dev/x-twitter-scraper-ruby/tree/main/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

@@ -12,8 +12,8 @@ Report vulnerabilities privately through
 Do not open public issues for secrets, credential handling defects, private
 data exposure, or package supply-chain concerns.
 
-We aim to acknowledge reports within 3 business days. We will coordinate a
-disclosure timeline after confirming the issue.
+Maintainers acknowledge reports within 3 business days.
+We coordinate disclosure after confirming the issue.
 
 ## Scope
 

data/lib/x_twitter_scraper/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x-twitter-scraper
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.3
 platform: ruby
 authors:
 - Xquik
@@ -972,5 +972,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: Ruby SDK for the Xquik API
+summary: Ruby SDK for Twitter search, followers, webhooks & X automation. Not affiliated
+  with X Corp.
 test_files: []