funnel_http 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5daab559328b4688ea1b0df8f729922d5fb0a59c9bf9a59b6b8ad5151f9011e
-  data.tar.gz: e97215f71aeb86c5b3d5c728c573fcb5b0f2a4e3a1f3c86f60f8d76799122177
+  metadata.gz: a8e58f7f5762729ef1447c52424e00f63abbad0e57bff3d627e1257045c44da5
+  data.tar.gz: 960f3a22cfaa73eef6afabfb1758b38b0feb715e4485c73cecf3374ee5b4be83
 SHA512:
-  metadata.gz: b3b2dad1cd53e30867557448964cfb08f980cbe2fb10c6545cacf71776b4e5e9c5c1230d8975e470c7fb526ea2383fe67e62235aa8174e12360c692806fbaea9
-  data.tar.gz: eee89453a2d1aa51e9f6e1e44510abf941a0e914b8f9972c92b9495a7756ad4661206cd5ddebb224bcf9e194e9cd0552ac48f47d91af7ac42e688d4281f84899
+  metadata.gz: 802019c07462641eba8b376ca087bbfbb6210ab5cc40bf239a2a7f4234bdf5787d5448e61090a4d58e12383b19ad177e0b99cffef7262ebb50874d54e721bf3d
+  data.tar.gz: ffbd6c6b3b29176a13686a0e4d91de7268f0cf4663f1f47fa080b38ca8a7cbe9223de47116da84e94ecb1560cb8c59f150f787705bfc063604c7a715e96cce68

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
-[full changelog](http://github.com/sue445/funnel_http/compare/v0.4.0...main)
+[full changelog](http://github.com/sue445/funnel_http/compare/v0.5.0...main)
+
+## [0.5.0](https://github.com/sue445/funnel_http/releases/tag/v0.5.0) - 2025-04-14
+[full changelog](http://github.com/sue445/funnel_http/compare/v0.4.0...v0.5.0)
+
+* Impl `FunnelHttp::Client#perform!`
+  * https://github.com/sue445/funnel_http/pull/81
 
 ## [0.4.0](https://github.com/sue445/funnel_http/releases/tag/v0.4.0) - 2025-04-13
 [full changelog](http://github.com/sue445/funnel_http/compare/v0.3.2...v0.4.0)

data/README.md

@@ -64,6 +64,9 @@ responses = client.perform(requests)
 #   { url: "https://example.com/api/user/2", status_code: 200, body: "Response of /api/user/2", header: { "Content-Type" => ["text/plain;charset=utf-8"]} }
 #   { url: "https://example.com/api/user", status_code: 200, body: "Response of /api/user", header: { "Content-Type" => ["text/plain;charset=utf-8"]} }
 # ]
+
+# `#perform!` raise errors when http requests returns error status code (4xx, 5xx)
+responses = client.perform!(requests)
 ```
 
 ## Customize

data/lib/funnel_http/client.rb

@@ -41,10 +41,46 @@ module FunnelHttp
     # @return [Integer] `:status_code`
     # @return [String] `:body` Response body
     # @return [Hash{String => Array<String>}] `:header` Response header
+    #
+    # @note `#perform` doesn't raise errors when http requests returns error status code (4xx, 5xx)
     def perform(requests)
       ext_client.run_requests(normalize_requests(requests))
     end
 
+    # perform HTTP requests in parallel
+    #
+    # @overload perform(requests)
+    #   @param requests [Array<Hash{Symbol => Object}>] `Array` of following `Hash`
+    #   @option requests :method [String, Symbol] **[required]** Request method (e.g. `:get`, `"POST"`)
+    #   @option requests :url [String] **[required]** Request url
+    #   @option requests :header [Hash{String => String, Array<String>}, nil] Request header
+    #   @option requests :body [String, nil] Request body
+    #
+    # @overload perform(request)
+    #   @param request [Hash{Symbol => Object}]
+    #   @option request :method [String, Symbol] **[required]** Request method (e.g. `:get`, `"POST"`)
+    #   @option request :url [String] **[required]** Request url
+    #   @option request :header [Hash{String => String, Array<String>}, nil] Request header
+    #   @option request :body [String, nil] Request body
+    #
+    # @return [Array<Hash<Symbol => Object>>] `Array` of following `Hash`
+    # @return [String] `:url` Request url
+    # @return [Integer] `:status_code`
+    # @return [String] `:body` Response body
+    # @return [Hash{String => Array<String>}] `:header` Response header
+    #
+    # @raise [FunnelHttp::HttpAggregateError] 1+ errors returned out of multiple requests
+    #
+    # @note `#perform!` raise errors when http requests returns error status code (4xx, 5xx)
+    def perform!(requests)
+      responses = perform(requests)
+
+      error_responses = responses.select { |res| res[:status_code] >= 400 }
+      raise HttpAggregateError, error_responses unless error_responses.empty?
+
+      responses
+    end
+
     # @overload normalize_requests(requests)
     #   @param requests [Array<Hash{Symbol => Object}>] `Array` of following `Hash`
     #   @option requests :method [String, Symbol]  **[required]** Request method (e.g. `:get`, `"POST"`)

data/lib/funnel_http/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FunnelHttp
+  class Error < StandardError; end
+
+  # Aggregates multiple http errors
+  class HttpAggregateError < Error
+    # @!attribute [r] error_responses
+    #   @return [Array<Hash<Symbol => Object>>] `Array` of following `Hash`
+    #   @return [String] `:url` Request url
+    #   @return [Integer] `:status_code`
+    #   @return [String] `:body` Response body
+    #   @return [Hash{String => Array<String>}] `:header` Response header
+    attr_reader :error_responses
+
+    # @param error_responses [Array<Hash<Symbol => Object>>]
+    def initialize(error_responses)
+      @error_responses = error_responses
+      super(HttpAggregateError.generate_error_message(error_responses))
+    end
+
+    # Generate error message for `StandardError#initialize`
+    #
+    # @param error_responses [Array<Hash<Symbol => Object>>]
+    #
+    # @return [String]
+    def self.generate_error_message(error_responses)
+      error_responses.map { |res| "#{res[:url]} (#{res[:status_code]} error)" }.join(", ")
+    end
+  end
+end

data/lib/funnel_http/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FunnelHttp
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/funnel_http.rb

@@ -3,11 +3,10 @@
 require_relative "funnel_http/version"
 require_relative "funnel_http/client"
 require_relative "funnel_http/ext"
+require_relative "funnel_http/errors"
 require_relative "funnel_http/funnel_http"
 
 module FunnelHttp
-  class Error < StandardError; end
-
   USER_AGENT = "funnel_http/#{FunnelHttp::VERSION} (+https://github.com/sue445/funnel_http)"
 
   # Your code goes here...

data/sig/funnel_http/client.rbs

@@ -10,6 +10,8 @@ module FunnelHttp
 
     def perform: (fuzzy_request | Array[fuzzy_request] requests) -> Array[response]
 
+    def perform!: (fuzzy_request | Array[fuzzy_request] requests) -> Array[response]
+
     def normalize_requests: (fuzzy_request | Array[fuzzy_request] arg) -> Array[strict_request]
 
     private

data/sig/funnel_http/errors.rbs

@@ -0,0 +1,14 @@
+module FunnelHttp
+  class Error < StandardError
+  end
+
+  class HttpAggregateError < Error
+    @error_responses: Array[response]
+
+    attr_accessor error_responses: Array[response]
+
+    def initialize: (Array[response] error_responses) -> void
+
+    def self.generate_error_message: (Array[response] error_responses) -> String
+  end
+end

data/sig/funnel_http.rbs

@@ -2,9 +2,6 @@ module FunnelHttp
   VERSION: String
   USER_AGENT: String
 
-  class Error < StandardError
-  end
-
   type fuzzy_header = Hash[String, String | Array[String]]
 
   type fuzzy_request = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: funnel_http
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - sue445
@@ -202,12 +202,14 @@ files:
 - ext/funnel_http/run_requests.go
 - lib/funnel_http.rb
 - lib/funnel_http/client.rb
+- lib/funnel_http/errors.rb
 - lib/funnel_http/ext.rb
 - lib/funnel_http/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
 - sig/funnel_http.rbs
 - sig/funnel_http/client.rbs
+- sig/funnel_http/errors.rbs
 - sig/funnel_http/ext.rbs
 homepage: https://github.com/sue445/funnel_http
 licenses: