flash_s3_rails 0.0.1.beta1

data/.gitignore

@@ -0,0 +1,7 @@
+.rvmrc
+*.gem
+.bundle
+pkg/*
+lib/flash_s3_test/tmp
+lib/flash_s3_test/log
+lib/flash_s3_test/db/*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,156 @@
+PATH
+  remote: .
+  specs:
+    flash_s3_rails (0.0.1.beta1)
+      activesupport
+      jquery-ui-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.7)
+    arel (3.0.2)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.2)
+      ffi (~> 1.0.6)
+    daemons (1.0.10)
+    database_cleaner (0.7.2)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    eventmachine (0.12.10)
+    ffi (1.0.11)
+    gem_plugin (0.2.3)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    jquery-ui-rails (0.3.0)
+      jquery-rails
+      railties (>= 3.1.0)
+    json (1.6.6)
+    libwebsocket (0.1.3)
+      addressable
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    mongrel (1.2.0.pre2)
+      daemons (~> 1.0.10)
+      gem_plugin (~> 0.2.3)
+    multi_json (1.3.2)
+    nokogiri (1.5.2)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
+    rubyzip (0.9.7)
+    selenium-webdriver (2.21.2)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thin (1.3.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  database_cleaner
+  flash_s3_rails!
+  jquery-rails
+  mongrel (~> 1.2.0.pre2)
+  rails
+  rspec
+  rspec-rails
+  sqlite3
+  thin

data/README.md

@@ -0,0 +1,92 @@
+# FlashS3Rails
+
+Upload files to s3 with flash, including progress bars, in your Rails app.  Configuration requires an s3 key and secret only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flash_s3_rails', :require => 'flash_s3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flash_s3_rails
+
+## Usage
+
+### In `application.rb` or `<environment>.rb` or an initializer
+
+``` ruby
+config.flash_s3.bucket = 'mybucketname'
+config.flash_s3.s3_access_key_id = "myaccesskey"
+config.flash_s3.s3_secret_access_key = "mysecretaccesskey"
+```
+
+### In a migration
+
+``` ruby
+add_column :<your_model_name_pluralized>, :<your_attachment_name>_s3_key :string
+```
+
+e.g.
+
+``` ruby
+add_column :videos, :media_s3_key, :string
+```
+
+### In the Model
+
+Let's say it's called `Video`.
+
+``` ruby
+has_attached_s3_file :media
+```
+
+Substitute your upload name for `media`.
+
+### In the View
+
+#### Erb
+
+``` erb
+<%= flash_s3_uploader @video, :media, post_upload_callback_url  %>
+```
+
+#### Haml
+
+``` haml
+= flash_s3_uploader @video, :media, post_upload_callback_url
+```
+
+Note: You must use the url and not the path for your post callback hook.
+
+### In your Controller (post upload callback action)
+
+``` ruby
+def create
+  @video = Video.new(params[:video])
+  @video.save!
+  head :ok
+end
+```
+
+Or whatever ;)  The point is to `new`, `create`, `update_attributes`, etc, your Model instance with the `attachment_s3_key` column and `has_attached_s3_file` and save it!  Your s3_key will be saved automagically.
+
+## Upcoming
+
+* Additional _custom_ post callback params
+* More configurable, e.g. max file size, file type(s) accepted
+* Drop jquery-ui dependency and implement a simple css progress bar
+* Make the green box a little less ugly ;)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,46 @@
+require 'bundler/setup'
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec => ['spec:prepare'] do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+
+namespace :spec do
+  desc 'Create spec'
+  task :create, :path do |t, args|
+    spec_path = File.join('spec', args[:path].gsub(%r{.rb$}, '_spec.rb'))
+    klass = File.basename(args[:path], File.extname(args[:path])).split('_').map {|s| "#{s[0,1].upcase}#{s[1..-1]}" }.join
+    mkdir_p File.dirname(spec_path)
+
+    spec_doc = <<-EOS
+require 'spec_helper'
+
+describe #{klass} do
+end
+EOS
+
+    File.open(spec_path, 'w+') do |f|
+      f.puts spec_doc
+    end
+
+    puts spec_doc
+  end
+
+  task :prepare => ['db:migrate:reset', 'db:test:prepare']
+end
+
+ENV["RAILS_ENV"] ||= 'test'
+require 'flash_s3_test/config/application'
+FlashS3Test::Application.load_tasks
+
+task :server => 'db:migrate:reset' do
+  app = Rack::Builder.new { run FlashS3Test::Application }.to_app
+  Rack::Handler::Thin.run app, :Port => 3000
+end
+
+desc 'Default: run specs.'
+task :default => :spec

data/app/assets/javascripts/jquery.flashS3.js

@@ -0,0 +1,128 @@
+//= require vendor/flash_s3/swfupload
+
+(function ($) {
+  var methods = {
+    initialize: function (options) {
+      var elem = $(this);
+
+      methods.elem = function () {
+        return $(elem);
+      };
+
+      var settings = $.extend(true, {
+        file_queued_handler: methods.handleFileQueued,
+
+        upload_success_handler: methods.handleFileSuccess,
+
+        upload_progress_handler: methods.handleFileProgress,
+
+        file_size_limit : "0"
+      }, options);
+
+      elem.data('flashS3Settings', settings);
+
+      var sfwu = new SWFUpload(settings);
+      elem.data('flashS3Swfu', sfwu);
+
+      elem.find('a.flash_s3-start_button').click(function (evt) {
+        evt.preventDefault();
+        sfwu.startUpload();
+      });
+    },
+
+    progressbar: function (fileId) {
+      return $('li#' + fileId).data('flashS3Progressbar');
+    },
+
+    sfsu: function () {
+      return methods.elem().data('flashS3Swfu');
+    },
+
+    handleFileSuccess: function (file, serverData) {
+      var pb = methods.progressbar.call(methods.elem(), file.id);
+      if ($(pb).is('.ui-progressbar')) {
+        pb.progressbar('value', 100);
+      } // TODO else: make a css progress bar and handle here
+
+      var settings = methods.elem().data('flashS3Settings');
+      var recordKlass = settings.custom_settings.record_class_name;
+      var attachmentName = settings.custom_settings.attachment_name;
+      var s3KeyQueryParamKey = recordKlass + '[' + attachmentName + '][s3_key]';
+      var params = {};
+      params[s3KeyQueryParamKey] = $($.parseXML(serverData)).find('Key').text();
+      params.s3_file_class_name = recordKlass;
+      $.post(settings.custom_settings.create_s3_attachment_url, params);
+      this.startUpload();
+    },
+
+    handleFileProgress: function (file, bytesLoaded, bytesTotal) {
+      var percent = Math.ceil((bytesLoaded / bytesTotal) * 100);
+      var pb = methods.progressbar.call(methods.elem(), file.id);
+      if ($(pb).is('.ui-progressbar')) {
+        pb.progressbar('value', percent);
+      } // TODO else: make a css progress bar and handle here
+    },
+
+    handleFileQueued: function (file) {
+      var settings = methods.elem().data('flashS3Settings');
+
+      var listItem;
+      if (settings.custom_settings.file_upload_list_item_renderer) {
+        listItem = $.globalEval(settings.custom_settings.file_upload_list_item_renderer).call(this, file);
+      } else {
+        listItem = methods.fileUplaodListItemRenderer.call(this, file);
+
+        $('.ui-icon-close', listItem).click(function (evt) {
+          evt.preventDefault();
+          methods.sfsu().cancelUpload(file.id);
+          listItem.remove();
+        });
+      }
+      methods.elem().find('ol.flash_s3-file_transfers').append(listItem);
+    },
+
+    fileUplaodListItemRenderer: function (file) {
+      var listItem = $('<li class="flash_s3-file" id="' + file.id + '">' +
+          '<div class="flash_s3-filename">' + file.name + '</div>' +
+          '<div class="flash_s3-progress_bar" />' +
+          '<div class="ui-icon-close ui-icon" />' +
+          '</li>');
+      var pb;
+      if (methods.enablesJQueryUI()) {
+        pb = listItem.find('.flash_s3-progress_bar').progressbar();
+        listItem.data("flashS3Progressbar", pb);
+      } else {
+        pb = listItem.find('.flash_s3-progress_bar');
+        listItem.data("flashS3Progressbar", pb);
+      }
+
+      return listItem;
+    },
+    enablesJQueryUI: function () {
+      return true;
+    }
+  };
+
+  $.makePlugin = function (name, methods) {
+    $.fn[name] = function () {
+      var retVal;
+      var command = arguments[0] || 'initialize';
+      var args, options;
+      if ($.isPlainObject(command) || command === 'initialize') {
+        command = 'initialize';
+        args = [arguments[0] || {}];
+      } else if (command) {
+        args = $.makeArray(arguments).slice(1);
+      }
+
+      var iterator = $(this).each(function () {
+        var elem = $(this);
+        retVal = methods[command].apply(elem, args);
+      });
+
+      return retVal || iterator;
+    };
+  };
+
+  $.makePlugin('flashS3', methods);
+})(jQuery);