transloadit 0.1.2 → 0.9.0

data/README.md

@@ -35,11 +35,11 @@ and store the result on [Amazon S3](http://aws.amazon.com/s3/).
 First, we create two steps: one to resize the image to 320x240, and another to
 store the image in our S3 bucket.
 
-    resize = transloadit.step '/image/resize',
+    resize = transloadit.step 'resize', '/image/resize',
       width:  320,
       height: 240
 
-    store  = transloadit.step '/s3/store',
+    store  = transloadit.step 'store', '/s3/store',
       key:    'aws-access-key-id',
       secret: 'aws-secret-access-key',
       bucket: 's3-bucket-name'
@@ -108,9 +108,9 @@ Transloadit allows you to perform several processing steps in parallel. You
 simply need to `use` other steps. Following 
 [their example](http://transloadit.com/docs/assemblies#special-parameters):
 
-    encode = transloadit.step '/video/encode', { ... }
-    thumbs = transloadit.step '/video/thumbs', { ... }
-    export = transloadit.step '/s3/store',     { ... }
+    encode = transloadit.step 'encode', '/video/encode', { ... }
+    thumbs = transloadit.step 'thumbs', '/video/thumbs', { ... }
+    export = transloadit.step 'store',  '/s3/store',     { ... }
     
     export.use [ encode, thumbs ]
     

data/lib/transloadit/assembly.rb

@@ -50,14 +50,20 @@ class Transloadit::Assembly
   #   @param [Hash]      params additional POST data to submit with the request
   #
   def submit!(*ios)
-    params  = _extract_options!(*ios)
+    params  = _extract_options!(ios)
     payload = { :params => self.to_hash.update(params) }
     
+    # update the payload with file entries
     ios.each_with_index {|f, i| payload.update :"file_#{i}" => f }
     
+    # find a bored instance
+    Transloadit::Request.bored!
+    
+    # create the request
     request = Transloadit::Request.new '/assemblies',
       self.transloadit.secret
     
+    # post the request, extend it with the Assembly extensions
     request.post(payload).extend!(Transloadit::Response::Assembly)
   end
   
@@ -115,7 +121,7 @@ class Transloadit::Assembly
   # @param  *args  the arguments to search for an options hash
   # @return [Hash] the options passed, otherwise an empty hash
   #
-  def _extract_options!(*args)
+  def _extract_options!(args)
     args.last.is_a?(Hash) ? args.pop : {}
   end
 end

data/lib/transloadit/request.rb

@@ -24,33 +24,70 @@ 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)
+    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
+  # best server to use. If a full URL is given, the host provided will be
+  # used.
+  #
+  # @param [String] url    the API endpoint
+  # @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.secret = secret
   end
   
+  #
+  # Performs an HTTP GET to the request's URL. Takes an optional hash of
+  # query params.
+  #
+  # @param  [Hash] params additional query parameters
+  # @return [Transloadit::Response] the response
+  #
   def get(params = {})
     self.request! do
       self.api[url.path + self.to_query(params)].get(API_HEADERS)
     end
   end
   
+  #
+  # Performs an HTTP DELETE to the request's URL. Takes an optional hash of
+  # query params.
+  #
+  # @param  [Hash] params additional query parameters
+  # @return [Transloadit::Response] the response
+  #
   def delete(params = {})
     self.request! do
       self.api[url.path + self.to_query(params)].delete(API_HEADERS)
     end
   end
   
+  #
+  # Performs an HTTP POST 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 post(payload = {})
     self.request! do
       self.api[url.path].post(self.to_payload(payload), API_HEADERS)
     end
   end
   
+  #
+  # @return [String] a human-readable version of the prepared Request
+  #
   def inspect
     self.url.to_s.inspect
   end
@@ -59,15 +96,37 @@ 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.
+  # Otherwise uses the class-level API base.
+  #
+  # @return [RestClient::Resource] the API endpoint for this instance
+  #
   def api
     @api ||= begin
       case self.url.host
@@ -77,6 +136,14 @@ class Transloadit::Request
     end
   end
   
+  #
+  # Updates the POST payload passed to be compliant with the Transloadit API
+  # spec. JSONifies the value for the +params+ key and signs the request with
+  # the instance's +secret+ if it exists.
+  #
+  # @param  [Hash] the payload to update
+  # @return [Hash] the Transloadit-compliant POST payload
+  #
   def to_payload(payload = nil)
     return {} if payload.nil?
     return {} if payload.respond_to?(:empty?) and payload.empty?
@@ -88,32 +155,57 @@ class Transloadit::Request
     payload
   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
+  # signature.
+  #
+  # @param  [Hash] params the params to encode
+  # @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?
     
-    escape = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
-    params = URI.escape(params.to_json, escape)
+    escape    = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+    params    = {
+      :params    => URI.escape(params.to_json, escape),
+      :signature => self.signature(params)
+    }
     
-    # TODO: fix this to not depend on to_hash
-    '?' + self.to_hash.
-      update(:params => params).
-      map {|k,v| "#{k}=#{v}" }.
-      join('&')
+    '?' + params.map {|k,v| "#{k}=#{v}" if v }.compact.join('&')
   end
   
+  #
+  # Wraps a request's results in a Transloadit::Response, even if an exception
+  # is raised by RestClient.
+  #
   def request!(&request)
     Transloadit::Response.new request.call
   rescue RestClient::Exception => e
     Transloadit::Response.new e.response
   end
   
+  #
+  # Computes the HMAC digest of the params hash, if a secret was given to the
+  # instance.
+  #
+  # @param  [Hash] params the payload to sign
+  # @return [String] the HMAC signature for the params
+  #
   def signature(params)
     self.class._hmac(self.secret, params.to_json) if self.secret
   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
   end

data/lib/transloadit/response/assembly.rb

@@ -10,6 +10,6 @@ module Transloadit::Response::Assembly
   end
   
   def completed?
-    r['ok'] == 'ASSEMBLY_COMPLETED'
+    self['ok'] == 'ASSEMBLY_COMPLETED'
   end
 end

data/lib/transloadit/response.rb

@@ -1,27 +1,55 @@
 require 'transloadit'
+
+require 'rest-client'
 require 'delegate'
 
 class Transloadit::Response < Delegator
   autoload :Assembly, 'transloadit/response/assembly'
   
-  def initialize(response, &extension)
+  #
+  # Creates an enhanced response wrapped around a RestClient response.
+  #
+  # @param [RestClient::Response] response the JSON response to wrap
+  #
+  def initialize(response)
     self.__setobj__(response)
-    
-    instance_eval(&extension) if block_given?
   end
   
+  #
+  # Returns the attribute from the JSON response.
+  #
+  # @param  [String] attribute the attribute name to look up
+  # @return [String]           the value for the attribute
+  #
   def [](attribute)
     self.body[attribute]
   end
   
+  #
+  # Returns the parsed JSON body.
+  #
+  # @return [Hash] the parsed JSON body hash
+  #
   def body
     JSON.parse self.__getobj__.body
   end
   
+  #
+  # Inspects the body of the response.
+  #
+  # @return [String] a human-readable version of the body
+  #
   def inspect
     self.body.inspect
   end
   
+  #
+  # Chainably extends the response with additional methods. Used to add
+  # context-specific functionality to a response.
+  #
+  # @param  [Module] mod            the module to extend with
+  # @return [Transloadit::Response] the extended response
+  #
   def extend!(mod)
     self.extend(mod)
     self
@@ -29,15 +57,34 @@ class Transloadit::Response < Delegator
   
   protected
   
+  #
+  # The object to delegate method calls to.
+  #
+  # @return [RestClient::Response]
+  #
   def __getobj__
     @response
   end
   
+  #
+  # Sets the object to delegate method calls to.
+  #
+  # @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
+  # @return [Transloadit::Response] this response
+  #
   def replace(other)
     self.__setobj__ other.__getobj__
+    self
   end
 end

data/lib/transloadit/step.rb

@@ -9,6 +9,9 @@ require 'transloadit'
 # for futher information on robot types and their parameters.
 #
 class Transloadit::Step
+  # @return [String] the name to give the step
+  attr_accessor :name
+  
   # @return [String] the robot to use
   attr_reader :robot
   
@@ -18,27 +21,17 @@ class Transloadit::Step
   #
   # Creates a new Step with the given +robot+.
   #
+  # @param [String] name    the explicit name to give the step
   # @param [String] robot   the robot to use
   # @param [Hash]   options the configuration options for the robot; see
   #   {Transloadit#step} for possible values
   #
-  def initialize(robot, options = {})
+  def initialize(name, robot, options = {})
+    self.name    = name
     self.robot   = robot
     self.options = options
   end
   
-  #
-  # Automatically generates a unique, 32-character hex name for the step that
-  # uses this robot.
-  #
-  # @return [String] a randomly generated name
-  #
-  def name
-    # rand() is "good enough" for this; we generate 128 random bits (same
-    # length as a UUID for future compatibility) and convert it to hex
-    @name ||= rand(2 ** 128).to_s(16).rjust(32, '0')
-  end
-  
   #
   # Specifies that this Step should process the provided +input+ instead of
   # the output of the Step before it.

data/lib/transloadit/version.rb

@@ -1,4 +1,4 @@
 class Transloadit
   # The current version of Transloadit.
-  VERSION = '0.1.2'
+  VERSION = '0.9.0'
 end

data/lib/transloadit.rb

@@ -38,14 +38,15 @@ class Transloadit
   #
   # Creates a Transloadit::Step describing a step in an upload assembly.
   #
+  # @param  [String] name  the name to give the step
   # @param  [String] robot the robot to use in this step (e.g., '/image/resize')
   # @param  [Hash]   options a hash of options to customize the robot's
   #   operation; see the {online documentation}[http://transloadit.com/docs/building-assembly-instructions]
   #   for robot-specific options
   # @return [Step]   the created Step
   #
-  def step(robot, options = {})
-    Transloadit::Step.new(robot, options)
+  def step(name, robot, options = {})
+    Transloadit::Step.new(name, robot, options)
   end
   
   #

data/test/fixtures/cassettes/cancel_assembly.yml

@@ -0,0 +1,30 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :delete
+    uri: http://api2.jane.transloadit.com:80/assemblies/76fe5df1c93a0a530f3e583805cf98b4
+    body: 
+    headers: 
+      accept: 
+      - "*/*; q=0.5, application/xml"
+      accept-encoding: 
+      - gzip, deflate
+      user-agent: 
+      - Transloadit Ruby SDK 0.1.2
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      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: "{\"ok\":\"ASSEMBLY_CANCELED\",\"message\":\"The assembly was canceled.\",\"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"

data/test/fixtures/cassettes/fetch_assembly.yml

@@ -0,0 +1,28 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://api2.jane.transloadit.com:80/assemblies/76fe5df1c93a0a530f3e583805cf98b4
+    body: 
+    headers: 
+      accept: 
+      - "*/*; q=0.5, application/xml"
+      accept-encoding: 
+      - gzip, deflate
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      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: "{\"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"

data/test/fixtures/cassettes/fetch_bored.yml

@@ -0,0 +1,63 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://api2.transloadit.com:80/instances/bored
+    body: 
+    headers: 
+      accept: 
+      - "*/*; q=0.5, application/xml"
+      accept-encoding: 
+      - gzip, deflate
+      user-agent: 
+      - Transloadit Ruby SDK 0.1.2
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      access-control-allow-headers: 
+      - X-Requested-With, Content-Type, Accept, Content-Length
+      access-control-allow-methods: 
+      - POST, GET, PUT, DELETE, OPTIONS
+      access-control-allow-origin: 
+      - "*"
+      content-type: 
+      - text/plain
+      content-length: 
+      - "94"
+      connection: 
+      - keep-alive
+    body: "{\"ok\":\"BORED_INSTANCE_FOUND\",\"host\":\"jane.transloadit.com\",\"api2_host\":\"jane.transloadit.com\"}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://api2.transloadit.com:80/instances/bored?params=%7B%22params%22:%7B%22foo%22:%22bar%22%7D%7D
+    body: 
+    headers: 
+      accept: 
+      - "*/*; q=0.5, application/xml"
+      accept-encoding: 
+      - gzip, deflate
+      user-agent: 
+      - Transloadit Ruby SDK 0.1.2
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      access-control-allow-headers: 
+      - X-Requested-With, Content-Type, Accept, Content-Length
+      access-control-allow-methods: 
+      - POST, GET, PUT, DELETE, OPTIONS
+      access-control-allow-origin: 
+      - "*"
+      content-type: 
+      - text/plain
+      content-length: 
+      - "94"
+      connection: 
+      - keep-alive
+    body: "{\"ok\":\"BORED_INSTANCE_FOUND\",\"host\":\"jane.transloadit.com\",\"api2_host\":\"jane.transloadit.com\"}"
+    http_version: "1.1"

data/test/fixtures/cassettes/post_assembly.yml

@@ -0,0 +1,36 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: http://api2.transloadit.com:80/assemblies
+    body: params=%7B%22auth%22%3A%7B%22key%22%3A%22%22%2C%22expires%22%3A%222011%2F02%2F21%2023%3A15%3A43%2B00%3A00%22%7D%2C%22steps%22%3A%7B%22encode%22%3A%7B%22robot%22%3A%22%2Fvideo%2Fencode%22%7D%7D%7D&signature=d1a856e3d04103da448a512070139d3e721594cc
+    headers: 
+      accept: 
+      - "*/*; q=0.5, application/xml"
+      accept-encoding: 
+      - gzip, deflate
+      user-agent: 
+      - Transloadit Ruby SDK 0.1.2
+      content-length: 
+      - "278"
+      content-type: 
+      - application/x-www-form-urlencoded
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      access-control-allow-headers: 
+      - X-Requested-With, Content-Type, Accept, Content-Length
+      access-control-allow-methods: 
+      - POST, GET, PUT, DELETE, OPTIONS
+      access-control-allow-origin: 
+      - "*"
+      content-type: 
+      - text/plain
+      content-length: 
+      - "482"
+      connection: 
+      - keep-alive
+    body: "{\"ok\":\"ASSEMBLY_COMPLETED\",\"message\":\"The assembly was successfully completed.\",\"assembly_id\":\"2a4cb778995be35ffe5fcda3c01e4267\",\"assembly_url\":\"http://api2.jane.transloadit.com/assemblies/2a4cb778995be35ffe5fcda3c01e4267\",\"bytes_received\":278,\"bytes_expected\":278,\"client_agent\":\"Transloadit Ruby SDK 0.1.2\",\"client_ip\":\"74.95.29.209\",\"client_referer\":null,\"start_date\":\"2011/02/21 23:15:33 GMT\",\"upload_duration\":0.094,\"execution_duration\":0,\"fields\":{},\"uploads\":[],\"results\":{}}"
+    http_version: "1.1"

data/test/test_helper.rb

@@ -11,6 +11,6 @@ require 'vcr'
 
 VCR.config do |c|
   c.cassette_library_dir     = 'test/fixtures/cassettes'
-  c.default_cassette_options = { :record => :new_episodes }
+  c.default_cassette_options = { :record => :none }
   c.stub_with :webmock
 end

data/test/unit/test_transloadit.rb

@@ -41,15 +41,16 @@ describe Transloadit do
     end
     
     it 'must create steps' do
-      step = @transloadit.step('/image/resize', :width => 320)
-
+      step = @transloadit.step('resize', '/image/resize', :width => 320)
+      
       step.must_be_kind_of Transloadit::Step
+      step.name.   must_equal 'resize'
       step.robot.  must_equal '/image/resize'
       step.options.must_equal :width => 320
     end
     
     it 'must create assemblies' do                     
-      step     = @transloadit.step('')
+      step     = @transloadit.step(nil, nil)
       assembly = @transloadit.assembly :steps => step
       
       assembly.must_be_kind_of Transloadit::Assembly
@@ -58,8 +59,8 @@ describe Transloadit do
     
     it 'must create assemblies with multiple steps' do
       steps = [
-        @transloadit.step(''),
-        @transloadit.step(''),
+        @transloadit.step(nil, nil),
+        @transloadit.step(nil, nil),
       ]
       
       assembly = @transloadit.assembly :steps => steps

data/test/unit/transloadit/test_assembly.rb

@@ -12,7 +12,7 @@ describe Transloadit::Assembly do
   
   describe 'when initialized' do
     before do    
-      @step     = @transloadit.step '/video/thumbs'
+      @step     = @transloadit.step 'thumbs', '/video/thumbs'
       @redirect = 'http://foo.bar/'
       
       @assembly = Transloadit::Assembly.new @transloadit,
@@ -72,8 +72,8 @@ describe Transloadit::Assembly do
   
   describe 'with multiple steps' do
     before do
-      @encode = @transloadit.step '/video/encode'
-      @thumbs = @transloadit.step '/video/thumbs'
+      @encode = @transloadit.step 'encode', '/video/encode'
+      @thumbs = @transloadit.step 'thumbs', '/video/thumbs'
       
       @assembly = Transloadit::Assembly.new @transloadit,
         :steps => [ @encode, @thumbs ]

data/test/unit/transloadit/test_request.rb

@@ -1,5 +1,55 @@
 require 'test_helper'
 
 describe Transloadit::Request do
-  it 'should be tested'
+  REQUEST_URI = 'http://api2.jane.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4'
+  
+  before do
+    # reset the API endpoint between tests
+    Transloadit::Request.api Transloadit::Request::API_ENDPOINT
+  end
+  
+  it 'must allow initialization' do
+    request = Transloadit::Request.new '/'
+    request.must_be_kind_of Transloadit::Request
+  end
+  
+  it 'must locate bored instances' do
+    VCR.use_cassette 'fetch_bored' do
+      Transloadit::Request.bored!.
+        wont_equal Transloadit::Request::API_ENDPOINT.host
+    end
+  end
+  
+  describe 'when performing a GET' do
+    before do
+      @request = Transloadit::Request.new('instances/bored')
+    end
+    
+    it 'must inspect to the API URL' do
+      @request.inspect.must_equal @request.url.to_s.inspect
+    end
+    
+    it 'must perform a GET against the resource' do
+      VCR.use_cassette 'fetch_bored' do
+        @request.get(:params => { :foo => 'bar'})['ok'].
+          must_equal 'BORED_INSTANCE_FOUND'
+      end
+    end
+  end
+  
+  describe 'when performing a POST' do
+    before do
+      @request = Transloadit::Request.new('assemblies', '')
+    end
+    
+    it 'must perform a POST against the resource' do
+      VCR.use_cassette 'post_assembly' do
+        @request.post(:params => {
+          :auth  => { :key     => '',
+                      :expires => (Time.now + 10).utc.strftime('%Y/%m/%d %H:%M:%S+00:00') },
+          :steps => { :encode => { :robot => '/video/encode' } }
+        })['ok'].must_equal 'ASSEMBLY_COMPLETED'
+      end
+    end
+  end
 end

data/test/unit/transloadit/test_response.rb

@@ -1,5 +1,68 @@
 require 'test_helper'
 
 describe Transloadit::Response do
-  it 'should be tested'
+  REQUEST_URI = 'http://api2.jane.transloadit.com/assemblies/76fe5df1c93a0a530f3e583805cf98b4'
+  
+  it 'must allow delegate initialization' do
+    response = Transloadit::Response.new('test')
+    response.class.must_equal Transloadit::Response
+  end
+  
+  describe 'when initialized' do
+    before do
+      VCR.use_cassette 'fetch_assembly' do
+        @response = Transloadit::Response.new(
+          RestClient::Resource.new(REQUEST_URI).get
+        )
+      end
+    end
+    
+    it 'must parse the body' do
+      @response.body.must_be_kind_of Hash
+    end
+    
+    it 'must allow access to body attributes' do
+      %w{ ok message assembly_id assembly_url }.each do |attribute|
+        @response[attribute].must_equal @response.body[attribute]
+      end
+    end
+    
+    it 'must inspect as the body' do
+      @response.inspect.must_equal @response.body.inspect
+    end
+  end
+  
+  describe 'when extended as an assembly' do
+    before do
+      VCR.use_cassette 'fetch_assembly' do
+        @response = Transloadit::Response.new(
+          RestClient::Resource.new(REQUEST_URI).get
+        ).extend!(Transloadit::Response::Assembly)
+      end
+    end
+    
+    it 'must allow checking for completion' do
+      @response.completed?.must_equal true
+    end
+    
+    # TODO: can this be tested better?
+    it 'must allow reloading the assembly' do
+      VCR.use_cassette 'fetch_assembly' do
+        @response.send(:__getobj__).
+          wont_be_same_as @response.reload!.send(:__getobj__)
+        
+        @response.object_id.
+          must_equal @response.reload!.object_id
+      end
+    end
+    
+    it 'must allow canceling' do
+      VCR.use_cassette 'cancel_assembly' do
+        @response.cancel!
+        
+        @response.completed?.must_equal false
+        @response['ok']     .must_equal 'ASSEMBLY_CANCELED'
+      end
+    end
+  end
 end

data/test/unit/transloadit/test_step.rb

@@ -2,32 +2,26 @@ require 'test_helper'
 
 describe Transloadit::Step do
   it 'must allow initialization' do
-    Transloadit::Step.new('/s3/store').must_be_kind_of Transloadit::Step
+    Transloadit::Step.new('store', '/s3/store').
+      must_be_kind_of Transloadit::Step
   end
   
   describe 'when initialized' do
     before do
+      @name   = 'store'
       @robot  = '/s3/store'
       @key    = 'aws-access-key-id'
       @secret = 'aws-secret-access-key'
       @bucket = 's3-bucket-name'
       
-      @step = Transloadit::Step.new '/s3/store',
+      @step = Transloadit::Step.new @name, @robot,
         :key    => @key,
         :secret => @secret,
         :bucket => @bucket
     end
     
-    it 'must generate a name' do
-      @step.name.wont_equal nil
-    end
-    
-    it 'must generate a unique name' do
-      @step.name.wont_equal Transloadit::Step.new('').name
-    end
-    
-    it 'must generate a name with 32 hex characters' do
-      @step.name.length.must_equal 32
+    it 'should use the name given' do
+      @step.name.must_equal @name
     end
     
     it 'must remember the type' do
@@ -64,7 +58,7 @@ describe Transloadit::Step do
   
   describe 'when using alternative inputs' do
     before do
-      @step = Transloadit::Step.new '/image/resize'
+      @step = Transloadit::Step.new 'resize', '/image/resize'
     end
     
     it 'must allow using the original file as input' do
@@ -73,7 +67,7 @@ describe Transloadit::Step do
     end
     
     it 'must allow using another step' do
-      input = Transloadit::Step.new '/video/thumbnail'
+      input = Transloadit::Step.new 'thumbnail', '/video/thumbnail'
       
       @step.use(input).   must_equal [ input.name ]
       @step.options[:use].must_equal [ input.name ]
@@ -81,8 +75,8 @@ describe Transloadit::Step do
     
     it 'must allow using multiple steps' do
       inputs = [
-        Transloadit::Step.new('/video/thumbnail'),
-        Transloadit::Step.new('/image/resize')
+        Transloadit::Step.new('thumbnail', '/video/thumbnail'),
+        Transloadit::Step.new('resize',    '/image/resize')
       ]
       
       @step.use(inputs).  must_equal inputs.map {|i| i.name }

metadata

@@ -2,7 +2,7 @@
 name: transloadit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Stephen
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 -05:00
+date: 2011-02-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -134,6 +134,10 @@ files:
 - lib/transloadit/response/assembly.rb
 - lib/transloadit/step.rb
 - lib/transloadit/version.rb
+- test/fixtures/cassettes/cancel_assembly.yml
+- test/fixtures/cassettes/fetch_assembly.yml
+- test/fixtures/cassettes/fetch_bored.yml
+- test/fixtures/cassettes/post_assembly.yml
 - test/fixtures/cassettes/submit_assembly.yml
 - test/test_helper.rb
 - test/unit/test_transloadit.rb
@@ -171,6 +175,10 @@ signing_key:
 specification_version: 3
 summary: Official Ruby gem for Transloadit
 test_files: 
+- test/fixtures/cassettes/cancel_assembly.yml
+- test/fixtures/cassettes/fetch_assembly.yml
+- test/fixtures/cassettes/fetch_bored.yml
+- test/fixtures/cassettes/post_assembly.yml
 - test/fixtures/cassettes/submit_assembly.yml
 - test/test_helper.rb
 - test/unit/test_transloadit.rb