x 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d4866e1c2d6c395cb876a5d7b63f91d62e7c16a6f03cf7a13b5d7d6f0a6169
-  data.tar.gz: 651cae67b8b3a7a277169918ab387678937dee586665f8676dbf2674ec13479a
+  metadata.gz: b4e43c461d1aa0e058f2dfcbb53f85fbcf5ade26e1f4a169a044454d9110f2b9
+  data.tar.gz: 267f92093e37ecc6e82c1fdd6cc2eb8615a58e6e586e4eaa63a4d8b890e1afc6
 SHA512:
-  metadata.gz: 2663a18ed461013e25b943ace001c57f0309ff860836edb3ef6e5888100921ee4e262d6851387f0a7ea999c9f7dbdaa7147820a243fa7796de03b29b24e472f7
-  data.tar.gz: e421119a4505742e55132a1782c9c0ebebc36dc801a5c263f540b39eec24bd022b0acf4d843d9af8ecf893d06a45e52c0f1ec68c684ee21db079df0826efa850
+  metadata.gz: 6c68483c77e776f13a7178775148ca16046515dad0ce3d259667b49d0194b89714d70fe0bddf9b14b0cd80514e276ad545fbf4913e9b65a8f106ec1e08443fa7
+  data.tar.gz: 58490badac233a7233331051fc7f2940e6648cd2c5a7de74261b968656b5617d01eeeea3eddfd514a25bac77628b54d78e09085924993700b8a52dc5817fd248

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.7.0] - 2023-09-02
+
+- Remove OAuth gem (7c29bb1)
+
+## [0.6.0] - 2023-08-30
+
+- Add configurable debug output stream for logging (fd2d4b0)
+- Remove bearer token authentication (efff940)
+- Define RBS type signatures (d7f63ba)
+
 ## [0.5.1] - 2023-08-16
 
 - Fix bearer token authentication (1a1ca93)

data/Gemfile

@@ -6,11 +6,13 @@ 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/README.md

@@ -1,31 +1,33 @@
 # X
 
-A Ruby interface to the X API.
+#### A Ruby interface to the X API.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add to the application's Gemfile:
 
-    $ bundle add x
+    bundle add x
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or, if Bundler is not being used to manage dependencies:
 
-    $ gem install x
+    gem install x
 
 ## Usage
 
