x 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b97ab44334b647867e9fdd400531d6e925a10533fb51be399c669c28d441c67
-  data.tar.gz: 03e6b5b78f62cdef778dea21128e8ea1b56955a1077c5ea040b6640694e7577a
+  metadata.gz: 7ff134774b6d6b28f3f72c740c74b1f44b11ce94cff63fbfe4eabc0414f600c3
+  data.tar.gz: 9f3b9abd3ca2628979676b5f634781b960adf6afe8a77559cf6f3a96ee738098
 SHA512:
-  metadata.gz: 47b47a9e6f98e6a61933d7f8f53d2477b2e921206894b2907171f04c2d94da05ebdbb25b501824240997d07c935cc0d2ea1269c6082e7488800c6c7d141f9c0e
-  data.tar.gz: a642eb6fa5e9b61b3cbcf7fff91506e7f44c6b5b5e7a7f16c4cc5ce7ed57d8d19191583fad4bd2bc174c8e9f010546c34d8c83a1b46444de3685805a4b6471dc
+  metadata.gz: cd471d0b216161f5e68832e83b5024a8a89cdda1c815f49543f8361b225776ad46f84690eddf9a9b884cf0ab540924ecae94ebd145f26ac07e44ffdf7c4ff1f2
+  data.tar.gz: 3670666ca95e154a253be800af600cdcaf44195b9dcd3d001e1404d85f27dd5939ce09bd25588cfbe81cefef92ce22bfcd26e105dcb70d813bc4efa221a4360d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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)
+
 ## [0.8.0] - 2023-09-14
 
 - Add (back) bearer token authentication (62e141d)

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:
@@ -74,6 +76,20 @@ The tests for the previous version of this library executed in about 2 seconds.
 
 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.
 
+## Sponsorship
+
+The X gem is free to use, but with X API pricing tiers, it actually costs money to develop and maintain. By contributing to the project, you help us:
+
+1. Maintain the library: Keeping it up-to-date and secure.
+2. Add new features: Enhancements that make your life easier.
+3. Provide support: Faster responses to issues and feature requests.
+
+⭐️ Bonus: Sponsors will get priority support and influence over the project roadmap. We will also list your name or your company's logo on our GitHub page.
+
+Building and maintaining an open-source project like this takes a considerable amount of time and effort. Your sponsorship can help sustain this project. Even a small monthly donation makes a huge difference!
+
+[Click here to sponsor this project.](https://github.com/sponsors/sferik)
+
 ## 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

@@ -9,6 +9,8 @@ module X
     extend Forwardable
 
     DEFAULT_BASE_URL = "https://api.twitter.com/2/".freeze
+    DEFAULT_HOST = "https://api.twitter.com".freeze
+    DEFAULT_PORT = 443
     DEFAULT_OPEN_TIMEOUT = 60 # seconds
     DEFAULT_READ_TIMEOUT = 60 # seconds
     DEFAULT_WRITE_TIMEOUT = 60 # seconds
@@ -18,21 +20,22 @@ module X
       Net::ReadTimeout
     ].freeze
 
-    attr_reader :base_uri
+    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
-      @http_client = Net::HTTP.new(base_uri.host, base_uri.port) if base_uri.host
-      @http_client.use_ssl = base_uri.scheme == "https"
-      @http_client.open_timeout = open_timeout
-      @http_client.read_timeout = read_timeout
-      @http_client.write_timeout = write_timeout
-      @http_client.set_debug_output(debug_output) if debug_output
+      apply_http_client_settings(
+        open_timeout: open_timeout,
+        read_timeout: read_timeout,
+        write_timeout: write_timeout,
+        debug_output: debug_output
+      )
     end
 
     def send_request(request)
@@ -46,10 +49,56 @@ module X
       raise ArgumentError, "Invalid base URL" unless base_uri.is_a?(URI::HTTPS) || base_uri.is_a?(URI::HTTP)
 
       @base_uri = base_uri
+      update_http_client_settings
     end
 
     def debug_output
       @http_client.instance_variable_get(:@debug_output)
     end
+
+    private
+
+    def apply_http_client_settings(open_timeout:, read_timeout:, write_timeout:, debug_output:)
+      @http_client.open_timeout = open_timeout
+      @http_client.read_timeout = read_timeout
+      @http_client.write_timeout = write_timeout
+      @http_client.set_debug_output(debug_output) if debug_output
+    end
+
+    def current_http_client_settings
+      {
+        open_timeout: @http_client.open_timeout,
+        read_timeout: @http_client.read_timeout,
+        write_timeout: @http_client.write_timeout,
+        debug_output: debug_output
+      }
+    end
+
+    def update_http_client_settings
+      conditionally_apply_http_client_settings do
+        host = @base_uri.host || DEFAULT_HOST
+        port = @base_uri.port || DEFAULT_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
+        yield
+        apply_http_client_settings(**settings)
+      else
+        yield
+      end
+    end
   end
 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/version.rb

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

data/sig/x.rbs

@@ -82,23 +82,32 @@ module X
   end
 
   class Connection
-    extend Forwardable
-
     DEFAULT_BASE_URL: String
+    DEFAULT_HOST: String
+    DEFAULT_PORT: Integer
     DEFAULT_OPEN_TIMEOUT: Integer
     DEFAULT_READ_TIMEOUT: Integer
     DEFAULT_WRITE_TIMEOUT: Integer
     NETWORK_ERRORS: Array[(singleton(::Errno::ECONNREFUSED) | singleton(::Net::OpenTimeout) | singleton(::Net::ReadTimeout))]
+    extend Forwardable
     @http_client: Net::HTTP
 
     attr_reader base_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
+    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, ?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) -> URI::Generic
+    def base_uri=: (URI::Generic | String base_url) -> void
     def debug_output: -> IO?
+
+    private
+    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
 
   class RequestBuilder
@@ -161,7 +170,7 @@ 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 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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-26 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.18
+rubygems_version: 3.4.19
 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