Add optional end-to-end upload test harness

Author: kvz

.gitattributes

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

.gitignore

@@ -16,3 +16,4 @@ env.sh
 .env
 vendor/bundle/
 .docker-cache/
+.cache/rubocop_cache/04e06e0faf5ad652d8bcbcfd85bac5f6c32e711e/3031a80880d8a984708138f0d003f77c4bad2648

README.md

@@ -515,6 +515,14 @@ The script forwards environment variables such as `TEST_NODE_PARITY` or credenti
 TEST_NODE_PARITY=1 ./scripts/test-in-docker.sh
 ```
 
+To exercise the optional end-to-end upload against a real Transloadit account, provide `TRANSLOADIT_KEY` and `TRANSLOADIT_SECRET` (via environment variables or `.env`) and set `RUBY_SDK_E2E=1`:
+
+```bash
+RUBY_SDK_E2E=1 ./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 the live assembly results. It respects `TRANSLOADIT_HOST` and `TRANSLOADIT_REGION` overrides when present.
+
 ### Releasing on RubyGems
 
 Let's say you wanted to release version `3.1.0`, here are the steps:

chameleon.jpg

@@ -31,6 +31,7 @@ class Transloadit
   attr_accessor :duration
 
   attr_accessor :max_size
+  attr_accessor :service
 
   #
   # Creates a new instance of the Transloadit API.
@@ -48,6 +49,7 @@ def initialize(options = {})
     self.secret = options[:secret]
     self.duration = options[:duration] || 5 * 60
     self.max_size = options[:max_size]
+    self.service = _normalize_service(options[:service]) || _service_from_region(options[:region])
 
     _ensure_key_provided
   end
@@ -108,7 +110,7 @@ def bill(month = Date.today.month, year = Date.today.year)
     month = format "%02d", month
     path = "bill/#{year}-#{month}"
 
-    Transloadit::Request.new(path, secret).get({auth: to_hash})
+    Transloadit::Request.new(request_url_for(path), secret).get({auth: to_hash})
   end
 
   #
@@ -135,6 +137,22 @@ def to_json
     MultiJson.dump(to_hash)
   end
 
+  #
+  # Resolves an absolute URL for API requests, honoring custom service overrides.
+  #
+  # @param [String] path the request path or URL
+  # @return [String] the resolved URL or original path if already absolute
+  #
+  def request_url_for(path)
+    return path if service.nil? || service.empty?
+
+    uri = URI.parse(path.to_s)
+    return path if uri.host
+
+    base = service.end_with?("/") ? service : "#{service}/"
+    URI.join(base, path.to_s.sub(%r{\A/}, "")).to_s
+  end
+
   # @param workspace [String] Workspace slug
   # @param template [String] Template slug or template ID
   # @param input [String] Input value that is provided as `${fields.input}` in the template
@@ -185,6 +203,30 @@ def signed_smart_cdn_url(
 
   private
 
+  #
+  # Normalizes service URLs, returning nil for blank values.
+  #
+  def _normalize_service(value)
+    return nil if value.nil?
+
+    str = value.to_s.strip
+    return nil if str.empty?
+
+    str
+  end
+
+  #
+  # Builds a service URL from a region hint, if one is provided.
+  #
+  def _service_from_region(region)
+    return nil if region.nil?
+
+    str = region.to_s.strip
+    return nil if str.empty?
+
+    "https://api2-#{str}.transloadit.com"
+  end
+
   #
   # Raises an ArgumentError if no {#key} has been assigned.
   #

lib/transloadit.rb

@@ -68,6 +68,7 @@ def _do_request(path, params = nil, method = "get", extra_params = nil)
       params = {params: params} if ["post", "put", "delete"].include? method
       params.merge!(extra_params) unless extra_params.nil?
     end
-    Transloadit::Request.new(path, transloadit.secret).public_send(method, params)
+    request_url = transloadit.request_url_for(path)
+    Transloadit::Request.new(request_url, transloadit.secret).public_send(method, params)
   end
 end

lib/transloadit/api_model.rb

@@ -52,6 +52,7 @@ def inspect
   #
   def extend!(mod)
     extend(mod)
+
     self
   end
 

lib/transloadit/response.rb

@@ -73,4 +73,19 @@ if [[ -f .env ]]; then
   DOCKER_ARGS+=(--env-file "$PWD/.env")
 fi
 
+PASSTHROUGH_ENV_VARS=(
+  TRANSLOADIT_KEY
+  TRANSLOADIT_SECRET
+  TRANSLOADIT_HOST
+  TRANSLOADIT_REGION
+  TRANSLOADIT_TEMPLATE_ID
+  RUBY_SDK_E2E
+)
+
+for var in "${PASSTHROUGH_ENV_VARS[@]}"; do
+  if [[ -n "${!var:-}" ]]; then
+    DOCKER_ARGS+=(-e "$var=${!var}")
+  fi
+done
+
 exec docker run "${DOCKER_ARGS[@]}" "$IMAGE_NAME" bash -lc "$RUN_CMD"

scripts/test-in-docker.sh

@@ -0,0 +1,103 @@
+require "test_helper"
+
+describe "Transloadit end-to-end upload" do
+  before do
+    skip "Set RUBY_SDK_E2E=1 to run live upload tests" unless e2e_enabled?
+
+    @key = ENV["TRANSLOADIT_KEY"]
+    @secret = ENV["TRANSLOADIT_SECRET"]
+    skip "TRANSLOADIT_KEY and TRANSLOADIT_SECRET must be set to run live upload tests" if blank?(@key) || blank?(@secret)
+
+    @service = resolve_service
+
+    @fixture_path = File.expand_path("../../chameleon.jpg", __dir__)
+    skip "chameleon.jpg fixture missing; run tests from the repository root" unless File.file?(@fixture_path)
+  end
+
+  it "uploads and processes the chameleon image" do
+    options = {
+      key: @key,
+      secret: @secret
+    }
+    options[:service] = @service if @service
+
+    transloadit = Transloadit.new(options)
+
+    resize_step = transloadit.step(
+      "resize",
+      "/image/resize",
+      use: ":original",
+      width: 128,
+      height: 128,
+      resize_strategy: "fit",
+      format: "png"
+    )
+
+    response = File.open(@fixture_path, "rb") do |upload|
+      transloadit.assembly.create!(
+        upload,
+        wait: true,
+        steps: resize_step
+      )
+    end
+
+    response.reload_until_finished!(tries: 120) unless response.finished?
+
+    _(response.completed?).must_equal true, "Assembly did not complete successfully: #{response.body.inspect}"
+
+    uploads = response["uploads"] || []
+    refute_empty uploads, "Expected uploads in the assembly response"
+
+    upload_info = uploads.first
+    basename = upload_info["basename"]
+    _(basename).must_equal File.basename(@fixture_path, ".*") if basename
+
+    filename = upload_info["name"]
+    _(filename).must_equal File.basename(@fixture_path) if filename
+
+    results = (response["results"] || {})["resize"] || []
+    refute_empty results, "Expected resize results in assembly response"
+
+    first_result = results.first
+    ssl_url = first_result["ssl_url"]
+    refute_nil ssl_url, "Missing ssl_url in resize result: #{first_result.inspect}"
+    _(ssl_url).must_match(/\Ahttps:\/\//)
+
+    meta = first_result["meta"] || {}
+    width = integer_if_present(meta["width"])
+    height = integer_if_present(meta["height"])
+    refute_nil width, "Missing width metadata: #{meta.inspect}"
+    refute_nil height, "Missing height metadata: #{meta.inspect}"
+    assert width.positive? && width <= 128, "Unexpected width #{width.inspect}"
+    assert height.positive? && height <= 128, "Unexpected height #{height.inspect}"
+  end
+
+  private
+
+  def e2e_enabled?
+    flag = ENV["RUBY_SDK_E2E"]
+    return false if blank?(flag)
+
+    %w[1 true yes on].include?(flag.to_s.strip.downcase)
+  end
+
+  def resolve_service
+    host = ENV["TRANSLOADIT_HOST"].to_s.strip
+    return host unless host.empty?
+
+    region = ENV["TRANSLOADIT_REGION"].to_s.strip
+    return nil if region.empty?
+
+    "https://api2-#{region}.transloadit.com"
+  end
+
+  def integer_if_present(value)
+    return nil if blank?(value)
+
+    value.to_i
+  end
+
+  def blank?(value)
+    value.respond_to?(:empty?) ? value.empty? : !value
+  end
+end

test/integration/test_e2e_upload.rb

@@ -72,4 +72,3 @@ def run_transloadit_sig(payload, key:, secret:, algorithm: nil)
 end
 
 Minitest::Test.include(TransloaditCliHelpers)
-