+First, obtain X credentails from https://developer.x.com.
+
 ```ruby
-x_oauth_credentials = {
+x_credentials = {
   api_key:             "INSERT YOUR X API KEY HERE",
   api_key_secret:      "INSERT YOUR X API KEY SECRET HERE",
-  access_token:        "INSERT YOUR X API ACCESS TOKEN HERE",
-  access_token_secret: "INSERT YOUR X API ACCESS TOKEN SECRET HERE",
+  access_token:        "INSERT YOUR X ACCESS TOKEN HERE",
+  access_token_secret: "INSERT YOUR X ACCESS TOKEN SECRET HERE",
 }
 
-# Initialize X API client with OAuth credentials
-x_client = X::Client.new(**x_oauth_credentials)
+# Initialize an X API client with your OAuth credentials
+x_client = X::Client.new(**x_credentials)
 
-# Request yourself
+# Get data about yourself
 x_client.get("users/me")
 # {"data"=>{"id"=>"7505382", "name"=>"Erik Berlin", "username"=>"sferik"}}
 
@@ -33,18 +35,18 @@ x_client.get("users/me")
 tweet = x_client.post("tweets", '{"text":"Hello, World! (from @gem)"}')
 # {"data"=>{"edit_history_tweet_ids"=>["1234567890123456789"], "id"=>"1234567890123456789", "text"=>"Hello, World! (from @gem)"}}
 
-# Delete a tweet
+# Delete the tweet you just posted
 x_client.delete("tweets/#{tweet["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_oauth_credentials)
+v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)
 
 # Request 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_oauth_credentials)
+ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_credentials)
 
 # Request your ad accounts
 ads_client.get("accounts")
@@ -52,29 +54,61 @@ ads_client.get("accounts")
 
 ## History and Philosophy
 
-This library is a rewrite of the [Twitter Ruby library](https://github.com/sferik/twitter). Over 16 years, 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 potential new features must be weighed against the benefits of simplicity:
+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:
 
 * Less code is easier to maintain.
 * Less code means fewer bugs.
 * Less code runs faster.
 
-In the immortal words of [Ezra Zygmuntowicz](https://github.com/ezmobius) and his [Merb](https://github.com/merb) project (may they both rest in peace): “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 one dependency ([oauth](https://rubygems.org/gems/oauth)) and I’d like to keep it that way. If anything, it should have fewer.
+In the immortal words of [Ezra Zygmuntowicz](https://github.com/ezmobius) and his [Merb](https://github.com/merb) project (may they both rest in peace):
+
+> No code is faster than no code.
 
-The tests for the previous version of this library ran 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. At the same time, we aim to maintain 100% C0 code coverage.
+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.
 
-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—just read the code. The code is always right.
+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.
 
-This project conforms to [Standard Ruby](https://github.com/standardrb/standard). Patches that don’t maintain that standard will not be accepted.
+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.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+1. Checkout and repo:
+
+       git checkout git@github.com:sferik/x-ruby.git
+
+2. Enter the repo’s directory:
+
+       cd x-ruby
+
+3. Install dependencies via Bundler:
+
+       bin/setup
+
+4. Run the default Rake task to ensure all tests pass:
+
+       bundle exec rake
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+5. Create a new branch for your feature or bug fix:
+
+       git checkout -b my-new-branch
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/x.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/x-ruby.
+
+Pull requests will only be accepted if they meet all the following criteria:
+
+1. Code must conform to [Standard Ruby](https://github.com/standardrb/standard). This can be verified with:
+
+       bundle exec rake standard
+
+2. For any new code paths, tests must be added to maintain 100% C0 code coverage. This can be verified with:
+
+       bundle exec rake test
+
+3. For any new classes or methods, RBS type signatures must be added (to sig/x.rbs). This can be verified with:
+
+       bundle exec rake steep
 
 ## License
 

data/Rakefile

@@ -12,4 +12,12 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop standard]
+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

@@ -0,0 +1,13 @@
+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

data/lib/x/authenticator.rb

@@ -1,43 +1,81 @@
-require "oauth"
-require "forwardable"
+require "base64"
+require "cgi"
+require "json"
+require "openssl"
+require "securerandom"
+require "uri"
 
 module X
-  # Handles OAuth and bearer token authentication
+  # Handles OAuth authentication
   class Authenticator
-    extend Forwardable
+    attr_accessor :api_key, :api_key_secret, :access_token, :access_token_secret
 
-    attr_accessor :bearer_token
+    OAUTH_VERSION = "1.0".freeze
+    OAUTH_SIGNATURE_METHOD = "HMAC-SHA1".freeze
 
-    def_delegator :@access_token, :secret, :access_token_secret
-    def_delegator :@access_token, :secret=, :access_token_secret=
-    def_delegator :@access_token, :token, :access_token
-    def_delegator :@access_token, :token=, :access_token=
-    def_delegator :@consumer, :key, :api_key
-    def_delegator :@consumer, :key=, :api_key=
-    def_delegator :@consumer, :secret, :api_key_secret
-    def_delegator :@consumer, :secret=, :api_key_secret=
-
-    def initialize(bearer_token:, api_key:, api_key_secret:, access_token:, access_token_secret:)
-      if bearer_token
-        @bearer_token = bearer_token
-      else
-        initialize_oauth(api_key, api_key_secret, access_token, access_token_secret)
-      end
+    def initialize(api_key, api_key_secret, access_token, access_token_secret)
+      @api_key = api_key
+      @api_key_secret = api_key_secret
+      @access_token = access_token
+      @access_token_secret = access_token_secret
     end
 
     def sign!(request)
-      @consumer.sign!(request, @access_token)
+      method = request.method
+      uri, query_params = split_uri(request.uri)
+      request.add_field("Authorization", oauth_header(method, uri, query_params))
     end
 
     private
 
-    def initialize_oauth(api_key, api_key_secret, access_token, access_token_secret)
-      unless api_key && api_key_secret && access_token && access_token_secret
-        raise ArgumentError, "Missing OAuth credentials"
-      end
+    def split_uri(uri)
+      uri_base = uri.path.to_s
+      query_params = URI.decode_www_form(uri.query.to_s).to_h
+      [uri_base, query_params]
+    end
+
+    def oauth_header(method, uri, query_params)
+      oauth_params = default_oauth_params
+      all_params = query_params.merge(oauth_params)
+      oauth_params["oauth_signature"] = generate_signature(method, uri, all_params)
+      formatted_oauth_header(oauth_params)
+    end
+
+    def default_oauth_params
+      {
+        "oauth_consumer_key" => @api_key,
+        "oauth_nonce" => SecureRandom.hex,
+        "oauth_signature_method" => OAUTH_SIGNATURE_METHOD,
+        "oauth_timestamp" => Time.now.utc.to_i.to_s,
+        "oauth_token" => @access_token,
+        "oauth_version" => OAUTH_VERSION
+      }
+    end
+
+    def generate_signature(method, uri, params)
+      Base64.encode64(OpenSSL::HMAC.digest(
+        OpenSSL::Digest.new("sha1"),
+        signing_key,
+        signature_base_string(method, uri, params)
+      )).chomp
+    end
+
+    def signature_base_string(method, uri, params)
+      encoded_params = encode_params(params)
+      "#{method}&#{CGI.escape(uri)}&#{CGI.escape(encoded_params)}"
+    end
+
+    def encode_params(params)
+      # TODO: Replace CGI.escape with CGI.escapeURIComponent when support for Ruby 3.1 is dropped
+      params.sort.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join("&").gsub("+", "%20")
+    end
+
+    def signing_key
+      "#{CGI.escape(@api_key_secret)}&#{CGI.escape(@access_token_secret)}"
+    end
 
-      @consumer = OAuth::Consumer.new(api_key, api_key_secret, site: ClientDefaults::DEFAULT_BASE_URL)
-      @access_token = OAuth::Token.new(access_token, access_token_secret)
+    def formatted_oauth_header(params)
+      "OAuth #{params.sort.map { |k, v| "#{k}=\"#{CGI.escape(v.to_s)}\"" }.join(", ")}"
     end
   end
 end

data/lib/x/client.rb

@@ -11,25 +11,23 @@ module X
     extend Forwardable
     include ClientDefaults
 
-    def_delegators :@authenticator, :bearer_token, :api_key, :api_key_secret, :access_token, :access_token_secret
-    def_delegators :@authenticator, :bearer_token=, :api_key=, :api_key_secret=, :access_token=, :access_token_secret=
-    def_delegators :@connection, :base_url, :open_timeout, :read_timeout, :write_timeout
-    def_delegators :@connection, :base_url=, :open_timeout=, :read_timeout=, :write_timeout=
+    def_delegators :@authenticator, :api_key, :api_key_secret, :access_token, :access_token_secret
+    def_delegators :@authenticator, :api_key=, :api_key_secret=, :access_token=, :access_token_secret=
+    def_delegators :@connection, :base_url, :open_timeout, :read_timeout, :write_timeout, :debug_output
+    def_delegators :@connection, :base_url=, :open_timeout=, :read_timeout=, :write_timeout=, :debug_output=
     def_delegators :@request_builder, :content_type, :user_agent
     def_delegators :@request_builder, :content_type=, :user_agent=
     def_delegators :@response_handler, :array_class, :object_class
     def_delegators :@response_handler, :array_class=, :object_class=
 
-    def initialize(bearer_token: nil, api_key: nil, api_key_secret: nil, access_token: nil, access_token_secret: nil,
+    def initialize(api_key:, api_key_secret:, access_token:, access_token_secret:,
       base_url: DEFAULT_BASE_URL, content_type: DEFAULT_CONTENT_TYPE, user_agent: DEFAULT_USER_AGENT,
       open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT, write_timeout: DEFAULT_WRITE_TIMEOUT,
-      array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
-      @authenticator = Authenticator.new(bearer_token: bearer_token, api_key: api_key, api_key_secret: api_key_secret,
-        access_token: access_token, access_token_secret: access_token_secret)
-      @connection = Connection.new(base_url: base_url, open_timeout: open_timeout, read_timeout: read_timeout,
-        write_timeout: write_timeout)
-      @request_builder = RequestBuilder.new(content_type: content_type, user_agent: user_agent)
-      @response_handler = ResponseHandler.new(array_class: array_class, object_class: object_class)
+      debug_output: nil, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
+      @authenticator = Authenticator.new(api_key, api_key_secret, access_token, access_token_secret)
+      @connection = Connection.new(base_url, open_timeout, read_timeout, write_timeout, debug_output: debug_output)
+      @request_builder = RequestBuilder.new(content_type, user_agent)
+      @response_handler = ResponseHandler.new(array_class, object_class)
     end
 
     def get(endpoint)
@@ -51,10 +49,9 @@ module X
     private
 
     def send_request(http_method, endpoint, body = nil)
-      request = @request_builder.build(authenticator: @authenticator, http_method: http_method, base_url: base_url,
-        endpoint: endpoint, body: body)
-      response = @connection.send_request(request: request)
-      @response_handler.handle(response: response)
+      request = @request_builder.build(@authenticator, http_method, base_url, endpoint, body: body)
+      response = @connection.send_request(request)
+      @response_handler.handle(response)
     end
   end
 end

data/lib/x/connection.rb

@@ -14,17 +14,19 @@ module X
 
     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:, open_timeout:, read_timeout:, write_timeout:)
-      self.base_url = URI(base_url)
-      @http_client = Net::HTTP.new(@base_url.host, @base_url.port)
-      @http_client.use_ssl = @base_url.scheme == "https"
+    def initialize(url, open_timeout, read_timeout, write_timeout, debug_output: nil)
+      self.base_url = url
+      @http_client = Net::HTTP.new(base_url.host, base_url.port) if base_url.host
+      @http_client.use_ssl = base_url.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
     end
 
-    def send_request(request:)
+    def send_request(request)
       @http_client.request(request)
     rescue *NETWORK_ERRORS => e
       raise NetworkError, "Network error: #{e.message}"
@@ -36,5 +38,9 @@ module X
 
       @base_url = uri
     end
+
+    def debug_output
+      @http_client.instance_variable_get(:@debug_output)
+    end
   end
 end

data/lib/x/errors/error.rb

@@ -8,7 +8,7 @@ module X
     include ClientDefaults
     attr_reader :object
 
-    def initialize(msg = nil, response: nil, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
+    def initialize(msg, response:, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
       if json_response?(response)
         @object = JSON.parse(response.body, array_class: array_class, object_class: object_class)
       end

data/lib/x/errors/network_error.rb

@@ -1,5 +1,5 @@
 require_relative "error"
 
 module X
-  class NetworkError < Error; end
+  class NetworkError < StandardError; end
 end

data/lib/x/errors/too_many_requests_error.rb

@@ -6,21 +6,21 @@ module X
   class TooManyRequestsError < ClientError
     include ClientDefaults
 
-    def initialize(msg = nil, response: nil, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
+    def initialize(msg, response:, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
       @response = response
       super
     end
 
     def limit
-      @response&.fetch("x-rate-limit-limit", 0).to_i
+      @response.fetch("x-rate-limit-limit", 0).to_i
     end
 
     def remaining
-      @response&.fetch("x-rate-limit-remaining", 0).to_i
+      @response.fetch("x-rate-limit-remaining", 0).to_i
     end
 
     def reset_at
-      Time.at(@response&.fetch("x-rate-limit-reset", 0).to_i).utc if @response
+      Time.at(@response.fetch("x-rate-limit-reset", 0).to_i).utc
     end
 
     def reset_in

data/lib/x/request_builder.rb

@@ -13,13 +13,13 @@ module X
 
     attr_accessor :content_type, :user_agent
 
-    def initialize(content_type:, user_agent:)
+    def initialize(content_type, user_agent)
       @content_type = content_type
       @user_agent = user_agent
     end
 
-    def build(authenticator:, http_method:, base_url:, endpoint:, body: nil)
-      url = URI.join(base_url, endpoint)
+    def build(authenticator, http_method, base_url, endpoint, body: nil)
+      url = URI.join(base_url.to_s, endpoint)
       request = create_request(http_method, url, body)
       add_authorization(request, authenticator)
       add_content_type(request)
@@ -40,11 +40,7 @@ module X
     end
 
     def add_authorization(request, authenticator)
-      if authenticator.bearer_token
-        request.add_field("Authorization", "Bearer #{authenticator.bearer_token}")
-      else
-        authenticator.sign!(request)
-      end
+      authenticator.sign!(request)
     end
 
     def add_content_type(request)

data/lib/x/response_handler.rb

@@ -10,20 +10,18 @@ module X
 
     attr_accessor :array_class, :object_class
 
-    def initialize(array_class:, object_class:)
+    def initialize(array_class, object_class)
       @array_class = array_class
       @object_class = object_class
     end
 
-    def handle(response:)
+    def handle(response)
       if successful_json_response?(response)
         return JSON.parse(response.body, array_class: array_class, object_class: object_class)
       end
 
       error_class = ERROR_CLASSES[response.code.to_i] || Error
       error_message = "#{response.code} #{response.message}"
-      raise error_class, error_message if empty_response_body?(response)
-
       raise error_class.new(error_message, response: response, array_class: array_class, object_class: object_class)
     end
 
@@ -32,9 +30,5 @@ module X
     def successful_json_response?(response)
       response.is_a?(Net::HTTPSuccess) && response.body && response["content-type"] == DEFAULT_CONTENT_TYPE
     end
-
-    def empty_response_body?(response)
-      response.body.nil? || response.body.empty?
-    end
   end
 end

data/lib/x/version.rb

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

data/sig/x.rbs

@@ -1,4 +1,145 @@
 module X
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  VERSION: Gem::Version
+
+  class Authenticator
+    OAUTH_VERSION: String
+    OAUTH_SIGNATURE_METHOD: String
+
+    attr_accessor api_key: String
+    attr_accessor api_key_secret: String
+    attr_accessor access_token: String
+    attr_accessor access_token_secret: String
+    def initialize: (String api_key, String api_key_secret, String access_token, String access_token_secret) -> void
+    def sign!: (Net::HTTPRequest request) -> void
+
+    private
+    def split_uri: (URI::Generic uri) -> [String, Hash[String, String]]
+    def oauth_header: (String method, String uri, Hash[String, String] query_params) -> String
+    def default_oauth_params: -> Hash[String, String]
+    def generate_signature: (String method, String uri, Hash[String, String] params) -> String
+    def signature_base_string: (String method, String uri, Hash[String, String] params) -> String
+    def encode_params: (Hash[String, String] params) -> String
+    def signing_key: -> String
+    def formatted_oauth_header: (Hash[String, String] params) -> String
+  end
+
+  module ClientDefaults
+    DEFAULT_BASE_URL: String
+    DEFAULT_CONTENT_TYPE: String
+    DEFAULT_OPEN_TIMEOUT: Integer
+    DEFAULT_READ_TIMEOUT: Integer
+    DEFAULT_WRITE_TIMEOUT: Integer
+    DEFAULT_USER_AGENT: String
+    DEFAULT_ARRAY_CLASS: Class
+    DEFAULT_OBJECT_CLASS: Class
+  end
+
+  class Error < StandardError
+    include ClientDefaults
+
+    attr_reader object: untyped
+    def initialize: (String msg, response: Net::HTTPResponse, ?array_class: Class, ?object_class: Class) -> void
+
+    private
+    def json_response?: (Net::HTTPResponse response) -> bool
+  end
+
+  class ClientError < Error
+  end
+
+  class BadRequestError < ClientError
+  end
+
+  class AuthenticationError < ClientError
+  end
+
+  class ForbiddenError < ClientError
+  end
+
+  class NotFoundError < ClientError
+  end
+
+  class TooManyRequestsError < ClientError
+    include ClientDefaults
+    @response: Net::HTTPResponse
+
+    def initialize: (String msg, response: Net::HTTPResponse, ?array_class: Class, ?object_class: Class) -> void
+    def limit: -> Integer
+    def remaining: -> Integer
+    def reset_at: -> Time
+    def reset_in: -> Integer?
+  end
+
+  class ServerError < Error
+  end
+
+  class ServiceUnavailableError < ServerError
+  end
+
+  module Errors
+    ERROR_CLASSES: Hash[Integer, singleton(AuthenticationError) | singleton(BadRequestError) | singleton(ForbiddenError) | singleton(NotFoundError) | singleton(ServerError) | singleton(ServiceUnavailableError) | singleton(TooManyRequestsError)]
+    NETWORK_ERRORS: Array[(singleton(::Errno::ECONNREFUSED) | singleton(::Net::OpenTimeout) | singleton(::Net::ReadTimeout))]
+  end
+
+  class NetworkError < Error
+  end
+
+  class Connection
+    extend Forwardable
+    include Errors
+    @http_client: Net::HTTP
+
+    attr_reader base_url: URI::Generic
+    def initialize: (URI::Generic | String url, Float | Integer open_timeout, Float | Integer read_timeout, Float | Integer write_timeout, ?debug_output: IO?) -> void
+    def send_request: (Net::HTTPRequest request) -> Net::HTTPResponse
+    def base_url=: (URI::Generic | String new_base_url) -> URI::Generic
+    def debug_output: -> IO?
+  end
+
+  class RequestBuilder
+    HTTP_METHODS: Hash[::Symbol, (singleton(::Net::HTTP::Get) | singleton(::Net::HTTP::Post) | singleton(::Net::HTTP::Put) | singleton(::Net::HTTP::Delete))]
+
+    attr_accessor content_type: String
+    attr_accessor user_agent: String
+    def initialize: (String content_type, String user_agent) -> void
+    def build: (Authenticator authenticator, :delete | :get | :post | :put http_method, URI::Generic base_url, String endpoint, ?body: nil) -> (Net::HTTPRequest)
+
+    private
+    def create_request: (:delete | :get | :post | :put http_method, URI::Generic url, nil body) -> (Net::HTTPRequest)
+    def add_authorization: (Net::HTTPRequest request, Authenticator authenticator) -> void
+    def add_content_type: (Net::HTTPRequest request) -> void
+    def add_user_agent: (Net::HTTPRequest request) -> void
+  end
+
+  class ResponseHandler
+    include Errors
+    include ClientDefaults
+
+    attr_accessor array_class: Class
+    attr_accessor object_class: Class
+    def initialize: (Class array_class, Class object_class) -> void
+    def handle: (Net::HTTPResponse response) -> untyped
+
+    private
+    def successful_json_response?: (Net::HTTPResponse response) -> bool
+  end
+
+  class Client
+    extend Forwardable
+    include ClientDefaults
+    @authenticator: Authenticator
+    @connection: Connection
+    @request_builder: RequestBuilder
+    @response_handler: ResponseHandler
+
+    attr_reader base_url: URI::Generic
+    def initialize: (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) -> void
+    def get: (String endpoint) -> untyped
+    def post: (String endpoint, ?nil body) -> untyped
+    def put: (String endpoint, ?nil body) -> untyped
+    def delete: (String endpoint) -> untyped
+
+    private
+    def send_request: (:delete | :get | :post | :put http_method, String endpoint, ?nil body) -> untyped
+  end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: oauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+date: 2023-09-02 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 - sferik@gmail.com
@@ -37,6 +23,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - lib/x.rb
 - lib/x/authenticator.rb
 - lib/x/client.rb
@@ -57,12 +44,12 @@ files:
 - lib/x/response_handler.rb
 - lib/x/version.rb
 - sig/x.rbs
-homepage: https://github.com/sferik/x-ruby
+homepage: https://sferik.github.io/x-ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/sferik/x-ruby
+  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'