transloadit-rails 0.9.2 → 1.0.0

data/README.md

@@ -9,19 +9,25 @@ you to automate uploading files through the Transloadit REST API.
 
 ## Install
 
-    gem install transloadit-rails
+```bash
+$ gem install transloadit-rails
+```
 
 ## Getting started
 
 To get started, you need to add the 'transloadit-rails' gem to your Rails
 project's Gemfile.
 
-    gem 'transloadit-rails'
+```bash
+$ echo "gem 'transloadit-rails'" >> Gemfile
+```
 
 Now update your bundle and run the generator.
 
-    $ bundle install
-    $ rails g transloadit:install
+```bash
+$ bundle install
+$ rails g transloadit:install
+```
 
 ## Configuration
 
@@ -29,21 +35,23 @@ Edit `config/transloadit.yml`. It has an `auth` section for your transloadit
 credentials and a `templates` section to define or refer to existing
 templates.
 
-    auth:
-      key   : '4d2e...'
-      secret: '8ad1...' # optional, but highly recommended
-    
-    templates:
-        # template identified by template_id
-        s3_store: '4d2e...'
-        
-        # template defined inline
-        image_resize:
-          steps:
-            resize:
-              robot : '/image/resize'
-              width : 320
-              height: 200
+```yaml
+auth:
+  key   : '4d2e...'
+  secret: '8ad1...' # optional, but highly recommended
+
+templates:
+  # template identified by template_id
+  s3_store: '4d2e...'
+  
+  # template defined inline
+  image_resize:
+    steps:
+      resize:
+        robot : '/image/resize'
+        width : 320
+        height: 200
+```
 
 ## Usage
 
