x-twitter-scraper 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555fec62a3933481fdd9a81c890b5b98a5057b4cb63463c758c5e080a2fca0e9
-  data.tar.gz: 5df2449756eb4b073f9be3470251ea85e31a314027598c4f4df3faf9f47a348b
+  metadata.gz: 720e81b23d31d986e70ddeb1fc6b1957ac6153b0215acc5e54db342266a2d373
+  data.tar.gz: 98e135d7941dd8f7e7d08ee757d73a845b880bcba3159d0b316dab17d88a61b2
 SHA512:
-  metadata.gz: 70841e5323433e367cfad34d01cf3df821255dea9c5882cd7ba0f3ae256da4320be7d2f2d29b1a0a62803b43e5bd0bc163a867fbb83adf019d78a38465640140
-  data.tar.gz: b0f929e18ba74d8341e5a5dc1153a099159e55a66c11fb799646aea7182e2e42c4bc2fbefa8b8ee60940574d1f6bd1d32ebc5db265cfe530c9b76cadb4399c5c
+  metadata.gz: 345212dd7d32857b46c287776fca45f863c943ecfd5f78c059b841516493025be1cfe63ab00036a7bd08bec4c976a94c05816df1e56bc242ca50968966b7d5b7
+  data.tar.gz: 2afd1eaf5e26ea50b462356a8ce83fe6e54ce8194215b4041b886035cdaac57851f6d24cee42ede87f447f1328f5e8a402c99c7ac4499479a421a0d4543f6ed4

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.4.4 (2026-07-14)
+
+Full Changelog: [v0.4.3...v0.4.4](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.4.3...v0.4.4)
+
+### Features
+
+* regenerate the SDK from the finalized API contract
+* add guest wallets, credit top-ups, keyword monitors, webhook resume, account challenges, and write-action status
+* refresh current read and write request and response types
+
+### Security
+
+* retain OIDC trusted publishing and immutable GitHub Actions pins
+
+## 0.4.3 (2026-07-14)
+
+Full Changelog: [v0.4.2...v0.4.3](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.4.2...v0.4.3)
+
+### Bug Fixes
+
+* identify the gem author as Xquik in published package metadata
+* declare base64 as a runtime dependency for Ruby 4 clean installs
+
 ## 0.4.2 (2026-07-14)
 
 Full Changelog: [v0.4.1...v0.4.2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.4.1...v0.4.2)

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 X Twitter Scraper
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -25,7 +25,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.4.2"
+gem "x-twitter-scraper", "~> 0.4.4"
 ```
 
 <!-- x-release-please-end -->
@@ -52,13 +52,13 @@ Request parameters that correspond to file uploads can be passed as raw contents
 ```ruby
 require "pathname"
 
-# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
+# Use `Pathname` to send the filename and avoid paging a large file into memory:
 response = x_twitter_scraper.x.media.upload(file: Pathname("/path/to/file"))
 
 # Alternatively, pass file contents or a `StringIO` directly:
 response = x_twitter_scraper.x.media.upload(file: File.read("/path/to/file"))
 
-# Or, to control the filename and/or content type:
+# Or, control the filename and content type:
 file =
   XTwitterScraper::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
 response = x_twitter_scraper.x.media.upload(file: file)
@@ -66,7 +66,7 @@ response = x_twitter_scraper.x.media.upload(file: file)
 puts(response.mediaId)
 ```
 
-Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+Passing a raw `IO` descriptor disables retries because pipes cannot be rewound safely.
 
 ### Handling errors
 
@@ -74,7 +74,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  tweet = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10)
+  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`
@@ -117,7 +117,7 @@ x_twitter_scraper = XTwitterScraper::Client.new(
 )
 
 # Or, configure per-request:
-x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10, request_options: {max_retries: 5})
+x_twitter_scraper.account.retrieve(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -131,7 +131,7 @@ x_twitter_scraper = XTwitterScraper::Client.new(
 )
 
 # Or, configure per-request:
-x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit: 10, request_options: {timeout: 5})
+x_twitter_scraper.account.retrieve(request_options: {timeout: 5})
 ```
 
 On timeout, `XTwitterScraper::Errors::APITimeoutError` is raised.
@@ -161,10 +161,8 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-paginated_tweets =
-  x_twitter_scraper.x.tweets.search(
-    q: "from:elonmusk",
-    limit: 10,
+account =
+  x_twitter_scraper.account.retrieve(
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -172,7 +170,7 @@ paginated_tweets =
     }
   )
 
-puts(paginated_tweets[:my_undocumented_property])
+puts(account[:my_undocumented_property])
 ```
 
 #### Undocumented request params

data/lib/x_twitter_scraper/client.rb

@@ -22,31 +22,27 @@ module XTwitterScraper
     # @return [String, nil]
     attr_reader :bearer_token
 
-    # Account info & settings
+    # Account info and settings
     # @return [XTwitterScraper::Resources::Account]
     attr_reader :account
 
