x-twitter-scraper 0.4.5 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96a110a16a759489aa7803fe46b1f93e8e4a2fa1b98c5aa30e56e56adb2cb53f
-  data.tar.gz: e73def41689f49e3adb3abcb4ef37e16c9bfc6de4627982496bdde73604484a0
+  metadata.gz: 8fa98c5d4ef5480cdd4fa0c729abf871cea84f607cb2d2094ca3473b9a8ec091
+  data.tar.gz: 0c8306194c89096f355018670d4028407e3a8a5047b38912ffbca97d59d5f95e
 SHA512:
-  metadata.gz: dc1952fa0e535871074858d27da39385649d9cb207af6c81ea5e2913e32d5d30e8148f9368bef3cf7ac90dc8dcc9da86ea8a99c5a962206e4c9ac472790ffc9f
-  data.tar.gz: ef72e6f46a8498788f4d90b2fa77eb640fbe477335f8cab300b9d62117dd060437a8f240d83b91eede2af39c238b767997f32c6db135c3792629a3012f64d406
+  metadata.gz: 8fd5b815d6407c517515ed2fdf74d2c05bd9bf4a60917aca2f94424496ea2e69d9fe4064c4c11ac1414f2cbdad18d67bf3a5aa942664247d34139305fd77ef08
+  data.tar.gz: 5b2f06d0f6d88d796859dadcfb7ba4dc8ca7d0bf711c24c8c5c47c310c63ef966a89aea2ba299637ce2181ec2f363445ce60085fdeaa73e2f4ea7497f6c23387

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 0.5.2 (2026-07-22)
+
+Full Changelog: [v0.5.1...v0.5.2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.5.1...v0.5.2)
+
+## 0.5.1 (2026-07-22)
+
+Full Changelog: [v0.5.0...v0.5.1](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.5.0...v0.5.1)
+
+### Chores
+
+* sync generated SDK contracts ([855299c](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/855299c5db85833679c9377a9ba90b1c349d5a44))
+* verify final public contract ([b91af35](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/b91af355fc06443c5fcacca4ad6ade560577ddf2))
+
+## 0.5.0 (2026-07-22)
+
+Full Changelog: [v0.4.5...v0.5.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.4.5...v0.5.0)
+
+### Features
+
+* **api:** propagate durable write actions ([b959adc](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/b959adc349d87f75be1dfb858c92479c637588d8))
+* **api:** propagate production write-action contract ([b433f8d](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/b433f8d824bcb1ca60592d21d9f90b8baa79878a))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([9ad8d7c](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/9ad8d7c87cdd91232cf5ba76a5f5022d43cb7348))
+
+
+### Bug Fixes
+
+* **client:** elide content type header on requests without body ([b0186db](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/b0186db54e9074f563ae6528506fbd12d607d607))
+
+
+### Chores
+
+* **deps:** support connection_pool 3 ([ad578c2](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/ad578c2453ff451f3317606f542baa491267a250))
+
 ## 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)

data/README.md

@@ -1,31 +1,19 @@
-# X (Twitter) Scraper Ruby SDK: Tweet Search, Profile Tweets, Followers & Posting
+# Xquik Ruby SDK
 