@@ -51,14 +59,27 @@ Refer to the templates with the `transloadify` helper. This requires jQuery,
 and loads the [Transloadit jQuery plugin](https://github.com/transloadit/jquery-sdk).
 It also uses JavaScript to ensure your form is encoded as `multipart/form-data`.
 
-    <%= form_for :upload, :html => { :id => 'upload' } do |form| %>
-      <%= form.transloadit :s3_store %>
-      <%= form.label      :file, 'File to upload' %>
-      <%= form.file_field :file %>
-      <%= form.submit %>
-    <% end %>
-    
-    <%= transloadit_jquerify :upload %>
+```erb
+<%= form_for :upload, :html => { :id => 'upload' } do |form| %>
+  <%= transloadit :s3_store %>
+  <%= form.label      :file, 'File to upload' %>
+  <%= form.file_field :file %>
+  <%= form.submit %>
+<% end %>
+
+<%= transloadit_jquerify :upload %>
+```
+
+If you want to use the automatic transload parameter decoding, you have to include
+the Transloadit::Rails::ParamsDecoder module into your controller
+
+```ruby
+class YourController
+  include Transloadit::Rails::ParamsDecoder
+end
+```
+
+that way the param[:transloadit] is automatically decoded for you, if it exists
 
 ## Tutorial
 
@@ -67,77 +88,95 @@ setup rails project.
 
 If you haven't already done so, go ahead and install Rails.
 
-    $ gem install rails
+```bash
+$ gem install rails
+```
 
 With rails installed, let's create a new app called 'my_app'.
 
-    $ rails new my_app
-    $ cd my_app
+```bash
+$ rails new my_app
+$ cd my_app
+```
 
 In order to use transloadit in this app, we need to add the gem to our Gemfile
 and bundle things up.
 
-    $ echo "gem 'transloadit-rails'" >> Gemfile
-    $ bundle install
+```bash
+$ echo "gem 'transloadit-rails'" >> Gemfile
+$ bundle install
+```
 
 With that in place, it's time to generate our transloadit configuration, as
 well as a basic UploadsController and a dummy Upload model.
 
-    $ rails g transloadit:install
-    $ rails g controller uploads new create
-    $ rails g model upload
-    $ rails db:migrate
+```bash
+$ rails g transloadit:install
+$ rails g controller uploads new create
+$ rails g model upload
+$ rake  db:migrate
+```
 
 The controller generator we just executed has probably put two GET routes into
 your `config/routes.rb`. We don't want those, so lets go ahead an overwrite
 them with this.
 
-    MyApp::Application.routes.draw do
-      resources :uploads
-    end
+```ruby
+MyApp::Application.routes.draw do
+  resources :uploads
+end
+```
 
 Next we need to configure our `config/transloadit.yml` file. For this tutorial,
 just put in your credentials, and define an image resize step as indicated
 below:
 
-    auth:
-      key   : '4d2e...'
-      secret: '8ad1...'
-
-    templates:
-        image_resize:
-          steps:
-            resize:
-              robot : '/image/resize'
-              format: 'jpg'
-              width : 320
-              height: 200
+```yaml
+auth:
+  key   : '4d2e...'
+  secret: '8ad1...'
+
+templates:
+  image_resize:
+    steps:
+      resize:
+        robot : '/image/resize'
+        format: 'jpg'
+        width : 320
+        height: 200
+```
 
 Alright, time to create our upload form. In order to do that, please open
 `app/views/uploads/new.html.erb`, and put the following code in:
 
-    <%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js' %>
+```erb
+<%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js' %>
 
-    <h1>Upload an image</h1>
-    <%= form_for Upload.new, :html => { :id => 'upload' } do |form| %>
-      <%= form.transloadit :image_resize %>
-      <%= form.label      :file, 'File to upload' %>
-      <%= form.file_field :file %>
-      <%= form.submit %>
-    <% end %>
+<h1>Upload an image</h1>
+<%= form_for Upload.new, :html => { :id => 'upload' } do |form| %>
+  <%= transloadit :image_resize %>
+  <%= form.label      :file, 'File to upload' %>
+  <%= form.file_field :file %>
+  <%= form.submit %>
+<% end %>
 
-    <%= transloadit_jquerify :upload, :wait => true %>
+<%= transloadit_jquerify :upload, :wait => true %>
+```
 
 With this in place, we can modify the `app/views/uploads/create.html.erb` view
 to render the uploaded and resized image:
 
-    <h1>Resized upload image</h1>
-    <%= image_tag params['transloadit']['results']['resize'].first['url'] %>
+```erb
+<h1>Resized upload image</h1>
+<%= image_tag params[:transloadit][:results][:resize].first[:url] %>
+```
 
 That's it. If you've followed the steps closely, you should now be able to
 try your first upload. Don't forget do start your rails server first:
 
-    $ rails server
+```bash
+$ rails server
+```
 
 Then go to http://localhost:3000/uploads/new, and upload an image. If you did
 everything right, you should see the uploaded and resized file as soon as the

data/app/helpers/transloadit_helper.rb

@@ -5,12 +5,13 @@ module TransloaditHelper
   #
   def transloadit_jquerify(id, options = {})
     javascript_tag %{
-      $(document).ready(function() {
+      $(function() {
         var script = '//assets.transloadit.com/js/jquery.transloadit2.js';
-        
+
         $.getScript(script, function() {
-          $('##{id}').attr('enctype', 'multipart/form-data');
-          $('##{id}').transloadit(#{options.to_json});
+          $('##{id}')
+            .attr('enctype', 'multipart/form-data')
+            .transloadit(#{options.to_json});
         });
       });
     }

data/lib/transloadit/generators.rb

@@ -1,4 +1,4 @@
-require 'transloadit/rails'
+require 'transloadit/rails/engine'
 
 module Transloadit::Generators
   autoload :InstallGenerator, 'generators/transloadit/install_generator'

data/lib/transloadit/rails/engine.rb

@@ -0,0 +1,70 @@
+require 'transloadit/rails'
+require 'transloadit/generators'
+require 'rails'
+
+class Transloadit
+  module Rails
+    class Engine < ::Rails::Engine
+      CONFIG_PATH = 'config/transloadit.yml'
+    
+      autoload :ParamsDecoder, 'transloadit/rails/params_decoder'
+      autoload :ViewHelper,    'transloadit/rails/view_helper'
+
+      initializer 'transloadit-rails.action_controller' do |app|
+        ActiveSupport.on_load :action_controller do
+          helper TransloaditHelper
+        end
+      end
+
+      initializer 'transloadit-rails.action_view' do |app|
+        ActiveSupport.on_load :action_view do
+          include Transloadit::Rails::ViewHelper
+        end
+      end
+
+      initializer 'transloadit.configure' do |app|
+        self.class.application = app
+      end
+
+      def self.configuration
+        YAML.load_file self.application.root.join(CONFIG_PATH)
+      end
+
+      class << self
+        attr_accessor :application
+
+        extend ActiveSupport::Memoizable
+        memoize :configuration unless ::Rails.env.development?
+      end
+
+      #
+      # Returns the Transloadit authentication object.
+      #
+      def self.transloadit
+        Transloadit.new(
+          :key    => self.configuration['auth']['key'],
+          :secret => self.configuration['auth']['secret']
+        )
+      end
+
+      #
+      # Creates an assembly for the named template.
+      #
+      def self.template(name, options = {})
+        template = self.configuration['templates'].try(:fetch, name.to_s)
+
+        self.transloadit.assembly case template
+          when String then { :template_id => template }.merge(options)
+          when Hash   then template                    .merge(options)
+        end
+      end
+
+      #
+      # Signs a request to the Transloadit API.
+      #
+      def self.sign(params)
+        Transloadit::Request.send :_hmac, self.transloadit.secret, params
+      end
+    end
+  end
+end

data/lib/transloadit/rails/{controller_extensions.rb → params_decoder.rb}

@@ -1,15 +1,15 @@
 require 'transloadit/rails'
 
-module Transloadit::Rails::ControllerExtensions
+module Transloadit::Rails::ParamsDecoder
   extend ActiveSupport::Concern
-  
+
   included do
     before_filter :decode_transloadit_json
   end
-    
+
   def decode_transloadit_json
     return unless params[:transloadit].present?
-    
+
     # wrap transloadit params in a HashWithIndifferentAccess
     params[:transloadit] = ActiveSupport::HashWithIndifferentAccess.new(
       ActiveSupport::JSON.decode params[:transloadit]

data/lib/transloadit/rails/version.rb

@@ -1,5 +1,5 @@
 class Transloadit
-  class Rails
-    VERSION = '0.9.2'
+  module Rails
+    VERSION = '1.0.0'
   end
 end

data/lib/transloadit/rails/view_helper.rb

@@ -0,0 +1,15 @@
+require 'transloadit/rails/engine'
+
+module Transloadit::Rails::ViewHelper
+  #
+  # Inserts hidden fields specifying and signing the template for Transloadit
+  # to process.
+  #
+  def transloadit(template, options = {})
+    params    = Transloadit::Rails::Engine.template(template, options).to_json
+    signature = Transloadit::Rails::Engine.sign(params)
+
+    hidden_field_tag(:params,    params,    :id => nil) +
+    hidden_field_tag(:signature, signature, :id => nil)
+  end
+end

data/lib/transloadit/rails.rb

@@ -1,66 +1,3 @@
 require 'transloadit'
-require 'transloadit/generators'
-require 'rails'
-
-class Transloadit::Rails < Rails::Engine
-  CONFIG_PATH = 'config/transloadit.yml'
-  
-  autoload :ControllerExtensions, 'transloadit/rails/controller_extensions'
-  autoload :FormHelper,           'transloadit/rails/form_helper'
-  
-  config.to_prepare do
-    # add the two helpers to the view stack
-    class ActionController::Base
-      include Transloadit::Rails::ControllerExtensions
-      helper TransloaditHelper
-    end
-    
-    class ActionView::Helpers::FormBuilder
-      include Transloadit::Rails::FormHelper
-    end
-  end
-  
-  initializer 'transloadit.configure' do |app|
-    self.class.application = app
-  end
-  
-  def self.configuration
-    YAML.load_file self.application.root.join(CONFIG_PATH)
-  end
-  
-  class << self
-    attr_accessor :application
-    
-    extend ActiveSupport::Memoizable
-    memoize :configuration unless Rails.env.development?
-  end
-  
-  #
-  # Returns the Transloadit authentication object.
-  #
-  def self.transloadit
-    Transloadit.new(
-      :key    => self.configuration['auth']['key'],
-      :secret => self.configuration['auth']['secret']
-    )
-  end
-  
-  #
-  # Creates an assembly for the named template.
-  #
-  def self.template(name, options = {})
-    template = self.configuration['templates'].try(:fetch, name.to_s)
-    
-    self.transloadit.assembly case template
-      when String then { :template_id => template }.merge(options)
-      when Hash   then template                    .merge(options)
-    end
-  end
-  
-  #
-  # Signs a request to the Transloadit API.
-  #
-  def self.sign(params)
-    Transloadit::Request.send :_hmac, self.transloadit.secret, params
-  end
-end
+require 'transloadit/rails/engine'
+require 'transloadit/rails/version'

data/lib/transloadit-rails.rb

@@ -1 +1 @@
-require 'transloadit/rails'
+require 'transloadit/rails'

data/transloadit-rails.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w{ lib }
   
   gem.add_dependency 'transloadit'
-  gem.add_dependency 'rails', '~> 3'
+  gem.add_dependency 'railties', '~> 3'
   
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest' # needed for < 1.9.2

metadata

@@ -2,7 +2,7 @@
 name: transloadit-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Stephen
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 -04:00
+date: 2011-06-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +26,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rails
+  name: railties
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -111,9 +111,10 @@ files:
 - lib/transloadit-rails.rb
 - lib/transloadit/generators.rb
 - lib/transloadit/rails.rb
-- lib/transloadit/rails/controller_extensions.rb
-- lib/transloadit/rails/form_helper.rb
+- lib/transloadit/rails/engine.rb
+- lib/transloadit/rails/params_decoder.rb
 - lib/transloadit/rails/version.rb
+- lib/transloadit/rails/view_helper.rb
 - test/generators/transloadit/test_install_generator.rb
 - test/test_helper.rb
 - transloadit-rails.gemspec

data/lib/transloadit/rails/form_helper.rb

@@ -1,15 +0,0 @@
-require 'transloadit/rails'
-
-module Transloadit::Rails::FormHelper
-  #
-  # Inserts hidden fields specifying and signing the template for Transloadit
-  # to process.
-  #
-  def transloadit(template, options = {})
-    params    = Transloadit::Rails.template(template, options).to_json
-    signature = Transloadit::Rails.sign(params)
-    
-    @template.hidden_field_tag(:params,    params,    :id => nil) +
-    @template.hidden_field_tag(:signature, signature, :id => nil)
-  end
-end