Basic Uploads

.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.0.0'
+gem 'sqlite3'
+gem 'sass-rails', '~> 4.0.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.0.0'
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  gem 'sdoc', require: false
+end
+
+gem 's3_direct_upload'

Gemfile.lock

@@ -0,0 +1,128 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.3)
+    erubis (2.7.0)
+    execjs (2.0.2)
+    hike (1.2.3)
+    i18n (0.6.5)
+    jbuilder (1.5.2)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.2.0)
+    jquery-fileupload-rails (0.4.1)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    s3_direct_upload (0.1.6)
+      coffee-rails (>= 3.2.1)
+      jquery-fileupload-rails (~> 0.4.1)
+      rails (>= 3.2)
+      sass-rails (>= 3.2.5)
+    sass (3.2.12)
+    sass-rails (4.0.1)
+      railties (>= 4.0.0, < 5.0)
+      sass (>= 3.1.10)
+      sprockets-rails (~> 2.0.0)
+    sdoc (0.3.20)
+      json (>= 1.1.3)
+      rdoc (~> 3.10)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    turbolinks (1.3.1)
+      coffee-rails
+    tzinfo (0.3.38)
+    uglifier (2.3.2)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 4.0.0)
+  jbuilder (~> 1.2)
+  jquery-rails
+  rails (= 4.0.0)
+  s3_direct_upload
+  sass-rails (~> 4.0.0)
+  sdoc
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)

README.md

@@ -0,0 +1,70 @@
+S3 Direct Upload Example
+========================
+
+This application was a result of [this](https://github.com/waynehoover/s3_direct_upload/issues/108). There was no simple example on how to use the `s3_direct_upload` [Gem for Rails](https://github.com/waynehoover/s3_direct_upload), so I decided to make one.
+
+
+
+Getting Started
+---------------
+
+1. Fork/Clone the repo
+
+2. Sign up for AWS S3 & set up **AWS Access Keys** ([How?](https://console.aws.amazon.com/iam/home?#security_credential))
+
+3. Create a Bucket and set the following `CORS Configuration`:
+
+  ```
+  <CORSConfiguration>
+    <CORSRule>
+        <AllowedOrigin>*</AllowedOrigin>
+        <AllowedMethod>GET</AllowedMethod>
+        <AllowedMethod>POST</AllowedMethod>
+        <AllowedMethod>PUT</AllowedMethod>
+        <MaxAgeSeconds>3000</MaxAgeSeconds>
+        <AllowedHeader>*</AllowedHeader>
+    </CORSRule>
+  </CORSConfiguration>
+  ```
+
+4. Since your `s3_direct_upload.rb` initializer file is already set up, you just need to **Export your AWS Credentials** to environment (For Heroku, [see this](https://devcenter.heroku.com/articles/config-vars#setting-up-config-vars-for-a-deployed-application))
+
+  ```
+  export AWS_S3_BUCKET=your-bucket-name
+  export AWS_ACCESS_KEY_ID=your-aws-access-key-id
+  export AWS_SECRET_ACCESS_KEY=your-aws-secret-access-key
+  ``` 
+
+5. **Everything's done!** Start your rails server, and navigate to `http://0.0.0.0:3000` to see the app in action. 
+
+
+
+Where to go from here?
+----------------------
+
+- Read the [Official Documentation](https://github.com/waynehoover/s3_direct_upload) for `s3_direct_upload`
+- Understand the code. Important files to see are:
+   - `config/initializers/s3_direct_upload.rb`
+   - `app/views/documents/index.html.erb`
+   - `app/assets/javascripts/application.js`
+- Other, not-so-important files that've been changed:
+   - `config/routes.rb`
+   - `app/models/document.rb`
+   - `app/controllers/documents_controller.rb`
+   - `app/assets/stylesheets/application.css`
+
+
+
+Monkey Patch
+------------
+
+This gem didn't work at first for me and [a couple of these guys](https://github.com/waynehoover/s3_direct_upload/issues/30). Turns out it had something to do with the URLs of the S3 Buckets. The problem was solved thanks to the [Monkey Patch by @k13n](https://github.com/waynehoover/s3_direct_upload/issues/30#issuecomment-14719437). I've added this patch to `config/initializers/s3_direct_upload.rb` file despite the fact that [these URLs are slower](https://github.com/waynehoover/s3_direct_upload/issues/30#issuecomment-14787558).
+
+If you're feeling brave, try using the app without the patch.
+
+
+
+Other Crap
+----------
+
+The code wasn't meant to offend anyone. I only tried to make a simple example to get people started with the beautiful `s3_direct_upload` gem. If you find something that can be done in a better (and simpler) way, do let me know.

README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+S3DirectUploadExample::Application.load_tasks

app/assets/javascripts/application.js

@@ -0,0 +1,28 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require s3_direct_upload
+//= require_tree .
+
+$(function() {
+	$('#s3_uploader').S3Uploader({
+		remove_completed_progress_bar: false,
+		progress_bar_target: $('#uploads_container')
+	});
+
+	$('#s3_uploader').bind('s3_upload_failed', function(e, content) {
+		return alert(content.filename + ' failed to upload. Error: ' + content.error_thrown);
+	});
+});

app/assets/javascripts/documents.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

app/assets/stylesheets/application.css

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require s3_direct_upload_progress_bars
+ *= require_tree .
+ */

app/assets/stylesheets/documents.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the documents controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

app/controllers/documents_controller.rb

@@ -0,0 +1,18 @@
+class DocumentsController < ApplicationController
+	def index
+	end
+
+	def new
+		@document = Document.create(file_params)
+		redirect_to
+	end
+
+	def view
+		@document = Document.find(params[:id])
+	end
+
+	private
+		def file_params
+			params.require(:document).permit(:file_url)
+		end
+end

app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

app/helpers/documents_helper.rb

@@ -0,0 +1,2 @@
+module DocumentsHelper
+end

app/models/document.rb

@@ -0,0 +1,2 @@
+class Document < ActiveRecord::Base
+end

app/views/documents/index.html.erb

@@ -0,0 +1,19 @@
+<%= s3_uploader_form callback_url: new_url,
+					 id: "s3_uploader",
+					 callback_param: "document[file_url]",
+					 expiration: 2.hours.from_now.utc.iso8601,
+					 callback_method: "POST",
+					 max_file_size: 5.megabytes do %>
+
+	<%= file_field_tag :file, multiple: true %>
+<% end %>
+
+<div id="uploads_container"></div>
+<script id="template-upload" type="text/x-tmpl">
+	<div id="upload_{%=o.unique_id%}" class="upload">
+		<h5>{%=o.name%}</h5>
+		<div class="progress progress-striped active">
+			<div class="bar" style="width: 0%"></div>
+		</div>
+	</div>
+</script>

app/views/documents/view.html.erb

@@ -0,0 +1 @@
+<%= @document.file_url %>

app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>S3DirectUploadExample</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>