transloadit 1.2.0 → 2.0.0

data/lib/transloadit/exception.rb

@@ -0,0 +1,27 @@
+require 'transloadit'
+
+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}"
+    end
+  end
+
+  #
+  # Exception raised when Response#reload_until_finished! reaches limit specified in :tries option
+  #
+  class ReloadLimitReached < StandardError
+    def message
+      "reload_until_finished! reached limit specified in :tries option. This is not a rate limit and you may continue to poll for updates."
+    end
+  end
+end

data/lib/transloadit/request.rb

@@ -13,7 +13,7 @@ class Transloadit::Request
   API_ENDPOINT = URI.parse('http://api2.transloadit.com/')
 
   # The default headers to send to the API.
-  API_HEADERS  = { 'User-Agent' => %{Transloadit Ruby SDK #{Transloadit::VERSION}} }
+  API_HEADERS  = { 'User-Agent' => "Transloadit Ruby SDK #{Transloadit::VERSION}" }
 
   # The HMAC algorithm used for calculation request signatures.
   HMAC_ALGORITHM = OpenSSL::Digest.new('sha1')
@@ -24,14 +24,6 @@ class Transloadit::Request
   # @return [String] the authentication secret to sign the request with
   attr_accessor :secret
 
-  #
-  # Automatically sets the API endpoint to the server with the most free
-  # resources. This is called automatically the first time a request is made.
-  #
-  def self.bored!
-    self.api self.bored
-  end
-
   #
   # Prepares a request against an endpoint URL, optionally with an encryption
   # secret. If only a path is passed, the API will automatically determine the
@@ -60,15 +52,16 @@ class Transloadit::Request
   end
 
   #
-  # Performs an HTTP DELETE to the request's URL. Takes an optional hash of
-  # query params.
+  # Performs an HTTP DELETE to the request's URL. Takes an optional hash
+  # containing the form-encoded payload.
   #
-  # @param  [Hash] params additional query parameters
+  # @param  [Hash] payload the payload to form-encode along with the POST
   # @return [Transloadit::Response] the response
   #
-  def delete(params = {})
+  def delete(payload = {})
     self.request! do
-      self.api[url.path + self.to_query(params)].delete(API_HEADERS)
+      options = {:payload => self.to_payload(payload)}
+      self.api(options = options)[url.path].delete(API_HEADERS)
     end
   end
 
@@ -85,6 +78,19 @@ class Transloadit::Request
     end
   end
 
+  #
+  # Performs an HTTP PUT to the request's URL. Takes an optional hash
+  # containing the form-encoded payload.
+  #
+  # @param  [Hash] payload the payload to form-encode along with the POST
+  # @return [Transloadit::Response] the response
+  #
+  def put(payload = {})
+    self.request! do
+      self.api[url.path].put(self.to_payload(payload), API_HEADERS)
+    end
+  end
+
   #
   # @return [String] a human-readable version of the prepared Request
   #
@@ -96,30 +102,6 @@ class Transloadit::Request
 
   attr_writer :url
 
-  #
-  # Locates the API server with the smallest job queue.
-  #
-  # @return [String] the hostname of the most bored server
-  #
-  def self.bored
-    self.new(API_ENDPOINT + '/instances/bored').get['api2_host']
-  end
-
-  #
-  # Sets or retrieves the base URI of the API endpoint.
-  #
-  # @overload self.api
-  #   @return [RestClient::Resource] the current API endpoint
-  #
-  # @overload self.api(uri)
-  #   @param [String] the hostname or URI to set the API endpoint to
-  #   @return [RestClient::Resource] the new API endpoint
-  #
-  def self.api(uri = nil)
-    @api   = RestClient::Resource.new(uri) if uri
-    @api ||= RestClient::Resource.new(self.bored)
-  end
-
   #
   # Retrieves the current API endpoint. If the URL of the request contains a
   # hostname, then the hostname is used as the base endpoint of the API.
@@ -127,11 +109,11 @@ class Transloadit::Request
   #
   # @return [RestClient::Resource] the API endpoint for this instance
   #
-  def api
+  def api(options = {})
     @api ||= begin
       case self.url.host
-        when String then RestClient::Resource.new(self.url.host)
-        else self.class.api
+        when String then RestClient::Resource.new(self.url.host, options = options)
+        else RestClient::Resource.new(API_ENDPOINT.host, options = options)
       end
     end
   end

data/lib/transloadit/response/assembly.rb

@@ -29,6 +29,10 @@ module Transloadit::Response::Assembly
     self['ok'] == 'ASSEMBLY_EXECUTING'
   end
 
+  def replaying?
+    self['ok'] == 'ASSEMBLY_REPLAYING'
+  end
+
   def finished?
     aborted? || canceled? || completed? || error?
   end
@@ -36,4 +40,25 @@ module Transloadit::Response::Assembly
   def uploading?
     self['ok'] == 'ASSEMBLY_UPLOADING'
   end
+
+  def rate_limit?
+    self['error'] == 'RATE_LIMIT_REACHED'
+  end
+
+  def wait_time
+    self['info']['retryIn'] || 0
+  end
+
+  DEFAULT_RELOAD_TRIES = 600
+
+  def reload_until_finished!(options = {})
+    tries = options[:tries] || DEFAULT_RELOAD_TRIES
+
+    tries.times do
+      sleep 1; reload!
+      return self if finished?
+    end
+
+    raise Transloadit::Exception::ReloadLimitReached
+  end
 end

data/lib/transloadit/template.rb

@@ -0,0 +1,63 @@
+require 'transloadit'
+
+#
+# Represents a Template API ready to interact with its corresponding REST API.
+#
+# See the Transloadit {documentation}[https://transloadit.com/docs/api-docs/#template-api]
+# for futher information on Templates and their parameters.
+#
+class Transloadit::Template < Transloadit::ApiModel
+  #
+  # Submits a template to be created.
+  #
+  # @param [Hash]  params POST data to submit with the request.
+  #   must contain keys 'name' and 'template'
+  #
+  # @option params [String] :name name assigned to the newly created template
+  # @option params [Hash] :template key, value pair of template content
+  #   see {template}[https://transloadit.com/templates]
+  #
+  def create(params)
+    _do_request('/templates', params, 'post')
+  end
+
+  #
+  # Returns a list of all templates
+  # @param [Hash]    additional GET data to submit with the request
+  #
+  def list(params = {})
+    _do_request('/templates', params)
+  end
+
+  #
+  # Returns a single template object specified by the template id
+  # @param [String]     id    id of the desired template
+  # @param [Hash]    additional GET data to submit with the request
+  #
+  def get(id, params = {})
+    _do_request("/templates/#{id}", params)
+  end
+
+  #
+  # Updates the template object specified by the template id
+  # @param [String]     id    id of the desired template
+  # @param [Hash]    additional POST data to submit with the request
+  #   must contain keys 'name' and 'template'
+  #
+  # @option params [String] :name name assigned to the newly created template
+  # @option params [Hash] :template key, value pair of template content
+  #   see {template}[https://transloadit.com/templates]
+  #
+  def update(id, params = {})
+    _do_request("/templates/#{id}", params, 'put')
+  end
+
+  #
+  # Deletes the template object specified by the template id
+  # @param [String]     id    id of the desired template
+  # @param [Hash]    additional POST data to submit with the request
+  #
+  def delete(id, params = {})
+    _do_request("/templates/#{id}", params, 'delete')
+  end
+end

data/lib/transloadit/version.rb

@@ -1,3 +1,3 @@
 class Transloadit
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/test/fixtures/cassettes/create_template.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api2.transloadit.com/templates
+    body:
+      encoding: UTF-8
+      string: params=%7B%22auth%22%3A%7B%22key%22%3A%22%22%7D%2C%22name%22%3A%22foo%22%2C%22template%22%3A%7B%22key%22%3A%22value%22%7D%7D
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Transloadit Ruby SDK 1.2.0
+      Content-Length:
+      - '124'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Host:
+      - api2.transloadit.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 25 Aug 2016 10:13:30 GMT
+      Content-Length:
+      - '104'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":"TEMPLATE_CREATED","template_name":"foo","template_content": {"key": "value"}}'
+    http_version: 
+  recorded_at: Thu, 25 Aug 2016 10:13:31 GMT
+recorded_with: VCR 3.0.3

data/test/fixtures/cassettes/delete_template.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://api2.transloadit.com/templates/55c965a063a311e6ba2d379ef10b28f7
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Transloadit Ruby SDK 1.2.0
+      Host:
+      - api2.transloadit.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 24 Aug 2016 11:15:20 GMT
+      Content-Length:
+      - '65'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":"TEMPLATE_DELETED","message":"Your template was successfully deleted."}'
+    http_version: 
+  recorded_at: Wed, 24 Aug 2016 11:15:19 GMT
+recorded_with: VCR 3.0.3

data/test/fixtures/cassettes/fetch_assemblies.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.transloadit.com/assemblies?params=%7B%22auth%22:%7B%22key%22:%22%22%7D%7D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Transloadit Ruby SDK 1.2.0
+      Host:
+      - api2.transloadit.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 16 Aug 2016 09:09:24 GMT
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"items":[],"count":0}'
+    http_version: 
+  recorded_at: Tue, 16 Aug 2016 09:09:24 GMT
+recorded_with: VCR 3.0.3

data/test/fixtures/cassettes/fetch_assembly_notifications.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.transloadit.com/assembly_notifications?params=%7B%22auth%22:%7B%22key%22:%22%22%7D%7D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Transloadit Ruby SDK 1.2.0
+      Host:
+      - api2.transloadit.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Cache-Control, Accept, Content-Length
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 16 Aug 2016 10:38:22 GMT
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"items":[],"count":0}'
+    http_version: 
+  recorded_at: Tue, 16 Aug 2016 10:38:22 GMT
+recorded_with: VCR 3.0.3

