uploader 0.1.3 → 0.1.7

data/README.rdoc

@@ -17,28 +17,41 @@ sudo gem install uploader
 config.gem 'uploader'
 
 
+=== Install jQuery
+uploader uses jQuery.  You'll need to include it in your application.  Download it here:
+http://jquery.com/
+
+Then include it in your layout:
+  <%= javascript_include_tag 'jquery/jquery.js' %>
+            
+Another option is to use jRails
+http://ennerchi.com/projects/jrails
+
 === Create a model for uploads.
 We recommend creating a model called upload.rb.  acts_as_uploader accepts all valid options for paperclip via :has_attached_file => {}
 
   class Upload < ActiveRecord::Base
-    acts_as_uploader  :enable_s3 => false,
-                      :has_attached_file => {
-                        :url     => "/system/:attachment/:id_partition/:style/:basename.:extension",
-                        :path    => ":rails_root/public/system/:attachment/:id_partition/:style/:basename.:extension",
-                        :styles  => { :icon => "30x30!", 
-                                      :thumb => "100>", 
-                                      :small => "150>", 
-                                      :medium => "300>", 
-                                      :large => "660>"},
-                        :default_url => "/images/profile_default.jpg",
-                        :storage => :s3,
-                        :s3_credentials => File.join(RAILS_ROOT, 'config', 's3.yml'),
-                        :bucket => "assets.#{SITE[:domain]}",
-                        :s3_host_alias => "assets.#{SITE[:domain]}",
-                        :convert_options => {
-                           :all => '-quality 80'
-                         }
-                           
+
+   acts_as_uploader  :enable_s3 => false,
+                     :has_attached_file => {
+                       :url     => "/system/:attachment/:id_partition/:style/:basename.:extension",
+                       :path    => ":rails_root/public/system/:attachment/:id_partition/:style/:basename.:extension",
+                       :styles  => { :icon => "30x30!", 
+                                     :thumb => "100>", 
+                                     :small => "150>", 
+                                     :medium => "300>", 
+                                     :large => "660>" },
+                       :default_url => "/images/profile_default.jpg",
+                       :storage => :s3,
+                       :s3_credentials => AMAZON_S3_CREDENTIALS,
+                       :bucket => "assets.example.com",
+                       :s3_host_alias => "assets.example.com",
+                       :convert_options => {
+                          :all => '-quality 80'
+                        }
+                     },
+                     :s3_path => ':id_partition/:style/:basename.:extension'
+                                                                  
     # only allow images:
     # validates_attachment_content_type :file, :content_type => ['image/jpeg', 'image/pjpeg', 'image/jpg']
     
@@ -97,7 +110,7 @@ controller instead of directly using the one inside the gem:
 
   class UploadsController < Uploader::UploadsController
     
-    before_filter :login_required
+    prepend_before_filter :login_required
     
     protected
     
@@ -123,6 +136,7 @@ controller instead of directly using the one inside the gem:
   
     # Simply attempts to redirect to the parent object.  You might want to build something more sophisticated that
     # redirect to different areas of you site depending on the type of object that was uploaded or on based on the parent.
+    # source can be :destroy_success, :create_success, :create_failure, :permission_denied
     def get_redirect
       @parent
     end
@@ -143,19 +157,6 @@ controller instead of directly using the one inside the gem:
     
   end
 
-
-=== Other Methods
-
-uploader assumes that you have a method called 'redirect_back_or_default' which is common in many Rails projects.  This method
-is called upon completion of destroy or created when the requested format is 'html'.  A simple implementation of this method is listed
-below:
-
-  def redirect_back_or_default(default)
-    redirect_to(session[:return_to] || default)
-    session[:return_to] = nil
-  end
-
-
 === Configure your views.
 You'll need something like this in your layout so that uploader can add in the required css and javascript files.
 
@@ -209,7 +210,54 @@ Create a file named s3.yml in your configuration directory and add the following
 There are a number of timing issues that you will run into if you attempt to upload files directly to s3.  To overcome that
 problem uploader includes a daemon process which will send the files to Amazon asynchronously.  Note that the uploader
 will leave your local copy in place.
-TODO docs for Daemon
+
+Add the daemons gem and plugin:
+  sudo gem install daemons
+
+Then inside your Rails project:
+  script/plugin install git://github.com/dougal/daemon_generator.git
+  script/generate daemon amazonaws
+  
+  RAILS_ENV=development lib/daemons/mailer_ctl start
+
+Learn more about the custom daemon gem with Ryan Bates screencast:
+  http://railscasts.com/episodes/129-custom-daemon
+
+
+== Use Rake to send files to s3
+uploader includes a task capable of sending files to s3 but it makes an assumption that the model you are interacting with
+is named 'Upload'.
+
+  rake uploader:upload_to_s3 
+
+If you want to use a different model or several models just add a rake task to your project:
+
+  desc 'Send all uploads to S3.  (Will only send uploads from a model named Upload)'
+  task :upload_to_s3 do
+    
+    uploads = Upload.pending_s3_migration
+    uploads.each do |upload|
+      upload.remote = upload.local
+      upload.save!
+    end
+    
+    photos = Photo.pending_s3_migration
+    photos.each do |photo|
+      photo.remote = photo.local
+      photo.save!
+    end
+    
+  end
+
+== Setup Domains
+If you use Amazon's S3 service you can setup a cname to clean up your urls.  Configure your s3 bucket as above:
+
+  :bucket => "assets.example.com"
+  :s3_host_alias => "assets.example.com"
+
+Your assets will be available at assets.example.com.s3.amazon.com.  You can then create a CNAME in your DNS entries
+to point "assets.example.com" to "assets.example.com.s3.amazon.com".  Your assets will then appear to be
+be served from assets.example.com even though they are loaded from Amazon.
 
 
 == Other Stuff

data/Rakefile

@@ -18,7 +18,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Uploader'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
@@ -31,7 +31,7 @@ begin
     gemspec.homepage = "http://github.com/jbasdf/uploader"
     gemspec.description = "Uploader gem that makes it simple add multiple file uploads to your Rails project using SWFUpload and Paperclip"
     gemspec.authors = ["Justin Ball", "David South"]
-    gemspec.files.include %w( tasks/rails.rake lib/uploader/*.rb lib/uploader/middleware/*.rb db/migrate/*.rb public/images/file_icons/* app/views/uploads/* )
+    #gemspec.files.include %w( tasks/rails.rake lib/uploader/*.rb lib/uploader/middleware/*.rb db/migrate/*.rb public/images/file_icons/* app/views/uploads/* )
     gemspec.rubyforge_project = 'uploader'    
   end
 rescue LoadError

data/TODO

@@ -1,2 +1,3 @@
 Figure out how to localize javascript files
-Write the tests
+Write the tests
+Match up icons with mime types in uploader_upload.rb

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.7

data/app/controllers/uploader/uploads_controller.rb

@@ -7,7 +7,7 @@ class Uploader::UploadsController < ApplicationController
   def create
     # Standard, one-at-a-time, upload action
     @upload = @parent.uploads.build(params[:upload])
-    @upload.creator = current_user
+    @upload.creator = get_creator
     @upload.save!
     message = t('uploader.successful_upload')
     upload_json = basic_uploads_json(@upload)
@@ -15,7 +15,7 @@ class Uploader::UploadsController < ApplicationController
     respond_to do |format|
       format.html do
         flash[:notice] = message
-        redirect_to redirect_back_or_default(get_redirect)
+        redirect_to get_redirect(:create_success)
       end
       format.js { render :text => get_upload_text(@upload) }
       format.json { render :json => upload_json }
@@ -25,7 +25,7 @@ class Uploader::UploadsController < ApplicationController
     respond_to do |format|
       format.html do
         flash[:notice] = message
-        redirect_back_or_default(get_redirect)
+        redirect_to get_redirect(:create_failure)
       end
       format.js { render :text => message }
       format.json { render :json => { :success => false, :message => message } }
@@ -35,8 +35,8 @@ class Uploader::UploadsController < ApplicationController
   def swfupload
     @upload = @parent.uploads.build
     @upload.is_public = true if params[:is_public] == true
-    @upload.creator = current_user
-    @upload.swfupload_local = params[:Filedata]
+    @upload.creator = get_creator
+    @upload.swfupload_local = params[:filedata]
     @upload.save!
     @parent.uploads << @upload
     respond_to do |format|
@@ -64,7 +64,7 @@ class Uploader::UploadsController < ApplicationController
     respond_to do |format|
       format.html do
         flash[:notice] = message
-        redirect_back_or_default(get_redirect)
+        redirect_to get_redirect(:destroy_success)
       end
       format.js { render :text => message }
       format.json { render :json => { :success => success, :message => message } }
@@ -86,7 +86,7 @@ class Uploader::UploadsController < ApplicationController
     respond_to do |format|
       format.html do
         flash[:notice] = message
-        redirect_to get_redirect
+        redirect_to get_redirect(:permission_denied)
       end
       format.js { render :text => message }
       format.json { render :json => { :success => false, :message => message } }
@@ -94,8 +94,8 @@ class Uploader::UploadsController < ApplicationController
   end
 
   # override this method in your controller to set the redirect file upload completion
-  # alternatively set redirect_back_or_default
-  def get_redirect
+  # source can be :destroy_success, :create_success, :create_failure, :permission_denied
+  def get_redirect(source)
     @parent
   end
 
@@ -111,6 +111,10 @@ class Uploader::UploadsController < ApplicationController
     end
   end
 
+  def get_creator
+    current_user
+  end
+  
   def has_permission_to_upload(user, upload_parent)
     upload_parent.can_upload?(user)
   end

data/app/views/uploads/_swf_upload.html.erb

@@ -12,7 +12,7 @@
 				<span class="legend"></span>
 				<input id="swf_cancel_button" type="button" value="<%=t('uploader.cancel_all')%>" style="display:none;" />
 				<p id="divStatus"></p>
-			</div>			
+			</div>
 		</div>
 		<noscript class="swf-error-msg">
 		  <%= t('uploader.javascript_not_enabled') %>

data/lib/active_record/acts/uploader_upload.rb

@@ -26,16 +26,14 @@ module ActiveRecord
           named_scope :documents, :conditions => "local_content_type IN (#{(Uploader::MimeTypeGroups::WORD_TYPES + Uploader::MimeTypeGroups::EXCEL_TYPES + Uploader::MimeTypeGroups::PDF_TYPES).collect{|type| "'#{type}'"}.join(',')})" 
           named_scope :files, :conditions => "local_content_type NOT IN (#{Uploader::MimeTypeGroups::IMAGE_TYPES.collect{|type| "'#{type}'"}.join(',')})"
           named_scope :since, lambda { |*args| { :conditions => ["created_at > ?", (args.first || 7.days.ago.to_s(:db)) ]} }
-          named_scope :pending_s3_migration, lambda {
-            { :conditions =>  ["remote_file_name IS NULL AND created_at <= ?", 20.minutes.ago.to_s(:db)],
-              :order => 'created_at DESC',
-              :limit => 1 }
-          }
-
+          named_scope :pending_s3_migration, lambda { { :conditions =>  ["remote_file_name IS NULL AND created_at <= ?", 20.minutes.ago.to_s(:db)], :order => 'created_at DESC' } }
+          
           # Paperclip
           has_attached_file :local, options[:has_attached_file].merge(:storage => :filesystem) # Override any storage settings.  This one has to be local.
           if options[:enable_s3] == true
-            has_attached_file :remote, options[:has_attached_file]
+            has_attached_file :remote, options[:has_attached_file].merge(:url => ':s3_alias_url',
+                                                                         :path => options[:s3_path],
+                                                                         :storage => :s3)
           end
 
 
@@ -44,6 +42,7 @@ module ActiveRecord
                                         
           class_eval <<-EOV
             validates_attachment_size :local, :less_than => 10.megabytes
+            
             before_post_process :transliterate_file_name
             before_create :add_width_and_height
             
@@ -133,19 +132,19 @@ module ActiveRecord
 
         def icon
           if self.is_pdf?
-            '/images/file_icons/pdf.gif'
+            '/images/file_icons/file_pdf.gif'
           elsif self.is_word?
-            '/images/file_icons/word.gif'
+            '/images/file_icons/file_doc.gif'
           elsif self.is_image?
             self.file.url(:icon)
           elsif self.is_mp3?
-            '/images/file_icons/mp3.gif'
+            '/images/file_icons/file_mp3.gif'
           elsif self.is_excel?
-            '/images/file_icons/excel.gif'
+            '/images/file_icons/file_xls.gif'
           elsif self.is_text?
-            '/images/file_icons/text.gif'
+            '/images/file_icons/file_txt.gif'
           else
-            '/images/file_icons/file.gif'
+            '/images/file_icons/file_raw.gif'
           end
         end
         

data/lib/daemons/amazonaws.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# You might want to change this
+ENV["RAILS_ENV"] ||= "production"
+
+require File.dirname(__FILE__) + "/../../config/environment"
+
+$running = true
+Signal.trap("TERM") do 
+  $running = false
+end
+
+# Waiting is a timer variable to allow the daemon to restart
+# within two seconds of the Signal rather than using a long
+# sleep command and forcing the daemon to wait.
+$waiting = 0
+
+ActiveRecord::Base.logger.info "[AmazonS3] Migration daemon started at #{Time.now}.\n"
+
+while($running) do
+
+  if $waiting < 120
+    $waiting += 2
+    sleep 2
+  else
+    $waiting = 0
+    upload = Upload.pending_s3_migration.first
+
+    if upload
+      $waiting = 120 - 2
+      ActiveRecord::Base.logger.info "[AmazonS3] Migrating upload ##{upload.id}\n"
+      upload.remote = upload.local
+      upload.save!
+    end
+  end
+end

data/lib/uploader/tasks.rb

@@ -16,17 +16,23 @@ module Uploader
           Rake::Task[:environment].invoke if defined?(RAILS_ROOT)
         end
         
-        desc 'Send all uploads to S3'
+        desc 'Send all uploads to S3.  (Will only send uploads from a model named Upload)'
         task :upload_to_s3 do
-          # TODO write rake task to upload to s3
+          uploads = Upload.pending_s3_migration
+          uploads.each do |upload|
+            upload.remote = upload.local
+            upload.save!
+          end
         end
 
         desc "Sync required files from uploader."
         task :sync do
           path = File.join(File.dirname(__FILE__), *%w[.. ..])
-          puts path
+          daemons_path = "#{RAILS_ROOT}/lib/daemons"
           system "rsync -ruv #{path}/public ."
           system "rsync -ruv #{path}/db ."
+          FileUtils.mkdir_p(daemons_path) unless File.directory?(daemons_path)          
+          FileUtils.cp_r("#{path}/lib/daemons/amazonaws.rb", "#{RAILS_ROOT}/lib/daemons/amazonaws.rb")
         end
         
       end