s3_cors_fileupload 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,51 @@
+.rvmrc
+
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler'
+  gem 'rdoc', '~> 3.12'
+  gem 'jeweler', '~> 1.8.4'
+end
+
+group :test do
+  gem 'rspec', '~> 2.11'
+  gem 'shoulda-matchers'
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    shoulda-matchers (1.4.1)
+      activesupport (>= 3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.11)
+  shoulda-matchers

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ben Atkins
+
+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.

data/README.md

@@ -0,0 +1,104 @@
+# S3CorsFileupload
+
+A gem to allow for uploading of files to directly AWS-S3 via CORS via the
+[jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/) for Rails 3.1 and greater.
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 's3_cors_fileupload'
+
+Then run `bundle install`.
+
+Next run the install generator, which creates a config file, then generates (but does not run)
+a migration to add a source_files table and a corresponding model, as well as a controller, routes,
+and views for the file uploading.
+
+    bundle exec rails generate s3_cors_fileupload:install
+
+Now run the migration that was just generated:
+
+    bundle exec rake db:migrate
+
+As you may have noticed, a config file was generated at `config/amazon_s3.yml`.  Edit this file and fill in
+the fields with your AWS S3 credentials.  You can make the config load from environment variables if you wish
+not to commit your S3 account information to your repository, like so:
+
+    secret_access_key: <%= ENV['S3_SECRET_ACCESS_KEY'] %>
+
+Add the following javascript and CSS to your asset pipeline:
+
+**s3_cors_fileupload.js**
+```javascript
+//= require s3_cors_fileupload
+```
+
+**jquery.fileupload-ui.css**
+```css
+*= require jquery.fileupload-ui
+```
+
+Now before you're ready to run the application, make sure your AWS S3 CORS settings for your bucket are setup
+to receive file uploads.  Before you put the application into production, I would highly recommend reading
+[the official documentation for CORS](http://docs.amazonwebservices.com/AmazonS3/latest/dev/cors.html).
+If you just want to get up and running, here is a configuration that will get you going:
+
+```
+<CORSConfiguration>
+    <CORSRule>
+        <AllowedOrigin>http://localhost:3000</AllowedOrigin>
+        <AllowedMethod>GET</AllowedMethod>
+        <AllowedMethod>POST</AllowedMethod>
+        <AllowedMethod>PUT</AllowedMethod>
+        <MaxAgeSeconds>3000</MaxAgeSeconds>
+        <AllowedHeader>*</AllowedHeader>
+    </CORSRule>
+</CORSConfiguration>
+```
+
+If you use this CORS Config, and you start to see warnings like
+"Origin http://localhost:3000 is not allowed by Access-Control-Allow-Origin", then you can modify the `AllowedOrigin`
+line like so:
+
+    <AllowedOrigin>*</AllowedOrigin>
+
+Just be sure to change this before you put it into production, otherwise anybody can upload to your bucket from any domain.
+
+## Usage
+
+Run your rails server
+
+    bundle exec rails s
+
+Then navigate to `http://<server_root>/source_files` to get started.  The files that `s3_cors_fileupload`'s install generator
+provide you with are just a guide to get you started.  I thought this would be helpful to others since it took me a while to
+get the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/) uploading directly to S3.  I encourage
+you to modify the controller, source files, and javascript as you see fit!
+
+## Notes
+
+The UI version of the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/)
+javascript uses aspects of [Twitter's Bootstrap](http://twitter.github.com/bootstrap/) for styling purposes.
+In index view file from this gem's generator it is included via a `stylesheet_link_tag` to use a copy of it
+[BootstrapCDN](http://www.bootstrapcdn.com/), but if you plan to use bootstrap in more places throughout
+your application, you may want look into using a gem such as
+`[twitter-bootstrap-rails](https://github.com/seyhunak/twitter-bootstrap-rails)`, which allows you to inject
+the stylesheets and javascripts from bootstrap into the asset pipeline.
+
+## Contributing to S3CorsFileupload
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Please try to add tests. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Make a pull request.
+
+Note: I am still in the process of trying to write a more thorough test suite, so any specs people want to contribute would be very welcome!
+
+## Copyright
+
+Copyright (c) 2012 Ben Atkins. See [LICENSE.txt](https://github.com/fullbridge-batkins/s3_cors_fileupload/blob/master/LICENSE.txt)
+for further details.

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "s3_cors_fileupload"
+  gem.homepage = "http://github.com/fullbridge-batkins/s3_cors_fileupload"
+  gem.license = "MIT"
+  gem.summary = %q{File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload javascript}
+  gem.description = %q{File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload javascript}
+  gem.email = ["benatkins@fullbridge.com"]
+  gem.authors = ["Ben Atkins"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+# end
+# 
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+# 
+# task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  require File.expand_path('../lib/s3_cors_fileupload/version', __FILE__)
+  version = S3CorsFileupload::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "s3_cors_fileupload #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :gem_console do
+  sh "irb -I lib -r s3_cors_fileupload.rb"
+end

data/lib/generators/s3_cors_fileupload/install/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Creates a config file, then generates (but does not run) a migration to add a source_files table and
+    a corresponding model, as well as a controller, routes, and views for the file uploading.
+
+Example:
+    rails generate s3_cors_fileupload:install
+
+    This will create:
+        db/migrate/create_source_files.rb
+        app/models/source_file.rb
+        app/controllers/s3_uploads_controller.rb
+        app/assets/javascripts/s3_uploads.js
+        app/views/s3_uploads/
+        app/views/s3_uploads/_template_download.html.erb
+        app/views/s3_uploads/_template_upload.html.erb
+        app/views/s3_uploads/_template_uploaded.html.erb
+        app/views/s3_uploads/index.html.erb

data/lib/generators/s3_cors_fileupload/install/install_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module S3CorsFileupload
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      # class_option :with_controller, :type => :boolean, :default => false, :desc => "Generate controller, views, and routes"
+
+      desc('Creates a config file, then generates (but does not run) a migration to add a source_files table and ' +
+            'a corresponding model, as well as a controller, routes, and views for the file uploading.')
+
+      def create_config_file
+        copy_file 'amazon_s3.yml', 'config/amazon_s3.yml'
+      end
+
+      def create_migration_file
+        migration_template 'create_source_files.rb', 'db/migrate/create_source_files.rb'
+      end
+
+      def create_model_file
+        copy_file 'source_file.rb', 'app/models/source_file.rb'
+      end
+
+      def create_controller
+        # if options.with_controller?
+        copy_file 's3_uploads_controller.rb', 'app/controllers/s3_uploads_controller.rb'
+        copy_file 's3_uploads.js', 'app/assets/javascripts/s3_uploads.js'
+      end
+
+      def create_views
+        Dir.foreach(File.expand_path('../templates/views', __FILE__)).reject { |file_name| %w(. ..).include?(file_name) }.each do |file_name|
+          copy_file "views/#{file_name}", "app/views/s3_uploads/#{file_name}"
+        end
+      end
+
+      def setup_routes
+        route(
+          ["resources :source_files, :only => [:index, :create, :destroy], :controller => 's3_uploads' do", "\n",
+        "    get :generate_key, :on => :collection", "\n",
+        "  end"].join
+        )
+      end
+
+    end
+  end
+end

data/lib/generators/s3_cors_fileupload/install/templates/amazon_s3.yml

@@ -0,0 +1,17 @@
+defaults: &defaults
+  access_key_id: your_access_key_id
+  secret_access_key: your_secret_access_key
+  acl: public-read # options: private, public-read, public-read-write, authenticated-read
+  max_file_size: 524288000 # 500 megabytes
+
+development:
+  <<: *defaults
+  bucket: your_development_bucket_name
+    
+test:
+  <<: *defaults
+  bucket: your_development_bucket_name
+  
+production:
+  <<: *defaults
+  bucket: <%= ENV['S3_BUCKET'] || 'your_production_bucket_name_here' %>

data/lib/generators/s3_cors_fileupload/install/templates/create_source_files.rb

@@ -0,0 +1,14 @@
+class CreateSourceFiles < ActiveRecord::Migration
+  def change
+    create_table :source_files do |t|
+      t.string :file_name
+      t.string :file_content_type
+      t.integer :file_size
+      t.string :url
+      t.string :key
+      t.string :bucket
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/s3_cors_fileupload/install/templates/s3_uploads.js

@@ -0,0 +1,94 @@
+/*
+ * s3-cors-file-upload
+ * http://github.com/fullbridge-batkins/s3_cors_fileupload
+ *
+ * Copyright 2012, Ben Atkins
+ * http://batkins.net
+ *
+ * Licensed under the MIT license:
+ * http://www.opensource.org/licenses/MIT
+ */
+
+// This global variable will hold s3 file credentials for files until it's time to submit them
+var s3_upload_hash = {};
+
+$(function() {
+  // hit the controller for info when the file comes in
+  $('#fileupload').bind('fileuploadadd', function (e, data) {
+      var content_type = data.files[0].type;
+      var file_name = data.files[0].name;
+     $.ajax({
+        url: '/source_files/generate_key',
+        type: 'GET',
+        dataType: 'json',
+        data: {filename: file_name}, // send the file name to the server so it can generate the key param
+        async: false,
+        success: function(data) {
+          // Now that we have our data, we add it to the global s3_upload_hash so that it can be
+          // accessed (in the fileuploadsubmit callback) prior to being submitted
+          s3_upload_hash[file_name] = {
+                                        key: data.key,
+                                        content_type: content_type
+                                      };
+        }
+      })
+    });
+  
+  // this gets triggered right before a file is about to be sent (and have their form action submitted)
+  $('#fileupload').bind('fileuploadsubmit', function (e, data) {
+      var file_name = data.files[0].name;
+      // transfer the data from the upload-template .form hidden fields to the real form's hidden fields
+      var form = $('#fileupload');
+      form.find('input[name=key]').val(s3_upload_hash[file_name]['key']);
+      form.find('input[name=Content-Type]').val(s3_upload_hash[file_name]['content_type']);
+      delete s3_upload_hash[file_name];
+  });
+   
+  $('#fileupload').bind('fileuploaddone', function (e, data) {
+    // the response will be XML, and can be accessed by calling `data.result`
+    //
+    // Here is an example of what the XML will look like coming back from S3:
+    //  <PostResponse>
+    //    <Location>https://bucket-name.s3.amazonaws.com/uploads%2F3ducks.jpg</Location>
+    //    <Bucket>bucket-name</Bucket>
+    //    <Key>uploads/3ducks.jpg</Key>
+    //    <ETag>"c7902ef289687931f34f92b65afda320"</ETag>
+    //  </PostResponse>
+     
+     $.post('/source_files',
+          {
+            'source_file[url]': $(data.result).find('Location').text(),
+            'source_file[bucket]': $(data.result).find('Bucket').text(),
+            'source_file[key]': $(data.result).find('Key').text(),
+            authenticity_token: $('meta[name=csrf-token]').attr('content')
+          },
+          function(data) {
+            $('#upload_files tbody').append(tmpl('template-uploaded', data));
+          },
+          'json'
+      );
+   });
+   
+   // remove the table row containing the source file information from the page
+   $('#fileupload').bind('fileuploaddestroyed', function (e, data) {
+      var deleted_object_id = data.url.split('/').pop();
+      // now remove the element from the page
+      $('#source_file_' + deleted_object_id).remove();
+   });
+ 
+});
+
+// used for displaying approximate file size on the file listing index.
+// functionality mimics what the jQuery-File-Upload script does.
+function formatFileSize(bytes) {
+    if (typeof bytes !== 'number') {
+        return '';
+    }
+    if (bytes >= 1000000000) {
+        return (bytes / 1000000000).toFixed(2) + ' GB';
+    }
+    if (bytes >= 1000000) {
+        return (bytes / 1000000).toFixed(2) + ' MB';
+    }
+    return (bytes / 1000).toFixed(2) + ' KB';
+}