-    # API key management (session auth only)
-    # @return [XTwitterScraper::Resources::APIKeys]
-    attr_reader :api_keys
-
-    # Subscription & billing
+    # Subscription, billing, and credits
     # @return [XTwitterScraper::Resources::Subscribe]
     attr_reader :subscribe
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     # @return [XTwitterScraper::Resources::Compose]
     attr_reader :compose
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     # @return [XTwitterScraper::Resources::Drafts]
     attr_reader :drafts
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     # @return [XTwitterScraper::Resources::Styles]
     attr_reader :styles
 
-    # Tweet composition, drafts, writing styles & radar
+    # AI tweet composition, drafts, writing styles, and radar
     # @return [XTwitterScraper::Resources::Radar]
     attr_reader :radar
 
@@ -58,7 +54,7 @@ module XTwitterScraper
     # @return [XTwitterScraper::Resources::Events]
     attr_reader :events
 
-    # Bulk data extraction (20 tool types)
+    # Bulk data extraction (23 tool types)
     # @return [XTwitterScraper::Resources::Extractions]
     attr_reader :extractions
 
@@ -66,32 +62,28 @@ module XTwitterScraper
     # @return [XTwitterScraper::Resources::Draws]
     attr_reader :draws
 
-    # Webhook endpoint management & delivery
+    # Webhook endpoint management and delivery
     # @return [XTwitterScraper::Resources::Webhooks]
     attr_reader :webhooks
 
-    # Push notification integrations (Telegram)
-    # @return [XTwitterScraper::Resources::Integrations]
-    attr_reader :integrations
-
-    # X data lookups (subscription required)
     # @return [XTwitterScraper::Resources::X]
     attr_reader :x
 
-    # Trending topics by region
+    # Trending topics and hashtags by region
     # @return [XTwitterScraper::Resources::Trends]
     attr_reader :trends
 
-    # @return [XTwitterScraper::Resources::Bot]
-    attr_reader :bot
-
     # @return [XTwitterScraper::Resources::Support]
     attr_reader :support
 
-    # Subscription & billing
+    # Subscription, billing, and credits
     # @return [XTwitterScraper::Resources::Credits]
     attr_reader :credits
 
+    # Accountless prepaid access for paid read endpoints
+    # @return [XTwitterScraper::Resources::GuestWallets]
+    attr_reader :guest_wallets
+
     # @api private
     #
     # @param security [Hash{Symbol=>Boolean}]
@@ -144,6 +136,19 @@ module XTwitterScraper
     )
       base_url ||= "https://xquik.com/api/v1"
 
+      headers = {}
+      custom_headers_env = ENV["X_TWITTER_SCRAPER_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key&.to_s
       @bearer_token = bearer_token&.to_s
 
@@ -152,11 +157,11 @@ module XTwitterScraper
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay
+        max_retry_delay: max_retry_delay,
+        headers: headers
       )
 
       @account = XTwitterScraper::Resources::Account.new(client: self)
-      @api_keys = XTwitterScraper::Resources::APIKeys.new(client: self)
       @subscribe = XTwitterScraper::Resources::Subscribe.new(client: self)
       @compose = XTwitterScraper::Resources::Compose.new(client: self)
       @drafts = XTwitterScraper::Resources::Drafts.new(client: self)
@@ -167,12 +172,11 @@ module XTwitterScraper
       @extractions = XTwitterScraper::Resources::Extractions.new(client: self)
       @draws = XTwitterScraper::Resources::Draws.new(client: self)
       @webhooks = XTwitterScraper::Resources::Webhooks.new(client: self)
-      @integrations = XTwitterScraper::Resources::Integrations.new(client: self)
       @x = XTwitterScraper::Resources::X.new(client: self)
       @trends = XTwitterScraper::Resources::Trends.new(client: self)
-      @bot = XTwitterScraper::Resources::Bot.new(client: self)
       @support = XTwitterScraper::Resources::Support.new(client: self)
       @credits = XTwitterScraper::Resources::Credits.new(client: self)
+      @guest_wallets = XTwitterScraper::Resources::GuestWallets.new(client: self)
     end
   end
 end

data/lib/x_twitter_scraper/internal/transport/base_client.rb

@@ -324,6 +324,11 @@ module XTwitterScraper
               XTwitterScraper::Internal::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
             end
 
+          # Generated methods always pass `req[:body]` for operations that define a
+          # request body, so only elide the content-type header when the operation
+          # has no body at all, not when an optional body param was omitted.
+          headers.delete("content-type") if body.nil? && !req.key?(:body)
+
           url = XTwitterScraper::Internal::Util.join_parsed_uri(
             @base_url_components,
             {**req, path: path, query: query}

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

@@ -443,9 +443,10 @@ module XTwitterScraper
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `error` is a `XTwitterScraper::Error`
-        #   error => {
-        #     error: error
+        #   # `content_disclosure` is a `XTwitterScraper::ContentDisclosure`
+        #   content_disclosure => {
+        #     advertising: advertising,
+        #     ai_generated: ai_generated
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/x_twitter_scraper/internal/util.rb

@@ -610,6 +610,7 @@ module XTwitterScraper
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -619,7 +620,7 @@ module XTwitterScraper
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || XTwitterScraper::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -635,6 +636,7 @@ module XTwitterScraper
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private