hey.rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8128fb1d6b6a9ea692e35d60a335081cdedf27ce74945a95de667c38d1647187
+  data.tar.gz: e1e860534d63ad6181bce7ee63a8f71ddc2fdc125311102dbd740169e4d338d7
+SHA512:
+  metadata.gz: d8a9182e54340bf43b3d910a9c33d24f2290fdcfa4ebe0ba7bf1042d36453c0c597b9745344bf85195a935bfabb47be84c56d5fb28b183013a1b08e20f091e50
+  data.tar.gz: e748d853ce770bdf70905d63ab9fc514e589c3925ffa8e2be96781f4a11b6f07502f312cc306485882fe85f1c941ef947ef4796b6af640e32d73a004790d6122

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-10-17
+
+### Added
+
+- Initial release: a file-by-file Ruby port of [rakyll/hey](https://github.com/rakyll/hey),
+  built on async-http. Goroutines and channels become `Async` tasks and
+  `Async::LimitedQueue`; `net/http` becomes `Async::HTTP::Client`; Go's
+  `text/template` output becomes ERB.
+- Every flag the Go original accepts: `-n`, `-c`, `-q`, `-z`, `-o`, `-m`, `-H`,
+  `-t`, `-A`, `-d`, `-D`, `-T`, `-U`, `-a`, `-x`, `-h2`, `-host`, `-cpus`,
+  `-disable-compression`, `-disable-keepalive` and `-disable-redirects`, parsed
+  with Go's `flag` semantics.
+- Summary and CSV output byte-identical to the Go original's, including its
+  `%%` and swapped fastest/slowest quirks, and its `-a` bug. See the README.
+- Per-phase request timings (DNS, connection, request write, response wait,
+  response read) recovered by instrumenting the endpoint and request body,
+  since async-http has no equivalent of `net/http`'s trace hooks. Bodyless
+  requests report a request-write time of zero.
+- `-cpus` is accepted and ignored, because async runs on a single thread per
+  process. `-x` tunnels via HTTP CONNECT, so a proxied run's DNS and connection
+  timings are not meaningful.
+
+[Unreleased]: https://github.com/n-at-han-k/hey.rb/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/n-at-han-k/hey.rb/releases/tag/v1.0.0

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

data/NOTICE

@@ -0,0 +1,18 @@
+hey.rb
+Copyright 2026 Nathan Kidd
+
+This product includes software developed at Google Inc.
+
+This is a Ruby port of hey (https://github.com/rakyll/hey), originally written
+in Go:
+
+    Copyright 2014 Google Inc. All Rights Reserved.
+
+hey was originally called boom, and was influenced by Tarek Ziade's tool at
+https://github.com/tarekziade/boom.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files except in compliance with the License. You may obtain a copy of the
+License at
+
+    http://www.apache.org/licenses/LICENSE-2.0

data/README.md

@@ -0,0 +1,165 @@
+![hey](http://i.imgur.com/szzD9q0.png)
+
+hey is a tiny program that sends some load to a web application.
+
+This is a Ruby port of [rakyll/hey](https://github.com/rakyll/hey), translated
+file by file from the Go original. It is built on
+[async-http](https://github.com/socketry/async-http): Go's goroutines and
+channels become `Async` tasks and queues, and `net/http` becomes
+`Async::HTTP::Client`.
+
+hey was originally called boom and was influenced from Tarek Ziade's
+tool at [tarekziade/boom](https://github.com/tarekziade/boom). Using the same name was a mistake as it resulted in cases
+where binary name conflicts created confusion.
+To preserve the name for its original owner, we renamed this project to hey.
+
+## Installation
+
+Requires Ruby 3.2 or later. The gem is named `hey.rb`, because `hey` was
+already taken; the command it installs is `hey`.
+
+```
+gem install hey.rb
+hey https://google.com
+```
+
+From a checkout:
+
+```
+git clone https://github.com/n-at-han-k/hey.rb
+cd hey.rb
+bundle install
+./exe/hey https://google.com
+```
+
+With [Nix](https://nixos.org/), the included flake provides a dev shell with
+every dependency:
+
+```
+nix develop
+./exe/hey https://google.com
+```
+
+## Usage
+
+hey runs provided number of requests in the provided concurrency level and prints stats.
+
+It also supports HTTP2 endpoints.
+
+```
+Usage: hey [options...] <url>
+
+Options:
+  -n  Number of requests to run. Default is 200.
+  -c  Number of workers to run concurrently. Total number of requests cannot
+      be smaller than the concurrency level. Default is 50.
+  -q  Rate limit, in queries per second (QPS) per worker. Default is no rate limit.
+  -z  Duration of application to send requests. When duration is reached,
+      application stops and exits. If duration is specified, n is ignored.
+      Examples: -z 10s -z 3m.
+  -o  Output type. If none provided, a summary is printed.
+      "csv" is the only supported alternative. Dumps the response
+      metrics in comma-separated values format.
+
+  -m  HTTP method, one of GET, POST, PUT, DELETE, HEAD, OPTIONS.
+  -H  Custom HTTP header. You can specify as many as needed by repeating the flag.
+      For example, -H "Accept: text/html" -H "Content-Type: application/xml" .
+  -t  Timeout for each request in seconds. Default is 20, use 0 for infinite.
+  -A  HTTP Accept header.
+  -d  HTTP request body.
+  -D  HTTP request body from file. For example, /home/user/file.txt or ./file.txt.
+  -T  Content-type, defaults to "text/html".
+  -U  User-Agent, defaults to version "hey/0.0.1".
+  -a  Basic authentication, username:password.
+  -x  HTTP Proxy address as host:port.
+  -h2 Enable HTTP/2.
+
+  -host	HTTP Host header.
+
+  -disable-compression  Disable compression.
+  -disable-keepalive    Disable keep-alive, prevents re-use of TCP
+                        connections between different HTTP requests.
+  -disable-redirects    Disable following of HTTP redirects
+  -cpus                 Number of used cpu cores.
+                        (default for current machine is 4 cores)
+
+```
+
+## Examples
+
+Make requests with default settings:
+```
+hey https://google.com
+```
+
+Make 1000 requests with 100 concurrent workers:
+```
+hey -n 1000 -c 100 https://google.com
+```
+
+Run load test for 30 seconds:
+```
+hey -z 30s https://google.com
+```
+
+Make POST request with custom body:
+```
+hey \
+    -m POST \
+    -d "param1=value1&param2=value2" \
+    https://google.com
+```
+
+Add custom headers:
+```
+hey \
+    -H "Accept: application/json" \
+    -H "Authorization: Bearer token" \
+    https://google.com
+```
+
+Test with HTTP/2:
+```
+hey -h2 https://google.com
+```
+
+Rate limit to 10 queries per second per worker:
+```
+hey -q 10 -c 5 -z 30s https://google.com
+```
+
+Dump per-request metrics as CSV:
+```
+hey -n 1000 -o csv https://google.com
+```
+
+## Development
+
+```
+rspec
+```
+
+## Notes on the port
+
+The translation is file for file, and the summary and CSV output are
+byte-identical to the Go original's, including two quirks that were kept
+rather than fixed:
+
+  - The latency distribution prints `%%` where a single `%` was intended, and
+    a percentile that was not reached prints as a `0%` row.
+  - In the "Details" block the columns labelled *fastest* and *slowest* are
+    the other way round for every stage except the overall figures.
+
+`-a` (basic authentication) also has no effect, because `hey.go` replaces the
+request's header set after writing the Authorization header. Setting the
+header explicitly with `-H "Authorization: ..."` works.
+
+Three flags differ because the runtime does:
+
+  - `-cpus` is accepted and ignored; async runs on a single thread per process.
+  - `-x` tunnels via HTTP CONNECT, so the DNS and connection timings reported
+    for a proxied run are not meaningful.
+  - Request-write and response-wait timings are derived from when async-http
+    finishes writing the body and returns response headers, rather than from
+    `net/http`'s per-phase trace hooks. Bodyless requests therefore report a
+    request-write time of zero.