x 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a5b12497937f06eb22779e6c78ef9dc18d5e9c5b049c96b4da461b058c6998
-  data.tar.gz: 96f4e02f93df2e39589095f12d5a1e790f17159f932cc1ab72330e301815bda4
+  metadata.gz: e2906018cf3e05342abe1bc6c938f3d1b3cf9d1d84c3813a96a11b693fbe0960
+  data.tar.gz: f84f47e1a9ea06b101712ae1f9fd7198d71b2cbc7487a654b8442dd13e3244e0
 SHA512:
-  metadata.gz: f8540864206f44e6863653ec538d076d4f1c696dab4fff2b8eeb33b587603301d2d62faedb163c59cc9366439b28a29acff4068876b4013a05bf88090c61042f
-  data.tar.gz: ef425363ab320f922e9f05f28f4d21a8090b763ef0d2468dfcd0ff7b9d0c456efa7f0a21b034fc750e5d927aafd5c4ae1b9407696d242512a44c7114e4efda4a
+  metadata.gz: 2c98c3ea7e22d0b023a328207c9599dca0f74b54d5ed05eea04378c5c2ed5a2803799b7dcafa54d041d3b7dac8b3e08c8559d4cacb03b2419796368fa153401e
+  data.tar.gz: 36c0faa98a5f6657a88ce770924e2669f91fcea2985b38f1c82dc0766d0c5a5cf6a4b0342d4684f5b679b41dc76f5fa94b791a6468b6f0514c28f6d70864b41a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.9.1] - 2023-10-06
+
+- Allow successful empty responses (06bf7db)
+- Update default User-Agent string (296b36a)
+- Move query parameter escaping into RequestBuilder (56d6bd2)
+
+## [0.9.0] - 2023-09-26
+
+- Add support for HTTP proxies (3740f4f)
+
 ## [0.8.1] - 2023-09-20
 
 - Fix bug where setting Connection#base_uri= doesn't update the HTTP client (d5a89db)

data/README.md

@@ -56,6 +56,8 @@ ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_cred
 ads_client.get("accounts")
 ```
 
+See other common usage [examples](https://github.com/sferik/x-ruby/tree/main/examples).
+
 ## 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:
@@ -88,6 +90,14 @@ Building and maintaining an open-source project like this takes a considerable a
 
 [Click here to sponsor this project.](https://github.com/sponsors/sferik)
 
+## Sponsors
+
+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>
+
 ## Development
 
 1. Checkout and repo:

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "x"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/x/client.rb

@@ -26,6 +26,7 @@ module X
       open_timeout: Connection::DEFAULT_OPEN_TIMEOUT,
       read_timeout: Connection::DEFAULT_READ_TIMEOUT,
       write_timeout: Connection::DEFAULT_WRITE_TIMEOUT,
+      proxy_url: nil,
       content_type: RequestBuilder::DEFAULT_CONTENT_TYPE,
       user_agent: RequestBuilder::DEFAULT_USER_AGENT,
       debug_output: nil,
@@ -35,7 +36,7 @@ module X
 
       initialize_authenticator(bearer_token, api_key, api_key_secret, access_token, access_token_secret)
       @connection = Connection.new(base_url: base_url, open_timeout: open_timeout, read_timeout: read_timeout,
-        write_timeout: write_timeout, debug_output: debug_output)
+        write_timeout: write_timeout, debug_output: debug_output, proxy_url: proxy_url)
       @request_builder = RequestBuilder.new(content_type: content_type, user_agent: user_agent)
       @redirect_handler = RedirectHandler.new(@authenticator, @connection, @request_builder,
         max_redirects: max_redirects)

data/lib/x/connection.rb

@@ -20,14 +20,15 @@ module X
       Net::ReadTimeout
     ].freeze
 
-    attr_reader :base_uri, :http_client
+    attr_reader :base_uri, :proxy_uri, :http_client
 
     def_delegators :@http_client, :open_timeout, :read_timeout, :write_timeout
     def_delegators :@http_client, :open_timeout=, :read_timeout=, :write_timeout=
     def_delegator :@http_client, :set_debug_output, :debug_output=
 
     def initialize(base_url: DEFAULT_BASE_URL, open_timeout: DEFAULT_OPEN_TIMEOUT,
-      read_timeout: DEFAULT_READ_TIMEOUT, write_timeout: DEFAULT_WRITE_TIMEOUT, debug_output: nil)
+      read_timeout: DEFAULT_READ_TIMEOUT, write_timeout: DEFAULT_WRITE_TIMEOUT, proxy_url: nil, debug_output: nil)
+      @proxy_uri = URI(proxy_url) unless proxy_url.nil?
       self.base_uri = base_url
       apply_http_client_settings(
         open_timeout: open_timeout,
@@ -77,11 +78,19 @@ module X
       conditionally_apply_http_client_settings do
         host = @base_uri.host || DEFAULT_HOST
         port = @base_uri.port || DEFAULT_PORT
-        @http_client = Net::HTTP.new(host, port)
+        @http_client = build_http_client(host: host, port: port)
         @http_client.use_ssl = @base_uri.scheme == "https"
       end
     end
 
+    def build_http_client(host:, port:)
+      if @proxy_uri.nil?
+        Net::HTTP.new(host, port)
+      else
+        Net::HTTP.new(host, port, @proxy_uri&.host, @proxy_uri&.port, @proxy_uri&.user, @proxy_uri&.password)
+      end
+    end
+
     def conditionally_apply_http_client_settings
       if @http_client
         settings = current_http_client_settings

data/lib/x/oauth_authenticator.rb

@@ -72,22 +72,18 @@ module X
     end
 
     def signature_base_string(method, url, params)
-      "#{method}&#{encode(url)}&#{encode(encode_params(params))}"
-    end
-
-    def encode_params(params)
-      params.sort.map { |k, v| "#{k}=#{encode(v.to_s)}" }.join("&")
+      "#{method}&#{escape(url)}&#{escape(URI.encode_www_form(params.sort))}"
     end
 
     def signing_key
-      "#{encode(api_key_secret)}&#{encode(access_token_secret)}"
+      "#{escape(api_key_secret)}&#{escape(access_token_secret)}"
     end
 
     def format_oauth_header(params)
-      "OAuth #{params.sort.map { |k, v| "#{k}=\"#{encode(v.to_s)}\"" }.join(", ")}"
+      "OAuth #{params.sort.map { |k, v| "#{k}=\"#{escape(v.to_s)}\"" }.join(", ")}"
     end
 
-    def encode(value)
+    def escape(value)
       # TODO: Replace CGI.escape with CGI.escapeURIComponent when support for Ruby 3.1 is dropped
       CGI.escape(value.to_s).gsub("+", "%20")
     end

data/lib/x/redirect_handler.rb

@@ -49,7 +49,7 @@ module X
     def send_new_request(new_uri, new_request)
       @connection = Connection.new(base_url: new_uri, open_timeout: connection.open_timeout,
         read_timeout: connection.read_timeout, write_timeout: connection.write_timeout,
-        debug_output: connection.debug_output)
+        debug_output: connection.debug_output, proxy_url: connection.proxy_uri)
       connection.send_request(new_request)
     end
   end

data/lib/x/request_builder.rb

@@ -12,7 +12,7 @@ module X
       delete: Net::HTTP::Delete
     }.freeze
     DEFAULT_CONTENT_TYPE = "application/json; charset=utf-8".freeze
-    DEFAULT_USER_AGENT = "X-Client/#{VERSION} Ruby/#{RUBY_VERSION}".freeze
+    DEFAULT_USER_AGENT = "X-Client/#{VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} (#{RUBY_PLATFORM})".freeze
     AUTHORIZATION_HEADER = "Authorization".freeze
     CONTENT_TYPE_HEADER = "Content-Type".freeze
     USER_AGENT_HEADER = "User-Agent".freeze
@@ -24,8 +24,8 @@ module X
       @user_agent = user_agent
     end
 
-    def build(authenticator, http_method, url, body: nil)
-      request = create_request(http_method, url, body)
+    def build(authenticator, http_method, uri, body: nil)
+      request = create_request(http_method, uri, body)
       add_authorization(request, authenticator)
       add_content_type(request)
       add_user_agent(request)
@@ -34,12 +34,13 @@ module X
 
     private
 
-    def create_request(http_method, url, body)
+    def create_request(http_method, uri, body)
       http_method_class = HTTP_METHODS[http_method]
 
       raise ArgumentError, "Unsupported HTTP method: #{http_method}" unless http_method_class
 
-      request = http_method_class.new(url)
+      escaped_uri = escape_query_params(uri)
+      request = http_method_class.new(escaped_uri)
       request.body = body if body && http_method != :get
       request
     end
@@ -55,5 +56,9 @@ module X
     def add_user_agent(request)
       request.add_field(USER_AGENT_HEADER, user_agent) if user_agent
     end
+
+    def escape_query_params(uri)
+      URI(uri).tap { |u| u.query = URI.encode_www_form(URI.decode_www_form(uri.query)) if uri.query }
+    end
   end
 end

data/lib/x/response_handler.rb

@@ -32,19 +32,23 @@ module X
     end
 
     def handle(response)
-      if successful_json_response?(response)
-        return JSON.parse(response.body, array_class: array_class, object_class: object_class)
+      if success?(response)
+        JSON.parse(response.body, array_class: array_class, object_class: object_class) if json?(response)
+      else
+        error_class = ERROR_CLASSES[response.code.to_i] || Error
+        error_message = "#{response.code} #{response.message}"
+        raise error_class.new(error_message, response: response)
       end
-
-      error_class = ERROR_CLASSES[response.code.to_i] || Error
-      error_message = "#{response.code} #{response.message}"
-      raise error_class.new(error_message, response: response)
     end
 
     private
 
-    def successful_json_response?(response)
-      response.is_a?(Net::HTTPSuccess) && response.body && JSON_CONTENT_TYPE_REGEXP.match?(response["content-type"])
+    def success?(response)
+      response.is_a?(Net::HTTPSuccess)
+    end
+
+    def json?(response)
+      response.body && JSON_CONTENT_TYPE_REGEXP.match?(response["content-type"])
     end
   end
 end

data/lib/x/version.rb

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

data/sig/x.rbs

@@ -28,10 +28,9 @@ module X
     def generate_signature: (String method, String url, Hash[String, String] params) -> String
     def hmac_signature: (String base_string) -> String
     def signature_base_string: (String method, String url, Hash[String, String] params) -> String
-    def encode_params: (Hash[String, String] params) -> String
     def signing_key: -> String
     def format_oauth_header: (Hash[String, String] params) -> String
-    def encode: (String value) -> String
+    def escape: (String value) -> String
   end
 
   class Error < StandardError
@@ -93,10 +92,11 @@ module X
     @http_client: Net::HTTP
 
     attr_reader base_uri: URI::Generic
+    attr_reader proxy_uri: URI::Generic?
     attr_reader open_timeout : Float | Integer
     attr_reader read_timeout : Float | Integer
     attr_reader write_timeout : Float | Integer
-    def initialize: (?base_url: URI::Generic | String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?debug_output: IO?) -> void
+    def initialize: (?base_url: URI::Generic | String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO?) -> void
     def send_request: (Net::HTTPRequest request) -> Net::HTTPResponse
     def base_uri=: (URI::Generic | String base_url) -> void
     def debug_output: -> IO?
@@ -105,6 +105,7 @@ module X
     def apply_http_client_settings: (open_timeout: Float | Integer, read_timeout: Float | Integer, write_timeout: Float | Integer, debug_output: IO?) -> untyped
     def current_http_client_settings: -> {open_timeout: Float | Integer, read_timeout: Float | Integer, write_timeout: Float | Integer, debug_output: IO?}
     def update_http_client_settings: -> untyped
+    def build_http_client: (host: String, port: Integer) -> (Net::HTTP)
     def conditionally_apply_http_client_settings: { -> untyped } -> untyped
   end
 
@@ -119,13 +120,14 @@ module X
     attr_accessor content_type: String
     attr_accessor user_agent: String
     def initialize: (?content_type: String, ?user_agent: String) -> void
-    def build: (BearerTokenAuthenticator | OauthAuthenticator authenticator, Symbol http_method, URI::Generic url, ?body: String?) -> (Net::HTTPRequest)
+    def build: (BearerTokenAuthenticator | OauthAuthenticator authenticator, Symbol http_method, URI::Generic uri, ?body: String?) -> (Net::HTTPRequest)
 
     private
-    def create_request: (Symbol http_method, URI::Generic url, String? body) -> (Net::HTTPRequest)
+    def create_request: (Symbol http_method, URI::Generic uri, String? body) -> (Net::HTTPRequest)
     def add_authorization: (Net::HTTPRequest request, BearerTokenAuthenticator | OauthAuthenticator authenticator) -> void
     def add_content_type: (Net::HTTPRequest request) -> void
     def add_user_agent: (Net::HTTPRequest request) -> void
+    def escape_query_params: (URI::Generic uri) -> URI::Generic
   end
 
   class RedirectHandler
@@ -153,10 +155,11 @@ module X
     attr_accessor array_class: Class
     attr_accessor object_class: Class
     def initialize: (?array_class: Class, ?object_class: Class) -> void
-    def handle: (Net::HTTPResponse response) -> Hash[String, untyped]
+    def handle: (Net::HTTPResponse response) -> Hash[String, untyped]?
 
     private
-    def successful_json_response?: (Net::HTTPResponse response) -> bool
+    def success?: (Net::HTTPResponse response) -> bool
+    def json?: (Net::HTTPResponse response) -> bool
   end
 
   class Client
@@ -168,14 +171,14 @@ module X
     @response_handler: ResponseHandler
 
     attr_reader base_uri: URI::Generic
-    def initialize: (?bearer_token: String?, ?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?base_url: URI::Generic | String, ?content_type: String, ?user_agent: String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?debug_output: IO?, ?array_class: Class, ?object_class: Class, ?max_redirects: Integer) -> void
-    def get: (String endpoint) -> Hash[String, untyped]
-    def post: (String endpoint, ?nil body) -> Hash[String, untyped]
-    def put: (String endpoint, ?nil body) -> Hash[String, untyped]
-    def delete: (String endpoint) -> Hash[String, untyped]
+    def initialize: (?bearer_token: String?, ?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?base_url: URI::Generic | String, ?content_type: String, ?user_agent: String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO?, ?array_class: Class, ?object_class: Class, ?max_redirects: Integer) -> void
+    def get: (String endpoint) -> Hash[String, untyped]?
+    def post: (String endpoint, ?nil body) -> Hash[String, untyped]?
+    def put: (String endpoint, ?nil body) -> Hash[String, untyped]?
+    def delete: (String endpoint) -> Hash[String, untyped]?
 
     private
     def initialize_authenticator: (String? bearer_token, String? api_key, String? api_key_secret, String? access_token, String? access_token_secret) -> (BearerTokenAuthenticator | OauthAuthenticator)
-    def send_request: (Symbol http_method, String endpoint, ?nil body) -> Hash[String, untyped]
+    def send_request: (Symbol http_method, String endpoint, ?nil body) -> Hash[String, untyped]?
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,13 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- Steepfile
+- bin/console
+- bin/setup
 - lib/x.rb
 - lib/x/bearer_token_authenticator.rb
 - lib/x/client.rb
@@ -50,10 +48,12 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
   homepage_uri: https://sferik.github.io/x-ruby
   source_code_uri: https://github.com/sferik/x-ruby
   changelog_uri: https://github.com/sferik/x-ruby/blob/master/CHANGELOG.md
-  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://github.com/sferik/x-ruby/issues
+  documentation_uri: https://rubydoc.info/gems/x/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A Ruby interface to the X API.

data/.rubocop.yml

@@ -1,54 +0,0 @@
-require:
- - standard
- - standard-performance
- - rubocop-minitest
- - rubocop-performance
- - rubocop-rake
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-Layout/ArgumentAlignment:
-  Enabled: true
-  EnforcedStyle: with_fixed_indentation
-
-Layout/ArrayAlignment:
-  Enabled: true
-  EnforcedStyle: with_fixed_indentation
-
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable
-
-Layout/HashAlignment:
-  Enabled: true
-  EnforcedHashRocketStyle: key
-  EnforcedColonStyle: key
-  EnforcedLastArgumentHashStyle: always_inspect
-
-Layout/ParameterAlignment:
-  Enabled: true
-  EnforcedStyle: with_fixed_indentation
-  IndentationWidth: ~
-
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
-
-Metrics/ParameterLists:
-  CountKeywordArgs: false
-
-Style/Alias:
-  Enabled: true
-  EnforcedStyle: prefer_alias_method
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/Gemfile

@@ -1,18 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in x.gemspec
-gemspec
-
-gem "hashie", ">= 5"
-gem "minitest", ">= 5.19"
-gem "rake", ">= 13.0.6"
-gem "rbs", ">= 3.2.1"
-gem "rubocop", ">= 1.21"
-gem "rubocop-minitest", ">= 0.31"
-gem "rubocop-performance", ">= 1.18"
-gem "rubocop-rake", ">= 0.6"
-gem "simplecov", ">= 0.22"
-gem "standard", ">= 1.30.1"
-gem "steep", ">= 1.5.3"
-gem "timecop", ">= 0.9.6"
-gem "webmock", ">= 3.18.1"

data/Rakefile

@@ -1,23 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-require "standard/rake"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-require "steep"
-require "steep/cli"
-
-desc "Type check with Steep"
-task :steep do
-  Steep::CLI.new(argv: ["check"], stdout: $stdout, stderr: $stderr, stdin: $stdin).run
-end
-
-task default: %i[test rubocop standard steep]

data/Steepfile

@@ -1,13 +0,0 @@
-target :lib do
-  signature "sig"
-  check "lib"
-  library "base64"
-  library "cgi"
-  library "forwardable"
-  library "json"
-  library "net-http"
-  library "openssl"
-  library "securerandom"
-  library "uri"
-  configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
-end