funnel_http 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6d1f5ffef3ad3e41de07eb3b94342bd082724aa3d1daad338603fbedbabcdc
-  data.tar.gz: f3208ba0c9154bd99fd2d373e91d3679690f0f711c74a3f11038c500c08fbd8a
+  metadata.gz: ca358cfbd282a397a1e8e4458f00c842deb22b8c3715a57bc26dfa171c0394f5
+  data.tar.gz: e730cb4d2cc871a82547b6008db1f919243e8102bdd28bfaa95b9838208c38a1
 SHA512:
-  metadata.gz: 87f9ad18e8c0005f2a3520d06381f3e308bbf6372827b631d646546c48f929be5879da1296331d9bab4ec7667786ce353473930b6795b84d0a46c11f9e68ec12
-  data.tar.gz: c92e03744f09aa670972e188bb0c94db2b2920f028994db5bb0f26d3804d470345b43087d57195666d1236bfc2adcc9c8ee8ccde4c0ca50ae94b54887a0c1dd6
+  metadata.gz: 5b567c0a370a7cdba78948dcb7ab66b97192c9bc227dc2b5da3fc5234fc955cf6e35b22455322a79235fbda3fbe51822765706229c928c5998709aa1808a6bc8
+  data.tar.gz: e3d5993b8445e7385c51ad410aa4d2e703c9f397129ae01551f1cb3d31cf5dcbc94c713009f02bb980c0c8c53702bb3dc31504f9e03736da472a43ea606fde31

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
-[full changelog](http://github.com/sue445/funnel_http/compare/v0.1.0...main)
+[full changelog](http://github.com/sue445/funnel_http/compare/v0.3.0...main)
+
+## [0.3.0](https://github.com/sue445/funnel_http/releases/tag/v0.3.0) - 2025-01-12
+[full changelog](http://github.com/sue445/funnel_http/compare/v0.2.0...v0.3.0)
+
+* Support request body
+  * https://github.com/sue445/funnel_http/pull/51
+
+## [0.2.0](https://github.com/sue445/funnel_http/releases/tag/v0.2.0) - 2025-01-07
+[full changelog](http://github.com/sue445/funnel_http/compare/v0.1.0...v0.2.0)
+
+* Support Ruby 3.4
+  * https://github.com/sue445/funnel_http/pull/48
 
 ## [0.1.0](https://github.com/sue445/funnel_http/releases/tag/v0.1.0) - 2024-12-18
 

data/README.md

@@ -1,6 +1,7 @@
 # FunnelHttp
 Perform HTTP requests in parallel
 
+[![Gem Version](https://badge.fury.io/rb/funnel_http.svg)](https://badge.fury.io/rb/funnel_http)
 [![build](https://github.com/sue445/funnel_http/actions/workflows/build.yml/badge.svg)](https://github.com/sue445/funnel_http/actions/workflows/build.yml)
 
 ## Requirements
@@ -44,12 +45,24 @@ requests = [
       "X-Multiple-Values" => ["1st value", "2nd value"],
     },
   },
+
+  # with request body
+  {
+    method: :post,
+    uri: "https://example.com/api/user",
+    header: {
+      "Authorization" => "Bearer xxxxxxxx",
+      "Content-Type" => "application/json",
+    },
+    body: '{"name": "sue445"}',
+  },
 ]
 
 responses = client.perform(requests)
 # => [
 #   { status_code: 200, body: "Response of /api/user/1", header: { "Content-Type" => ["text/plain;charset=utf-8"]} }
 #   { status_code: 200, body: "Response of /api/user/2", header: { "Content-Type" => ["text/plain;charset=utf-8"]} }
+#   { status_code: 200, body: "Response of /api/user", header: { "Content-Type" => ["text/plain;charset=utf-8"]} }
 # ]
 ```
 
@@ -72,6 +85,16 @@ client.add_default_request_header("Authorization", "Bearer xxxxxx")
 ## API Reference
 https://sue445.github.io/funnel_http/
 
+## Performance
+Depending on the case, `funnel_http` runs about 1.2x faster than pure-Ruby `Thread` :dash:
+
+See [benchmark/](benchmark/)
+
+### Why?
+`funnel_http` uses [Go's goroutine](https://go.dev/tour/concurrency) for asynchronous processing of HTTP requests.
+
+So this is faster than Ruby in many cases.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -26,7 +26,9 @@ namespace :go do
       sh "which golangci-lint" do |ok, _|
         raise "golangci-lint isn't installed. See. https://golangci-lint.run/welcome/install/" unless ok
       end
-      sh GoGem::RakeTask.build_env_vars, "golangci-lint run"
+
+      build_tag = GoGem::Util.ruby_minor_version_build_tag
+      sh GoGem::RakeTask.build_env_vars, "golangci-lint run --build-tags #{build_tag}"
     end
   end
 

data/benchmark/benchmark.rb

@@ -5,11 +5,11 @@ require "etc"
 
 ROOT_DIR = File.expand_path("..", __dir__)
 
-TEST_SERVER_URL = "http://localhost:8080/"
+TEST_SERVER_URL = ENV.fetch("TEST_SERVER_URL") { "http://localhost:8080/" }
 
 REQUEST_COUNT = 100
 
-BENCHMARK_CONCURRENCY = ENV.fetch("BENCHMARK_CONCURRENCY") { 4 }
+BENCHMARK_CONCURRENCY = (ENV.fetch("BENCHMARK_CONCURRENCY") { 4 }).to_i
 
 # Build native extension before running benchmark
 Dir.chdir(ROOT_DIR) do
@@ -32,7 +32,7 @@ def fetch_server
 end
 
 Benchmark.ips do |x|
-  x.config(warmup: 1, time: 2)
+  # x.config(warmup: 1, time: 2)
 
   x.report("FunnelHttp::Client#perform") do
     FunnelHttp::Client.new.perform(requests)

data/ext/funnel_http/funnel_http.go

@@ -26,6 +26,7 @@ func rb_funnel_http_run_requests(self C.VALUE, rbAry C.VALUE) C.VALUE {
 			Method: getRbHashValueAsString(rbHash, "method"),
 			URL:    getRbHashValueAsString(rbHash, "url"),
 			Header: getRbHashValueAsMap(rbHash, "header"),
+			Body:   getRbHashValueAsBytes(rbHash, "body"),
 		}
 		requests = append(requests, req)
 	}
@@ -111,6 +112,22 @@ func getRbHashValueAsString(rbHash ruby.VALUE, key string) string {
 	return ruby.Value2String(value)
 }
 
+func getRbHashValueAsBytes(rbHash ruby.VALUE, key string) []byte {
+	value := ruby.RbHashAref(rbHash, ruby.RbToSymbol(ruby.String2Value(key)))
+
+	if value == ruby.Qnil() {
+		return []byte{}
+	}
+
+	length := ruby.RSTRING_LENINT(value)
+	if length == 0 {
+		return []byte{}
+	}
+
+	char := ruby.RSTRING_PTR(value)
+	return C.GoBytes(unsafe.Pointer(char), C.int(length))
+}
+
 func getRbHashValueAsMap(rbHash ruby.VALUE, key string) map[string][]string {
 	rbHashValue := ruby.RbHashAref(rbHash, ruby.RbToSymbol(ruby.String2Value(key)))
 	rbKeys := ruby.CallFunction(rbHashValue, "keys")

data/ext/funnel_http/go.mod

@@ -5,7 +5,7 @@ go 1.23
 require (
 	github.com/cockroachdb/errors v1.11.3
 	github.com/jarcoal/httpmock v1.3.1
-	github.com/ruby-go-gem/go-gem-wrapper v0.5.1
+	github.com/ruby-go-gem/go-gem-wrapper v0.6.0
 	github.com/stretchr/testify v1.10.0
 	golang.org/x/sync v0.10.0
 )

data/ext/funnel_http/go.sum

@@ -36,6 +36,8 @@ github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZV
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/ruby-go-gem/go-gem-wrapper v0.5.1 h1:TFGH/eOJl0uYzYMwrcLbZxXNQiQbQjCq/VLXyRk1HRM=
 github.com/ruby-go-gem/go-gem-wrapper v0.5.1/go.mod h1:k2k+LziSCMxNYP4J9/9v90xdU6zlU1DJpJDTU6oJhHE=
+github.com/ruby-go-gem/go-gem-wrapper v0.6.0 h1:WFu2Cj/uzKAOemsrCo4P6vsdOgB5yesrrJtAqvLkAso=
+github.com/ruby-go-gem/go-gem-wrapper v0.6.0/go.mod h1:k2k+LziSCMxNYP4J9/9v90xdU6zlU1DJpJDTU6oJhHE=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=

data/ext/funnel_http/run_requests.go

@@ -13,6 +13,7 @@ type Request struct {
 	Method string
 	URL    string
 	Header map[string][]string
+	Body   []byte
 }
 
 // Response is proxy between CRuby and Go
@@ -33,8 +34,7 @@ func RunRequests(httpClient *http.Client, requests []Request) ([]Response, error
 		request := request
 
 		g.Go(func() error {
-			var body []byte
-			httpReq, err := http.NewRequest(request.Method, request.URL, bytes.NewBuffer(body))
+			httpReq, err := http.NewRequest(request.Method, request.URL, bytes.NewBuffer(request.Body))
 			if err != nil {
 				return errors.WithStack(err)
 			}

data/ext/funnel_http/run_requests_test.go

@@ -1,9 +1,11 @@
 package main_test
 
 import (
+	"github.com/cockroachdb/errors"
 	"github.com/jarcoal/httpmock"
 	"github.com/stretchr/testify/assert"
 	"github.com/sue445/funnel_http"
+	"io"
 	"net/http"
 	"testing"
 )
@@ -42,13 +44,33 @@ func TestRunRequests(t *testing.T) {
 			return resp, nil
 		})
 
+	httpmock.RegisterResponder("POST", "http://example.com/1",
+		func(req *http.Request) (*http.Response, error) {
+			payload, err := io.ReadAll(req.Body)
+			if err != nil {
+				return nil, errors.WithStack(err)
+			}
+
+			resp := httpmock.NewStringResponse(200, string(payload))
+
+			resp.Header.Set("Content-Type", "text/plain")
+
+			for key, values := range req.Header {
+				for _, value := range values {
+					resp.Header.Add(key, value)
+				}
+			}
+
+			return resp, nil
+		})
+
 	tests := []struct {
 		name     string
 		requests []main.Request
 		expected []main.Response
 	}{
 		{
-			name: "1 request",
+			name: "GET 1 request",
 			requests: []main.Request{
 				{
 					Method: "GET",
@@ -70,7 +92,7 @@ func TestRunRequests(t *testing.T) {
 			},
 		},
 		{
-			name: "multiple requests",
+			name: "GET multiple requests",
 			requests: []main.Request{
 				{
 					Method: "GET",
@@ -106,6 +128,68 @@ func TestRunRequests(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "POST 1 request",
+			requests: []main.Request{
+				{
+					Method: "POST",
+					URL:    "http://example.com/1",
+					Header: map[string][]string{
+						"X-My-Request-Header": {"a", "b"},
+					},
+					Body: []byte("111"),
+				},
+			},
+			expected: []main.Response{
+				{
+					StatusCode: 200,
+					Body:       []byte("111"),
+					Header: map[string][]string{
+						"Content-Type":        {"text/plain"},
+						"X-My-Request-Header": {"a", "b"},
+					},
+				},
+			},
+		},
+		{
+			name: "POST multiple requests",
+			requests: []main.Request{
+				{
+					Method: "POST",
+					URL:    "http://example.com/1",
+					Header: map[string][]string{
+						"X-My-Request-Header": {"a", "b"},
+					},
+					Body: []byte("111"),
+				},
+				{
+					Method: "POST",
+					URL:    "http://example.com/1",
+					Header: map[string][]string{
+						"X-My-Request-Header": {"c", "d"},
+					},
+					Body: []byte("222"),
+				},
+			},
+			expected: []main.Response{
+				{
+					StatusCode: 200,
+					Body:       []byte("111"),
+					Header: map[string][]string{
+						"Content-Type":        {"text/plain"},
+						"X-My-Request-Header": {"a", "b"},
+					},
+				},
+				{
+					StatusCode: 200,
+					Body:       []byte("222"),
+					Header: map[string][]string{
+						"Content-Type":        {"text/plain"},
+						"X-My-Request-Header": {"c", "d"},
+					},
+				},
+			},
+		},
 	}
 
 	httpClient := http.Client{}

data/lib/funnel_http/client.rb

@@ -27,12 +27,14 @@ module FunnelHttp
     #   @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 [Integer] `:status_code`
@@ -78,6 +80,7 @@ module FunnelHttp
           url: request[:url].to_s,
           method: request[:method].to_s.upcase,
           header: normalize_header(request[:header]),
+          body: request[:body].freeze,
         }
       end
     end

data/lib/funnel_http/version.rb

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

data/rbs_collection.lock.yaml

@@ -14,7 +14,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0a6ea105a0afc7eaee4494585a7775f47eea6145
+    revision: 7ff8cf6ab2759cb1d0fb2ca8d6c1f8ccab2c605c
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
@@ -29,12 +29,20 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 7ff8cf6ab2759cb1d0fb2ca8d6c1f8ccab2c605c
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: rack
   version: '2.2'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0a6ea105a0afc7eaee4494585a7775f47eea6145
+    revision: 7ff8cf6ab2759cb1d0fb2ca8d6c1f8ccab2c605c
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rake
@@ -42,7 +50,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0a6ea105a0afc7eaee4494585a7775f47eea6145
+    revision: 7ff8cf6ab2759cb1d0fb2ca8d6c1f8ccab2c605c
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: sinatra
@@ -50,7 +58,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 0a6ea105a0afc7eaee4494585a7775f47eea6145
+    revision: 7ff8cf6ab2759cb1d0fb2ca8d6c1f8ccab2c605c
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: stringio

data/sig/funnel_http.rbs

@@ -10,7 +10,8 @@ module FunnelHttp
   type fuzzy_request = {
     method: String | Symbol,
     url: String,
-    header: fuzzy_header?
+    header: fuzzy_header?,
+    body: String?,
   }
 
   type strict_header = Hash[String, Array[String]]

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: funnel_http
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - sue445
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: go_gem
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +238,6 @@ metadata:
   changelog_uri: https://github.com/sue445/funnel_http/blob/main/CHANGELOG.md
   documentation_uri: https://sue445.github.io/funnel_http/
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -254,8 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Perform HTTP requests in parallel
 test_files: []