release: 0.10.4 (#53)

Author: Burak Bayır

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.10.3"
+  ".": "0.10.4"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)
@@ -273,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))

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-## Set Up
+## Set up
 
 The `.ruby-version` file works with rbenv and asdf's Ruby plugin.
 Install that Ruby version, then run:
@@ -11,13 +11,13 @@ Install that Ruby version, then run:
 
 Run `bundle exec rake` to list every task.
 
-## Generated Code
+## Generated code
 
 Most SDK files come from the API generator.
 Direct edits survive regeneration but can create conflicts.
 The generator never changes `lib/x_twitter_scraper/helpers/` or `examples/`.
 
-## Add Examples
+## Add examples
 
 Files under `examples/` remain handwritten.
 
@@ -35,7 +35,7 @@ chmod +x examples/<name>.rb
 ruby examples/<name>.rb
 ```
 
-## Use a Source Checkout
+## Use a source checkout
 
 Reference GitHub in your `Gemfile`:
 
@@ -49,7 +49,7 @@ Reference a local clone instead:
 gem "x-twitter-scraper", path: "<path-to-repo>"
 ```
 
-## Run Checks
+## Run checks
 
 ```bash
 bundle exec rake test
@@ -60,10 +60,9 @@ bundle exec rake docs:preview PORT=8808
 
 `format` rewrites files. `docs:preview` starts a local server.
 
-## Editor Support
+## Editor support
 
-Ruby LSP supports definition lookup. Solargraph supports completion.
-Install both to use both features.
+Install Ruby LSP for definition lookup and Solargraph for completion.
 
 Sorbet works here with 2 known caveats:
 

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    x-twitter-scraper (0.10.3)
+    x-twitter-scraper (0.10.4)
       base64
       cgi
       connection_pool

README.md

@@ -1,4 +1,4 @@
-# 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)
 
@@ -8,7 +8,7 @@ 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)
 
-## Common Twitter & X Tasks
+## Common Twitter & X tasks
 
 | Task | REST Route | Usage |
 | --- | --- | --- |
@@ -24,12 +24,14 @@ Use documented Xquik REST routes as a Twitter API alternative.
 
 ## 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.3"
+gem "x-twitter-scraper", "~> 0.10.4"
 ```
 
 <!-- x-release-please-end -->
@@ -41,15 +43,15 @@ 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)
 
 puts(response)
 ```
 
-### Handling Errors
+### Handling errors
 
 The SDK raises an `APIError` subclass for connection failures and non-2xx responses:
 
@@ -67,8 +69,6 @@ rescue XTwitterScraper::Errors::APIStatusError => e
 end
 ```
 
-The SDK uses these error classes:
-
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
 | HTTP 400         | `BadRequestError`          |
@@ -90,12 +90,12 @@ 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})
 ```
 
@@ -104,31 +104,28 @@ 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})
 ```
 
 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.
 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`.
 
-### Custom Requests
+## Custom requests
 
 Use `extra_query`, `extra_body`, or `extra_headers` under `request_options`.
 Matching `extra_` values override documented parameters.
@@ -158,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.
@@ -215,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
-
-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.

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).

lib/x_twitter_scraper/internal/type/base_model.rb

@@ -403,8 +403,8 @@ def recursively_to_h(model, convert:)
         # 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]

lib/x_twitter_scraper/internal/type/enum.rb

@@ -78,8 +78,7 @@ def hash = values.to_set.hash
 
         # @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]
         #

lib/x_twitter_scraper/request_options.rb

@@ -37,16 +37,14 @@ def self.validate!(opts)
     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]

lib/x_twitter_scraper/version.rb

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