transloadit 3.1.1 → 4.0.0

data/test/test_helper.rb

@@ -72,3 +72,29 @@ module TransloaditCliHelpers
 end
 
 Minitest::Test.include(TransloaditCliHelpers)
+
+module SingletonMethodOverrideHelpers
+  def with_singleton_method(target, name, implementation)
+    eigenclass = target.singleton_class
+
+    backup = "__orig_#{name}_for_test__"
+    had_method = eigenclass.method_defined?(name) || eigenclass.private_method_defined?(name)
+    eigenclass.send(:alias_method, backup, name) if had_method
+
+    target.define_singleton_method(name, &implementation)
+    yield
+  ensure
+    eigenclass = target.singleton_class
+    if eigenclass.method_defined?(name) || eigenclass.private_method_defined?(name)
+      eigenclass.send(:remove_method, name)
+    end
+    if had_method
+      eigenclass.send(:alias_method, name, backup)
+      if eigenclass.method_defined?(backup) || eigenclass.private_method_defined?(backup)
+        eigenclass.send(:remove_method, backup)
+      end
+    end
+  end
+end
+
+Minitest::Test.include(SingletonMethodOverrideHelpers)

data/test/unit/test_transloadit.rb

@@ -109,7 +109,7 @@ describe Transloadit do
 
     it "must produce Transloadit-compatible JSON output" do
       fixed_time = Time.utc(2025, 10, 28, 0, 0, 0)
-      Time.stub :now, fixed_time do
+      with_singleton_method(Time, :now, proc { fixed_time }) do
         _(@transloadit.to_json).must_equal MultiJson.dump(@transloadit.to_hash)
       end
     end

data/test/unit/transloadit/test_assembly.rb

@@ -64,9 +64,13 @@ describe Transloadit::Assembly do
 
       it "must send the signature before any file" do
         transloadit = Transloadit.new(key: "", secret: "foo")
-        Transloadit::Assembly.new(
-          transloadit
-        ).create! open("lib/transloadit/version.rb")
+        File.open("lib/transloadit/version.rb") do |file|
+          Transloadit::Assembly.new(
+            transloadit
+          ).create! file
+
+          _(file.closed?).must_equal false
+        end
 
         assert_requested(:post, "https://api2.transloadit.com/assemblies") do |req|
           position_params = req.body.index 'name="params"'
@@ -76,6 +80,7 @@ describe Transloadit::Assembly do
           _(position_params).wont_be_nil
           _(position_signature).wont_be_nil
           _(position_file).wont_be_nil
+          _(req.body).must_include 'filename="version.rb"'
 
           _(position_params < position_signature).must_equal true
           _(position_signature < position_file).must_equal true
@@ -146,12 +151,14 @@ describe Transloadit::Assembly do
       it "must call the create! method with the same parameters" do
         VCR.use_cassette "submit_assembly" do
           file = open("lib/transloadit/version.rb")
-          mocker = Minitest::Mock.new
-          mocker.expect :call, nil, [file]
-          @assembly.stub :create!, mocker do
+          create_arg = nil
+          with_singleton_method(@assembly, :create!, proc { |arg|
+            create_arg = arg
+            nil
+          }) do
             @assembly.submit!(file)
           end
-          mocker.verify
+          _(create_arg).must_equal file
         end
       end
     end
@@ -171,9 +178,12 @@ describe Transloadit::Assembly do
         @assembly.options[:tries] = 1
 
         VCR.use_cassette "rate_limit_succeed" do
-          assert_raises Transloadit::Exception::RateLimitReached do
+          error = assert_raises Transloadit::Exception::RateLimitReached do
             @assembly.create! open("lib/transloadit/version.rb")
           end
+
+          _(error.response["error"]).must_equal "RATE_LIMIT_REACHED"
+          _(error.message).must_equal "Transloadit Rate Limit Reached. Retry in 0 seconds"
         end
       end
 
@@ -211,6 +221,79 @@ describe Transloadit::Assembly do
     end
   end
 
+  describe "with multiple hash steps" do
+    it "must wrap its steps into one hash" do
+      hash_1 = {encode: {robot: "/video/encode"}, resize: {robot: "/image/resize"}}
+      hash_2 = {thumbs: {robot: "/video/thumbs"}}
+
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: [hash_1, hash_2]
+      (hash_1.keys + hash_2.keys).each do |key|
+        _(assembly.to_hash[:steps].keys).must_include key
+      end
+    end
+
+    it "must not allow duplicate steps" do
+      thumbs = {thumbs: {robot: "/video/thumbs"}}
+      thumbs_duplicate = {thumbs: {robot: "/video/encode"}}
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: [thumbs, thumbs_duplicate]
+      assert_raises ArgumentError do
+        assembly.create! open("lib/transloadit/version.rb")
+      end
+    end
+  end
+
+  describe "with mixture of hashes and steps" do
+    it "must wrap its steps into one hash" do
+      hash = {encode: {robot: "/video/encode"}, resize: {robot: "/image/resize"}}
+      step = @transloadit.step "thumbs", "/video/thumbs"
+
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: [hash, step]
+
+      hash.keys.each do |key|
+        _(assembly.to_hash[:steps].keys).must_include key
+      end
+
+      _(assembly.to_hash[:steps].keys).must_include step.name
+    end
+
+    it "must not allow duplicate steps" do
+      hash = {thumbs: {robot: "/video/thumbs"}}
+      step = @transloadit.step "thumbs", "/video/thumbs"
+
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: [hash, step]
+
+      assert_raises ArgumentError do
+        assembly.create! open("lib/transloadit/version.rb")
+      end
+    end
+  end
+
+  describe "with unsupported step class" do
+    it "raises error" do
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: Class.new
+
+      assert_raises ArgumentError do
+        assembly.create! open("lib/transloadit/version.rb")
+      end
+    end
+  end
+
+  describe "with unsupported array element" do
+    it "raises error" do
+      assembly = Transloadit::Assembly.new @transloadit,
+        steps: [Class.new]
+
+      assert_raises ArgumentError do
+        assembly.create! open("lib/transloadit/version.rb")
+      end
+    end
+  end
+
   describe "using assembly API methods" do
     include WebMock::API
 

data/test/unit/transloadit/test_request.rb

@@ -83,25 +83,6 @@ describe Transloadit::Request do
     lib_path = File.expand_path("../../../lib", __dir__)
 
     Dir.mktmpdir do |stub_dir|
-      File.write(File.join(stub_dir, "rest-client.rb"), <<~RUBY)
-        module RestClient
-          class Response; end
-
-          class Resource
-            def initialize(*); end
-            def [](*); self; end
-            def get(*); Response.new; end
-            def post(*); Response.new; end
-            def put(*); Response.new; end
-            def delete(*); Response.new; end
-          end
-
-          module Exceptions
-            class OpenTimeout < StandardError; end
-          end
-        end
-      RUBY
-
       File.write(File.join(stub_dir, "multi_json.rb"), <<~RUBY)
         require "json"
 
@@ -123,6 +104,7 @@ describe Transloadit::Request do
         begin
           require "transloadit/request"
           Transloadit::Request.new("/")
+          raise "RestClient was loaded" if defined?(RestClient)
         rescue StandardError => e
           warn e.full_message
           exit 1

data/test/unit/transloadit/test_response.rb

@@ -3,17 +3,36 @@ require "test_helper"
 describe Transloadit::Response do
   request_uri = "https://api2.jane.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4"
 
-  it "must allow delegate initialization" do
-    response = Transloadit::Response.new("test")
+  it "must allow initialization" do
+    response = Transloadit::Response.new(body: "{}", headers: {}, status: 200)
     _(response.class).must_equal Transloadit::Response
   end
 
+  it "must replace body, headers, and status together" do
+    response = Transloadit::Response.new(
+      body: '{"ok":"ASSEMBLY_EXECUTING"}',
+      headers: {"X-Request-Id" => "old-request"},
+      status: 202
+    )
+    replacement = Transloadit::Response.new(
+      body: '{"ok":"ASSEMBLY_COMPLETED"}',
+      headers: {"X-Request-Id" => "new-request"},
+      status: 200
+    )
+
+    returned = response.replace(replacement)
+
+    _(returned).must_be_same_as response
+    _(response["ok"]).must_equal "ASSEMBLY_COMPLETED"
+    _(response.headers).must_equal x_request_id: "new-request"
+    _(response.code).must_equal 200
+    _(response.status).must_equal 200
+  end
+
   describe "when initialized" do
     before do
       VCR.use_cassette "fetch_assembly_ok" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        )
+        @response = Transloadit::Request.new(request_uri).get
       end
     end
 
@@ -41,9 +60,7 @@ describe Transloadit::Response do
   describe "when extended as an assembly" do
     before do
       VCR.use_cassette "fetch_assembly_ok" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
     end
 
@@ -56,9 +73,6 @@ describe Transloadit::Response do
     # TODO: can this be tested better?
     it "must allow reloading the assembly" do
       VCR.use_cassette "fetch_assembly_ok", allow_playback_repeats: true do
-        _(@response.send(:__getobj__))
-          .wont_be_same_as @response.reload!.send(:__getobj__)
-
         _(@response.object_id)
           .must_equal @response.reload!.object_id
       end
@@ -79,9 +93,7 @@ describe Transloadit::Response do
   describe "long-running assembly" do
     before do
       VCR.use_cassette "fetch_assembly_executing" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
     end
 
@@ -109,9 +121,7 @@ describe Transloadit::Response do
   describe "statuses" do
     it "must allow checking for upload" do
       VCR.use_cassette "fetch_assembly_uploading" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
 
       _(@response.finished?).must_equal false
@@ -121,9 +131,7 @@ describe Transloadit::Response do
 
     it "must allow to check for executing" do
       VCR.use_cassette "fetch_assembly_executing" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
 
       _(@response.finished?).must_equal false
@@ -133,11 +141,9 @@ describe Transloadit::Response do
 
     it "must allow to check for replaying" do
       VCR.use_cassette "replay_assembly" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(
-            "https://api2.transloadit.com/assemblies/55c965a063a311e6ba2d379ef10b28f7/replay"
-          ).post({})
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(
+          "https://api2.transloadit.com/assemblies/55c965a063a311e6ba2d379ef10b28f7/replay"
+        ).post.extend!(Transloadit::Response::Assembly)
       end
 
       _(@response.finished?).must_equal false
@@ -147,9 +153,7 @@ describe Transloadit::Response do
 
     it "must allow to check for aborted" do
       VCR.use_cassette "fetch_assembly_aborted" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
 
       _(@response.finished?).must_equal true
@@ -158,9 +162,7 @@ describe Transloadit::Response do
 
     it "must allow to check for errors" do
       VCR.use_cassette "fetch_assembly_errors" do
-        @response = Transloadit::Response.new(
-          RestClient::Resource.new(request_uri).get
-        ).extend!(Transloadit::Response::Assembly)
+        @response = Transloadit::Request.new(request_uri).get.extend!(Transloadit::Response::Assembly)
       end
 
       _(@response.error?).must_equal true

data/test/unit/transloadit/test_transport_compatibility.rb

@@ -0,0 +1,222 @@
+require "test_helper"
+require "stringio"
+require "tempfile"
+
+describe "Faraday transport compatibility" do
+  include WebMock::API
+
+  before do
+    WebMock.reset!
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it "sends signed GET parameters and the client header to a selected host" do
+    endpoint = "https://api2.example.test/assemblies/assembly-id"
+    stub_request(:get, /\A#{Regexp.escape(endpoint)}/)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+
+    response = Transloadit::Request.new(endpoint, "secret").get(wait: true)
+
+    _(response["ok"]).must_equal "ASSEMBLY_COMPLETED"
+    assert_requested(:get, /\A#{Regexp.escape(endpoint)}/) do |request|
+      query = Addressable::URI.parse(request.uri.to_s).query_values
+      _(MultiJson.load(query.fetch("params"))).must_equal "wait" => true
+      _(query.fetch("signature")).must_match(/\Asha384:[0-9a-f]{96}\z/)
+      _(request.headers.fetch("Transloadit-Client")).must_equal "ruby-sdk:#{Transloadit::VERSION}"
+    end
+  end
+
+  it "form-encodes signed POST payloads" do
+    endpoint = "https://api2.transloadit.com/assemblies"
+    stub_request(:post, endpoint)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+
+    Transloadit::Request.new("/assemblies", "secret").post(params: {template_id: "template-id"})
+
+    assert_requested(:post, endpoint) do |request|
+      form = URI.decode_www_form(request.body).to_h
+      _(MultiJson.load(form.fetch("params"))).must_equal "template_id" => "template-id"
+      _(form.fetch("signature")).must_match(/\Asha384:[0-9a-f]{96}\z/)
+      _(request.headers.fetch("Content-Type")).must_match(/\Aapplication\/x-www-form-urlencoded/)
+    end
+  end
+
+  it "form-encodes signed PUT payloads" do
+    endpoint = "https://api2.transloadit.com/templates/template-id"
+    stub_request(:put, endpoint)
+      .to_return(status: 200, body: '{"ok":"TEMPLATE_UPDATED"}')
+
+    Transloadit::Request.new("/templates/template-id", "secret").put(params: {name: "Updated"})
+
+    assert_requested(:put, endpoint) do |request|
+      form = URI.decode_www_form(request.body).to_h
+      _(MultiJson.load(form.fetch("params"))).must_equal "name" => "Updated"
+      _(form.fetch("signature")).must_match(/\Asha384:[0-9a-f]{96}\z/)
+    end
+  end
+
+  it "form-encodes signed DELETE payloads" do
+    endpoint = "https://api2.transloadit.com/templates/template-id"
+    stub_request(:delete, endpoint)
+      .to_return(status: 200, body: '{"ok":"TEMPLATE_DELETED"}')
+
+    Transloadit::Request.new("/templates/template-id", "secret").delete(params: {reason: "cleanup"})
+
+    assert_requested(:delete, endpoint) do |request|
+      form = URI.decode_www_form(request.body).to_h
+      _(MultiJson.load(form.fetch("params"))).must_equal "reason" => "cleanup"
+      _(form.fetch("signature")).must_match(/\Asha384:[0-9a-f]{96}\z/)
+    end
+  end
+
+  it "returns non-success responses with SDK-owned status, headers, and body access" do
+    endpoint = "https://api2.example.test/assemblies/missing"
+    stub_request(:get, endpoint).to_return(
+      status: 422,
+      headers: {"Retry-After" => "5", "X-Request-Id" => "request-id"},
+      body: '{"error":"ASSEMBLY_NOT_FOUND"}'
+    )
+
+    response = Transloadit::Request.new(endpoint).get
+
+    _(response).must_be_kind_of Transloadit::Response
+    _(response).wont_be_kind_of Faraday::Response
+    _(response.code).must_equal 422
+    _(response.status).must_equal 422
+    _(response.headers).must_equal retry_after: "5", x_request_id: "request-id"
+    _(response["error"]).must_equal "ASSEMBLY_NOT_FOUND"
+  end
+
+  it "returns redirects without following them" do
+    endpoint = "https://api2.example.test/assemblies"
+    redirect = "https://uploads.example.test/assemblies"
+    stub_request(:post, endpoint).to_return(
+      status: 302,
+      headers: {"Location" => redirect},
+      body: "{}"
+    )
+
+    response = Transloadit::Request.new(endpoint).post
+
+    _(response.code).must_equal 302
+    _(response.headers[:location]).must_equal redirect
+    assert_not_requested(:post, redirect)
+  end
+
+  it "uploads multiple files after params and signature without closing caller-owned files" do
+    endpoint = "https://api2.transloadit.com/assemblies"
+    stub_request(:post, endpoint)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+
+    Tempfile.create(["first", ".txt"]) do |first|
+      Tempfile.create(["second", ".json"]) do |second|
+        first.write("first upload")
+        first.flush
+        second.write('{"second":"upload"}')
+        second.flush
+
+        Transloadit::Request.new("/assemblies", "secret").post(
+          params: {steps: {}},
+          file_0: first,
+          file_1: second
+        )
+
+        _(first.closed?).must_equal false
+        _(second.closed?).must_equal false
+      end
+    end
+
+    assert_requested(:post, endpoint) do |request|
+      params_position = request.body.index('name="params"')
+      signature_position = request.body.index('name="signature"')
+      first_position = request.body.index('name="file_0"')
+      second_position = request.body.index('name="file_1"')
+
+      _(request.headers.fetch("Content-Type")).must_match(/\Amultipart\/form-data; boundary=/)
+      _(params_position).wont_be_nil
+      _(signature_position).wont_be_nil
+      _(first_position).wont_be_nil
+      _(second_position).wont_be_nil
+      _(params_position < signature_position).must_equal true
+      _(signature_position < first_position).must_equal true
+      _(first_position < second_position).must_equal true
+      _(request.body).must_include "Content-Type: text/plain"
+      _(request.body).must_include "Content-Type: application/json"
+      _(request.body).must_include "first upload"
+      _(request.body).must_include '{"second":"upload"}'
+    end
+  end
+
+  it "preserves filename and content type from Rails-style uploaded files" do
+    endpoint = "https://api2.transloadit.com/assemblies"
+    stub_request(:post, endpoint)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+
+    Tempfile.create(["rails-upload", ".bin"]) do |file|
+      file.write("csv contents")
+      file.flush
+      upload = Object.new
+      upload.define_singleton_method(:read) { |*arguments| file.read(*arguments) }
+      upload.define_singleton_method(:path) { file.path }
+      upload.define_singleton_method(:original_filename) { "report.csv" }
+      upload.define_singleton_method(:content_type) { "text/csv" }
+
+      Transloadit::Request.new("/assemblies").post(params: {steps: {}}, file_0: upload)
+    end
+
+    assert_requested(:post, endpoint) do |request|
+      _(request.body).must_include 'filename="report.csv"'
+      _(request.body).must_include "Content-Type: text/csv"
+      _(request.body).must_include "csv contents"
+    end
+  end
+
+  it "uses safe metadata defaults for in-memory uploads" do
+    endpoint = "https://api2.transloadit.com/assemblies"
+    stub_request(:post, endpoint)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+    upload = StringIO.new("memory upload")
+
+    Transloadit::Request.new("/assemblies").post(params: {steps: {}}, file_0: upload)
+
+    _(upload.closed?).must_equal false
+    assert_requested(:post, endpoint) do |request|
+      _(request.body).must_include 'filename="upload"'
+      _(request.body).must_include "Content-Type: application/octet-stream"
+      _(request.body).must_include "memory upload"
+    end
+  end
+
+  it "uses the binary content type when a file extension is unknown" do
+    endpoint = "https://api2.transloadit.com/assemblies"
+    stub_request(:post, endpoint)
+      .to_return(status: 200, body: '{"ok":"ASSEMBLY_COMPLETED"}')
+
+    Tempfile.create(["upload", ".transloadit-unknown"]) do |upload|
+      upload.write("unknown upload")
+      upload.flush
+
+      Transloadit::Request.new("/assemblies").post(params: {steps: {}}, file_0: upload)
+    end
+
+    assert_requested(:post, endpoint) do |request|
+      _(request.body).must_include "Content-Type: application/octet-stream"
+      _(request.body).must_include "unknown upload"
+    end
+  end
+
+  it "wraps adapter failures and retains the original error as the cause" do
+    endpoint = "https://api2.example.test/assemblies/assembly-id"
+    stub_request(:get, endpoint).to_timeout
+
+    error = assert_raises Transloadit::Exception::RequestFailed do
+      Transloadit::Request.new(endpoint).get
+    end
+
+    _(error.message).must_equal "Transloadit request failed"
+    _(error.cause).must_be_kind_of Faraday::ConnectionFailed
+  end
+end

data/transloadit.gemspec

@@ -16,21 +16,22 @@ Gem::Specification.new do |gem|
   gem.description = "The transloadit gem allows you to automate uploading files through the Transloadit REST API"
 
   gem.required_rubygems_version = ">= 2.2.0"
-  gem.required_ruby_version = ">= 3.0.0"
+  gem.required_ruby_version = ">= 3.1.0"
 
   gem.files = `git ls-files`.split("\n")
   gem.require_paths = %w[lib]
 
-  gem.add_dependency "rest-client"
+  gem.add_dependency "faraday", ">= 2.0", "< 3.0"
+  gem.add_dependency "faraday-multipart", "~> 1.0"
   gem.add_dependency "multi_json"
   gem.add_dependency "mime-types"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "standard"
+  gem.add_development_dependency "standard", ">= 1.54"
 
-  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "vcr", ">= 6.4"
   gem.add_development_dependency "webmock"
 
   gem.add_development_dependency "yard"