Standardize signature parity testing, add Docker for testing (#73)

* Test in docker, simplify sig parity

* Add optional end-to-end upload test harness

* Run Ruby e2e upload test in CI

* Fail e2e CI job when secrets missing

* Fix e2e CI secret check expression

* Disable VCR for live e2e upload test

* Enable Ruby e2e test by default in Docker harness

* Restore URI dependency for request loader

* Release 3.1.1

* Stabilize to_json test by freezing time

* Document contributing workflow and add release helper

Author: kvz

.dockerignore

@@ -0,0 +1,9 @@
+.git
+.gitignore
+.docker-cache
+.bundle
+coverage
+pkg
+node_modules
+vendor/bundle
+.env

.gitattributes

@@ -0,0 +1,2 @@
+*.jpg binary
+

.github/workflows/ci.yml

@@ -43,3 +43,28 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage/coverage.json
           fail_ci_if_error: true
+  e2e:
+    needs: ci
+    if: >
+      github.event_name != 'pull_request' ||
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    env:
+      TRANSLOADIT_KEY: ${{ secrets.TRANSLOADIT_KEY }}
+      TRANSLOADIT_SECRET: ${{ secrets.TRANSLOADIT_SECRET }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+      - name: Ensure e2e credentials are configured
+        if: ${{ env.TRANSLOADIT_KEY == '' || env.TRANSLOADIT_SECRET == '' }}
+        run: |
+          echo "TRANSLOADIT_KEY and TRANSLOADIT_SECRET must be configured in repository secrets to run the e2e job." >&2
+          exit 1
+      - name: Run end-to-end upload test
+        env:
+          RUBY_SDK_E2E: 1
+        if: ${{ env.TRANSLOADIT_KEY != '' && env.TRANSLOADIT_SECRET != '' }}
+        run: bundle exec ruby -Itest test/integration/test_e2e_upload.rb

.gitignore

@@ -15,3 +15,5 @@ transloadit-*.gem
 env.sh
 .env
 vendor/bundle/
+.docker-cache/
+.cache/rubocop_cache/04e06e0faf5ad652d8bcbcfd85bac5f6c32e711e/3031a80880d8a984708138f0d003f77c4bad2648

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 3.1.1 / 2025-10-28
+
+- Add optional live end-to-end upload harness and CI job for parity verification, defaulted in Docker tests (kvz)
+- Restore missing `require "uri"` to prevent `NameError` when loading `Transloadit::Request` (kvz)
+
 ### 3.1.0 / 2024-11-24
 
 - Add Smart CDN signature support via `signed_smart_cdn_url` method (kvz)

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing
+
+Thanks for helping improve the Transloadit Ruby SDK! This guide covers local development, testing, and publishing new releases.
+
+## Local Development
+
+After cloning the repository, install dependencies and run the test suite:
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+To exercise the signature parity suite against the Node.js CLI, make sure `npx transloadit` is available and run:
+
+```bash
+TEST_NODE_PARITY=1 bundle exec rake test
+```
+
+You can warm the CLI cache ahead of time:
+
+```bash
+TRANSLOADIT_KEY=... TRANSLOADIT_SECRET=... \
+  npx --yes transloadit smart_sig --help
+TRANSLOADIT_KEY=... TRANSLOADIT_SECRET=... \
+  npx --yes transloadit sig --algorithm sha384 --help
+```
+
+Set `COVERAGE=0` to skip coverage instrumentation if desired:
+
+```bash
+COVERAGE=0 bundle exec rake test
+```
+
+## Docker Workflow
+
+The repository ships with a helper that runs tests inside a reproducible Docker image:
+
+```bash
+./scripts/test-in-docker.sh
+```
+
+Pass a custom command to run alternatives (Bundler still installs first):
+
+```bash
+./scripts/test-in-docker.sh bundle exec ruby -Itest test/unit/transloadit/test_request.rb
+```
+
+The script forwards environment variables such as `TEST_NODE_PARITY` and credentials from `.env`, so you can combine parity checks and integration tests. End-to-end uploads are enabled by default; unset them by running:
+
+```bash
+RUBY_SDK_E2E=0 ./scripts/test-in-docker.sh
+```
+
+## Live End-to-End Test
+
+To exercise the optional live upload:
+
+```bash
+RUBY_SDK_E2E=1 TRANSLOADIT_KEY=... TRANSLOADIT_SECRET=... \
+  ./scripts/test-in-docker.sh bundle exec ruby -Itest test/integration/test_e2e_upload.rb
+```
+
+The test uploads `chameleon.jpg`, resizes it, and asserts on a real assembly response.
+
+## Releasing to RubyGems
+
+1. Update the version and changelog:
+   - Bump `lib/transloadit/version.rb`.
+   - Add a corresponding entry to `CHANGELOG.md`.
+2. Run the full test suite (including Docker, parity, and e2e checks as needed).
+3. Commit the release changes and tag:
+   ```bash
+   git commit -am "Release X.Y.Z"
+   git tag -a vX.Y.Z -m "Release X.Y.Z"
+   ```
+4. Push the commit and tag:
+   ```bash
+   git push origin main
+   git push origin vX.Y.Z
+   ```
+5. Publish the gem using the helper script:
+   ```bash
+   GEM_HOST_API_KEY=... ./scripts/notify-registry.sh
+   ```
+6. Draft a GitHub release from the new tag and publish the generated notes.
+
+### RubyGems Credentials
+
+- You must belong to the `transloadit` organization on RubyGems with permission to push the `transloadit` gem.
+- Generate an API key with **Push Rubygems** permissions at <https://rubygems.org/profile/edit>. Copy the token and keep it secure.
+- Export the token as `GEM_HOST_API_KEY` in your environment before running `./scripts/notify-registry.sh`. The script refuses to run if the variable is missing.
+
+That’s it! Thank you for contributing.
+

Dockerfile

@@ -0,0 +1,19 @@
+# syntax=docker/dockerfile:1
+
+FROM ruby:3.3 AS base
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+       build-essential \
+       git \
+       curl \
+       ca-certificates \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Node.js for parity checks
+RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - \
+    && apt-get install -y --no-install-recommends nodejs \
+    && npm install -g npm@latest \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /workspace

README.md

@@ -467,34 +467,4 @@ If you still need support for Ruby 2.x, 2.0.1 is the last version that supports
 
 ## Contributing
 
-Contributions are welcome!
-
-### Running tests
-
-```bash
-bundle install
-bundle exec rake test
-```
-
-To also test parity against the Node.js reference implementation, run:
-
-```bash
-TEST_NODE_PARITY=1 bundle exec rake test
-```
-
-To disable coverage reporting, run:
-
-```bash
-COVERAGE=0 bundle exec rake test
-```
-
-### Releasing on RubyGems
-
-Let's say you wanted to release version `3.1.0`, here are the steps:
-
-1. Update the version number in the version file `version.rb` and `CHANGELOG.md`
-2. Commit: `git add CHANGELOG.md lib/transloadit/version.rb && git commit -m "Release 3.1.0"`
-3. Create a git tag: `git tag -a v3.1.0 -m "Release 3.1.0"`
-4. Push the git tag: `git push origin v3.1.0`
-5. Release on RubyGems: `gem build transloadit.gemspec && gem push transloadit-3.1.0.gem`
-6. Draft a release [here](https://github.com/transloadit/ruby-sdk/releases). Click the `v3.1.0` tag and click `Generate release notes`. Inspect and Publish.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for local development, testing, and release instructions.

chameleon.jpg

@@ -2,8 +2,8 @@
 require "date"
 require "json"
 require "openssl"
-require "uri"
 require "cgi"
+require "uri"
 
 #
 # Implements the Transloadit REST API in Ruby. Check the {file:README.md README}