x 0.15.4 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 731556dfa3e6417d5e0ea9305d6a6b87cc87bd360d71277df0b3dd1c5c8400b5
-  data.tar.gz: a1170fee36003355b65fe7a6a2732eb750ab0681bae74539d3f1eb17bfd96f65
+  metadata.gz: 4df136d018c47058c7524faada6292a1464b34f2f0e98f2a76e8491630b28d1c
+  data.tar.gz: f7101280a194f40bef57a82e9670cd6ddf409e80b7563072384b8f8c7687cb63
 SHA512:
-  metadata.gz: ec96213eaf3a727ba153c9df7f4f92649b45d3089944d3c02bf6c56960a593845818b7e9e4c947b0317dc6ec4325c7563652d9bcebd911c677171ba1d397fd21
-  data.tar.gz: dc3d6fb361ec7de40ac47d065c3840dd4972f7a32ebb17ed3969b56fc6257272d82c66d035b298956ac1209548c54e46530c75dbea3d23b8ebcd341480670a41
+  metadata.gz: 24599b2cb2604a711a1a810cb21b0631ce26519dcee977e12bf494fdde1be55c08bf4e2716b6c281918010847e8c1bd72cd236a44f0343ece70a66f4a908ab1f
+  data.tar.gz: 84cdf631377ed38f0400a0f82d6dc42609839eeb4ba81d77526017af8541365152adb4f3e73f2722ae2645a494cf697976c1ae85039c9bd2b82edb1efe97136f

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.17.0] - 2025-12-02
+* Add MediaUploader.upload_binary method (9f2f108)
+* Don't forward filename during media upload (492214d)
+
+## [0.16.0] - 2025-06-24
+* Remove media_type parameter from non-chunked upload and append methods (f1f38b5)
+* Fix media upload (dcb418a)
+* Add await_processing! method to handle media upload failures (6cfc973)
+* Move media_category in body for media upload (b790636)
+
 ## [0.15.4] - 2025-05-02
 * Use dedicated endpoints for chunked media upload (d54d0d0)
 

data/README.md

@@ -23,7 +23,8 @@ Or, if Bundler is not being used to manage dependencies:
 
 ## Usage
 
