x 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5f85bad7fca01ea015e9a7acb13c6652ad6d06f651acacba1609f5299045ab
-  data.tar.gz: e10427f17c76a569c5bea2c6f50cc71d812ea9987db1c288db2e319d976760c8
+  metadata.gz: ff49ecaad847aef0d9da4bdfc4f89cc3bc54da5edbadab40be265e9ec2ec1cf6
+  data.tar.gz: 1ddef9c1479654f53ed7a889cb33b3d1e4d972c005c4f631726bb4270721c2b0
 SHA512:
-  metadata.gz: f5ab83ea7ee748d3e17c43bc5f7ce55a59685e7d4e10039c5e7cc28f0bca7b31c689e868f763c5f84b7ffcc9ea92f850b578cc14fede2c29cd24e73cad4c4548
-  data.tar.gz: 01cf440dbad6c968d4cf8b83b4ac496d03309904c9d2c2b1aa01a0bd8d2894a5bfec1990ec7a01de488098b69917e82216cd1d53828c3d594ab49a7a6436e6b2
+  metadata.gz: 406e9aaa6f6166f9d267718ac22e94324b243c85475b30cb7569db957683014644542a3b44a6a3d337f0658a1204e8656b1b0c4ed2355b12ffc195c34b0734e4
+  data.tar.gz: b0754554e6272ef9b9ede3f650c3c407b71ae6ed8ede70d6da314ca408874898e83c2d6c14b31335817b0fb036422adde8ccefe3c13c274794c2e08229196812

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-08-10
+
+- Add configurable write timeout (2a31f84)
+- Use built-in Gem::Version class (066e0b6)
+
 ## [0.4.0] - 2023-08-06
 
 - Refactor Client into Authenticator, RequestBuilder, Connection, ResponseHandler (6bee1e9)

data/README.md

@@ -52,7 +52,7 @@ 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 200 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, 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:
 
 * Less code is easier to maintain.
 * Less code means fewer bugs.

data/lib/x/client.rb

@@ -11,26 +11,25 @@ module X
     extend Forwardable
     include ClientDefaults
 
-    attr_reader :base_url
-    attr_accessor :content_type, :open_timeout, :read_timeout, :user_agent, :array_class, :object_class
-
     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 :@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,
-      base_url: DEFAULT_BASE_URL, content_type: DEFAULT_CONTENT_TYPE,
-      open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT, user_agent: DEFAULT_USER_AGENT,
+      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)
-      self.base_url = base_url
-      @content_type = content_type
-      @open_timeout = open_timeout
-      @read_timeout = read_timeout
-      @user_agent = user_agent
-      @array_class = array_class
-      @object_class = object_class
+      @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)
     end
 
     def get(endpoint)
@@ -49,44 +48,13 @@ module X
       send_request(:delete, endpoint)
     end
 
-    def base_url=(new_base_url)
-      uri = URI(new_base_url)
-      raise ArgumentError, "Invalid base URL" unless uri.is_a?(URI::HTTPS) || uri.is_a?(URI::HTTP)
-
-      @base_url = uri
-    end
-
     private
 
     def send_request(http_method, endpoint, body = nil)
-      request = RequestBuilder.build(http_method, @base_url, endpoint, body)
-      add_headers(request)
-
-      response = Connection.send_request(@base_url, @open_timeout, @read_timeout, request)
-
-      ResponseHandler.new(response, @array_class, @object_class).handle
-    end
-
-    def add_headers(request)
-      add_authorization(request)
-      add_content_type(request)
-      add_user_agent(request)
-    end
-
-    def add_authorization(request)
-      if @authenticator.bearer_token
-        request["Authorization"] = "Bearer #{@bearer_token}"
-      else
-        @authenticator.sign!(request)
-      end
-    end
-
-    def add_content_type(request)
-      request["Content-Type"] = @content_type if @content_type
-    end
-
-    def add_user_agent(request)
-      request["User-Agent"] = @user_agent if @user_agent
+      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)
     end
   end
 end

data/lib/x/client_defaults.rb

@@ -8,6 +8,7 @@ module X
     DEFAULT_OBJECT_CLASS = Hash
     DEFAULT_OPEN_TIMEOUT = 60 # seconds
     DEFAULT_READ_TIMEOUT = 60 # seconds
-    DEFAULT_USER_AGENT = "X-Client/#{Version} Ruby/#{RUBY_VERSION}".freeze
+    DEFAULT_WRITE_TIMEOUT = 60 # seconds
+    DEFAULT_USER_AGENT = "X-Client/#{VERSION} Ruby/#{RUBY_VERSION}".freeze
   end
 end

data/lib/x/connection.rb

@@ -1,21 +1,40 @@
+require "forwardable"
 require "net/http"
-require_relative "errors/network_error"
+require "uri"
 require_relative "errors/errors"
+require_relative "errors/network_error"
 
 module X
   # Sends HTTP requests
   class Connection
+    extend Forwardable
     include Errors
 
