transloadit 3.1.2 → 4.1.0

data/lib/transloadit/request.rb

@@ -1,6 +1,8 @@
 require "transloadit"
 
-require "rest-client"
+require "faraday"
+require "faraday/multipart"
+require "mime/types"
 require "openssl"
 
 #
@@ -47,7 +49,7 @@ class Transloadit::Request
   #
   def get(params = {})
     request! do
-      api[url.path + to_query(params)].get(API_HEADERS)
+      api.get(url.path + to_query(params), nil, API_HEADERS)
     end
   end
 
@@ -60,8 +62,10 @@ class Transloadit::Request
   #
   def delete(payload = {})
     request! do
-      options = {payload: to_payload(payload)}
-      api(options)[url.path].delete(API_HEADERS)
+      api.delete(url.path) do |request|
+        request.headers.update(API_HEADERS)
+        request.body = to_payload(payload)
+      end
     end
   end
 
@@ -74,7 +78,7 @@ class Transloadit::Request
   #
   def post(payload = {})
     request! do
-      api[url.path].post(to_payload(payload), API_HEADERS)
+      api.post(url.path, to_payload(payload), API_HEADERS)
     end
   end
 
@@ -87,7 +91,7 @@ class Transloadit::Request
   #
   def put(payload = {})
     request! do
-      api[url.path].put(to_payload(payload), API_HEADERS)
+      api.put(url.path, to_payload(payload), API_HEADERS)
     end
   end
 
@@ -118,12 +122,20 @@ class Transloadit::Request
   # hostname, then the hostname is used as the base endpoint of the API.
   # Otherwise uses the class-level API base.
   #
-  # @return [RestClient::Resource] the API endpoint for this instance
+  # @return [Faraday::Connection] the API endpoint for this instance
   #
-  def api(options = {})
+  def api
     @api ||= case url.host
-    when String then RestClient::Resource.new("#{url.scheme}://#{url.host}", options)
-    else RestClient::Resource.new("#{API_ENDPOINT.scheme}://#{API_ENDPOINT.host}", options)
+    when String then connection_for("#{url.scheme}://#{url.host}")
+    else connection_for("#{API_ENDPOINT.scheme}://#{API_ENDPOINT.host}")
+    end
+  end
+
+  def connection_for(base_url)
+    Faraday.new(url: base_url) do |connection|
+      connection.request :multipart
+      connection.request :url_encoded
+      connection.adapter Faraday.default_adapter
     end
   end
 
@@ -151,12 +163,33 @@ class Transloadit::Request
     sig = signature(new_payload[:params])
     new_payload[:signature] = sig unless sig.nil?
 
-    # Copy all values, excluding :params and :signature keys.
-    new_payload.update payload.reject { |key, _| key == :params || key == :signature }
+    payload.each do |key, value|
+      next if key == :params || key == :signature
+
+      new_payload[key] = upload?(value) ? multipart_file(value) : value
+    end
 
     new_payload
   end
 
+  def upload?(value)
+    value.respond_to?(:read)
+  end
+
+  def multipart_file(file)
+    path = file.path if file.respond_to?(:path)
+    filename = file.original_filename if file.respond_to?(:original_filename)
+    filename = File.basename(path) if filename.to_s.empty? && path
+    filename = "upload" if filename.to_s.empty?
+
+    content_type = file.content_type if file.respond_to?(:content_type)
+    content_type = MIME::Types.type_for(path).first&.content_type if content_type.to_s.empty? && path
+    content_type = "application/octet-stream" if content_type.to_s.empty?
+
+    source = path || file
+    Faraday::Multipart::FilePart.new(source, content_type, filename)
+  end
+
   #
   # Updates the GET/DELETE params hash to be compliant with the Transloadit
   # API by URI escaping and encoding the params hash, and attaching a
@@ -181,18 +214,17 @@ class Transloadit::Request
   end
 
   #
-  # Wraps a request's results in a Transloadit::Response, even if an exception
-  # is raised by RestClient.
+  # Wraps a request's result in a Transloadit::Response.
   #
   def request!(&request)
-    Transloadit::Response.new yield
-  rescue RestClient::Exception => e
-    # The response attribute can be nil, for example for RestClient::Exceptions::OpenTimeout exceptions.
-    # Then, we cannot convert them into a Transloadit::Response, so instead we raise them again for
-    # the user to be visible.
-    # See https://github.com/transloadit/ruby-sdk/issues/53
-    raise e if e.response.nil?
-    Transloadit::Response.new e.response
+    response = yield
+    Transloadit::Response.new(
+      body: response.body,
+      headers: response.headers,
+      status: response.status
+    )
+  rescue Faraday::Error
+    raise Transloadit::Exception::RequestFailed, "Transloadit request failed"
   end
 
   #

data/lib/transloadit/response.rb

@@ -1,20 +1,30 @@
 require "transloadit"
 
-require "rest-client"
-require "delegate"
-
-class Transloadit::Response < Delegator
+class Transloadit::Response
   autoload :Assembly, "transloadit/response/assembly"
 
   #
-  # Creates an enhanced response wrapped around a RestClient response.
+  # Creates a response without exposing the underlying HTTP client.
   #
-  # @param [RestClient::Response] response the JSON response to wrap
+  # @param [String] body the raw response body
+  # @param [Hash] headers the response headers
+  # @param [Integer] status the HTTP response status
   #
-  def initialize(response)
-    __setobj__(response)
+  def initialize(body:, headers:, status:)
+    @raw_body = body
+    @headers = normalize_headers(headers)
+    @status = status
   end
 
+  # @return [Hash] normalized response headers
+  attr_reader :headers
+
+  # @return [Integer] the HTTP response status
+  attr_reader :status
+
+  # RestClient exposed the status through +code+ in previous SDK versions.
+  alias_method :code, :status
+
   #
   # Returns the attribute from the JSON response.
   #
@@ -31,7 +41,7 @@ class Transloadit::Response < Delegator
   # @return [Hash] the parsed JSON body hash
   #
   def body
-    MultiJson.load __getobj__.body
+    MultiJson.load @raw_body
   end
 
   #
@@ -56,36 +66,28 @@ class Transloadit::Response < Delegator
     self
   end
 
-  protected
-
-  #
-  # The object to delegate method calls to.
-  #
-  # @return [RestClient::Response]
-  #
-  def __getobj__
-    @response
-  end
-
   #
-  # Sets the object to delegate method calls to.
+  # Replaces this response's HTTP data with another response's data.
   #
-  # @param  [RestClient::Response] response the response to delegate to
-  # @return [RestClient::Response]          the delegated response
-  #
-  def __setobj__(response)
-    @response = response
-  end
-
-  #
-  # Replaces the object this instance delegates to with the one the other
-  # object uses.
-  #
-  # @param  [Delegator] other       the object whose delegate to use
+  # @param  [Transloadit::Response] other the response whose data to use
   # @return [Transloadit::Response] this response
   #
   def replace(other)
-    __setobj__ other.__getobj__
+    @raw_body = other.raw_body
+    @headers = other.headers
+    @status = other.status
     self
   end
+
+  protected
+
+  attr_reader :raw_body
+
+  private
+
+  def normalize_headers(headers)
+    headers.to_h.each_with_object({}) do |(name, value), normalized|
+      normalized[name.to_s.downcase.tr("-", "_").to_sym] = value
+    end
+  end
 end

data/lib/transloadit/version.rb

@@ -1,3 +1,3 @@
 class Transloadit
-  VERSION = "3.1.2"
+  VERSION = "4.1.0"
 end

data/lib/transloadit.rb

@@ -2,7 +2,7 @@ require "multi_json"
 require "date"
 require "json"
 require "openssl"
-require "cgi"
+require "cgi/escape"
 require "uri"
 
 #
@@ -79,6 +79,10 @@ class Transloadit
   # @option options [String] :template_id the ID of a
   #   {template}[https://transloadit.com/templates] to use instead of
   #   specifying options here directly
+  # @option options [Hash] :fields custom metadata, retained as typed JSON;
+  #   passing upload IOs here is deprecated in favor of :uploads
+  # @option options [Hash<String, IO>] :uploads named multipart uploads, kept
+  #   separate from the signed JSON Instructions
   #
   def assembly(options = {})
     Transloadit::Assembly.new(self, options)

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
@@ -116,7 +121,7 @@ describe Transloadit::Assembly do
 
         assert_requested(:post, "https://api2.transloadit.com/assemblies") do |req|
           values = values_from_post_body(req.body)
-          _(values["tag"]).must_equal "ninja-cat"
+          _(values.keys).must_equal ["params"]
           _(MultiJson.load(values["params"])["fields"]["tag"]).must_equal "ninja-cat"
         end
       end
@@ -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