api-response-presenter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e509264188009fe9c15dd6c38c58286b338a688e33372f1e15ab690e4f7416
-  data.tar.gz: a3365ff34ea26895b3393dccc4c450ccb6645dd7d7410931c2ba4c47e1c16690
+  metadata.gz: dc3133cf4ef59c353137dc02d8d34e431cb1f7f57360549206bc477e8cef8164
+  data.tar.gz: 5aa97d07e425e3f178934418c5ff025a3f2cf90c3f4217144f167f55daa6a87a
 SHA512:
-  metadata.gz: f205f9e01e0853e9afed337b6460b3672984bb632eb2e6d7ed6ea9a41d31d9bf3e3ca2cd265f9929a856b304b4f8b2b909a470ab7e5d9ee319d6ac0725e02b68
-  data.tar.gz: 3fb35b7a9b8def679a29868f4b9cab6fd7cd9a48a653e3d5a5329b8fcbf9a72ec9bf132cee5bcc67ee3c64e54debc3c045abdcd6ce3d4c6e991e2c2c08cacc6f
+  metadata.gz: e72be12e09674208d9e763ce8ceb3067dc2d7ed305afdbc984e9f4870f56f22a36c70075efc4cefaf33774bcf13cb70631c807bd76ed418ebb52e74a68bc0039
+  data.tar.gz: 9a13ab7903e5c322f3760ee2b324ed695bad33c50b825a06ad4ec58bf4bbe16500c44066f6b2bba51726d3c0fb48171ba3d755f4802327fceb7bcdab54548fe9

data/README.md

@@ -3,7 +3,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/golifox/api-response-presenter/badge.svg)](https://coveralls.io/github/golifox/api-response-presenter)
 [![Inline docs](https://inch-ci.org/github/golifox/api-response-presenter.svg?branch=main)](https://inch-ci.org/github/golifox/api-response-presenter)
 
-The `api-response-presenter` gem provides a flexible and easy-to-use interface for processing API responses using Faraday or
+The `api-response-presenter` gem provides a flexible and easy-to-use interface for presenting API responses using Faraday or
 RestClient with the possibility to configure global settings or per-instance settings. It leverages
 the `Dry::Configurable` for configurations, ensuring high performance and full test coverage.
 
@@ -35,7 +35,7 @@ gem install api-response-presenter
 
 ### Configuration
 
-You can configure api_response globally in an initializer or setup block:
+You can configure `api-response-presenter` globally in an initializer or setup block:
 
 ```ruby
 # config/initializers/api_response.rb
@@ -88,6 +88,30 @@ end
 
 ```
 
+Also you can create decorator for using functionality e.g.
+
+```ruby
+module ApiResponseHandler # or ExternalApiBaseClass
+  private def with_presentation(response, **, &)
+    ApiResponse::Presenter.call(response, **, &)
+  end
+end
+
+class ExtenalApiService < ExternalApiBaseClass
+  # or include ApiResponseHandler
+
+  ...
+
+  def get_external_data(*, **, &)
+    response = get('/data', *)
+
+    with_presentation(response, **, &)
+  end
+  
+  ...
+end
+```
+
 ### Config options
 
 - `ApiResponse.config.adapter`: response adapter that you are using. 
@@ -174,8 +198,12 @@ class EmployeeApiService
   def self.get_employees(monad: false, adapter: :faraday, **options)
     # or (params, presenter_options = {})
     response = Faraday.get('https://api.example.com/data', params) # => body: "{\"data\": [{\"id\": 1, \"name\": \"John\"}]}"
-    ApiResponse::Presenter.call(response, monad: monad, adapter: adapter) do |c|
-      c.extract_from_body = ->(body) { Kaminari.paginate_array(body[:data]).page(1).per(5) }
+
+    page = options.fetch(:page, 1)
+    per = options.fetch(:per, 5)
+
+    ApiResponse::Presenter.call(response, monad: monad, adapter: adapter) do |c|  
+      c.extract_from_body = ->(body) { Kaminari.paginate_array(body[:data]).page(page).per(per) }
       c.struct = Employee
       c.default_return_value = []
     end
@@ -249,6 +277,31 @@ or
 ApiResponse::Presenter.call(response, success_processor: MyClass, failure_processor: MyClass, parser: MyClass)
 ```
 
+NOTE: If you are using Faraday with Oj middleware to parse json body already, you should redefine parser like this (in next gem version will be available configuring parsing (on/off))
+
+```ruby
+# config/initializers/api_response.rb
+
+require 'api_response'
+
+class EmptyParser
+  attr_reader :response, :config
+
+  def initialize(response, config: nil)
+    @response = response
+    @config = config
+  end
+
+  def call
+    response.body
+  end
+end
+
+ApiResponse.configure do |config|
+  config.parser = EmptyParser
+end
+```
+
 #### Options
 
 Also you can add custom options to `ApiResponse.config.options = {}` and use it in your processor or parser:

data/api_response_presenter.gemspec

@@ -25,9 +25,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'dry-initializer', '~> 3.0'
   s.add_runtime_dependency 'dry-monads', '~> 1.6'
   s.add_runtime_dependency 'dry-types', '~> 1.5'
-  s.add_runtime_dependency 'oj', '~> 3.13'
+  s.add_runtime_dependency 'oj', '~> 3.16.3'
   s.add_runtime_dependency 'zeitwerk', '~> 2.4'
 
+  s.add_runtime_dependency 'dry-struct', '~> 1.5'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
 end

data/lib/api_response/processor/failure.rb

@@ -32,7 +32,7 @@ module ApiResponse
 
       def build_error_monad
         status = config.default_status || prepare_status(response)
-        error = config.default_error || response_body.fetch(:error, nil) || response_body
+        error = config.error_json ? response_body : build_error
         error_key = config.default_error_key || response_body.fetch(:error_key, nil)
 
         Failure({error: error, error_key: error_key, status: status})
@@ -58,6 +58,10 @@ module ApiResponse
           config.default_status
         end
       end
+
+      def build_error
+        config.default_error || response_body
+      end
     end
   end
 end

data/lib/api_response/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiResponse
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-response-presenter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Rybolovlev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 3.16.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 3.16.3
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement