tuber 0.0.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b8831d5bdb6338f58cee603b906c4d41a4c36a0a4ac497ab3761838e8e5ffa
-  data.tar.gz: 361c630c0d818b347dc033ba14c6679a60ea1d35e8bfb22feae2f86ac9ca151b
+  metadata.gz: 28e2397d8368c54a6711fa1db82b5c54ea649a4113e4da808b9dbc6db9cec1cb
+  data.tar.gz: dee769c5e37ff64726e1563150af3a25e2dc3f65405844f58b76bafbf4f7148f
 SHA512:
-  metadata.gz: 39705970d8f4128a944dbb48741cebfaf34071eba99a50c5ee308c4b5f5d416d9c6ae2b054ea792701aea751da3fc26fc683d1bad074c38642d9911dd03c2d0e
-  data.tar.gz: 1e3e6de54b17990613c44b81d4318cfc5b6dcef81f94bef600614ca93cccf29503c3ab63dbc34decc44a8e2a63def7a6008a029039bd0a87f84dcb14a37e92e0
+  metadata.gz: 48a99c28b12b3f83cd1f24f743fabda6f06a97802c3e2633bb805f7309a3574508d45b3ba7c2ce1cfd7842b1f92159115e19f7331362c79d662c687f0b60af75
+  data.tar.gz: 60fa0ea0b9d9440ba798bf953f640f9a6c654bf3988bdca58bc51e037bfa347fefc606964c81a236335467cd5441ce4344ef9382a725e2920d69d8a871ba996f

data/.github/workflows/ruby.yml

@@ -0,0 +1,68 @@
+# CI runs the full suite against Tuber (the primary target) and the portable
+# subset against stock beanstalkd (Tuber-only tests skip via require_tuber!).
+
+name: Build Status
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: tuber (ruby ${{ matrix.ruby-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4", "4.0"]
+
+    steps:
+    - uses: actions/checkout@v4
+    # Not a service container: the image's entrypoint needs the `server`
+    # subcommand, and services can't pass a command.
+    - name: Start tuber
+      run: |
+        docker run -d --name tuber -p 11300:11300 ghcr.io/tuberq/tuber:latest server
+        for i in $(seq 1 30); do (echo > /dev/tcp/127.0.0.1/11300) 2>/dev/null && exit 0; sleep 1; done
+        docker logs tuber; exit 1
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake test:full
+      env:
+        TUBER_TEST_ADDRESS: 127.0.0.1
+
+  beanstalkd-compat:
+    name: beanstalkd compat (ruby ${{ matrix.ruby-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.7", "4.0"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Download & Extract beanstalkd
+      run: curl -L https://github.com/beanstalkd/beanstalkd/archive/refs/tags/v1.13.tar.gz | tar xz
+    - name: Make beanstalkd
+      run: make
+      working-directory: beanstalkd-1.13
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Daemonize beanstalkd
+      run: ./beanstalkd-1.13/beanstalkd -l 127.0.0.1 &
+    - name: Run tests
+      run: bundle exec rake test:full
+      env:
+        TUBER_TEST_ADDRESS: 127.0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+_yardoc
+.bundle
+.config
+.yardoc
+*.gem
+*.rbc
+coverage
+doc/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.yardopts

@@ -0,0 +1,8 @@
+--output-dir doc/
+--readme README.md
+--title Tuber
+--markup-provider=redcarpet
+--markup=markdown
+--protected
+--no-private
+lib/tuber/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,134 @@
+# CHANGELOG for the tuber gem
+
+The tuber gem is a fork of [beaneater](https://github.com/beanstalkd/beaneater), taken at
+beaneater 1.1.4. Entries from 1.1.4 down are beaneater's history, kept for reference.
+(0.0.1 was an empty placeholder published to claim the gem name.)
+
+## 0.6.0 (September 16 2026)
+
+Reconnection release. The gem retried reconnects but not connects, so a
+consumer that caught `Tuber::NotConnected` and built a new client — the obvious
+thing to write — never reached the retrying path, and a server restart of a few
+seconds was enough to kill it. `reconnect!` makes the existing healing
+reachable, and `connect_retries` gives a cold start a window wider than the
+outage. Existing behaviour is unchanged until `connect_retries` is raised, with
+two exceptions noted below: `NotConnected` messages gained a suffix (the
+historical text remains a strict prefix), and a connect error other than
+`ECONNREFUSED` is now retried and surfaced as `NotConnected` rather than
+escaping as a raw `Errno`.
+
+* Add `Tuber#reconnect!` / `Connection#reconnect!`: re-establishes the connection and replays its tube state (watched tubes with their weights, the used tube, the reserve mode). This healing only ever ran when the connection itself noticed a dropped socket, so a consumer that caught `Tuber::NotConnected` had no way to reach it and had to build a new client — which starts with no tube state and has to re-watch and re-weight every tube by hand.
+* Add `connect_retries` and `connect_retry_interval` configuration. The initial connect took exactly one attempt with no retry, so a cold start during a server restart — a web boot, a fresh `Tuber.new`, a daemon rebuilding its client after an error — failed where an established connection would have healed. Defaults to the historical single attempt; raising it also lifts the reconnect budget of connections already established, so one knob covers both.
+* Retry a connect that fails for any reason the server might be unreachable (`ETIMEDOUT`, `EHOSTUNREACH`, `ENETUNREACH`, DNS failure, connect timeout), not only `ECONNREFUSED`. Those previously escaped as a raw `Errno` from the middle of a reconnect, a class no consumer thinks to rescue.
+* `Tuber::NotConnected` now names the underlying error in its message and keeps it as the exception's `cause`. A bare `rescue` collapsed every connect failure into "Connection to beanstalk '...' is closed!", hiding whether the server refused, timed out, or was never resolved — exactly what you need during an outage.
+* `Connection#close` no longer raises if the socket cannot be closed cleanly; the connection is gone either way and `reconnect!` must not fail on the way to replacing it.
+* Fix a reconnect silently dropping per-tube weights and the connection's reserve mode ([#1](https://github.com/tuberq/tuber-gem/issues/1)). Both are per-connection server state that a fresh socket resets, so a consumer that healed across a brief server restart kept working but quietly fell back to FIFO. `Connection` now remembers the weight each tube was watched with and the mode set by `Tubes#reserve_mode`, and replays them (watch, then `ignore default`, then `reserve-mode`) when re-initialising tubes.
+* Fix `_initialize_tubes` sending `ignore default` after a reconnect even when `default` was one of the watched tubes, which dropped it from the watch list.
+* `Connection#add_to_watched` now takes an optional weight as a second argument, and `Connection#tube_weights` / `Connection#reserve_mode` expose the replayed state.
+
+## 0.5.1 (August 13 2026)
+
+* Fix empty keyword arguments forwarded through `Tube#transmit`, `Tubes#transmit` and `Jobs#transmit` arriving as an extra positional `{}` on Ruby 2.7
+* CI: start the Tuber container with an explicit `server` subcommand, add Ruby 4.0 to the test matrix
+
+## 0.5.0 (August 13 2026)
+
+First functional release under the `tuber` name. Versioning restarts below 1.0
+while the Tuber-first API settles; 1.0.0 will follow once it has. Entries below
+1.1.4 with earlier version numbers are beaneater history.
+
+* **Renamed from `beaneater` to `tuber`** (briefly `russet` while the gem name was being freed up, though never published under that name). The `Beaneater` class is now `Tuber`, and `require 'beaneater'` becomes `require 'tuber'`. Nothing else changed in the rename — see "Migrating from beaneater" in the README.
+* Fix `_with_retry` retransmitting non-idempotent commands (`put`/`delete`/`release`/`bury`/`touch`/`kick` and batch variants) after a reconnect: the first send's fate is unknown, so a re-sent `put` could duplicate a job and a re-sent `delete` could raise `NOT_FOUND` for work that succeeded. These verbs now reconnect (and re-watch tubes) but re-raise the original connection error so the caller decides; idempotent commands keep the transparent retry.
+* Add `Jobs#touch_all` (Tuber 0.12.0+): one-command heartbeat for every job the connection holds, returning how many were still held
+* Add `Tube#flush_buried` (Tuber only): atomically deletes only the buried jobs in a tube, returning the count
+* Add optional long-poll `timeout` to `reserve_batch` (Tuber only): `tubes.reserve_batch(count, timeout)` blocks up to `timeout` seconds for the first job, then drains what's ready
+* Add `connect_timeout` (Ruby 3+), `resolv_timeout` (Ruby 3+), `read_timeout`, and `write_timeout` configuration options (@rveznaver)
+* Fix fractional timeout handling for `read_timeout` and `write_timeout` socket options
+* Add `TUBER_URL` environment variable and `config.tuber_url` as the primary way to point at a server; `BEANSTALKD_URL` and `config.beanstalkd_url` remain as compatible fallbacks/aliases
+* Tests can target a specific server via `TUBER_TEST_ADDRESS`, and Tuber-only tests skip automatically against stock beanstalkd; CI runs the full suite against Tuber and the portable subset against beanstalkd
+* Fix `StatStruct#[]` raising a `SyntaxError` when looking up hyphenated beanstalkd keys (e.g. `stats['current-jobs-ready']`); keys are now underscored before lookup to match how they are stored
+
+## 1.1.4 (March 6 2026)
+
+* Add frozen string literal comments for Ruby 3.4 compatibility (@nearapogee)
+* Update tests for Ruby 3.4.x (@nearapogee)
+* Add GitHub Actions CI workflow (@Ifiht)
+* Update README.md (@Ifiht)
+
+## 1.1.3 (Oct 14 2022)
+
+* Fixes issue introduced in 1.1.2 re YML parsing (@pond)
+* Fix job lookup test so it passes again
+
+## 1.1.2 (Oct 10 2022)
+
+* Fixes beaneater when used with Ruby 3.1 and YAML 4 (@pond)
+
+## 1.1.1 (April 27th 2021)
+
+* Support Ruby 3 keyword arguments (@yahonda)
+* Add CI for Ruby 3 (@yahonda)
+
+## 1.1.0 (April 25th 2021)
+
+* 'clear' behavior was failing unexpectedly, swallow issues during delete as well (@bfolkens)
+* Fix assigned but unused variables (@utilum)
+* Fix last_used tube not stored (@albb0920)
+* Fix deprecation warning in ruby 2.7 (@albb0920)
+* Fix watched tubes not restored after reconnect (@albb0920)
+* Fix keyword arguemnt warning (@albb0920)
+
+## 1.0.0 (April 26th 2015)
+
+* Beginning from version 1.0.0 the support for `Beaneater::Pool` has been dropped (@alup)
+* `Jobs#find_all` method has been removed, since it is no longer necessary after removing pool (@alup)
+* `Tubes` is now an enumerable allowing `tubes` to be handled as a collection (@Aethelflaed)
+
+## 0.3.3 (August 16th 2014)
+
+* Fix failure when job is not defined and fix exception handling for jobs (@nicholasorenrawlings)
+* Add reserve_timeout option to job processing (@nicholasorenrawlings)
+* Add travis-ci badge (@tdg5)
+* Fix tests to run more reliably (@tdg5)
+
+## 0.3.2 (Sept 15 2013)
+
+* Fix #29 ExpectedCrlfError name and invocation (@tdg5)
+
+## 0.3.1 (Jun 28 2013)
+
+* Fixes issue with "chomp" nil exception when losing connection (Thanks @simao)
+* Better handling of unknown or invalid commands during transmit
+* Raise proper CRLF exception (Thanks @carlosmoutinho)
+
+## 0.3.0 (Jan 23 2013)
+
+* Replace Telnet with tcpsocket thanks @vidarh
+
+## 0.2.2 (Dec 2 2012)
+
+* Fixes status and ID parsing in a response (Thanks @justincase)
+
+## 0.2.1 (Dec 1 2012)
+
+* Convert command to ASCII_8Bit to avoid gsub issues
+
+## 0.2.0 (Nov 12 2012)
+* Fix 1.8.7 compatibility issues
+* Add configuration block to beaneater and better job parsing
+* BREAKING: json jobs now return as string by default not hashes
+
+## 0.1.2 (Nov 7 2012)
+
+* Add timeout: false to transmit to allow longer reserve
+
+## 0.1.1 (Nov 4 2012)
+
+* Add `Jobs#find_all` to fix #10
+* Fixed issue with `tubes-list` by merging results
+* Add `Job#ttr`, `Job#pri`, `Job#delay`
+* Improved yardocs coverage and accuracy
+
+## 0.1.0 (Nov 1 2012)
+
+* Initial release!

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tuber.gemspec
+gemspec
+
+group :development do
+  # 3.5.1 fixes CVE-2020-26298 (XSS when processing quotes). The old '~> 1'
+  # pin was inherited from beaneater and capped us below the fix.
+  gem 'redcarpet', '~> 3.6', '>= 3.5.1'
+  gem 'github-markup'
+  gem 'yard'
+end
+
+group :development, :test do
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2012 Nico Taing
+Copyright (c) 2026 Dan Milne
+
+Tuber is a fork of beaneater (https://github.com/beanstalkd/beaneater),
+originally written by Nico Taing and contributors, and is distributed under
+the same MIT License.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.