x-twitter-scraper 0.10.2 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eed85b02b44c9bcefbbec637c0063d3f95038d8951f30108ad4ab3853a60335
-  data.tar.gz: 3b26cbff158153d925e414d3b8fea75ae087b49d96014125a96c2c7e7b9a7667
+  metadata.gz: 7f4f7490097e2a6d503e322f7cc58ad97ee1969eb5d63630b51cabba1e1475fa
+  data.tar.gz: e4d5168613a265fda0cf590313d0f636dad69fdde68cf01a62b117bc74669830
 SHA512:
-  metadata.gz: 0b0f8c7ba5e866d08cb7fcf488481639e4026b08ae56e9a47e8b5919ad6be2f88b09485b9783b310aab837e7faa9aa07d2b12d3ebcbf22d7df2bca20ce2bde80
-  data.tar.gz: 2d0eda060f2b3e5433951ab27fe1b12c48ffb083b989a53c8944edb68e31ae4ce0d39cdcd682b0aad76205441fc7cb35147a4398ce6ccb93e729de655d1c22af
+  metadata.gz: 25f7299ef958d3305df6f392af953a70b87aa1ae639486a90416e49c84fe27faaddd6472f4ba42349c6daf71353143f5a54026904321be69c115abbf63e93fdd
+  data.tar.gz: b34e28eba91790af3eb1e585156557ffd631fefd835cc9b1d84b5a8a35e7b81c7b78a8e1a0d7bcbc08e5db872ec2295b1866fede239f4a634d5005450fd09d43

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 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)
+
+### 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)
@@ -261,8 +281,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,18 +1,14 @@
-# Xquik Ruby SDK: Twitter Search, Followers & X Automation
+# 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 the Xquik Ruby SDK for Twitter search, timelines, profiles & followers. Manage media, webhooks & X automation with typed request objects. It provides a Twitter API alternative through documented Xquik REST routes.
+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.
 
 [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)
 
-## Choose the Ruby SDK
-
-Choose this gem for Ruby services that use Sorbet or RBS. Reuse one client for pooled connections.
-
-## Common Twitter & X Tasks
-
-Map each task to its REST route.
+## Common Twitter & X tasks
 
 | Task | REST Route | Usage |
 | --- | --- | --- |
@@ -28,12 +24,14 @@ Map each task to its REST route.
 
 ## Installation
 
+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.2"
+gem "x-twitter-scraper", "~> 0.10.4"
 ```
 
 <!-- x-release-please-end -->
@@ -45,7 +43,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)
@@ -53,7 +51,7 @@ 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:
 
@@ -66,13 +64,11 @@ rescue XTwitterScraper::Errors::APIConnectionError => e
 rescue XTwitterScraper::Errors::RateLimitError => e
   puts("Rate limited. Retry later.")
 rescue XTwitterScraper::Errors::APIStatusError => e
-  puts("The server returned another non-2xx status.")
+  puts("Request failed. Inspect the returned HTTP status.")
   puts(e.status)
 end
 ```
 
-The SDK uses these error classes:
-
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
 | HTTP 400         | `BadRequestError`          |
@@ -89,17 +85,17 @@ The SDK uses these error classes:
 
 ### Retries
 
-The SDK retries connection errors, timeouts, and HTTP 408, 409, 429, and 5xx responses.
-It uses exponential backoff and attempts 2 retries by default.
+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
-# 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})
 ```
 
@@ -108,25 +104,20 @@ x_twitter_scraper.account.retrieve(request_options: {max_retries: 5})
 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})
 ```
 
-On timeout, `XTwitterScraper::Errors::APITimeoutError` is raised.
-
-Timed-out requests follow the default retry policy.
+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:
 
 1. Access known and unknown fields with `obj[:prop]`.
 2. Destructure fields with `obj => {prop: prop}` or pattern matching.
@@ -134,13 +125,10 @@ 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`.
 
-### Making Custom or Undocumented Requests
-
-#### Undocumented Properties
+## Custom requests
 
-Send undocumented parameters and read undocumented response properties:
-
-A matching `extra_` option overrides its documented parameter.
+Use `extra_query`, `extra_body`, or `extra_headers` under `request_options`.
+Matching `extra_` values override documented parameters.
 
 ```ruby
 account =
@@ -155,12 +143,6 @@ account =
 puts(account[:my_undocumented_property])
 ```
 
-#### Undocumented Request Parameters
-
-Pass extra values through `extra_query`, `extra_body`, or `extra_headers` under `request_options:`.
-
-#### Undocumented Endpoints
-
 Use `client.request` for undocumented endpoints while retaining authentication and retries:
 
 ```ruby
@@ -173,7 +155,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.
@@ -183,7 +165,7 @@ 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`.
+The gem ships [RBI](https://sorbet.org/docs/rbi) definitions without `sorbet-runtime`.
 
 Pass request hashes or typed parameter objects:
 
@@ -198,8 +180,7 @@ x_twitter_scraper.x.tweets.search(**params)
 
 ### Enums
 
-The SDK does not depend on `sorbet-runtime` or provide [`T::Enum`](https://sorbet.org/docs/tenum) instances.
-It uses tagged symbols, which remain primitives at runtime:
+Tagged symbols replace [`T::Enum`](https://sorbet.org/docs/tenum) and remain runtime primitives:
 
 ```ruby
 # :en
@@ -231,17 +212,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
-
-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

@@ -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/version.rb

@@ -5,5 +5,5 @@
 # frozen_string_literal: true
 
 module XTwitterScraper
-  VERSION = "0.10.2"
+  VERSION = "0.10.4"
 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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x-twitter-scraper
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.4
 platform: ruby
 authors:
 - Xquik