x 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d4866e1c2d6c395cb876a5d7b63f91d62e7c16a6f03cf7a13b5d7d6f0a6169
-  data.tar.gz: 651cae67b8b3a7a277169918ab387678937dee586665f8676dbf2674ec13479a
+  metadata.gz: 7ab2b0ef63fad89db285efc1527b16a3b199691a5cb51013cc55f32fd1fcde56
+  data.tar.gz: e035f65fea8a8409a69a58f08ade709c2affe7c0afc12f62e6928d095ac2aa7f
 SHA512:
-  metadata.gz: 2663a18ed461013e25b943ace001c57f0309ff860836edb3ef6e5888100921ee4e262d6851387f0a7ea999c9f7dbdaa7147820a243fa7796de03b29b24e472f7
-  data.tar.gz: e421119a4505742e55132a1782c9c0ebebc36dc801a5c263f540b39eec24bd022b0acf4d843d9af8ecf893d06a45e52c0f1ec68c684ee21db079df0826efa850
+  metadata.gz: 41f24b7dc58d4d886da758a0d2b1430c68617c2594975c1fd17c9a04c7cde8a826e6672dd03c4be3ae3ba0d0022cfe8d0f6c6b5a97e2df64511a92e56e2c6361
+  data.tar.gz: ffc98321391ec7b71bed31dc82832086c39a79a76b18d0f0ae284a062d329f49fb96cd66421c8bae3b204a48978cc97a079be54b05883f6e462c2be2827f3a94

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [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

@@ -18,8 +18,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 x_oauth_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

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,9 @@
+target :lib do
+  signature "sig"
+  check "lib"
+  library "forwardable"
+  library "json"
+  library "net-http"
+  library "uri"
+  configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
+end

data/lib/x/authenticator.rb

@@ -2,12 +2,10 @@ require "oauth"
 require "forwardable"
 
 module X
-  # Handles OAuth and bearer token authentication
+  # Handles OAuth authentication
   class Authenticator
     extend Forwardable
 
-    attr_accessor :bearer_token
-
     def_delegator :@access_token, :secret, :access_token_secret
     def_delegator :@access_token, :secret=, :access_token_secret=
     def_delegator :@access_token, :token, :access_token
@@ -17,27 +15,13 @@ module X
     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)
+      @consumer = OAuth::Consumer.new(api_key, api_key_secret, site: ClientDefaults::DEFAULT_BASE_URL)
+      @access_token = OAuth::Token.new(access_token, access_token_secret)
     end
 
     def sign!(request)
       @consumer.sign!(request, @access_token)
     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
-
-      @consumer = OAuth::Consumer.new(api_key, api_key_secret, site: ClientDefaults::DEFAULT_BASE_URL)
-      @access_token = OAuth::Token.new(access_token, access_token_secret)
-    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.6.0")
 end

data/sig/x.rbs

@@ -1,4 +1,142 @@
+module OAuth
+  class Consumer
+    def initialize: (String api_key, String api_key_secret, site: String) -> void
+    def sign!: (Net::HTTPRequest request, OAuth::Token token) -> void
+  end
+  class Token
+    def initialize: (String access_token, String access_token_secret) -> void
+  end
+end
+
 module X
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  VERSION: Gem::Version
+
+  class Authenticator
+    extend Forwardable
+    @consumer: OAuth::Consumer
+    @access_token: OAuth::Token
+
+    def initialize: (String api_key, String api_key_secret, String access_token, String access_token_secret) -> void
+    def sign!: (Net::HTTPRequest request) -> void
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -37,6 +37,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - lib/x.rb
 - lib/x/authenticator.rb
 - lib/x/client.rb