data/test/fixtures/cassettes/fetch_assembly_ok.yml

@@ -1,5 +1,41 @@
 ---
 http_interactions:
+- request:
+    method: get
+    uri: http://api2.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - text/plain
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Headers:
+      - X-Requested-With, Content-Type, Accept, Content-Length
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: ! '{"ok":"ASSEMBLY_COMPLETED","message":"The assembly was successfully
+        completed.","assembly_id":"76fe5df1c93a0a530f3e583805cf98b4","assembly_url":"http://api2.jane.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4","bytes_received":95355,"bytes_expected":95355,"client_agent":"Transloadit
+        Ruby SDK 0.1.2","client_ip":"74.95.29.209","client_referer":null,"start_date":"2011/02/21
+        15:54:17 GMT","upload_duration":0.394,"execution_duration":0.006,"fields":{},"uploads":[{"id":"0767b43537389a177a1be96ab06e8a4b","name":"test.png","basename":"test","ext":"png","size":95010,"mime":"image/jpeg","type":"image","field":"file_0","original_id":"0767b43537389a177a1be96ab06e8a4b","url":"http://tmp.jane.transloadit.com/upload/bf7801cb21fb96cbafd403467244d125.png","meta":{"width":640,"height":480,"date_recorded":null,"date_file_created":null,"date_file_modified":"2011/02/21
+        15:54:17 GMT","title":null,"description":null,"location":null,"city":null,"state":null,"country":null,"country_code":null,"keywords":"Photo
+        Booth","aperture":null,"exposure_compensation":null,"exposure_mode":null,"exposure_time":null,"flash":null,"focal_length":null,"f_number":null,"iso":null,"light_value":null,"metering_mode":null,"shutter_speed":null,"white_balance":null,"device_name":null,"device_vendor":null,"device_software":null,"latitude":null,"longitude":null,"frame_count":null}}],"results":{}}'
+    http_version: '1.1'
+  recorded_at: Fri, 08 Mar 2013 15:13:10 GMT
 - request:
     method: get
     uri: http://api2.jane.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4