x 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c6252a6765246fe6ca0820e5ce96f9e66d9611e91b2d59753730fad6b87f67e
-  data.tar.gz: 7a7dc55ece60d848cde08c151e887a1cc86808408a864c05934c4be906b2021a
+  metadata.gz: 553e0e0e9a87126211bf62942b02cb2c7c8b6d9380ee8fd4336058038c9735b0
+  data.tar.gz: 34922d1e52a0c04de3c6fe090e854174d78d437c8e14b061a95ca4ab5e1a0438
 SHA512:
-  metadata.gz: 4216ad5a466dd1a714a638a45d9c0996f40c16247f7fc6eb0ff756d301c3cd63aac5ca95fd421940634e3661db5cb41e19300b73f8ef01056c14e21ad89edea1
-  data.tar.gz: a27036e7dd594f9b13b5cd66267c57b63679352ea3eeeaada13adbba838c6cdad5d8f841fe35b808950fc610808c219679e72334091b3d8de1dca5899ba386b5
+  metadata.gz: e28c53b17bb053c26326d46940eb539c4612d6f4a547b074e974c2b6ddee616bb37af6c2dd2d4d84b05a21aa2946306de074889b90bd411b2a268793e40d72a0
+  data.tar.gz: 79ab655009e07915cf71158bb2976301d1519093c753b6f8fc1d128781b4844e867551c3d430bb0226aa113d3c7342efdd401e08d4f3d920a7437dfa8c432ba6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.12.1] - 2023-11-28
+* Ensure split chunks are written as binary (c6e257f)
+* Require tmpdir in X::MediaUploader (9e7c7f1)
+
 ## [0.12.0] - 2023-11-02
 * Ensure Authenticator is passed to RedirectHandler (fc8557b)
 * Add AUTHENTICATION_HEADER to X::Authenticator base class (85a2818)

data/README.md

@@ -41,24 +41,24 @@ x_client = X::Client.new(**x_credentials)
 x_client.get("users/me")
 # {"data"=>{"id"=>"7505382", "name"=>"Erik Berlin", "username"=>"sferik"}}
 
-# Post a tweet
-tweet = x_client.post("tweets", '{"text":"Hello, World! (from @gem)"}')
+# Post
+post = x_client.post("tweets", '{"text":"Hello, World! (from @gem)"}')
 # {"data"=>{"edit_history_tweet_ids"=>["1234567890123456789"], "id"=>"1234567890123456789", "text"=>"Hello, World! (from @gem)"}}
 
-# Delete the tweet you just posted
-x_client.delete("tweets/#{tweet["data"]["id"]}")
+# Delete the post
+x_client.delete("tweets/#{post["data"]["id"]}")
 # {"data"=>{"deleted"=>true}}
 
 # Initialize an API v1.1 client
 v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)
 
-# Request your account settings
+# Get your account settings
 v1_client.get("account/settings.json")
 
 # Initialize an X Ads API client
 ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_credentials)
 
