transloadit 1.0.0 → 1.0.1

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+### 1.0.1 / 2011-02-08 ###
+
+[Full list of changes](https://github.com/transloadit/ruby-sdk/compare/v1.0.0...v1.0.1)
+
+* Enhancements
+  * support custom form fields for Transloadit::Assembly
+
+* New Maintainers
+  * Robin Mehner <robin@coding-robin.de>
+
+### 1.0.0 / 2011-09-06 ###
+
+* Initial release

data/README.md

@@ -9,23 +9,29 @@ you to automate uploading files through the Transloadit REST API.
 
 ## Install
 
-    gem install transloadit
+```bash
+gem install transloadit
+```
 
 ## Getting started
 
 To get started, you need to require the 'transloadit' gem:
 
-    $ irb -rubygems
-    >> require 'transloadit'
-    => true
+```bash
+$ irb -rubygems
+>> require 'transloadit'
+=> true
+```
 
 Then create a Transloadit instance, which will maintain your authentication
 credentials and allow us to make requests to the API.
 
-    transloadit = Transloadit.new(
-      :key    => 'transloadit-auth-key',
-      :secret => 'transloadit-auth-secret'
-    )
+```ruby
+transloadit = Transloadit.new(
+  :key    => 'transloadit-auth-key',
+  :secret => 'transloadit-auth-secret'
+)
+```
 
 ### 1. Resize and store an image
 
@@ -35,51 +41,59 @@ 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 'resize', '/image/resize',
-      :width  => 320,
-      :height => 240
+```ruby
+resize = transloadit.step 'resize', '/image/resize',
+  :width  => 320,
+  :height => 240
 
-    store  = transloadit.step 'store', '/s3/store',
-      :key    => 'aws-access-key-id',
-      :secret => 'aws-secret-access-key',
-      :bucket => 's3-bucket-name'
+store  = transloadit.step 'store', '/s3/store',
+  :key    => 'aws-access-key-id',
+  :secret => 'aws-secret-access-key',
+  :bucket => 's3-bucket-name'
+```
 
 Now that we have the steps, we create an assembly (which is just a request to
 process a file or set of files) and let Transloadit do the rest.
 
-    assembly = transloadit.assembly(
-      :steps => [ resize, store ]
-    )
-    
-    response = assembly.submit! open('lolcat.jpg')
+```ruby
+assembly = transloadit.assembly(
+  :steps => [ resize, store ]
+)
+
+response = assembly.submit! open('lolcat.jpg')
+```
 
 When the `submit!` method returns, the file has been uploaded but may not yet
 be done processing. We can use the returned object to check if processing has
 completed, or examine other attributes of the request.
 
-    # returns the unique API ID of the assembly
-    response[:assembly_id] # => '9bd733a...'
-    
-    # returns the API URL endpoint for the assembly
-    response[:assembly_url] # => 'http://api2.vivian.transloadit.com/assemblies/9bd733a...'
-    
-    # checks how many bytes were expected / received by transloadit
-    response[:bytes_expected] # => 92933
-    response[:bytes_received] # => 92933
-    
-    # checks if all processing has been completed
-    response.completed? # => false
-    
-    # cancels further processing on the assembly
-    response.cancel! # => true
+```ruby
+# returns the unique API ID of the assembly
+response[:assembly_id] # => '9bd733a...'
+
+# returns the API URL endpoint for the assembly
+response[:assembly_url] # => 'http://api2.vivian.transloadit.com/assemblies/9bd733a...'
+
+# checks how many bytes were expected / received by transloadit
+response[:bytes_expected] # => 92933
+response[:bytes_received] # => 92933
+
+# checks if all processing has been completed
+response.completed? # => false
+
+# cancels further processing on the assembly
+response.cancel! # => true
+```
 
 It's important to note that none of these queries are "live" (with the
 exception of the `cancel!` method). They all check the response given by the
 API at the time the assembly was created. You have to explicitly ask the
 assembly to reload its results from the API.
 
