transloadit 2.0.1 → 3.0.0

data/lib/transloadit/assembly.rb

@@ -1,4 +1,4 @@
-require 'transloadit'
+require "transloadit"
 
 #
 # Represents an Assembly API ready to make calls to the REST API endpoints.
@@ -22,7 +22,7 @@ class Transloadit::Assembly < Transloadit::ApiModel
   # server-side template. It's submitted along with a list of files to process,
   # at which point Transloadit will process and store the files according to the
   # rules in the Assembly.
-  # See the Transloadit {documentation}[http://transloadit.com/docs/building-assembly-instructions]
+  # See the Transloadit {documentation}[https://transloadit.com/docs/building-assembly-instructions]
   # for futher information on Assemblies and their parameters.
   #
   # Accepts as many IO objects as you wish to process in the assembly.
@@ -36,7 +36,7 @@ class Transloadit::Assembly < Transloadit::ApiModel
   #   @param [Array<IO>] *ios   the files for the assembly to process
   #   @param [Hash]      params additional POST data to submit with the request;
   #     for a full list of parameters, see the official documentation
-  #     on {templates}[http://transloadit.com/docs/templates].
+  #     on {templates}[https://transloadit.com/docs/templates].
   #   @option params [Step, Array<Step>] :steps the steps to perform in this
   #     assembly
   #   @option params [String] :notify_url A URL to be POSTed when the assembly
@@ -46,18 +46,18 @@ class Transloadit::Assembly < Transloadit::ApiModel
   #     specifying params here directly
   #
   def create!(*ios, **params)
-    params[:steps] = _wrap_steps_in_hash(params[:steps]) if !params[:steps].nil?
+    params[:steps] = _wrap_steps_in_hash(params[:steps]) unless params[:steps].nil?
 
     extra_params = {}
-    extra_params.merge!(self.options[:fields]) if self.options[:fields]
+    extra_params.merge!(options[:fields]) if options[:fields]
 
-    trials = self.options[:tries] || DEFAULT_TRIES
+    trials = options[:tries] || DEFAULT_TRIES
     (1..trials).each do |trial|
       # update the payload with file entries
-      ios.each_with_index {|f, i| extra_params.update :"file_#{i}" => f }
+      ios.each_with_index { |f, i| extra_params.update "file_#{i}": f }
 
       response = _do_request(
-        '/assemblies',params,'post', extra_params
+        "/assemblies", params, "post", extra_params
       ).extend!(Transloadit::Response::Assembly)
 
       return response unless response.rate_limit?
@@ -71,9 +71,9 @@ class Transloadit::Assembly < Transloadit::ApiModel
   # keeping this method for backward compatibility
   #
   def submit!(*ios)
-    warn "#{caller(1)[0]}: warning: Transloadit::Assembly#submit!"\
+    warn "#{caller(1..1).first}: warning: Transloadit::Assembly#submit!" \
       " is deprecated. use Transloadit::Assembly#create! instead"
-    self.create!(*ios)
+    create!(*ios)
   end
 
   #
@@ -81,7 +81,7 @@ class Transloadit::Assembly < Transloadit::ApiModel
   # @param [Hash]        additional GET data to submit with the request
   #
   def list(params = {})
-    _do_request('/assemblies', params)
+    _do_request("/assemblies", params)
   end
 
   #
@@ -98,8 +98,8 @@ class Transloadit::Assembly < Transloadit::ApiModel
   # @param [Hash]     params   additional POST data to submit with the request
   #
   def replay(id, params = {})
-    params.merge!({ :wait => false })
-    _do_request("/assemblies/#{id}/replay", params, 'post').extend!(Transloadit::Response::Assembly)
+    params[:wait] = false
+    _do_request("/assemblies/#{id}/replay", params, "post").extend!(Transloadit::Response::Assembly)
   end
 
   #
@@ -116,17 +116,17 @@ class Transloadit::Assembly < Transloadit::ApiModel
   # @param [Hash]        params     additional POST data to submit with the request
   #
   def replay_notification(id, params = {})
-    _do_request("/assembly_notifications/#{id}/replay", params, 'post')
+    _do_request("/assembly_notifications/#{id}/replay", params, "post")
   end
 
   #
   # @return [Hash] a Transloadit-compatible Hash of the Assembly's contents
   #
   def to_hash
