transloadit-rails 0.9.0 → 0.9.1

data/README.md

@@ -51,9 +51,101 @@ 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 :thing, :html => { :id => 'upload' } do |form| %>
+    <%= form_for :upload, :html => { :id => 'upload' } do |form| %>
       <%= form.transloadit :s3_store %>
-      <%= form.file_field :file, 'File to upload' %>
+      <%= form.label      :file, 'File to upload' %>
+      <%= form.file_field :file %>
+      <%= form.submit %>
     <% end %>
     
     <%= transloadit_jquerify :upload %>
+
+## Tutorial
+
+In this tutorial, you are going to learn how to use transloadit in a freshly
+setup rails project.
+
+If you haven't already done so, go ahead an install rails as well as the
+transloadit gem:
+
+    $ gem install rails
+    $ gem install transloadit
+
+With rails installed, let's create a new app called 'my_app':
+
+    $ 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
+
+With that in place, it's time to generate our transloadit configuration, as
+well as a basic UploadsController:
+
+    $ rails generate transloadit:install
+    $ rails generate controller uploads new create
+
+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
+
+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
+
+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' %>
+
+    <h1>Upload an image</h1>
+    <%= form_for :upload, :html => { :id => 'upload' } do |form| %>
+      <%= form.transloadit :image_resize %>
+      <%= form.label      :file, 'File to upload' %>
+      <%= form.file_field :file %>
+      <%= form.submit %>
+    <% end %>
+
+    <%= transloadit_jquerify :upload, :wait => true %>
+
+Now let's open up our `uploads_controller.rb` in order to modify our `create`
+action to parse the response JSON we get from the jQuery plugin:
+
+    def create
+      @upload = ActiveSupport::JSON.decode(params[:transloadit])
+    end
+
+With this in place, we can modify the `create.html.erb` view to render the
+uploaded and resized image:
+
+    <h1>Resized upload image</h1>
+    <%= image_tag @upload['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
+
+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
+upload finishes.

data/app/helpers/transloadit_helper.rb

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

data/lib/generators/transloadit/install_generator.rb

@@ -4,14 +4,9 @@ require 'rails/generators'
 class Transloadit::Generators::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path('../../../templates/transloadit', __FILE__)
   
-  desc %{Installs the Transloadit jQuery plugin and creates the config file}
+  desc %{Installs an empty Transloadit config file}
   
   def copy_configuration
     template 'transloadit.yml', 'config/transloadit.yml'
   end
-  
-  def copy_jquery_plugin
-    get 'http://assets.transloadit.com/js/jquery.transloadit2.js',
-      'public/javascripts/jquery.transloadit2.js'
-  end
 end

data/lib/transloadit/rails.rb

@@ -3,6 +3,8 @@ require 'transloadit/generators'
 require 'rails'
 
 class Transloadit::Rails < Rails::Engine
+  CONFIG_PATH = 'config/transloadit.yml'
+  
   autoload :FormHelper, 'transloadit/rails/form_helper'
   
   config.to_prepare do
@@ -15,14 +17,18 @@ class Transloadit::Rails < Rails::Engine
   end
   
   initializer 'transloadit.configure' do |app|
-    # preload the contents of the configuration file.
-    app.root.join('config/transloadit.yml').open do |file|
-      self.class.config = YAML.load(file)
-    end rescue nil
+    self.class.application = app
+  end
+  
+  def self.configuration
+    YAML.load_file self.application.root.join(CONFIG_PATH)
   end
   
   class << self
-    attr_accessor :config
+    attr_accessor :application
+    
+    extend ActiveSupport::Memoizable
+    memoize :configuration unless Rails.env.development?
   end
   
   #
@@ -30,8 +36,8 @@ class Transloadit::Rails < Rails::Engine
   #
   def self.transloadit
     Transloadit.new(
-      :key    => self.config['auth']['key'],
-      :secret => self.config['auth']['secret']
+      :key    => self.configuration['auth']['key'],
+      :secret => self.configuration['auth']['secret']
     )
   end
   
@@ -39,7 +45,7 @@ class Transloadit::Rails < Rails::Engine
   # Creates an assembly for the named template.
   #
   def self.template(name, options = {})
-    template = self.config['templates'][name.to_s]
+    template = self.configuration['templates'].try(:fetch, name.to_s)
     
     self.transloadit.assembly case template
       when String then { :template_id => template }.merge(options)

data/lib/transloadit/rails/version.rb

@@ -1,5 +1,5 @@
 require 'transloadit/rails'
 
 class Transloadit::Rails
-  VERSION = '0.9.0'
-end
+  VERSION = '0.9.1'
+end

data/test/generators/transloadit/test_install_generator.rb

@@ -8,12 +8,6 @@ class InstallGeneratorTest < Rails::Generators::TestCase
     prepare_destination
   end
   
-  test 'the jQuery plugin is installed' do
-    run_generator
-    
-    assert_file 'public/javascripts/jquery.transloadit2.js'
-  end
-  
   test 'the Transloadit config file is installed' do
     run_generator
     

metadata

@@ -2,7 +2,7 @@
 name: transloadit-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - Stephen
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 Z
+date: 2011-04-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: transloadit