transloadit 1.0.5 → 1.0.6

data/CHANGELOG.md

@@ -1,6 +1,20 @@
+### 1.0.6 / 2013-04-22 ###
+
+* We now have more statuses available in the response:
+    * finished? to check if processing is finished
+    * error? to check if processing failed with errors
+    * canceled? to check if processing was canceled
+    * aborted? to check if processing was aborted
+    * executing? to check if processing is still executing
+    * uploading? to check if the upload is still going
+* Please use `finished?` to check if procssing is finished and `completed?` to
+  check if completed successfully
+
 ### 1.0.5 / 2013-03-13 ###
 
 * Use MultiJSON so everyone can use the JSON parser they like. (thanks @kselden for the patch)
+* Switch to Kramdown for RDoc formatting
+* Support jRuby 1.8/1.9 and MRI 2.0.0 too
 
 ### 1.0.4 / 2013-03-06 ###
 

data/README.md

@@ -63,6 +63,17 @@ assembly = transloadit.assembly(
 )
 
 response = assembly.submit! open('lolcat.jpg')
+
+# loop until processing is finished
+until response.finished?
+  sleep 1; response.reload! # you'll want to implement a timeout in your production app
+end
+
+if response.error?
+ # handle error
+else
+ # handle other cases
+end
 ```
 
 When the `submit!` method returns, the file has been uploaded but may not yet
@@ -80,11 +91,17 @@ response[:assembly_url] # => 'http://api2.vivian.transloadit.com/assemblies/9bd7
 response[:bytes_expected] # => 92933
 response[:bytes_received] # => 92933
 
-# checks if all processing has been completed
-response.completed? # => false
+# checks if all processing has been finished
+response.finished? # => false
 
 # cancels further processing on the assembly
 response.cancel! # => true
+
+# checks if processing was succesfully completed
+response.completed? # => true
+
+# checks if the processing returned with an error
+response.error? # => false
 ```
 
 It's important to note that none of these queries are "live" (with the

data/lib/transloadit/response/assembly.rb

@@ -4,12 +4,36 @@ module Transloadit::Response::Assembly
   def reload!
     self.replace Transloadit::Request.new(self['assembly_url']).get
   end
-  
+
   def cancel!
     self.replace Transloadit::Request.new(self['assembly_url']).delete
   end
-  
+
+  def aborted?
+    self['ok'] == 'REQUEST_ABORTED'
+  end
+
+  def canceled?
+    self['ok'] == 'ASSEMBLY_CANCELED'
+  end
+
   def completed?
     self['ok'] == 'ASSEMBLY_COMPLETED'
   end
+
+  def error?
+    self['error'] != nil
+  end
+
+  def executing?
+    self['ok'] == 'ASSEMBLY_EXECUTING'
+  end
+
+  def finished?
+    aborted? || canceled? || completed? || error?
+  end
+
+  def uploading?
+    self['ok'] == 'ASSEMBLY_UPLOADING'
+  end
 end

data/lib/transloadit/version.rb

@@ -1,4 +1,3 @@
 class Transloadit
-  # The current version of Transloadit.
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/test/fixtures/cassettes/fetch_assembly_aborted.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.jane.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":"REQUEST_ABORTED","message":"The upload connection was closed or timed out before receiving all data.","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
+recorded_with: VCR 2.4.0

data/test/fixtures/cassettes/fetch_assembly_errors.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.jane.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_CANCELED","message":"The assembly is still in the process of being uploaded.","error": "INVALID_FORM_DATA", "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
+recorded_with: VCR 2.4.0

data/test/fixtures/cassettes/fetch_assembly_executing.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.jane.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_EXECUTING","message":"The assembly is currently being executed.","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
+recorded_with: VCR 2.4.0

data/test/fixtures/cassettes/fetch_assembly_uploading.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api2.jane.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_UPLOADING","message":"The assembly is still in the process of being uploaded.","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
+recorded_with: VCR 2.4.0

data/test/unit/transloadit/test_response.rb

@@ -2,25 +2,25 @@ require 'test_helper'
 
 describe Transloadit::Response do
   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
+      VCR.use_cassette 'fetch_assembly_ok' 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]
@@ -32,43 +32,95 @@ describe Transloadit::Response do
         @response[attribute].must_equal @response.body[attribute.to_s]
       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
+      VCR.use_cassette 'fetch_assembly_ok' 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
+      @response.finished?.must_equal true
+      @response.error?.must_equal false
     end
-    
+
     # TODO: can this be tested better?
     it 'must allow reloading the assembly' do
-      VCR.use_cassette 'fetch_assembly', :allow_playback_repeats => true 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
     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'
+        @response.canceled?.must_equal true
+        @response.finished?.must_equal true
+      end
+    end
+  end
+
+  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)
+      end
+
+      @response.finished?.must_equal false
+      @response.uploading?.must_equal true
+      @response.error?.must_equal false
+    end
+
+    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)
+      end
+
+      @response.finished?.must_equal false
+      @response.executing?.must_equal true
+      @response.error?.must_equal false
+    end
+
+    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)
+      end
+
+      @response.finished?.must_equal true
+      @response.aborted?.must_equal true
+    end
+
+    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)
       end
+
+      @response.error?.must_equal true
+      @response.finished?.must_equal true
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transloadit
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -179,7 +179,11 @@ files:
 - lib/transloadit/step.rb
 - lib/transloadit/version.rb
 - test/fixtures/cassettes/cancel_assembly.yml
-- test/fixtures/cassettes/fetch_assembly.yml
+- test/fixtures/cassettes/fetch_assembly_aborted.yml
+- test/fixtures/cassettes/fetch_assembly_errors.yml
+- test/fixtures/cassettes/fetch_assembly_executing.yml
+- test/fixtures/cassettes/fetch_assembly_ok.yml
+- test/fixtures/cassettes/fetch_assembly_uploading.yml
 - test/fixtures/cassettes/fetch_bored.yml
 - test/fixtures/cassettes/post_assembly.yml
 - test/fixtures/cassettes/submit_assembly.yml
@@ -210,13 +214,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: transloadit
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 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_assembly_aborted.yml
+- test/fixtures/cassettes/fetch_assembly_errors.yml
+- test/fixtures/cassettes/fetch_assembly_executing.yml
+- test/fixtures/cassettes/fetch_assembly_ok.yml
+- test/fixtures/cassettes/fetch_assembly_uploading.yml
 - test/fixtures/cassettes/fetch_bored.yml
 - test/fixtures/cassettes/post_assembly.yml
 - test/fixtures/cassettes/submit_assembly.yml