-    self.options.merge(
-      :auth  => self.transloadit.to_hash,
-      :steps => self.steps
-    ).delete_if {|k,v| v.nil?}
+    options.merge(
+      auth: transloadit.to_hash,
+      steps: steps
+    ).delete_if { |k, v| v.nil? }
   end
 
   private
@@ -140,11 +140,14 @@ class Transloadit::Assembly < Transloadit::ApiModel
   #
   def _wrap_steps_in_hash(steps)
     case steps
-      when nil                then steps
-      when Hash               then steps
-      when Transloadit::Step  then steps.to_hash
-      else
-        steps.inject({}) {|h, s| h.update s }
+    when nil then steps
+    when Hash then steps
+    when Transloadit::Step then steps.to_hash
+    else
+      if steps.uniq(&:name) != steps
+        raise ArgumentError, "There are different Assembly steps using the same name"
+      end
+      steps.inject({}) { |h, s| h.update s }
     end
   end
 
@@ -160,7 +163,7 @@ class Transloadit::Assembly < Transloadit::ApiModel
       warn "Rate limit reached. Waiting for #{response.wait_time} seconds before retrying."
       sleep response.wait_time
       # RestClient closes file streams at the end of a request.
-      ios.collect! {|file| open file.path }
+      ios.collect! { |file| File.open file.path }
     else
       raise Transloadit::Exception::RateLimitReached.new(response)
     end

data/lib/transloadit/exception.rb

@@ -1,15 +1,13 @@
-require 'transloadit'
+require "transloadit"
 
-require 'rest-client'
+require "rest-client"
 
 module Transloadit::Exception
-
   #
   # Exception raised when Rate limit error response is returned from the API.
   # See {Rate Limiting}[https://transloadit.com/docs/api-docs/#rate-limiting]
   #
   class RateLimitReached < RestClient::RequestEntityTooLarge
-
     def default_message
       retry_msg = " Retry in #{@response.wait_time} seconds" if @response
       "Transloadit Rate Limit Reached.#{retry_msg}"

data/lib/transloadit/request.rb

@@ -1,7 +1,7 @@
-require 'transloadit'
+require "transloadit"
 
-require 'rest-client'
-require 'openssl'
+require "rest-client"
+require "openssl"
 
 #
 # Wraps requests to the Transloadit API. Ensures all API requests return a
@@ -10,16 +10,16 @@ require 'openssl'
 #
 class Transloadit::Request
   # The default Transloadit API endpoint.
-  API_ENDPOINT = URI.parse('https://api2.transloadit.com/')
+  API_ENDPOINT = URI.parse("https://api2.transloadit.com/")
 
   # The default headers to send to the API.
-  API_HEADERS  = { 'User-Agent' => "Transloadit Ruby SDK #{Transloadit::VERSION}" }
+  API_HEADERS = {"Transloadit-Client" => "ruby-sdk:#{Transloadit::VERSION}"}
 
   # The HMAC algorithm used for calculation request signatures.
-  HMAC_ALGORITHM = OpenSSL::Digest.new('sha1')
+  HMAC_ALGORITHM = OpenSSL::Digest.new("sha1")
 
   # @return [String] the API endpoint for the request
-  attr_reader   :url
+  attr_reader :url
 
   # @return [String] the authentication secret to sign the request with
   attr_accessor :secret
@@ -34,7 +34,7 @@ class Transloadit::Request
   # @param [String] secret an optional secret with which to sign the request
   #
   def initialize(url, secret = nil)
-    self.url    = URI.parse(url.to_s)
+    self.url = URI.parse(url.to_s)
     self.secret = secret
   end
 
@@ -46,8 +46,8 @@ class Transloadit::Request
   # @return [Transloadit::Response] the response
   #
   def get(params = {})
-    self.request! do
-      self.api[url.path + self.to_query(params)].get(API_HEADERS)
+    request! do
+      api[url.path + to_query(params)].get(API_HEADERS)
     end
   end
 
@@ -59,9 +59,9 @@ class Transloadit::Request
   # @return [Transloadit::Response] the response
   #
   def delete(payload = {})
-    self.request! do
-      options = {:payload => self.to_payload(payload)}
-      self.api(options = options)[url.path].delete(API_HEADERS)
+    request! do
+      options = {payload: to_payload(payload)}
+      api(options)[url.path].delete(API_HEADERS)
     end
   end
 