-    def self.send_request(base_url, open_timeout, read_timeout, request)
-      url = URI(base_url)
-      http = Net::HTTP.new(url.host, url.port)
-      http.use_ssl = url.scheme == "https"
-      http.open_timeout = open_timeout
-      http.read_timeout = read_timeout
-      http.request(request)
+    attr_reader :base_url
+
+    def_delegators :@http_client, :open_timeout, :read_timeout, :write_timeout
+    def_delegators :@http_client, :open_timeout=, :read_timeout=, :write_timeout=
+
+    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"
+      @http_client.open_timeout = open_timeout
+      @http_client.read_timeout = read_timeout
+      @http_client.write_timeout = write_timeout
+    end
+
+    def send_request(request:)
+      @http_client.request(request)
     rescue *NETWORK_ERRORS => e
       raise NetworkError, "Network error: #{e.message}"
     end
+
+    def base_url=(new_base_url)
+      uri = URI(new_base_url)
+      raise ArgumentError, "Invalid base URL" unless uri.is_a?(URI::HTTPS) || uri.is_a?(URI::HTTP)
+
+      @base_url = uri
+    end
   end
 end

data/lib/x/errors/error.rb

@@ -1,4 +1,6 @@
 require "json"
+require "net/http"
+require_relative "../client_defaults"
 
 module X
   # Base error class
@@ -6,8 +8,10 @@ module X
     include ClientDefaults
     attr_reader :object
 
-    def initialize(msg = nil, response = nil, object_class = DEFAULT_OBJECT_CLASS)
-      @object = JSON.parse(response.body, object_class: object_class) if json_response?(response)
+    def initialize(msg = nil, response: nil, 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
       super(msg)
     end
 

data/lib/x/errors/errors.rb

@@ -1,3 +1,4 @@
+require "net/http"
 require_relative "bad_request_error"
 require_relative "authentication_error"
 require_relative "forbidden_error"

data/lib/x/errors/too_many_requests_error.rb

@@ -1,10 +1,12 @@
-require "net/http"
 require_relative "client_error"
+require_relative "../client_defaults"
 
 module X
   # Rate limit error
   class TooManyRequestsError < ClientError
-    def initialize(msg, response = nil, object_class = ClientDefaults::DEFAULT_OBJECT_CLASS)
+    include ClientDefaults
+
+    def initialize(msg = nil, response: nil, array_class: DEFAULT_ARRAY_CLASS, object_class: DEFAULT_OBJECT_CLASS)
       @response = response
       super
     end

data/lib/x/request_builder.rb

@@ -11,12 +11,25 @@ module X
       delete: Net::HTTP::Delete
     }.freeze
 
-    def self.build(http_method, base_url, endpoint, body = nil)
+    attr_accessor :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)
-      create_request(http_method, url, body)
+      request = create_request(http_method, url, body)
+      add_authorization(authenticator, request)
+      add_content_type(request)
+      add_user_agent(request)
+      request
     end
 
-    def self.create_request(http_method, url, body)
+    private
+
+    def create_request(http_method, url, body)
       http_method_class = HTTP_METHODS[http_method]
 
       raise ArgumentError, "Unsupported HTTP method: #{http_method}" unless http_method_class
@@ -25,5 +38,21 @@ module X
       request.body = body if body && http_method != :get
       request
     end
+
+    def add_authorization(authenticator, request)
+      if authenticator.bearer_token
+        request["Authorization"] = "Bearer #{@bearer_token}"
+      else
+        authenticator.sign!(request)
+      end
+    end
+
+    def add_content_type(request)
+      request["Content-Type"] = content_type if content_type
+    end
+
+    def add_user_agent(request)
+      request["User-Agent"] = user_agent if user_agent
+    end
   end
 end

data/lib/x/response_handler.rb

@@ -1,4 +1,5 @@
 require "json"
+require "net/http"
 require_relative "errors/errors"
 
 module X
@@ -7,28 +8,33 @@ module X
     include ClientDefaults
     include Errors
 
-    def initialize(response, array_class, object_class)
-      @response = response
+    attr_accessor :array_class, :object_class
+
+    def initialize(array_class:, object_class:)
       @array_class = array_class
       @object_class = object_class
     end
 
-    def handle
-      if successful_json_response?
-        return JSON.parse(@response.body, array_class: @array_class, object_class: @object_class)
+    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 @response.body.nil? || @response.body.empty?
+      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)
+      raise error_class.new(error_message, response: response, array_class: array_class, object_class: object_class)
     end
 
     private
 
-    def successful_json_response?
-      @response.is_a?(Net::HTTPSuccess) && @response.body && @response["content-type"] == DEFAULT_CONTENT_TYPE
+    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,39 +1,5 @@
-module X
-  # The version of this library
-  module Version
-    module_function
-
-    def major
-      0
-    end
-
-    def minor
-      4
-    end
-
-    def patch
-      0
-    end
+require "rubygems/version"
 
-    def pre
-      nil
-    end
-
-    def to_h
-      {
-        major: major,
-        minor: minor,
-        patch: patch,
-        pre: pre
-      }
-    end
-
-    def to_a
-      [major, minor, patch, pre].compact
-    end
-
-    def to_s
-      to_a.join(".")
-    end
-  end
+module X
+  VERSION = Gem::Version.create("0.5.0")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth