uploadify-rails 3.1.1 → 3.1.1.1

data/Gemfile

@@ -1,2 +1,2 @@
 source :rubygems
-gemspe
+gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Uploadify::Rails
 
-TODO: Write a gem description
+Uploadify plugin for Ruby on Rails asset pipeline.
 
 ## Installation
 
@@ -18,7 +18,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add to your JavaScript pipeline:
+
+    //= require uploadify
+
+Add to you CSS pipeline:
+
+    /*
+     *= require uploadify
+    */
+
+You can configure options in an initializer.  For example:
+
+    Uploadify::Rails.configure do |config|
+      config.uploader        = 'uploads/create'
+      config.buttonText      = lambda { I18n.t('uploader.upload_file') }
+      config.queueID         = 'uploadify_queue_div'
+      config.onUploadSuccess = true
+    end
+
+When you define any callbacks as true, you should define a function 'window.UploadifyRails.#{callback}' in your javascript asset files with the appropriate arguments.  For convenience, you can run `rake uploadify_rails:coffee` to generate a coffeescript file with those functions already outlined.  You can delete or leave as-is any functions in that file whose configuration values are not set to true.
+
+For convenient access to your configuration, add to you ApplicationHelper:
+
+    include UploadifyRailsHelper
+
+You can then access the uploadifier options using `uploadify_rails_options` in a view.  For example:
+
+    <script type='text/javascript'>
+      $(document).ready(function() {
+        $('input#uploadify').uploadify(<%= uploadify_rails_options %>);
+      });
+    </script>
+
+## Using flash_cookie_session
+If uploadify will be sending data back to your Rails application, just put 'gem "flash_cookie_session"' in your Gemfile, BEFORE 'gem "uploadify-rails"'.
+
+(If you are designing a plugin, remember to put 'require "flash_cookie_session"' at the top of your engine file.  Make sure it's included before 'require "uploadify-rails"'.)
+
+In most cases, 'flash_cookie_session' should be in your Gemfile.  However, if uploadify is configured to send data to a different web application, such as, for instance, if you're uploading files directly to Amazon S3, omit flash_cookie_session.  (If you require it for other parts of your application, list it in the Gemfile AFTER "uploadify-rails".)
 
 ## Contributing
 

data/lib/tasks/install.rake

@@ -0,0 +1,8 @@
+require 'uploadify-rails/callback_generator'
+
+namespace :uploadify_rails do
+  desc "create uploadify.js.coffee in app/assets/javascripts with a skeleton of all Uploadify callbacks"
+  task :coffee do
+    Uploadify::Rails::CallbackGenerator.new.create_coffeescript_file
+  end
+end

data/lib/templates/uploadify-rails.js.coffee

@@ -0,0 +1,55 @@
+window.UploadifyRails = {}
+
+window.UploadifyRails.onCancel = (file) ->
+  true
+
+window.UploadifyRails.onClearQueue = (queueItemCount) ->
+  true
+
+window.UploadifyRails.onDestroy = ->
+  true
+
+window.UploadifyRails.onDialogClose = (queueData) ->
+  true
+
+window.UploadifyRails.onDialogOpen = ->
+  true
+
+window.UploadifyRails.onDisable = ->
+  true
+
+window.UploadifyRails.onEnable = ->
+  true
+
+window.UploadifyRails.onFallback = ->
+  true
+
+window.UploadifyRails.onInit = (instance) ->
+  true
+
+window.UploadifyRails.onQueueComplete = (queueData) ->
+  true
+
+window.UploadifyRails.onSelect = (file) ->
+  true
+
+window.UploadifyRails.onSelectError = (file, errorCode, errorMsg) ->
+  true
+
+window.UploadifyRails.onSWFReady = ->
+  true
+
+window.UploadifyRails.onUploadComplete = (file) ->
+  true
+
+window.UploadifyRails.onUploadError = (file, errorCode, errorMsg, errorString) ->
+  true
+
+window.UploadifyRails.onUploadProgress = (file, bytesUploaded, bytesTotal, totalBytesUploaded, totalBytesTotal) ->
+  true
+
+window.UploadifyRails.onUploadStart = (file) ->
+  true
+
+window.UploadifyRails.onUploadSuccess = (file, data, response) ->
+  true

data/lib/uploadify-rails.rb

@@ -1,2 +1,4 @@
+require "uploadify-rails/helpers/uploadify_rails_helper"
+require "uploadify-rails/configuration"
 require "uploadify-rails/version"
-require "uploadify-rails/engine"
+require "uploadify-rails/engine"

data/lib/uploadify-rails/callback_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/base'
+
+module Uploadify
+  module Rails
+    class CallbackGenerator < ::Rails::Generators::Base
+      COFFEESCRIPT_FILE = 'uploadify-rails.js.coffee'
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def create_coffeescript_file
+        puts "Creating coffeescript file..."
+        copy_file COFFEESCRIPT_FILE, ::Rails.application.config.root + 'app' + 'assets' + 'javascripts' + COFFEESCRIPT_FILE
+        puts "Done!"
+      end
+    end
+  end
+end

data/lib/uploadify-rails/configuration.rb

@@ -0,0 +1,134 @@
+module Uploadify
+  module Rails
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield self.configuration
+    end
+
+    class ConfigurationError < StandardError; end
+
+    class Configuration
+    private
+      def self.callbacks
+        [:onCancel, :onClearQueue, :onDestroy, :onDialogClose, :onDialogOpen, :onDisable, :onEnable, :onFallback, :onInit, :onQueueComplete, :onSelectError, :onSelect, :onSWFReady, :onUploadComplete, :onUploadError, :onUploadSuccess, :onUploadProgress, :onUploadStart]
+      end
+      def self.value_options
+        [:uploader, :buttonClass, :buttonCursor, :buttonImage, :buttonText, :checkExisting, :fileObjName, :fileSizeLimit, :fileTypeDesc, :fileTypeExts, :height, :method, :progressData, :queueID, :queueSizeLimit, :removeTimeout, :successTimeout, :uploadLimit, :width, :overrideEvents]
+      end
+      def self.bool_options
+        [:auto, :debug, :multi, :preventCaching, :removeCompleted, :requeueErrors]
+      end
+      def self.callback_args
+        @@callback_definitions ||= {
+          :onCancel => [:file],
+          :onClearQueue => [:queueItemCount],
+          :onDialogClose => [:queueData],
+          :onInit => [:instance],
+          :onQueueComplete => [:queueData],
+          :onSelect => [:file],
+          :onSelectError => [:file, :errorCode, :errorMsg],
+          :onUploadComplete => [:file],
+          :onUploadError => [:file, :errorCode, :errorMsg, :errorString],
+          :onUploadProgress => [:file, :bytesUploaded, :bytesTotal, :totalBytesUploaded, :totalBytesTotal],
+          :onUploadStart => [:file],
+          :onUploadSuccess => [:file, :data, :response]
+        }
+      end
+    public
+      self.callbacks.each { |option|
+        attr_accessor option
+      }
+      self.value_options.each { |option|
+        attr_accessor option
+      }
+      self.bool_options.each { |option|
+        attr_accessor option
+      }
+      attr_accessor :formData
+
+      if defined?(FlashCookieSession)
+        def uploadify_options protection_token, cookies, auth_token
+          generate_option_hash do |option_hash|
+            option_hash[:formData] = required_form_data(protection_token, cookies, auth_token).merge(@formData || {})
+          end
+        end
+      else
+        def uploadify_options
+          generate_option_hash do |option_hash|
+            option_hash[:formData] = @formData unless @formData.nil?
+          end
+        end
+      end
+
+    private
+      def generate_option_hash &block
+        validate_options
+        @option_hash = {}
+        insert_options self.class.value_options
+        insert_options self.class.bool_options
+        insert_options self.class.callbacks.each do |k,v|
+          @option_hash[k] = "_____#{k}____" if v
+        end
+        yield @option_hash
+        @json = @option_hash.to_json
+        set_callbacks_without_quotes
+        @json.html_safe
+      end
+
+      def validate_options
+        raise ConfigurationError, "UploadifyRails.Configuration.formData must be a hash" unless @formData.is_a?(Hash) || @formData.nil?
+        raise ConfigurationError, "UploadifyRails.Configuration.overrideEvents must be a Array" unless @overrideEvents.is_a?(Array) || @overrideEvents.nil?
+        raise ConfigurationError, "UploadifyRails.Configuration.progressData must be either :percentage or :speed" unless @progressData.nil? || [:percentage, :speed].include?(@progressData.to_sym)
+        raise ConfigurationError, "UploadifyRails.Configuration.buttonCursor must be either :arrow or :hand" unless @buttonCursor.nil? || [:arrow, :hand].include?(@buttonCursor.to_sym)
+        raise ConfigurationError, 'Please set UploadifyRails.Configuration.uploader to the route of the uploading action.  Run `rake routes` to find the correct value' if @uploader.nil?
+        self.class.bool_options.each { |bool_option|
+          raise ConfigurationError, "UploadifyRails.Configuration.#{bool_option} must be either 'true' or 'false'" unless [true, false, nil].include?(get_value(bool_option))
+        }
+        self.class.callbacks.each { |callback|
+          raise ConfigurationError, "UploadifyRails.Configuration.#{callback} must be either 'true' or 'false'\nRun 'rake uploadify_rails:coffee' to generate a coffeescript file and define callbacks there" unless [true, false, nil].include?(get_value(callback))
+        }
+      end
+      def args_for callback
+        args = self.class.callback_args
+        args.key?(callback) ? args[callback].join(',') : ''
+      end
+      def set_callbacks_without_quotes
+        insert_options self.class.callbacks.each do |k,v|
+          if v
+            args = args_for k
+            @json.gsub!("\"#{@option_hash[k]}\"", "function(#{args}) { window.UploadifyRails.#{k}(#{args}); return true;}")
+          end
+        end
+      end
+      def get_value option
+        self.instance_variable_get("@#{option}")
+      end
+      def required_form_data protection_token, cookies, auth_token
+        @session_key ||= ::Rails.application.config.session_options[:key]
+        @forgery_token = protection_token
+        {
+          :_http_accept  => 'application/javascript',
+          :_method       => 'post',
+          @session_key   => cookies[@session_key],
+          @forgery_token => auth_token
+        }
+      end
+      def insert_options keys
+        keys.each do |option|
+          value = get_value(option)
+          value = value.call if value.is_a?(Proc)
+          unless value.nil?
+            if block_given?
+              yield option, value
+            else
+              @option_hash[option] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uploadify-rails/helpers/uploadify_rails_helper.rb

@@ -0,0 +1,10 @@
+module UploadifyRailsHelper
+  def uploadify_rails_options
+    config = Uploadify::Rails.configuration
+    if defined?(FlashCookieSession)
+      config.uploadify_options(request_forgery_protection_token, cookies, form_authenticity_token)
+    else
+      config.uploadify_options
+    end
+  end
+end

data/lib/uploadify-rails/version.rb

@@ -1,5 +1,5 @@
 module Uploadify
   module Rails
-    VERSION = "3.1.1"
+    VERSION = "3.1.1.1"
   end
 end

data/uploadify-rails.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["filip@tepper.pl"]
   gem.description   = %q{Uploadify plugin for Ruby on Rails asset pipeline}
   gem.summary       = %q{Uploadify plugin for Ruby on Rails asset pipeline}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/filiptepper/uploadify-rails/"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadify-rails
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Uploadify plugin for Ruby on Rails asset pipeline
 email:
@@ -23,8 +23,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/tasks/install.rake
+- lib/templates/uploadify-rails.js.coffee
 - lib/uploadify-rails.rb
+- lib/uploadify-rails/callback_generator.rb
+- lib/uploadify-rails/configuration.rb
 - lib/uploadify-rails/engine.rb
+- lib/uploadify-rails/helpers/uploadify_rails_helper.rb
 - lib/uploadify-rails/version.rb
 - uploadify-rails.gemspec
 - vendor/assets/images/uploadify/uploadify-cancel.png
@@ -32,7 +37,7 @@ files:
 - vendor/assets/javascripts/uploadify.js
 - vendor/assets/javascripts/uploadify/jquery.uploadify.js.erb
 - vendor/assets/stylesheets/uploadify.css.erb
-homepage: ''
+homepage: https://github.com/filiptepper/uploadify-rails/
 licenses: []
 post_install_message: 
 rdoc_options: []