@@ -73,8 +73,8 @@ class Transloadit::Request
   # @return [Transloadit::Response] the response
   #
   def post(payload = {})
-    self.request! do
-      self.api[url.path].post(self.to_payload(payload), API_HEADERS)
+    request! do
+      api[url.path].post(to_payload(payload), API_HEADERS)
     end
   end
 
@@ -86,8 +86,8 @@ class Transloadit::Request
   # @return [Transloadit::Response] the response
   #
   def put(payload = {})
-    self.request! do
-      self.api[url.path].put(self.to_payload(payload), API_HEADERS)
+    request! do
+      api[url.path].put(to_payload(payload), API_HEADERS)
     end
   end
 
@@ -95,7 +95,18 @@ class Transloadit::Request
   # @return [String] a human-readable version of the prepared Request
   #
   def inspect
-    self.url.to_s.inspect
+    url.to_s.inspect
+  end
+
+  #
+  # Computes an HMAC digest from the key and message.
+  #
+  # @param  [String] key     the secret key to sign with
+  # @param  [String] message the message to sign
+  # @return [String]         the signature of the message
+  #
+  def self._hmac(key, message)
+    OpenSSL::HMAC.hexdigest HMAC_ALGORITHM, key, message
   end
 
   protected
@@ -110,11 +121,9 @@ class Transloadit::Request
   # @return [RestClient::Resource] the API endpoint for this instance
   #
   def api(options = {})
-    @api ||= begin
-      case self.url.host
-        when String then RestClient::Resource.new(self.url.host, options = options)
-        else RestClient::Resource.new(API_ENDPOINT.host, options = options)
-      end
+    @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)
     end
   end
 
@@ -128,13 +137,24 @@ class Transloadit::Request
   #
   def to_payload(payload = nil)
     return {} if payload.nil?
-    return {} if payload.respond_to?(:empty?) and payload.empty?
+    return {} if payload.respond_to?(:empty?) && payload.empty?
+
+    # Create a new hash with JSONified params and a signature if a secret was provided.
+    # Note: We first set :params and :signature to ensure that these are the first fields
+    # in the multipart requests, before any file. Otherwise, a signature will only be transmitted
+    # after all files have been uploaded. The order of the fields in a multipart request
+    # follows the order of the entries in the returned hash here.
+    # See https://github.com/transloadit/ruby-sdk/issues/51
+    new_payload = {
+      params: MultiJson.dump(payload[:params])
+    }
+    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 }
 
-    # TODO: refactor this, don't update a hash that's not ours
-    payload.update :params    => MultiJson.dump(payload[:params])
-    payload.update :signature => self.signature(payload[:params])
-    payload.delete :signature if payload[:signature].nil?
-    payload
+    new_payload
   end
 
   #
@@ -146,19 +166,18 @@ class Transloadit::Request
   # @return [String] the URI-encoded and escaped query parameters
   #
   def to_query(params = nil)
-    return '' if params.nil?
-    return '' if params.respond_to?(:empty?) and params.empty?
+    return "" if params.nil?
+    return "" if params.respond_to?(:empty?) && params.empty?
 
-    escape    = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
     params_in_json = MultiJson.dump(params)
-    uri_params = URI.escape(params_in_json, escape)
+    uri_params = URI.encode_www_form_component(params_in_json)
 
