x 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ff134774b6d6b28f3f72c740c74b1f44b11ce94cff63fbfe4eabc0414f600c3
-  data.tar.gz: 9f3b9abd3ca2628979676b5f634781b960adf6afe8a77559cf6f3a96ee738098
+  metadata.gz: e2906018cf3e05342abe1bc6c938f3d1b3cf9d1d84c3813a96a11b693fbe0960
+  data.tar.gz: f84f47e1a9ea06b101712ae1f9fd7198d71b2cbc7487a654b8442dd13e3244e0
 SHA512:
-  metadata.gz: cd471d0b216161f5e68832e83b5024a8a89cdda1c815f49543f8361b225776ad46f84690eddf9a9b884cf0ab540924ecae94ebd145f26ac07e44ffdf7c4ff1f2
-  data.tar.gz: 3670666ca95e154a253be800af600cdcaf44195b9dcd3d001e1404d85f27dd5939ce09bd25588cfbe81cefef92ce22bfcd26e105dcb70d813bc4efa221a4360d
+  metadata.gz: 2c98c3ea7e22d0b023a328207c9599dca0f74b54d5ed05eea04378c5c2ed5a2803799b7dcafa54d041d3b7dac8b3e08c8559d4cacb03b2419796368fa153401e
+  data.tar.gz: 36c0faa98a5f6657a88ce770924e2669f91fcea2985b38f1c82dc0766d0c5a5cf6a4b0342d4684f5b679b41dc76f5fa94b791a6468b6f0514c28f6d70864b41a

data/CHANGELOG.md

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

data/README.md

@@ -90,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/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/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.9.0")
+  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
@@ -121,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
@@ -155,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
@@ -171,13 +172,13 @@ module X
 
     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, ?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]
+    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.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -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.