plupload-rails3 0.0.4

data/.gitignore

@@ -0,0 +1 @@
+*.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in plupload-rails3.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,38 @@
+Copyright (c) 2011 Sammy Larbi MIT License for plupload-rails3:
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-------------------
+
+Plupload and components Licenses:
+
+Plupload uses GPLv2, and its Silverlight components use:
+
+FJCore (MIT License) (http://code.google.com/p/fjcore/) that includes 
+The Independent JPEG Group's JPEG software (IJG.txt) and 
+Java Advanced Imaging IO by Sun Microsystems (JAI.txt)
+
+PngEncoder (http://www.gnu.org/licenses/lgpl-2.1.txt)
+
+ZipLib (http://www.icsharpcode.net/OpenSource/SharpZipLib/)
+
+-------------------
+
+JQuery lets you choose between MIT and GPL licenses.

data/README.md

@@ -0,0 +1,100 @@
+plupload-rails3
+==============
+
+[Plupload](http://www.plupload.com/) lets you upload multiple files at a time and even allows drag and drop from the local file system into the browser (with Firefox and Safari).
+
+This plugin tries to make its integration with Rails 3 very simple.
+
+To install as a plugin (from inside your project's directory):
+
+    rails plugin install git://github.com/codeodor/plupload-rails3.git
+
+To remove the plugin:
+
+    rails plugin uninstall plupload-rails3
+
+
+To install as a gem:
+
+1. Put `gem 'plupload-rails3'` in your application's Gemfile
+2. Run `bundle install` from the command line inside your application's directory
+3. Run `bundle exec rake plupload_rails3:install_assets` from the command line inside your application's directory
+
+To remove the gem from your project, remove the line in your Gemfile. You can remove the assets that got copied to your application by running `bundle exec rake plupload_rails3:uninstall_assets` from the command line inside your application's directory.
+
+For Rails 3.1, you'll also need to tell the asset pipeline about the new assets. 
+
+In assets/javascripts/application.js make sure your application provides URL access to the plupload scripts, CSS, and images:
+
+    //= provide_tree ../../../vendor/assets/javascripts/plupload-rails3
+    //= provide_tree ../../../vendor/assets/stylesheets/plupload-rails3
+    //= provide_tree ../../../vendor/assets/images/plupload-rails3
+
+
+    
+
+
+To use:
+
+    <%= plupload(model, method, options={:plupload_container=>'uploader'}) %>
+    <div id="uploader" name="uploader" style="width: 100%;"></div>
+   
+
+If you are using a nested resource, model can be an array like you'd use for url_for. For example: `model = [@folder, @file]` where `@file` is the model you're interested in uploading, but it is nested under `@folder`.
+
+
+Options can be:
+
+* :params => A hash of params you want submitted with each uploaded file.
+* :plupload_container => The name of the div or whatever where plupload is going to render itself. Defaults to 'uploader'
+* :max_file_size => An integer indicating the number of megabytes to allow. Defaults to 10.
+* :filters => An array of hashes with :title and :extension keys specifying the files to look for. Defaults to [], which will show all files. 
+* :pluploader => a value of `true` indicates that you want to have the files submitted with your form instead of in individual requests. To make this work, you need to add `match 'plupload_rails/_plupload_uploader', :controller=>'plupload_rails', :action=>'_plupload_uploader', :as=>'pluploader'` to your config/routes.rb file so plupload can upload the files, and then this plugin will insert some extra form fields into your page via JavaScript. Those fields tell the middleware how to form the request parameters before they get to your controller.
+* :field_name => the name of the field, which defaults to model_name[method_name]
+
+Example filter: 
+    
+    :filters=>[{:title=>'Images', :extensions=>'jpg,gif,png'},{:title=>'PDF', :extensions=>'pdf'}])
+
+
+Note: Most of the plupload code in lib/app/views/plupload/_uploader_scripts.html.erb is from http://www.theroamingcoder.com/node/50, where I learned how to use Plupload with Rails.
+
+
+Example 1: Uploading the files hitting the action once for each file
+====================================================================
+
+In your view:
+
+    <%= plupload(@library_file, :payload, {:params=>{:library_file=>{:title=>"some title"}}}) %>
+
+Also in the view, you'll need to tell it where to go:
+
+    <div id="uploader" name="uploader" style="width: 100%;"></div>
+
+@library_file should be your model, where :payload is the method which holds the file contents, so that when plupload uploads the files (it hits #create once for each file) it will put the uploaded file in params[:library_file][:payload] which you can then read like this in your controller:
+
+    params[:library_file][:payload] = params[:library_file][:payload].read
+
+Then if you're storing it in the DB, you let it continue on to 
+
+    @library_file = LibraryFile.new(params[:library_file])
+
+
+Example 2: Uploading the files for a has_many relationship with accepts_nested_attributes_for
+=============================================================================================
+Consider the common case of an Album which has_many Photos. 
+
+In your form for an album, you can use:
+
+    <%= plupload(@album, :photos, options={:plupload_container=>'uploader', :pluploader=>true, :field_name=>'album[photos][][payload]'}) %>
+  <div id="uploader" name="uploader" style="width: 100%;"></div>
+
+
+What this does is tells the plugin to use the pluploader (which needs a route: `match 'plupload_rails/_plupload_uploader', :controller=>'plupload_rails', :action=>'_plupload_uploader', :as=>'pluploader'`) and tells it what to name the field - in this case the Album `has_many` Photos, and the method we want on photo is called `payload`.
+
+
+
+
+
+Copyright (c) 2011 [Sammy Larbi](http://www.codeodor.com), released under the MIT license 
+(with Plupload and it's components using other licenses -- see LICENSE file)

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the plupload_rails3 plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the plupload_rails3 plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PluploadRails3'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,3 @@
+require 'plupload-rails3'
+
+config.middleware.use(ActionDispatch::PluploadParamsRenamer)

data/install.rb

@@ -0,0 +1,9 @@
+asset_mover_file = File.join(File.dirname(__FILE__), 'lib/plupload-rails3/asset_mover')
+
+if File.exists?(asset_mover_file) 
+  require asset_mover_file
+else #to install locally, I have to use rails runner instead of rails plugin install, and it gives a messed up path
+  require File.join(Rails.root, File.dirname(__FILE__), 'lib/plupload-rails3/asset_mover')
+end
+
+install_plupload_assets

data/lib/app/controllers/plupload_rails_controller.rb

@@ -0,0 +1,38 @@
+class PluploadRailsController < ActionController::Base
+  def _plupload_uploader
+    plupload_temp_path = "tmp/plupload-rails3/#{File.basename(params[:file].tempfile.path)}"
+    FileUtils.mv(params[:file].tempfile, plupload_temp_path)
+    add_fields_for_files_to_forms =<<END
+      function _pluploadRails_addFieldsForFilesToForms(){
+        for(var i=0; document.forms.length; i++) {
+          var theForm = document.forms[i];
+          var input = document.createElement("input");
+          input.name='_plupload_files[]';
+          input.type='hidden';
+          input.value='#{File.expand_path(params[:file].tempfile.path)}';
+          theForm.appendChild(input);
+          
+          var input = document.createElement("input");
+          input.name='_plupload_original_names[]';
+          input.type='hidden';
+          input.value='#{params[:file].original_filename}';
+          theForm.appendChild(input);
+          
+          var input = document.createElement("input");
+          input.name='_plupload_content_types[]';
+          input.type='hidden';
+          input.value='#{params[:file].content_type}';
+          theForm.appendChild(input);
+          
+          var input = document.createElement("input");
+          input.name='_plupload_upload';
+          input.type='hidden';
+          input.value='#{params[:_plupload_upload]}';
+          if(document.getElementsByName(input.name).length == 0) theForm.appendChild(input);
+        }
+      }
+      _pluploadRails_addFieldsForFilesToForms();
+END
+    render :text=>add_fields_for_files_to_forms
+  end
+end

data/lib/app/helpers/plupload_helper.rb

@@ -0,0 +1,14 @@
+module PluploadHelper
+  def plupload(model_object, model_object_method, options={})
+    options[:plupload_container] ||= 'uploader'
+    options[:max_file_size] ||= 10
+    options[:filters] ||= []
+    options[:params] ||= {}
+    options[:field_name] ||= [model_object].flatten.pop.class.name.underscore.downcase + "[#{model_object_method}]"
+    render :partial=>'plupload/uploader_scripts', :locals=>{
+        :model_object=>model_object, 
+        :model_object_method=>model_object_method, 
+        :options=>options
+      }
+  end  
+end

data/lib/app/middleware/plupload_params_renamer.rb

@@ -0,0 +1,38 @@
+require 'action_dispatch/http/request'
+module ActionDispatch
+  class PluploadParamsRenamer
+    def initialize(app)
+      @app = app
+    end
+   
+    def call(env)
+      req = Rack::Request.new(env)
+      form_hash = Rails.version < "3.1" ? req.POST : env['rack.request.form_hash']
+      form_hash ||= {}
+      
+      if form_hash["_plupload_upload"]
+        object, method = form_hash["_plupload_upload"].split(/[\[\]]/)
+        submethod =  form_hash["_plupload_upload"].split(/[\[\]]/)[-1]
+        form_hash[object] ||= {} 
+        if form_hash["_plupload_files"]
+          form_hash[object][method] = []
+          form_hash["_plupload_files"].each_with_index do |file, i|
+            plupload_temp_path = "tmp/plupload-rails3/#{File.basename(file)}"
+            FileUtils.mv(plupload_temp_path, file)
+
+            original_filename = form_hash["_plupload_original_names"][i]
+            content_type = form_hash["_plupload_content_types"][i]
+
+            uploaded_file = ActionDispatch::Http::UploadedFile.new(:tempfile=>File.new(file), :content_type=>content_type, :filename=>original_filename)
+
+            form_hash[object][method] << {submethod=>uploaded_file}
+          end
+        else
+          form_hash[object][method] = form_hash["file"] 
+        end
+      end 
+
+      @app.call(env)
+    end
+  end
+end

data/lib/app/views/plupload/_uploader_scripts.html.erb

@@ -0,0 +1,72 @@
+<% if Rails.version < "3.1" %>
+<!-- load JQuery if not loaded -->
+<script type="text/javascript" src="http://www.google.com/jsapi"></script>
+<script type="text/javascript">
+  if(typeof jQuery === 'undefined') google.load("jquery", "1.3");
+</script>
+
+<!-- Load Queue widget CSS and jQuery -->
+<style type="text/css">@import url(/stylesheets/plupload-rails3/plupload.queue.css);</style>
+
+<!-- Load plupload and all it's runtimes and finally the jQuery queue widget -->
+<script type="text/javascript" src="/javascripts/plupload-rails3/plupload/js/plupload.full.js"></script>
+<script type="text/javascript" src="/javascripts/plupload-rails3/plupload/js/jquery.plupload.queue/jquery.plupload.queue.js"></script>
+
+<!-- Thirdparty intialization scripts, needed for the Google Gears and BrowserPlus runtimes -->
+<script type="text/javascript" src="http://bp.yahooapis.com/2.4.21/browserplus-min.js"></script>
+<script type="text/javascript" src="/javascripts/plupload-rails3/plupload/js/plupload.gears.js"></script>
+<% else %>
+  
+  <style type="text/css">@import url(/assets/plupload-rails3/plupload.queue.3.1.css);</style>
+  <%= stylesheet_link_tag 'plupload-rails3/plupload/js/plupload.full.js' %>
+  <%= javascript_include_tag 'plupload-rails3/plupload/js/plupload.full.js' %>
+  <%= javascript_include_tag 'plupload-rails3/plupload/js/jquery.plupload.queue/jquery.plupload.queue.js' %>
+  <%= javascript_include_tag 'plupload-rails3/plupload/js/plupload.gears.js' %>
+  
+<% end %>
+
+
+<script type="text/javascript">
+  	
+  // Convert divs to queue widgets when the DOM is ready
+  $(function() {   
+    var authtoken = $("input[name=authenticity_token]").val();
+    $("#<%= options[:plupload_container] %>").pluploadQueue({
+      // General settings
+      runtimes : 'html5,flash,silverlight,gears,browserplus',
+      <% unless options[:pluploader] %>
+        url : '<%= url_for(model_object) %>',
+      <% else %>
+        url : '<%= pluploader_path %>',
+      <% end %>
+      max_file_size : '<%= options[:max_file_size] %>mb',
+      //chunk_size : '1mb',
+      //unique_names : true,
+      multipart: true,
+      multipart_params : 
+      $.extend({
+          <% if options[:params].count > 0 %>'<%= CGI::unescape(options[:params].to_query.split("=").join("':'")) %>'<% end %>
+        }, 
+        {
+          authenticity_token : authtoken, 
+          "_method" : "<%= [model_object].flatten.pop.new_record? ? 'post' : 'put' %>", 
+          "_plupload_upload" : "<%= options[:field_name] %>"
+        }
+      ),
+      <% if options[:filters].count > 0 %>
+        filters : <%= options[:filters].to_json.to_s.html_safe %>,
+      <% end %>
+      flash_swf_url : '/javascripts/plupload-rails3/plupload/js/plupload.flash.swf',
+      silverlight_xap_url : '/javascripts/plupload-rails3/plupload/js/plupload.silverlight.xap'
+      <% if options[:pluploader] %>
+      , 
+      init: {
+        FileUploaded: function(up, file, info) {
+          eval(info.response);
+        }
+      }
+      <% end %>
+    });
+
+  });
+</script>

data/lib/plupload-rails3.rb

@@ -0,0 +1,20 @@
+require "plupload-rails3/version"
+require "plupload-rails3/railtie"
+
+require 'app/helpers/plupload_helper'
+require 'app/middleware/plupload_params_renamer'
+require 'app/controllers/plupload_rails_controller'
+
+%w{ middleware helpers controllers }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+end
+
+ActionController::Base.append_view_path File.expand_path(File.join(File.dirname(__FILE__), 'app', 'views'))
+
+#ActionView::Base.send :include, PluploadHelper
+ActionController::Base.helper(PluploadHelper)
+
+#ActionController::Dispatcher.middleware.insert_before(ActionDispatch::ParamsParser, ActionDispatch::PluploadParamsRenamer)

data/lib/plupload-rails3/asset_mover.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+
+def plupload_asset_destination
+  if Rails.version < "3.1"
+    dest = {  
+      :img => "public/images",
+      :js => "public/javascripts",
+      :css => "public/stylesheets"
+    } 
+  else
+    dest = {  
+      :img => "vendor/assets/images",
+      :js => "vendor/assets/javascripts",
+      :css => "vendor/assets/stylesheets"
+    }
+  end
+  return dest
+end  
+
+def install_plupload_assets  
+  plupload_asset_destination.keys.each do |asset_type|
+    directory = File.join(Rails.root, plupload_asset_destination[asset_type])
+    puts "Making directory: #{directory}/plupload-rails3"
+    FileUtils.mkdir_p(directory)
+  end
+  
+  dest = File.join(Rails.root, plupload_asset_destination[:img])
+  puts "Copying image assets to #{dest}/plupload-rails3"
+  FileUtils.cp_r(File.join(File.dirname(__FILE__), '../public/images/plupload-rails3'), dest)
+  
+  dest = File.join(Rails.root, plupload_asset_destination[:js])
+  puts "Copying javascript assets to #{dest}"
+  FileUtils.cp_r(File.join(File.dirname(__FILE__), '../public/javascripts/plupload-rails3'), dest)
+  
+  dest = File.join(Rails.root, plupload_asset_destination[:css])
+  puts "Copying stylesheet assets to #{dest}"
+  FileUtils.cp_r(File.join(File.dirname(__FILE__), '../public/stylesheets/plupload-rails3'), dest)
+  
+  dest = File.join(Rails.root, 'tmp/plupload-rails3')
+  puts "Creating tmp folder at #{dest}"
+  FileUtils.mkdir(dest)
+end
+
+def uninstall_plupload_assets
+  plupload_asset_destination.keys.each do |asset_type|
+    directory = File.join(Rails.root, plupload_asset_destination[asset_type], "plupload-rails3")
+    puts "Removing directory #{directory} and its contents"
+    FileUtils.rm_r(directory)
+  end
+  
+  directory = File.join(Rails.root,'tmp/plupload-rails3')
+  puts "Removing directory #{directory} and its contents"
+  FileUtils.rm_r(directory)
+end

data/lib/plupload-rails3/railtie.rb

@@ -0,0 +1,12 @@
+module PluploadRails3
+  class Railtie < Rails::Railtie
+    initializer "plupload-rails3.configure_middleware" do |app|
+      app.middleware.use ActionDispatch::PluploadParamsRenamer
+    end
+    
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+      
+  end
+end