sofia 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720c61ca3d6708e000cde2eab720a283199d02ae5c02e45c9c513da7493c0366
-  data.tar.gz: 14e66efc3be75d6ec3e12d638b0df237e474212a52930bcb64dd7126b9ecf62c
+  metadata.gz: 2c16a0331d44fdc638dc0efc3a30c4f9c4bfdfb7546361e37070b34ba88ed784
+  data.tar.gz: 9496ec65c4403845ade1a049fc62453738d65f84363d32dc75f364778a58b6b8
 SHA512:
-  metadata.gz: 7c635e0eef70a141af112b4955e031103c1e06d09afefb6ff55a91026f0bfdcc09256d35bf0cb92819cb48edc02d5c5e58620419b0f681d4287c4367d601a17a
-  data.tar.gz: a8c3cd787e0c7375f55671454f1f577bbdaf25fa3d1ce227940779fc76ba36be2f516b758be7f6dd91e9569a545697293e542ab571e0443731f934b4b32931a9
+  metadata.gz: c92bc688a73c1e3e6c0acbaa6c3ee21d0da5f237b82d920155a64976e377d98b8df234dea65f35bf1a98f7c8543ef1c815c36b6474f6278a398d376ea4e36345
+  data.tar.gz: 796638bc140e642d0fb3d71598ae9a3e60e3e6dd786ca3589dbb39258f6cee16943b89fc4961d9f6c876b7c4119081a4523d4a801a3b0fe0fd6ba366d3d6652a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.1.4] - 2026-04-20
+
+### Added
+
+- Soren gem updated to 0.1.5
+
+## [0.1.3] - 2026-04-17
+
+### Added
+
+- Soren gem updated to 0.1.3
+
 ## [0.1.2] - 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/version.rb

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

metadata

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