sofia 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b5f47033833ca64f26bc2c6c9e7807dd68c2eae26c5f9e425390f9bf08d7b3d
-  data.tar.gz: 77fb9dbbb9106d5d3c15363bed3b218b0c6796cf8434047775de552b01e96765
+  metadata.gz: a7d9da1b3491c63c1c05616b6ccba0ba8a9355204dfdc6db8b0935943386d963
+  data.tar.gz: 98721c8043ae738d53b0014eea9b45918aa4f79fed17b37e5a8142d2549ba3a5
 SHA512:
-  metadata.gz: b94051c45846711ad7939161b963928443fb1a877d80fe1b786eba4a888d78b7f48b00deb31edf9baaf8c0f46fd063cc91805ef6b92c863c204b3f48cce8e134
-  data.tar.gz: f73c2498619c4bd113c5aa79ef113b6e99152b8c0432f52ac469ea7b6201cfac42b671c03ee062329742f590721e50b28ed0bf4e39a984251435152fb0a102b0
+  metadata.gz: f7a7a098c6299be5e9aec18f6cbecd5eaaac580c3051a13d13155f98c676475c86b10bc1f66a8c5ceb8502f50f5b8832c2d589148322cb75b1e2d169f5fcd959
+  data.tar.gz: 5ff87ca97606ceae67bef7e9fcfeb2188fe9b32df455ccb055a61eebe5b4944253a43774b7df6a88b7a23cbc72849becd35817d2772b607cd325bf6b6cbae654

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.1.5] - 2026-04-20
+
+### Fixed
+
+- Properly handle responses with empty '' body.
+
+## [0.1.4] - 2026-04-20
+
+### Added
+
+- Soren gem updated to 0.1.5
+
 ## [0.1.3] - 2026-04-17
 
 ### Added

data/README.md

@@ -1,24 +1,75 @@
 # Sofia
 
-This is a personal project created for self-learning purposes. The goal is to create a simple HTTP client abstraction layer, similar to `Faraday`. At the current moment `Sofia` supports only `NetHTTP` as adapter, and only with `Content-Type: JSON` and default configuration. While basic, at the current moment `Sofia` is implemented into my other project [Shopik](https://github.com/KubaJadrzak/Shopik) and allows to perform HTTP requests correctly. I will add more functionality with time. The goal is to ultimately create my own HTTP client as well.
+A simple HTTP client abstraction layer for Ruby, similar to `Faraday`. Sofia provides an abstraction layer so you can swap the underlying HTTP library without changing your application code. 
+
+Sofia is currently implemented in my integration with Espago Payment System [Shopik](https://github.com/KubaJadrzak/Shopik) alongside my own HTTP client library [Soren](https://github.com/KubaJadrzak/soren), and everything seems to be working pretty good :P
 
 # How it works
 
-In order to perform a request with `Sofia` you need to initialize an instance of `client` class by providing `base_url` and `adapter`. At the current moment the only supported adapter is `NetHTTP` and it will be used by default.
+Initialize a client with a `base_url` and an optional `adapter` (defaults to `:net_http`):
+
 ```rb
- @client = Sofia.new(base_url: base_url, adapter: adapter)
+@client = Sofia.new(base_url: base_url, adapter: adapter)
 ```
 
-You can perform a request via method `send` on the instance of `client` class. You need to provide http request type (for now only `get`, `post`, `put`, `patch`, `delete` are supported) as method argument as well as block of code with configuration, for example: 
+Call the desired HTTP method via `send` with a configuration block. The supported methods are `get`, `post`, `put`, `patch`, and `delete`:
+
 ```rb
-    response = @client.send(method) do |req|
-      req.path = path
-      req.headers['Accept'] = 'application/json'
-      req.headers['Authorization'] = "Basic #{encoded_credentials}"
-      req.body = body if body
-    end
+response = @client.send(method) do |req|
+  req.path = path
+  req.headers['Accept'] = 'application/json'
+  req.headers['Authorization'] = "Basic #{encoded_credentials}"
+  req.body = body if body
+end
+```
+
+At the current moment Sofia supports only JSON!!!
+
+# Errors
+
+Response codes in the `400–499` and `500–599` ranges are not raised as errors — inspect `response.status`, `response.client_error?`, or `response.server_error?` yourself.
+
+| Error | Cause |
+|---|---|
+| `Sofia::Error::TimeoutError` | Read, write, or connection timeout |
+| `Sofia::Error::ConnectionFailed` | DNS failure, refused connection, network error |
+| `Sofia::Error::SSLError` | TLS handshake failure |
+| `Sofia::Error::ParserError` | Response body is not valid JSON |
+
+## Adapters
+
+Sofia supports two adapter: `:net_http` as well as `:soren`. [Soren](https://github.com/KubaJadrzak/soren) is my own simple HTTP client library :P.
+
+```rb
+# Default — Net::HTTP
+client = Sofia.new(base_url: 'https://api.example.com', adapter: :net_http)
+
+# Soren
+client = Sofia.new(base_url: 'https://api.example.com', adapter: :soren)
+```
+
+## Timeouts
+
+Timeouts can be configured per client via the `options:` keyword:
+
+```rb
+client = Sofia.new(
+  base_url: 'https://api.example.com',
+  adapter: :net_http,
+  options: {
+    read_timeout:       60,   # seconds — default 30
+    write_timeout:      30,   # seconds — default 30
+    connection_timeout: 5,    # seconds — default 10
+  },
+)
 ```
-It is a good practice to rescue errors which can be thrown by `Sofia`. The response codes `400-499`  and `500-599` are not errors, instead you need to handle these on your own. This is an example of the entire flow that allows you to make a request based on my [Shopik](https://github.com/KubaJadrzak/Shopik) project where `Sofia` is implement as HTTP client abstraction layer:
+
+Both adapters support all three timeout values.
+
+## Example
+
+This is an example of the entire flow from my [Shopik](https://github.com/KubaJadrzak/Shopik) project, where both `Sofia` HTTP client abstraction layer and `Soren` HTTP client library are implemented:
+
 ```rb
 class EspagoClient
 
@@ -27,7 +78,7 @@ class EspagoClient
     @user = Rails.application.credentials.dig(:espago, :app_id)
     @password = Rails.application.credentials.dig(:espago, :password)
 
-    @client = Sofia.new(base_url: base_url)
+    @client = Sofia.new(base_url: base_url, adapter: :soren)
   end
 
   def send(path, body: nil, method: :get)

data/lib/sofia/response.rb

@@ -37,7 +37,7 @@ module Sofia
     #: -> JSONValue?
     def body
       body = raw_body
-      return unless body
+      return if body.nil? || body.empty?
 
       JSON.parse(body)
     rescue JSON::ParserError

data/lib/sofia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sofia
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sofia
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - KubaJadrzak