x-twitter-scraper 0.10.2 → 0.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +14 -30
  4. data/lib/x_twitter_scraper/version.rb +1 -1
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2eed85b02b44c9bcefbbec637c0063d3f95038d8951f30108ad4ab3853a60335
4
- data.tar.gz: 3b26cbff158153d925e414d3b8fea75ae087b49d96014125a96c2c7e7b9a7667
3
+ metadata.gz: 377c00b19b9d19ebb8a350b172937dc5805869f1e7d500da6ec4fec43996d659
4
+ data.tar.gz: e57a1128b31495941ff65b3418c059d64c2afb3d7ae69de55b1ce45937a73c59
5
5
  SHA512:
6
- metadata.gz: 0b0f8c7ba5e866d08cb7fcf488481639e4026b08ae56e9a47e8b5919ad6be2f88b09485b9783b310aab837e7faa9aa07d2b12d3ebcbf22d7df2bca20ce2bde80
7
- data.tar.gz: 2d0eda060f2b3e5433951ab27fe1b12c48ffb083b989a53c8944edb68e31ae4ce0d39cdcd682b0aad76205441fc7cb35147a4398ce6ccb93e729de655d1c22af
6
+ metadata.gz: 81ef337f2a4176e1d855428f770bc6fd4f758f4512183c6284d8e07a2d44c2cd658c8b17e008c7f10bbf9dc56d3b4c224c518c91da46b2a7080fbab0a61ed6f7
7
+ data.tar.gz: 91c815184295402c9bb9a13317d7743942b8fcfa0c991324af1995064ed63748c9cb4cc052980fe479dda23591d21ee4c14fe21e9f351093a614b770ded2cf9d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.10.3 (2026-08-21)
4
+
5
+ Full Changelog: [v0.10.2...v0.10.3](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.2...v0.10.3)
6
+
7
+ ### Documentation
8
+
9
+ * tighten SDK and contribution guidance
10
+
11
+ ### Chores
12
+
13
+ * simplify repository comments and formatter output
14
+
3
15
  ## 0.10.2 (2026-08-20)
4
16
 
5
17
  Full Changelog: [v0.10.1...v0.10.2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.10.1...v0.10.2)
data/README.md CHANGED
@@ -2,18 +2,14 @@
2
2
 
3
3
  [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13739/badge)](https://www.bestpractices.dev/projects/13739)
4
4
 
5
- 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.
5
+ Use the Xquik Ruby SDK for Twitter search, timelines, profiles & followers.
6
+ Manage media, webhooks & X automation with typed requests.
7
+ Use documented Xquik REST routes as a Twitter API alternative.
6
8
 
7
9
  [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)
8
10
 
9
- ## Choose the Ruby SDK
10
-
11
- Choose this gem for Ruby services that use Sorbet or RBS. Reuse one client for pooled connections.
12
-
13
11
  ## Common Twitter & X Tasks
14
12
 
15
- Map each task to its REST route.
16
-
17
13
  | Task | REST Route | Usage |
18
14
  | --- | --- | --- |
19
15
  | Search tweets without the X API | `GET /x/tweets/search` | Use keyword or advanced operator queries. |
@@ -33,7 +29,7 @@ Add the gem to your `Gemfile`:
33
29
  <!-- x-release-please-start-version -->
34
30
 
35
31
  ```ruby
36
- gem "x-twitter-scraper", "~> 0.10.2"
32
+ gem "x-twitter-scraper", "~> 0.10.3"
37
33
  ```
38
34
 
39
35
  <!-- x-release-please-end -->
@@ -66,7 +62,7 @@ rescue XTwitterScraper::Errors::APIConnectionError => e
66
62
  rescue XTwitterScraper::Errors::RateLimitError => e
67
63
  puts("Rate limited. Retry later.")
68
64
  rescue XTwitterScraper::Errors::APIStatusError => e
69
- puts("The server returned another non-2xx status.")
65
+ puts("Request failed. Inspect the returned HTTP status.")
70
66
  puts(e.status)
71
67
  end
72
68
  ```
@@ -89,8 +85,8 @@ The SDK uses these error classes:
89
85
 
90
86
  ### Retries
91
87
 
92
- The SDK retries connection errors, timeouts, and HTTP 408, 409, 429, and 5xx responses.
93
- It uses exponential backoff and attempts 2 retries by default.
88
+ The SDK retries connection errors, timeouts & HTTP 408, 409, 429, and 5xx responses.
89
+ It uses exponential backoff with 2 retries by default.
94
90
  Set `max_retries` to change or disable retries:
95
91
 
96
92
  ```ruby
@@ -117,9 +113,7 @@ x_twitter_scraper = XTwitterScraper::Client.new(
117
113
  x_twitter_scraper.account.retrieve(request_options: {timeout: 5})
118
114
  ```
119
115
 
120
- On timeout, `XTwitterScraper::Errors::APITimeoutError` is raised.
121
-
122
- Timed-out requests follow the default retry policy.
116
+ Timeouts raise `XTwitterScraper::Errors::APITimeoutError` and follow the retry policy.
123
117
 
124
118
  ## Advanced Concepts
125
119
 
@@ -134,13 +128,10 @@ The base model provides these operations:
134
128
  4. Print classes and instances in a readable format.
135
129
  5. Convert values with `#to_h`, `#deep_to_h`, `#to_json`, or `#to_yaml`.
136
130
 
137
- ### Making Custom or Undocumented Requests
138
-
139
- #### Undocumented Properties
131
+ ### Custom Requests
140
132
 
141
- Send undocumented parameters and read undocumented response properties:
142
-
143
- A matching `extra_` option overrides its documented parameter.
133
+ Use `extra_query`, `extra_body`, or `extra_headers` under `request_options`.
134
+ Matching `extra_` values override documented parameters.
144
135
 
145
136
  ```ruby
146
137
  account =
@@ -155,12 +146,6 @@ account =
155
146
  puts(account[:my_undocumented_property])
156
147
  ```
157
148
 
158
- #### Undocumented Request Parameters
159
-
160
- Pass extra values through `extra_query`, `extra_body`, or `extra_headers` under `request_options:`.
161
-
162
- #### Undocumented Endpoints
163
-
164
149
  Use `client.request` for undocumented endpoints while retaining authentication and retries:
165
150
 
166
151
  ```ruby
@@ -183,7 +168,7 @@ Other SDK classes do not lock their data.
183
168
 
184
169
  ## Sorbet
185
170
 
186
- The SDK includes [RBI](https://sorbet.org/docs/rbi) definitions. It does not depend on `sorbet-runtime`.
171
+ The gem ships [RBI](https://sorbet.org/docs/rbi) definitions without `sorbet-runtime`.
187
172
 
188
173
  Pass request hashes or typed parameter objects:
189
174
 
@@ -198,8 +183,7 @@ x_twitter_scraper.x.tweets.search(**params)
198
183
 
199
184
  ### Enums
200
185
 
201
- The SDK does not depend on `sorbet-runtime` or provide [`T::Enum`](https://sorbet.org/docs/tenum) instances.
202
- It uses tagged symbols, which remain primitives at runtime:
186
+ Tagged symbols replace [`T::Enum`](https://sorbet.org/docs/tenum) and remain runtime primitives:
203
187
 
204
188
  ```ruby
205
189
  # :en
@@ -242,6 +226,6 @@ Ruby 3.2.0 or higher.
242
226
 
243
227
  ## Contributing
244
228
 
245
- See [the contributing documentation](https://github.com/Xquik-dev/x-twitter-scraper-ruby/tree/main/CONTRIBUTING.md).
229
+ Read the [contribution guide](CONTRIBUTING.md).
246
230
 
247
231
  Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.
data/lib/x_twitter_scraper/version.rb CHANGED
@@ -5,5 +5,5 @@
5
5
  # frozen_string_literal: true
6
6
 
7
7
  module XTwitterScraper
8
- VERSION = "0.10.2"
8
+ VERSION = "0.10.3"
9
9
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: x-twitter-scraper
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.2
4
+ version: 0.10.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Xquik