nxt_http_client 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15083d70472500d85d5b14313db955407d41c0381253824df06d7b62408be81
-  data.tar.gz: c8eac41c1f068d3cfb2892eadda053deb928e8bb1595cade76549d53e72db677
+  metadata.gz: 6cccf6ffc8c507e36f58161ef7bd6b6412312015f5cf53d26f9ac2ea52244b8c
+  data.tar.gz: bc67df2f1885c7a49dabbdf4b49f823ec2f6bd1acba006295b847a1d181ed4aa
 SHA512:
-  metadata.gz: edaeb82434e63eaebe71ddfc93d029d91e468d800dc21b42825136e483ef4353f229df48737eb59f373bea51f5365c8d3ba6faea553b93ac4b4fa4f2eed5c376
-  data.tar.gz: 141abc01af4c33257773c42e4d8f6ca82e59034e9ecdbd49adf837b395d0c345bbc493e0e718f2c779d1befeea4057c0ef9a1b5913315a25419349aeec1a8319
+  metadata.gz: 9ed4b1e266af12b23d2d7e4cbfd448a0ae5e9e9cf9fd48358f06b2d515e1d58e8db68fe29742f28908b30f9e93f51e9de9d181c30302c2b098647d23f3417631
+  data.tar.gz: f0f391aa5e8ea47fea76d197442b95799a9c6e9d17723dc958612d42dc499c872082b968a906a65f1367f07817ea304bb52d41addc0b1273e2bbb89460c041f4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.1.0 2023-04-03
+- Introduce a Typhoeus::Hydra interface for batch executions
+
 # v1.0.4 2022-06-08
 - Fix bug where callbacks were shared between unrelated child client class ([#130](https://github.com/nxt-insurance/nxt_http_client/pull/130))
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_http_client (1.0.4)
+    nxt_http_client (1.1.0)
       activesupport (< 8.0)
       nxt_registry
       typhoeus
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,18 +17,18 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    ethon (0.15.0)
+    ethon (0.16.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
     hashdiff (1.0.1)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.18.0)
     nxt_registry (0.3.10)
       activesupport
     nxt_vcr_harness (0.1.4)
@@ -59,7 +59,7 @@ GEM
     timecop (0.9.5)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     vcr (6.1.0)
     webmock (3.14.0)

data/lib/nxt_http_client/batch_execution.rb

@@ -0,0 +1,26 @@
+module NxtHttpClient
+  def self.execute_in_batch(*client_instances, ignore_around_callbacks: false, raise_errors: true)
+    client_map = Hash.new do |hash, key|
+      hash[key] = { request: nil, error: nil, result: nil }
+    end
+
+    client_instances.each do |client|
+      client.singleton_class.include(NxtHttpClient::Client::BatchPatch)
+      client.assign_batch_data(client_map[client], ignore_around_callbacks)
+    end
+
+    hydra = Typhoeus::Hydra.new
+
+    client_instances.each do |client|
+      client.call.tap do |request|
+        hydra.queue(request)
+      end
+    end
+
+    hydra.run
+
+    client_map.map do |client, response_data|
+      client.finish(response_data[:request], response_data[:result], response_data[:error], raise_errors: raise_errors)
+    end
+  end
+end

data/lib/nxt_http_client/client/batch_patch.rb

@@ -0,0 +1,55 @@
+module NxtHttpClient
+  class Client
+    module BatchPatch
+      attr_reader :callback_map, :ignore_around_callbacks
+
+      def assign_batch_data(callback_map, ignore_around_callbacks)
+        @callback_map = callback_map
+        @ignore_around_callbacks = ignore_around_callbacks
+      end
+
+      def fire(url = '', **opts, &block)
+        response_handler = build_response_handler(opts[:response_handler], &block)
+        request = build_request(url, **opts.except(:response_handler))
+        callback_map[:request] = request
+
+        setup_on_headers_callback(request, response_handler)
+        setup_on_body_callback(request, response_handler)
+
+        request.on_complete do |response|
+          callback_map[:result] = callback_or_response(response, response_handler)
+        rescue StandardError => e
+          callback_map[:error] = e
+        end
+
+        if callbacks.any_around_callbacks? && ignore_around_callbacks != true
+          raise(
+            ArgumentError,
+            <<~TXT
+              `around_fire` callbacks are not supported when firing batches. \
+              Pass `ignore_around_callbacks: true` to `execute_in_batch` \
+              in order to acknowledge and muffle this.
+            TXT
+          )
+        end
+
+        run_before_fire_callbacks(request, response_handler)
+
+        request
+      end
+
+      def finish(request, result, error, raise_errors: true)
+        result = run_after_fire_callbacks(request, request.response, result, error)
+
+        case [error, raise_errors]
+        in [nil, _]
+          result
+        in [_, true]
+          raise error
+        in [_, false]
+          error
+        end
+      end
+    end
+  end
+end

data/lib/nxt_http_client/fire_callbacks.rb

@@ -30,6 +30,10 @@ module NxtHttpClient
       end
     end
 
+    def any_around_callbacks?
+      registry.resolve(:around).any?
+    end
+
     def any_after_callbacks?
       registry.resolve(:after).any?
     end

data/lib/nxt_http_client/version.rb

@@ -1,3 +1,3 @@
 module NxtHttpClient
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/nxt_http_client.rb

@@ -11,6 +11,8 @@ require 'nxt_http_client/logger'
 require 'nxt_http_client/fire_callbacks'
 require 'nxt_http_client/client_dsl'
 require 'nxt_http_client/client'
+require 'nxt_http_client/client/batch_patch'
+require 'nxt_http_client/batch_execution'
 require 'nxt_http_client/error'
 
 module NxtHttpClient

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_http_client
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -216,7 +216,9 @@ files:
 - bin/console
 - bin/setup
 - lib/nxt_http_client.rb
+- lib/nxt_http_client/batch_execution.rb
 - lib/nxt_http_client/client.rb
+- lib/nxt_http_client/client/batch_patch.rb
 - lib/nxt_http_client/client_dsl.rb
 - lib/nxt_http_client/config.rb
 - lib/nxt_http_client/error.rb