-    params    = {
-      :params    => uri_params,
-      :signature => self.signature(params_in_json)
+    params = {
+      params: uri_params,
+      signature: signature(params_in_json)
     }
 
-    '?' + params.map {|k,v| "#{k}=#{v}" if v }.compact.join('&')
+    "?" + params.map { |k, v| "#{k}=#{v}" if v }.compact.join("&")
   end
 
   #
@@ -166,7 +185,7 @@ class Transloadit::Request
   # is raised by RestClient.
   #
   def request!(&request)
-    Transloadit::Response.new request.call
+    Transloadit::Response.new yield
   rescue RestClient::Exception => e
     Transloadit::Response.new e.response
   end
@@ -179,19 +198,6 @@ class Transloadit::Request
   # @return [String] the HMAC signature for the params
   #
   def signature(params)
-    self.class._hmac(self.secret, params) if self.secret.to_s.length > 0
-  end
-
-  private
-
-  #
-  # Computes an HMAC digest from the key and message.
-  #
-  # @param  [String] key     the secret key to sign with
-  # @param  [String] message the message to sign
-  # @return [String]         the signature of the message
-  #
-  def self._hmac(key, message)
-    OpenSSL::HMAC.hexdigest HMAC_ALGORITHM, key, message
+    self.class._hmac(secret, params) if secret.to_s.length > 0
   end
 end

data/lib/transloadit/response/assembly.rb

@@ -1,36 +1,36 @@
-require 'transloadit'
+require "transloadit"
 
 module Transloadit::Response::Assembly
   def reload!
-    self.replace Transloadit::Request.new(self['assembly_url']).get
+    replace Transloadit::Request.new(self["assembly_ssl_url"]).get
   end
 
   def cancel!
-    self.replace Transloadit::Request.new(self['assembly_url']).delete
+    replace Transloadit::Request.new(self["assembly_ssl_url"]).delete
   end
 
   def aborted?
-    self['ok'] == 'REQUEST_ABORTED'
+    self["ok"] == "REQUEST_ABORTED"
   end
 
   def canceled?
-    self['ok'] == 'ASSEMBLY_CANCELED'
+    self["ok"] == "ASSEMBLY_CANCELED"
   end
 
   def completed?
-    self['ok'] == 'ASSEMBLY_COMPLETED'
+    self["ok"] == "ASSEMBLY_COMPLETED"
   end
 
   def error?
-    self['error'] != nil
+    self["error"] != nil
   end
 
   def executing?
-    self['ok'] == 'ASSEMBLY_EXECUTING'
+    self["ok"] == "ASSEMBLY_EXECUTING"
   end
 
   def replaying?
-    self['ok'] == 'ASSEMBLY_REPLAYING'
+    self["ok"] == "ASSEMBLY_REPLAYING"
   end
 
   def finished?
@@ -38,15 +38,15 @@ module Transloadit::Response::Assembly
   end
 
   def uploading?
-    self['ok'] == 'ASSEMBLY_UPLOADING'
+    self["ok"] == "ASSEMBLY_UPLOADING"
   end
 
   def rate_limit?
-    self['error'] == 'RATE_LIMIT_REACHED'
+    self["error"] == "RATE_LIMIT_REACHED"
   end
 
   def wait_time
-    self['info']['retryIn'] || 0
+    self["info"]["retryIn"] || 0
   end
 
   DEFAULT_RELOAD_TRIES = 600
@@ -55,7 +55,8 @@ module Transloadit::Response::Assembly
     tries = options[:tries] || DEFAULT_RELOAD_TRIES
 
     tries.times do
-      sleep 1; reload!
+      sleep 1
+      reload!
       return self if finished?
     end
 

data/lib/transloadit/response.rb

@@ -1,10 +1,10 @@
-require 'transloadit'
+require "transloadit"
 
-require 'rest-client'
-require 'delegate'
+require "rest-client"
+require "delegate"
 
 class Transloadit::Response < Delegator
-  autoload :Assembly, 'transloadit/response/assembly'
+  autoload :Assembly, "transloadit/response/assembly"
 
   #
   # Creates an enhanced response wrapped around a RestClient response.
@@ -12,7 +12,7 @@ class Transloadit::Response < Delegator
   # @param [RestClient::Response] response the JSON response to wrap
   #
   def initialize(response)
-    self.__setobj__(response)
+    __setobj__(response)
   end
 
   #
@@ -22,7 +22,7 @@ class Transloadit::Response < Delegator
   # @return [String]           the value for the attribute
   #
   def [](attribute)
-    self.body[attribute.to_s]
+    body[attribute.to_s]
   end
 
   #
@@ -31,7 +31,7 @@ class Transloadit::Response < Delegator
   # @return [Hash] the parsed JSON body hash
   #
   def body
-    MultiJson.load self.__getobj__.body
+    MultiJson.load __getobj__.body
   end
 
   #
@@ -40,7 +40,7 @@ class Transloadit::Response < Delegator
   # @return [String] a human-readable version of the body
   #
   def inspect
-    self.body.inspect
+    body.inspect
   end
 
   #
@@ -51,7 +51,7 @@ class Transloadit::Response < Delegator
   # @return [Transloadit::Response] the extended response
   #
   def extend!(mod)
-    self.extend(mod)
+    extend(mod)
     self
   end
 
@@ -84,7 +84,7 @@ class Transloadit::Response < Delegator
   # @return [Transloadit::Response] this response
   #
   def replace(other)
-    self.__setobj__ other.__getobj__
+    __setobj__ other.__getobj__
     self
   end
 end

data/lib/transloadit/step.rb

@@ -1,11 +1,11 @@
-require 'transloadit'
+require "transloadit"
 
 #
 # Implements the concept of a step in the Transloadit API. Each Step has a
 # +robot+ (e.g., '/image/resize' or '/video/thumbnail') and a hash of
 # +options+ specific to the chosen robot.
 #
-# See the Transloadit {documentation}[http://transloadit.com/docs/building-assembly-instructions]
+# See the Transloadit {documentation}[https://transloadit.com/docs/building-assembly-instructions]
 # for futher information on robot types and their parameters.
 #
 class Transloadit::Step
@@ -27,8 +27,8 @@ class Transloadit::Step
   #   {Transloadit#step} for possible values
   #
   def initialize(name, robot, options = {})
-    self.name    = name
-    self.robot   = robot
+    self.name = name
+    self.robot = robot
     self.options = options
   end
 
@@ -38,7 +38,7 @@ class Transloadit::Step
   #
   # @param [Step, Array<Step>, Symbol, nil] input The input
   #   step to use. Follows the conventions outlined in the
-  #   online  {documentation}[http://transloadit.com/docs/building-assembly-instructions#special-parameters].
+  #   online  {documentation}[https://transloadit.com/docs/building-assembly-instructions#special-parameters].
   #   The symbol +:original+ specifies that the original file should be sent
   #   to the robot. A Step indicates that this Step's output should be used
   #   as the input to this one. Likewise, an array of Steps tells Transloadit
@@ -49,12 +49,12 @@ class Transloadit::Step
   #   that will actually be sent to the REST API.
   #
   def use(input)
-    self.options.delete(:use) and return if input.nil?
+    options.delete(:use) && return if input.nil?
 
-    self.options[:use] = case input
-      when Symbol then input.inspect
-      when Array  then input.map {|i| i.name }
-      else             [ input.name ]
+    options[:use] = case input
+    when Symbol then input.inspect
+    when Array then input.map { |i| i.name }
+    else [input.name]
     end
   end
 
@@ -62,21 +62,21 @@ class Transloadit::Step
   # @return [String] a human-readable version of the Step
   #
   def inspect
-    self.to_hash[self.name].inspect
+    to_hash[name].inspect
   end
 
   #
   # @return [Hash] a Transloadit-compatible Hash of the Step's contents
   #
   def to_hash
-    { self.name => options.merge(:robot => self.robot) }
+    {name => options.merge(robot: robot)}
   end
 
   #
   # @return [String] JSON-encoded String containing the Step's hash contents
   #
   def to_json
-    MultiJson.dump(self.to_hash)
+    MultiJson.dump(to_hash)
   end
 
   protected

data/lib/transloadit/template.rb

@@ -1,4 +1,4 @@
-require 'transloadit'
+require "transloadit"
 
 #
 # Represents a Template API ready to interact with its corresponding REST API.
@@ -18,7 +18,7 @@ class Transloadit::Template < Transloadit::ApiModel
   #   see {template}[https://transloadit.com/templates]
   #
   def create(params)
-    _do_request('/templates', params, 'post')
+    _do_request("/templates", params, "post")
   end
 
   #
@@ -26,7 +26,7 @@ class Transloadit::Template < Transloadit::ApiModel
   # @param [Hash]    additional GET data to submit with the request
   #
   def list(params = {})
-    _do_request('/templates', params)
+    _do_request("/templates", params)
   end
 
   #
@@ -49,7 +49,7 @@ class Transloadit::Template < Transloadit::ApiModel
   #   see {template}[https://transloadit.com/templates]
   #
   def update(id, params = {})
-    _do_request("/templates/#{id}", params, 'put')
+    _do_request("/templates/#{id}", params, "put")
   end
 
   #
@@ -58,6 +58,6 @@ class Transloadit::Template < Transloadit::ApiModel
   # @param [Hash]    additional POST data to submit with the request
   #
   def delete(id, params = {})
-    _do_request("/templates/#{id}", params, 'delete')
+    _do_request("/templates/#{id}", params, "delete")
   end
 end

data/lib/transloadit/version.rb

@@ -1,3 +1,3 @@
 class Transloadit
-  VERSION = '2.0.1'
+  VERSION = "3.0.0"
 end