-    # reloads the response's contents from the REST API
-    response.reload!
+```ruby
+# reloads the response's contents from the REST API
+response.reload!
+```
 
 In general, you use hash accessor syntax to query any direct attribute from
 the [response](http://transloadit.com/docs/assemblies#response-format).
@@ -93,30 +107,34 @@ Transloadit HTTP API.
 Multiple files can be given to the `submit!` method in order to upload more
 than one file in the same request. You can also pass a single step for the
 `steps` parameter, without having to wrap it in an Array.
-    
-    assembly = transloadit.assembly(steps: store)
-    
-    response = assembly.submit!(
-      open('puppies.jpg'),
-      open('kittens.jpg'),
-      open('ferrets.jpg')
-    )
+
+```ruby
+assembly = transloadit.assembly(steps: store)
+
+response = assembly.submit!(
+  open('puppies.jpg'),
+  open('kittens.jpg'),
+  open('ferrets.jpg')
+)
+```
 
 ### 3. Parallel Assembly
 
 Transloadit allows you to perform several processing steps in parallel. You
-simply need to `use` other steps. Following 
+simply need to `use` other steps. Following
 [their example](http://transloadit.com/docs/assemblies#special-parameters):
 
-    encode = transloadit.step 'encode', '/video/encode', { ... }
-    thumbs = transloadit.step 'thumbs', '/video/thumbs', { ... }
-    export = transloadit.step 'store',  '/s3/store',     { ... }
-    
-    export.use [ encode, thumbs ]
-    
-    transloadit.assembly(
-      :steps => [ encode, thumbs, export ]
-    ).submit! open('ninja-cat.mpg')
+```ruby
+encode = transloadit.step 'encode', '/video/encode', { ... }
+thumbs = transloadit.step 'thumbs', '/video/thumbs', { ... }
+export = transloadit.step 'store',  '/s3/store',     { ... }
+
+export.use [ encode, thumbs ]
+
+transloadit.assembly(
+  :steps => [ encode, thumbs, export ]
+).submit! open('ninja-cat.mpg')
+```
 
 You can also tell a step to use the original uploaded file by passing the
 Symbol `:original` instead of another step.
@@ -124,6 +142,32 @@ Symbol `:original` instead of another step.
 Check the YARD documentation for more information on using
 [use](http://rubydoc.info/gems/transloadit/frames/Transloadit/Step#use-instance_method).
 
+### 4. Using a Template
+
+Transloadit allows you to use custom [templates](http://transloadit.com/docs/templates)
+for recurring encoding tasks. In order to use these do the following:
+
+```ruby
+transloadit.assembly(
+  :template_id => 'YOUR_TEMPLATE_ID'
+).submit! open('ninja-cat.mpg')
+```
+
+You can use your steps together with this template and even use variables.
+The [Transloadit documentation](http://transloadit.com/docs/templates#passing-variables-into-a-template) has some nice
+examples for that.
+
+### 5. Using fields
+
+Transloadit allows you to submit form field values that you'll get back in the
+notification. This is quite handy if you want to add additional custom meta data
+to the upload itself. You can use fields like the following:
+
+```ruby
+transloadit.assembly(
+  :fields => {:tag => 'ninjacats'}
+).submit! open('ninja-cat.mpg')
+```
 ## Documentation
 
 Up-to-date YARD documentation is automatically generated. You can view the

data/lib/transloadit/assembly.rb

@@ -52,6 +52,7 @@ class Transloadit::Assembly
   def submit!(*ios)
     params  = _extract_options!(ios)
     payload = { :params => self.to_hash.update(params) }
+    payload.merge!(self.options[:fields]) if self.options[:fields]
     
     # update the payload with file entries
     ios.each_with_index {|f, i| payload.update :"file_#{i}" => f }
@@ -81,7 +82,7 @@ class Transloadit::Assembly
     self.options.merge(
       :auth  => self.transloadit.to_hash,
       :steps => self.steps
-    ).delete_if {|k,v| v.nil? }
+    ).delete_if {|k,v| v.nil? || k == :fields}
   end
   
   #

data/lib/transloadit/request.rb

@@ -190,7 +190,7 @@ class Transloadit::Request
   # Computes the HMAC digest of the params hash, if a secret was given to the
   # instance.
   #
-  # @param  [Hash] params the payload to sign
+  # @param  [String] params the JSON encoded payload to sign
   # @return [String] the HMAC signature for the params
   #
   def signature(params)

data/lib/transloadit/version.rb

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

data/test/unit/transloadit/test_assembly.rb

@@ -68,6 +68,47 @@ describe Transloadit::Assembly do
         response.headers[:location].must_match %r{^http://foo.bar/}
       end
     end
+
+    describe 'with additional parameters' do
+      include WebMock::API
+
+      before do
+        stub_request(:post, 'jane.transloadit.com/assemblies')
+      end
+
+      after do
+        WebMock.reset!
+      end
+
+      it 'must allow to send a template id along' do
+        VCR.use_cassette 'fetch_bored' do
+          Transloadit::Assembly.new(
+            @transloadit,
+            :template_id => 'TEMPLATE_ID'
+          ).submit!
+
+          assert_requested(:post, 'jane.transloadit.com/assemblies') do |req|
+            values = values_from_post_body(req.body)
+            JSON.parse(values['params'])['template_id'].must_equal 'TEMPLATE_ID'
+          end
+        end
+      end
+
+      it 'must allow to send the fields hash' do
+        VCR.use_cassette 'fetch_bored' do
+          Transloadit::Assembly.new(
+            @transloadit,
+            :fields => {:tag => 'ninja-cat'}
+          ).submit!
+
+          assert_requested(:post, 'jane.transloadit.com/assemblies') do |req|
+            values = values_from_post_body(req.body)
+            values['tag'].must_equal 'ninja-cat'
+            JSON.parse(values['params'])['fields'].must_be_nil
+          end
+        end
+      end
+    end
   end
   
   describe 'with multiple steps' do
@@ -85,3 +126,7 @@ describe Transloadit::Assembly do
     end
   end
 end
+
+def values_from_post_body(body)
+  Addressable::URI.parse('?' + URI.decode(body)).query_values
+end

data/transloadit.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |gem|
   gem.version  = Transloadit::VERSION
   gem.platform = Gem::Platform::RUBY
   
-  gem.authors  = %w{ Stephen Touset }
-  gem.email    = %w{ stephen@touset.org }
+  gem.authors  = [ "Stephen Touset", "Robin Mehner" ]
+  gem.email    = %w{ stephen@touset.org robin@coding-robin.de }
   gem.homepage = 'http://github.com/transloadit/ruby-sdk/'
   
   gem.summary     = 'Official Ruby gem for Transloadit'

metadata

@@ -1,129 +1,127 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: transloadit
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  version: 1.0.0
 platform: ruby
-authors: 
-- Stephen
-- Touset
+authors:
+- Stephen Touset
+- Robin Mehner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-09 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70165484171720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484171720
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70165484170960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484170960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70165484169980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484169980
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70165484169000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484169000
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70165484167640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484167640
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70165484166920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484166920
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70165484166120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484166120
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70165484165280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *70165484165280
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70165484163840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-description: The transloadit gem allows you to automate uploading files through the Transloadit REST API
-email: 
+  prerelease: false
+  version_requirements: *70165484163840
+description: The transloadit gem allows you to automate uploading files through the
+  Transloadit REST API
+email:
 - stephen@touset.org
+- robin@coding-robin.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -146,35 +144,31 @@ files:
 - test/unit/transloadit/test_response.rb
 - test/unit/transloadit/test_step.rb
 - transloadit.gemspec
-has_rdoc: true
 homepage: http://github.com/transloadit/ruby-sdk/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: transloadit
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Official Ruby gem for Transloadit
-test_files: 
+test_files:
 - test/fixtures/cassettes/cancel_assembly.yml
 - test/fixtures/cassettes/fetch_assembly.yml
 - test/fixtures/cassettes/fetch_bored.yml