-# Request your ad accounts
+# Get your ad accounts
 ads_client.get("accounts")
 ```
 
@@ -66,7 +66,7 @@ See other common usage [examples](https://github.com/sferik/x-ruby/tree/main/exa
 
 ## History and Philosophy
 
-This library is a rewrite of the [Twitter Ruby library](https://github.com/sferik/twitter). Over 16 years of development, that library ballooned to over 3,000 lines of code (plus 7,500 lines of tests). At the time of writing, this library is about 300 lines of code (plus 200 test lines) and I’d like to keep it that way. That doesn’t mean new features won’t be added over time, but the benefits of more code must be weighted against the benefits of less:
+This library is a rewrite of the [Twitter Ruby library](https://github.com/sferik/twitter). Over 16 years of development, that library ballooned to over 3,000 lines of code (plus 7,500 lines of tests), not counting dependencies. This library is about 500 lines of code (plus 1000 test lines) and has no runtime dependencies. That doesn’t mean new features won’t be added over time, but the benefits of more code must be weighed against the benefits of less:
 
 * Less code is easier to maintain.
 * Less code means fewer bugs.
@@ -76,9 +76,7 @@ In the immortal words of [Ezra Zygmuntowicz](https://github.com/ezmobius) and hi
 
 > No code is faster than no code.
 
-The fastest code is the code that is never executed because it doesn’t exist. That principle should apply not just to this library itself but to third-party dependencies. At present, this library has no runtime dependencies and I’d like to keep it that way.
-
-The tests for the previous version of this library executed in about 2 seconds. That sounds pretty fast until you see that tests for this library run in 2 hundredths of a second. This means you can automatically run the tests any time you write a file and receive immediate feedback. For such of workflows, 2 seconds feels painfully slow.
+The tests for the previous version of this library executed in about 2 seconds. That sounds pretty fast until you see that tests for this library run in one-twentieth of a second. This means you can automatically run the tests any time you write a file and receive immediate feedback. For such of workflows, 2 seconds feels painfully slow.
 
 This code is not littered with comments that are intended to generate documentation. Rather, this code is intended to be simple enough to serve as its own documentation. If you want to understand how something works, don’t read the documentation—it might be wrong—read the code. The code is always right.
 
@@ -103,6 +101,8 @@ Many thanks to our sponsors (listed in order of when they sponsored this project
 <a href="https://betterstack.com"><img src="https://raw.githubusercontent.com/sferik/x-ruby/main/sponsor_logos/better_stack.svg" alt="Better Stack" width="200" align="middle"></a>
 <img src="https://raw.githubusercontent.com/sferik/x-ruby/main/sponsor_logos/spacer.png" width="20" align="middle">
 <a href="https://sentry.io"><img src="https://raw.githubusercontent.com/sferik/x-ruby/main/sponsor_logos/sentry.svg" alt="Sentry" width="200" align="middle"></a>
+<img src="https://raw.githubusercontent.com/sferik/x-ruby/main/sponsor_logos/spacer.png" width="20" align="middle">
+<a href="https://ifttt.com"><img src="https://raw.githubusercontent.com/sferik/x-ruby/main/sponsor_logos/ifttt.svg" alt="IFTTT" width="200" align="middle"></a>
 
 ## Development
 

data/lib/x/authenticator.rb

@@ -1,5 +1,4 @@
 module X
-  # Base Authenticator class
   class Authenticator
     AUTHENTICATION_HEADER = "Authorization".freeze
 

data/lib/x/bearer_token_authenticator.rb

@@ -1,7 +1,6 @@
 require_relative "authenticator"
 
 module X
-  # Handles bearer token authentication
   class BearerTokenAuthenticator < Authenticator
     attr_accessor :bearer_token
 

data/lib/x/cgi.rb

@@ -1,7 +1,6 @@
 require "cgi"
 
 module X
-  # Namespaced CGI class
   class CGI
     # TODO: Replace CGI.escape with CGI.escapeURIComponent when support for Ruby 3.1 is dropped
     def self.escape(value)

data/lib/x/client.rb

@@ -7,7 +7,6 @@ require_relative "request_builder"
 require_relative "response_parser"
 
 module X
-  # Main public interface
   class Client
     extend Forwardable
 

data/lib/x/connection.rb

@@ -5,7 +5,6 @@ require "uri"
 require_relative "errors/network_error"
 
 module X
-  # Sends HTTP requests
   class Connection
     extend Forwardable
 

data/lib/x/errors/http_error.rb

@@ -2,7 +2,6 @@ require "json"
 require_relative "error"
 
 module X
-  # Base HTTP error class
   class HTTPError < Error
     JSON_CONTENT_TYPE_REGEXP = %r{application/(problem\+|)json}
 

data/lib/x/errors/too_many_requests.rb

@@ -1,7 +1,6 @@
 require_relative "client_error"
 
 module X
-  # Rate limit error class
   class TooManyRequests < ClientError
     def limit
       response["x-rate-limit-limit"].to_i

data/lib/x/media_uploader.rb

@@ -1,7 +1,7 @@
 require "securerandom"
+require "tmpdir"
 
 module X
-  # Helper module for uploading images and videos
   module MediaUploader
     extend self
 
@@ -72,7 +72,7 @@ module X
         File.open(file_path, "rb") do |f|
           while (chunk = f.read(chunk_size))
             file_paths << "#{Dir.mktmpdir}/x#{format("%03d", file_number += 1)}".tap do |path|
-              File.write(path, chunk)
+              File.binwrite(path, chunk)
             end
           end
         end

data/lib/x/oauth_authenticator.rb

@@ -7,7 +7,6 @@ require_relative "authenticator"
 require_relative "cgi"
 
 module X
-  # Handles OAuth authentication
   class OAuthAuthenticator < Authenticator
     OAUTH_VERSION = "1.0".freeze
     OAUTH_SIGNATURE_METHOD = "HMAC-SHA1".freeze

data/lib/x/redirect_handler.rb

@@ -6,7 +6,6 @@ require_relative "errors/too_many_redirects"
 require_relative "request_builder"
 
 module X
-  # Handles HTTP redirects
   class RedirectHandler
     DEFAULT_MAX_REDIRECTS = 10
 

data/lib/x/request_builder.rb

@@ -5,7 +5,6 @@ require_relative "cgi"
 require_relative "version"
 
 module X
-  # Creates HTTP requests
   class RequestBuilder
     DEFAULT_HEADERS = {
       "Content-Type" => "application/json; charset=utf-8",

data/lib/x/response_parser.rb

@@ -17,7 +17,6 @@ require_relative "errors/unauthorized"
 require_relative "errors/unprocessable_entity"
 
 module X
-  # Process HTTP responses
   class ResponseParser
     ERROR_MAP = {
       400 => BadRequest,

data/lib/x/version.rb

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

data/sig/x.rbs

@@ -279,7 +279,3 @@ module X
     def self.escape_params: (Hash[String, String] | Array[[String, String]] params) -> String
   end
 end
-
-class Dir
-  def self.mktmpdir: (?String? prefix_suffix) -> String
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A Ruby interface to the X API.