-First, obtain X credentails from <https://developer.x.com>.
+> [!NOTE]
+> First, obtain X credentials from <https://developer.x.com>.
 
 ```ruby
 require "x"
@@ -131,9 +132,9 @@ Many thanks to our sponsors (listed in order of when they sponsored this project
 
 ## Development
 
-1. Checkout and repo:
+1. Clone the repo:
 
-       git checkout git@github.com:sferik/x-ruby.git
+       git clone git@github.com:sferik/x-ruby.git
 
 2. Enter the repo’s directory:
 

data/lib/x/connection.rb

@@ -13,7 +13,7 @@ module X
     DEFAULT_OPEN_TIMEOUT = 60 # seconds
     DEFAULT_READ_TIMEOUT = 60 # seconds
     DEFAULT_WRITE_TIMEOUT = 60 # seconds
-    DEFAULT_DEBUG_OUTPUT = File.open(File::NULL, "w")
+    DEFAULT_DEBUG_OUTPUT = File.open(IO::NULL, "w")
     NETWORK_ERRORS = [
       Errno::ECONNREFUSED,
       Errno::ECONNRESET,

data/lib/x/media_upload_validator.rb

@@ -0,0 +1,17 @@
+module X
+  module MediaUploadValidator
+    module_function
+
+    MEDIA_CATEGORIES = %w[dm_gif dm_image dm_video subtitles tweet_gif tweet_image tweet_video].freeze
+
+    def validate_file_path!(file_path:)
+      raise "File not found: #{file_path}" unless File.exist?(file_path)
+    end
+
+    def validate_media_category!(media_category:)
+      return if MEDIA_CATEGORIES.include?(media_category.downcase)
+
+      raise ArgumentError, "Invalid media_category: #{media_category}. Valid values: #{MEDIA_CATEGORIES.join(", ")}"
+    end
+  end
+end

data/lib/x/media_uploader.rb

@@ -1,5 +1,7 @@
+require "json"
 require "securerandom"
 require "tmpdir"
+require_relative "media_upload_validator"
 
 module X
   module MediaUploader
@@ -7,8 +9,7 @@ module X
 
     MAX_RETRIES = 3
     BYTES_PER_MB = 1_048_576
-    MEDIA_CATEGORIES = %w[dm_gif dm_image dm_video subtitles tweet_gif tweet_image tweet_video].freeze
-    DM_GIF, DM_IMAGE, DM_VIDEO, SUBTITLES, TWEET_GIF, TWEET_IMAGE, TWEET_VIDEO = MEDIA_CATEGORIES
+    DM_GIF, DM_IMAGE, DM_VIDEO, SUBTITLES, TWEET_GIF, TWEET_IMAGE, TWEET_VIDEO = MediaUploadValidator::MEDIA_CATEGORIES
     DEFAULT_MIME_TYPE = "application/octet-stream".freeze
     MIME_TYPES = %w[image/gif image/jpeg video/mp4 image/png application/x-subrip image/webp].freeze
     GIF_MIME_TYPE, JPEG_MIME_TYPE, MP4_MIME_TYPE, PNG_MIME_TYPE, SUBRIP_MIME_TYPE, WEBP_MIME_TYPE = MIME_TYPES
@@ -16,63 +17,63 @@ module X
                      "png" => PNG_MIME_TYPE, "srt" => SUBRIP_MIME_TYPE, "webp" => WEBP_MIME_TYPE}.freeze
     PROCESSING_INFO_STATES = %w[failed succeeded].freeze
 
-    def upload(client:, file_path:, media_category:, media_type: infer_media_type(file_path, media_category),
-      boundary: SecureRandom.hex)
-      validate!(file_path:, media_category:)
-      upload_body = construct_upload_body(file_path:, media_type:, boundary:)
-      headers = {"Content-Type" => "multipart/form-data, boundary=#{boundary}"}
-      client.post("media/upload?media_category=#{media_category}", upload_body, headers:)
+    def upload(client:, file_path:, media_category:, boundary: SecureRandom.hex)
+      MediaUploadValidator.validate_file_path!(file_path:)
+      upload_binary(client:, content: File.binread(file_path), media_category:, boundary:)
     end
 
-    def chunked_upload(client:, file_path:, media_category:, media_type: infer_media_type(file_path,
-      media_category), boundary: SecureRandom.hex, chunk_size_mb: 1)
-      validate!(file_path:, media_category:)
+    def upload_binary(client:, content:, media_category:, boundary: SecureRandom.hex)
+      MediaUploadValidator.validate_media_category!(media_category:)
+      upload_body = construct_upload_body(content:, media_category:, boundary:)
+      headers = {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
+      client.post("media/upload", upload_body, headers:)&.fetch("data")
+    end
+
+    def chunked_upload(client:, file_path:, media_category:, media_type: infer_media_type(file_path, media_category),
+      boundary: SecureRandom.hex, chunk_size_mb: 1)
+      MediaUploadValidator.validate_file_path!(file_path:)
+      MediaUploadValidator.validate_media_category!(media_category:)
       media = init(client:, file_path:, media_type:, media_category:)
       chunk_size = chunk_size_mb * BYTES_PER_MB
-      append(client:, file_paths: split(file_path, chunk_size), media:, media_type:, boundary:)
+      append(client:, file_paths: split(file_path, chunk_size), media:, boundary:)
       client.post("media/upload/#{media["id"]}/finalize")&.fetch("data")
     end
 
     def await_processing(client:, media:)
       loop do
         status = client.get("media/upload?command=STATUS&media_id=#{media["id"]}")&.fetch("data")
-        return status if !status["processing_info"] || PROCESSING_INFO_STATES.include?(status["processing_info"]["state"])
+        return status if status.nil? || !status["processing_info"] || PROCESSING_INFO_STATES.include?(status["processing_info"]["state"])
 
         sleep status["processing_info"]["check_after_secs"].to_i
       end
     end
 
-    private
-
-    def validate!(file_path:, media_category:)
-      raise "File not found: #{file_path}" unless File.exist?(file_path)
+    def await_processing!(client:, media:)
+      status = await_processing(client:, media:)
+      raise "Media processing failed" if status&.dig("processing_info", "state") == "failed"
 
-      return if MEDIA_CATEGORIES.include?(media_category.downcase)
-
-      raise ArgumentError, "Invalid media_category: #{media_category}. Valid values: #{MEDIA_CATEGORIES.join(", ")}"
+      status
     end
 
+    private
+
     def infer_media_type(file_path, media_category)
       case media_category.downcase
       when TWEET_GIF, DM_GIF then GIF_MIME_TYPE
       when TWEET_VIDEO, DM_VIDEO then MP4_MIME_TYPE
       when SUBTITLES then SUBRIP_MIME_TYPE
-      else MIME_TYPE_MAP[File.extname(file_path).delete(".").downcase] || DEFAULT_MIME_TYPE
+      else MIME_TYPE_MAP.fetch(File.extname(file_path).delete(".").downcase, DEFAULT_MIME_TYPE)
       end
     end
 
     def split(file_path, chunk_size)
-      file_number = -1
-      file_paths = [] # @type var file_paths: Array[String]
-
-      File.open(file_path, "rb") do |f|
-        while (chunk = f.read(chunk_size))
-          path = "#{Dir.mktmpdir}/x#{format("%03d", file_number += 1)}"
-          File.binwrite(path, chunk)
-          file_paths << path
-        end
+      file_size = File.size(file_path)
+      segment_count = (file_size.to_f / chunk_size).ceil
+      (0...segment_count).map do |segment_index|
+        segment_path = "#{Dir.mktmpdir}/x#{format("%03d", segment_index + 1)}"
+        File.binwrite(segment_path, File.binread(file_path, chunk_size, segment_index * chunk_size))
+        segment_path
       end
-      file_paths
     end
 
     def init(client:, file_path:, media_type:, media_category:)
@@ -81,11 +82,11 @@ module X
       client.post("media/upload/initialize", data)&.fetch("data")
     end
 
-    def append(client:, file_paths:, media:, media_type:, boundary: SecureRandom.hex)
+    def append(client:, file_paths:, media:, boundary: SecureRandom.hex)
       threads = file_paths.map.with_index do |file_path, index|
         Thread.new do
-          upload_body = construct_upload_body(file_path:, media_type:, segment_index: index, boundary:)
-          headers = {"Content-Type" => "multipart/form-data, boundary=#{boundary}"}
+          upload_body = construct_upload_body(content: File.binread(file_path), segment_index: index, boundary:)
+          headers = {"Content-Type" => "multipart/form-data; boundary=#{boundary}"}
           upload_chunk(client:, media_id: media["id"], upload_body:, file_path:, headers:)
         end
       end
@@ -107,13 +108,14 @@ module X
       Dir.delete(dirname) if Dir.empty?(dirname)
     end
 
-    def construct_upload_body(file_path:, media_type:, segment_index: nil, boundary: SecureRandom.hex)
+    def construct_upload_body(content:, media_category: nil, segment_index: nil, boundary: SecureRandom.hex)
       body = ""
       body += "--#{boundary}\r\nContent-Disposition: form-data; name=\"segment_index\"\r\n\r\n#{segment_index}\r\n" if segment_index
+      body += "--#{boundary}\r\nContent-Disposition: form-data; name=\"media_category\"\r\n\r\n#{media_category}\r\n" if media_category
       "#{body}--#{boundary}\r\n" \
-        "Content-Disposition: form-data; name=\"media\"; filename=\"#{File.basename(file_path)}\"\r\n" \
-        "Content-Type: #{media_type}\r\n\r\n" \
-        "#{File.binread(file_path)}\r\n" \
+        "Content-Disposition: form-data; name=\"media\"\r\n" \
+        "Content-Type: #{DEFAULT_MIME_TYPE}\r\n\r\n" \
+        "#{content}\r\n" \
         "--#{boundary}--\r\n"
     end
   end

data/lib/x/oauth_authenticator.rb

@@ -1,5 +1,5 @@
 require "base64"
-require "cgi"
+require "cgi/escape"
 require "json"
 require "openssl"
 require "securerandom"

data/lib/x/request_builder.rb

@@ -38,14 +38,13 @@ module X
 
     def add_authentication(request:, authenticator:)
       authenticator.header(request).each do |key, value|
-        request.add_field(key, value)
+        request[key] = value
       end
     end
 
     def add_headers(request:, headers:)
       DEFAULT_HEADERS.merge(headers).each do |key, value|
-        request.delete(key)
-        request.add_field(key, value)
+        request[key] = value
       end
     end
 

data/lib/x/version.rb

@@ -1,5 +1,5 @@
 require "rubygems/version"
 
 module X
-  VERSION = Gem::Version.create("0.15.4")
+  VERSION = Gem::Version.create("0.17.0")
 end

data/sig/x.rbs

@@ -245,7 +245,6 @@ module X
   module MediaUploader
     MAX_RETRIES: Integer
     BYTES_PER_MB: Integer
-    MEDIA_CATEGORIES: Array[String]
     DM_GIF: String
     DM_IMAGE: String
     DM_VIDEO: String
@@ -265,19 +264,28 @@ module X
     PROCESSING_INFO_STATES: Array[String]
     extend MediaUploader
 
-    def upload: (client: Client, file_path: String, media_category: String, ?media_type: String, ?boundary: String) -> untyped
+    def upload: (client: Client, file_path: String, media_category: String, ?boundary: String) -> untyped
+    def upload_binary: (client: Client, content: String, media_category: String, ?boundary: String) -> untyped
     def chunked_upload: (client: Client, file_path: String, media_category: String, ?media_type: String, ?boundary: String, ?chunk_size_mb: Integer) -> untyped
     def await_processing: (client: Client, media: untyped) -> untyped
+    def await_processing!: (client: Client, media: untyped) -> untyped
 
     private
-    def validate!: (file_path: String, media_category: String) -> nil
     def infer_media_type: (String file_path, String media_category) -> String
     def split: (String file_path, Integer chunk_size) -> Array[String]
     def init: (client: Client, file_path: String, media_type: String, media_category: String) -> untyped
-    def append: (client: Client, file_paths: Array[String], media: untyped, media_type: String, ?boundary: String) -> Array[String]
+    def append: (client: Client, file_paths: Array[String], media: untyped, ?boundary: String) -> Array[String]
     def upload_chunk: (client: Client, media_id: String, upload_body: String, file_path: String, ?headers: Hash[String, String]) -> Integer?
     def cleanup_file: (String file_path) -> Integer?
     def finalize: (client: Client, media: untyped) -> untyped
-    def construct_upload_body: (file_path: String, media_type: String, ?segment_index: Integer, ?boundary: String) -> String
+    def construct_upload_body: (content: String, ?media_category: String, ?segment_index: Integer, ?boundary: String) -> String
+  end
+
+  module MediaUploadValidator
+    MEDIA_CATEGORIES: Array[String]
+    extend MediaUploadValidator
+
+    def validate_file_path!: (file_path: String) -> nil
+    def validate_media_category!: (media_category: String) -> nil
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.15.4
+  version: 0.17.0
 platform: ruby
 authors:
 - Erik Berlin
@@ -59,6 +59,7 @@ files:
 - lib/x/errors/too_many_requests.rb
 - lib/x/errors/unauthorized.rb
 - lib/x/errors/unprocessable_entity.rb
+- lib/x/media_upload_validator.rb
 - lib/x/media_uploader.rb
 - lib/x/oauth_authenticator.rb
 - lib/x/rate_limit.rb
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby interface to the X API.
 test_files: []