-> **Xquik is an independent third-party service.** Not affiliated with X Corp.
-> "Twitter" and "X" are trademarks of X Corp.
-
-[![Ask DeepWiki](https://deepwiki.com/badge.svg?url=https%3A%2F%2Fgithub.com%2FXquik-dev%2Fx-twitter-scraper-ruby)](https://deepwiki.com/Xquik-dev/x-twitter-scraper-ruby)
-[![Skills.sh x-twitter-scraper Skill](https://skills.sh/b/xquik-dev/x-twitter-scraper)](https://skills.sh/xquik-dev/x-twitter-scraper)
-
-The Xquik Ruby SDK is a Twitter API SDK and X API alternative for tweet search, advanced Twitter search queries, profile tweets, user lookup, follower export, media download, media upload, monitoring, webhooks, and posting automation.
-
-Use it from Ruby 3.2.0+ applications to get tweets from profiles, search tweets by keyword or operator query, send tweets, post replies, like, repost, follow, DM, run giveaway draws, and automate X workflows. It ships with comprehensive types and docstrings in Yard, RBS, and RBI. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
-
-It is generated with [Stainless](https://www.stainless.com/).
+Use the Xquik API from Ruby 3.2+. The SDK includes Yard, RBS, and RBI types. It uses `net/http` with connection pooling.
 
 ## Documentation
 
-Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/x-twitter-scraper).
-
-The REST API documentation can be found on [xquik.com](https://xquik.com).
+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).
 
 ## Installation
 
-To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+Add the gem to your `Gemfile`:
 
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.4.5"
+gem "x-twitter-scraper", "~> 0.5.2"
 ```
 
 <!-- x-release-please-end -->
@@ -45,29 +33,6 @@ paginated_tweets = x_twitter_scraper.x.tweets.search(q: "from:elonmusk", limit:
 puts(paginated_tweets.has_next_page)
 ```
 
-### File uploads
-
-Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
-
-```ruby
-require "pathname"
-
-# 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, 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)
-
-puts(response.mediaId)
-```
-
-Passing a raw `IO` descriptor disables retries because pipes cannot be rewound safely.
-
 ### 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:
@@ -203,7 +168,7 @@ Unless otherwise specified, other classes in the SDK do not have locks protectin
 
 ## Sorbet
 
-This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+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:
 
@@ -263,3 +228,5 @@ Ruby 3.2.0 or higher.
 ## Contributing
 
 See [the contributing documentation](https://github.com/Xquik-dev/x-twitter-scraper-ruby/tree/main/CONTRIBUTING.md).
+
+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/client.rb

@@ -46,7 +46,7 @@ module XTwitterScraper
     # @return [XTwitterScraper::Resources::Radar]
     attr_reader :radar
 
-    # Real-time X account monitoring
+    # X account monitoring with 1-second checks
     # @return [XTwitterScraper::Resources::Monitors]
     attr_reader :monitors
 

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

@@ -4,6 +4,19 @@ module XTwitterScraper
   module Internal
     module Type
       # @api private
+      #
+      # @example
+      #   # `compose_create_response` is a `XTwitterScraper::Models::ComposeCreateResponse`
+      #   case compose_create_response
+      #   when XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult
+      #     puts(compose_create_response.content_rules)
+      #   when XTwitterScraper::Models::ComposeCreateResponse::ComposeRefineResult
+      #     puts(compose_create_response.composition_guidance)
+      #   when XTwitterScraper::Models::ComposeCreateResponse::ComposeScoreResult
+      #     puts(compose_create_response.checklist)
+      #   else
+      #     puts(compose_create_response)
+      #   end
       module Union
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport

data/lib/x_twitter_scraper/models/account_retrieve_response.rb

@@ -74,13 +74,13 @@ module XTwitterScraper
         required :active_hourly_burn, String, api_name: :activeHourlyBurn
 
         # @!attribute credits_per_active_monitor_day
-        #   Estimated daily credits for 1 active instant monitor.
+        #   Rounded daily estimate for 1 active monitor.
         #
         #   @return [String]
         required :credits_per_active_monitor_day, String, api_name: :creditsPerActiveMonitorDay
 
         # @!attribute credits_per_active_monitor_hour
-        #   Hourly credits charged for 1 active instant monitor.
+        #   Hourly credits charged for 1 active monitor.
         #
         #   @return [String]
         required :credits_per_active_monitor_hour, String, api_name: :creditsPerActiveMonitorHour
@@ -108,9 +108,9 @@ module XTwitterScraper
         #
         #   @param active_hourly_burn [String] Credits charged each hour for currently active monitors.
         #
-        #   @param credits_per_active_monitor_day [String] Estimated daily credits for 1 active instant monitor.
+        #   @param credits_per_active_monitor_day [String] Rounded daily estimate for 1 active monitor.
         #
-        #   @param credits_per_active_monitor_hour [String] Hourly credits charged for 1 active instant monitor.
+        #   @param credits_per_active_monitor_hour [String] Hourly credits charged for 1 active monitor.
         #
         #   @param events_included [Boolean] Webhook and event deliveries are included in monitor billing.
         #

data/lib/x_twitter_scraper/models/compose_create_params.rb

@@ -7,132 +7,204 @@ module XTwitterScraper
       extend XTwitterScraper::Internal::Type::RequestParameters::Converter
       include XTwitterScraper::Internal::Type::RequestParameters
 
-      # @!attribute step
-      #   Workflow step
+      # @!attribute body
       #
-      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Step]
-      required :step, enum: -> { XTwitterScraper::ComposeCreateParams::Step }
+      #   @return [XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeScoreRequest]
+      required :body, union: -> { XTwitterScraper::ComposeCreateParams::Body }
 
-      # @!attribute additional_context
-      #   Extra context or URLs (refine)
-      #
-      #   @return [String, nil]
-      optional :additional_context, String, api_name: :additionalContext
-
-      # @!attribute call_to_action
-      #   Desired call to action (refine)
-      #
-      #   @return [String, nil]
-      optional :call_to_action, String, api_name: :callToAction
-
-      # @!attribute draft
-      #   Tweet draft text to evaluate (score)
-      #
-      #   @return [String, nil]
-      optional :draft, String
-
-      # @!attribute goal
-      #   Optimization goal
-      #
-      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Goal, nil]
-      optional :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Goal }
-
-      # @!attribute has_link
-      #   Whether a link is attached (score)
-      #
-      #   @return [Boolean, nil]
-      optional :has_link, XTwitterScraper::Internal::Type::Boolean, api_name: :hasLink
-
-      # @!attribute has_media
-      #   Whether media is attached (score)
-      #
-      #   @return [Boolean, nil]
-      optional :has_media, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMedia
-
-      # @!attribute media_type
-      #   Media type (refine)
-      #
-      #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::MediaType, nil]
-      optional :media_type, enum: -> { XTwitterScraper::ComposeCreateParams::MediaType }, api_name: :mediaType
-
-      # @!attribute style_username
-      #   Cached style username for voice matching (compose)
-      #
-      #   @return [String, nil]
-      optional :style_username, String, api_name: :styleUsername
-
-      # @!attribute tone
-      #   Desired tone (refine)
-      #
-      #   @return [String, nil]
-      optional :tone, String
-
-      # @!attribute topic
-      #   Tweet topic (compose, refine)
-      #
-      #   @return [String, nil]
-      optional :topic, String
-
-      # @!method initialize(step:, additional_context: nil, call_to_action: nil, draft: nil, goal: nil, has_link: nil, has_media: nil, media_type: nil, style_username: nil, tone: nil, topic: nil, request_options: {})
-      #   @param step [Symbol, XTwitterScraper::Models::ComposeCreateParams::Step] Workflow step
-      #
-      #   @param additional_context [String] Extra context or URLs (refine)
-      #
-      #   @param call_to_action [String] Desired call to action (refine)
-      #
-      #   @param draft [String] Tweet draft text to evaluate (score)
-      #
-      #   @param goal [Symbol, XTwitterScraper::Models::ComposeCreateParams::Goal] Optimization goal
-      #
-      #   @param has_link [Boolean] Whether a link is attached (score)
-      #
-      #   @param has_media [Boolean] Whether media is attached (score)
-      #
-      #   @param media_type [Symbol, XTwitterScraper::Models::ComposeCreateParams::MediaType] Media type (refine)
-      #
-      #   @param style_username [String] Cached style username for voice matching (compose)
-      #
-      #   @param tone [String] Desired tone (refine)
-      #
-      #   @param topic [String] Tweet topic (compose, refine)
-      #
+      # @!method initialize(body:, request_options: {})
+      #   @param body [XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeScoreRequest]
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
-      # Workflow step
-      module Step
-        extend XTwitterScraper::Internal::Type::Enum
-
-        COMPOSE = :compose
-        REFINE = :refine
-        SCORE = :score
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Optimization goal
-      module Goal
-        extend XTwitterScraper::Internal::Type::Enum
-
-        ENGAGEMENT = :engagement
-        FOLLOWERS = :followers
-        AUTHORITY = :authority
-        CONVERSATION = :conversation
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # Media type (refine)
-      module MediaType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        PHOTO = :photo
-        VIDEO = :video
-        NONE = :none
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
+      module Body
+        extend XTwitterScraper::Internal::Type::Union
+
+        variant -> { XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest }
+
+        variant -> { XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest }
+
+        variant -> { XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest }
+
+        class ComposePrepareRequest < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute step
+          #
+          #   @return [Symbol, :compose]
+          required :step, const: :compose
+
+          # @!attribute topic
+          #   Subject for the post.
+          #
+          #   @return [String]
+          required :topic, String
+
+          # @!attribute goal
+          #   Editorial goal used to order the rules and questions.
+          #
+          #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest::Goal, nil]
+          optional :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal }
+
+          # @!attribute style_username
+          #   Username from a style analysis saved to this account.
+          #
+          #   @return [String, nil]
+          optional :style_username, String, api_name: :styleUsername
+
+          # @!method initialize(topic:, goal: nil, style_username: nil, step: :compose)
+          #   @param topic [String] Subject for the post.
+          #
+          #   @param goal [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest::Goal] Editorial goal used to order the rules and questions.
+          #
+          #   @param style_username [String] Username from a style analysis saved to this account.
+          #
+          #   @param step [Symbol, :compose]
+
+          # Editorial goal used to order the rules and questions.
+          #
+          # @see XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest#goal
+          module Goal
+            extend XTwitterScraper::Internal::Type::Enum
+
+            ENGAGEMENT = :engagement
+            FOLLOWERS = :followers
+            AUTHORITY = :authority
+            CONVERSATION = :conversation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class ComposeRefineRequest < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute goal
+          #   Editorial goal for the guidance.
+          #
+          #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal]
+          required :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal }
+
+          # @!attribute step
+          #
+          #   @return [Symbol, :refine]
+          required :step, const: :refine
+
+          # @!attribute tone
+          #   Requested writing tone.
+          #
+          #   @return [String]
+          required :tone, String
+
+          # @!attribute topic
+          #   Subject for the post.
+          #
+          #   @return [String]
+          required :topic, String
+
+          # @!attribute additional_context
+          #   Audience, constraints, sources, or other writing context.
+          #
+          #   @return [String, nil]
+          optional :additional_context, String, api_name: :additionalContext
+
+          # @!attribute call_to_action
+          #   Specific action the draft should request.
+          #
+          #   @return [String, nil]
+          optional :call_to_action, String, api_name: :callToAction
+
+          # @!attribute media_type
+          #   Planned media type.
+          #
+          #   @return [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::MediaType, nil]
+          optional :media_type,
+                   enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType },
+                   api_name: :mediaType
+
+          # @!method initialize(goal:, tone:, topic:, additional_context: nil, call_to_action: nil, media_type: nil, step: :refine)
+          #   @param goal [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal] Editorial goal for the guidance.
+          #
+          #   @param tone [String] Requested writing tone.
+          #
+          #   @param topic [String] Subject for the post.
+          #
+          #   @param additional_context [String] Audience, constraints, sources, or other writing context.
+          #
+          #   @param call_to_action [String] Specific action the draft should request.
+          #
+          #   @param media_type [Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::MediaType] Planned media type.
+          #
+          #   @param step [Symbol, :refine]
+
+          # Editorial goal for the guidance.
+          #
+          # @see XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest#goal
+          module Goal
+            extend XTwitterScraper::Internal::Type::Enum
+
+            ENGAGEMENT = :engagement
+            FOLLOWERS = :followers
+            AUTHORITY = :authority
+            CONVERSATION = :conversation
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Planned media type.
+          #
+          # @see XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest#media_type
+          module MediaType
+            extend XTwitterScraper::Internal::Type::Enum
+
+            PHOTO = :photo
+            VIDEO = :video
+            NONE = :none
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class ComposeScoreRequest < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute draft
+          #   Full post text for deterministic editorial checks.
+          #
+          #   @return [String]
+          required :draft, String
+
+          # @!attribute step
+          #
+          #   @return [Symbol, :score]
+          required :step, const: :score
+
+          # @!attribute has_link
+          #   True when a separate link card is attached.
+          #
+          #   @return [Boolean, nil]
+          optional :has_link, XTwitterScraper::Internal::Type::Boolean, api_name: :hasLink
+
+          # @!attribute has_media
+          #   @deprecated Ignored. Remove this field. Use hasLink for a separate link card.
+          #
+          #   Accepted for backward compatibility. Text checks ignore this field.
+          #
+          #   @return [Boolean, nil]
+          optional :has_media, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMedia
+
+          # @!method initialize(draft:, has_link: nil, has_media: nil, step: :score)
+          #   Some parameter documentations has been truncated, see
+          #   {XTwitterScraper::Models::ComposeCreateParams::Body::ComposeScoreRequest} for
+          #   more details.
+          #
+          #   @param draft [String] Full post text for deterministic editorial checks.
+          #
+          #   @param has_link [Boolean] True when a separate link card is attached.
+          #
+          #   @param has_media [Boolean] Accepted for backward compatibility. Text checks ignore this field.
+          #
+          #   @param step [Symbol, :score]
+        end
+
+        # @!method self.variants
+        #   @return [Array(XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeScoreRequest)]
       end
     end
   end