s3_direct_upload 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wayne
+
+MIT License
+
+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,123 @@
+# S3DirectUpload
+
+Easily generate a form that allows you to upload directly to Amazon S3.
+Multi file uploading supported by jquery-fileupload. 
+
+Code extracted from Ryan Bates' [gallery-jquery-fileupload](https://github.com/railscasts/383-uploading-to-amazon-s3/tree/master/gallery-jquery-fileupload).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 's3_direct_upload'
+
+Then add a new initalizer with your AWS credentials:
+
+**config/initalizers/s3_direct_upload.rb**
+```ruby
+S3DirectUpload.config do |c|
+  c.access_key_id = ""       # your access key id
+  c.secret_access_key = ""   # your secret access key
+  c.bucket = ""              # your bucket name
+end
+```
+
+Make sure your AWS S3 CORS settings for your bucket look something like this:
+```
+<CORSConfiguration>
+    <CORSRule>
+        <AllowedOrigin>http://0.0.0.0:3000</AllowedOrigin>
+        <AllowedMethod>GET</AllowedMethod>
+        <AllowedMethod>POST</AllowedMethod>
+        <AllowedMethod>PUT</AllowedMethod>
+        <MaxAgeSeconds>3000</MaxAgeSeconds>
+        <AllowedHeader>*</AllowedHeader>
+    </CORSRule>
+</CORSConfiguration>
+```
+In production the AllowedOrigin key should be your domain.
+
+Add the following js and css to your asset pipeline:
+
+**application.js**
+```ruby
+//= require s3_direct_upload
+```
+
+**application.css**
+```ruby
+//= require s3_direct_upload_progress_bars
+```
+
+## Usage
+
+Create a new view that uses the helper:
+```ruby
+<%= s3_uploader_form post: model_url, as: "model[image_url]" do %>
+  <%= file_field_tag :file, multiple: true %>
+<% end %>
+```
+
+Also place this template in the same view for the progress bars:
+```javascript
+<script id="template-upload" type="text/x-tmpl">
+<div class="upload">
+  {%=o.name%}
+  <div class="progress"><div class="bar" style="width: 0%"></div></div>
+</div>
+</script>
+```
+
+### Customizations
+Feel free to override the styling for the progress bars in s3_direct_upload_progress_bars, look at the source for inspiration.
+
+Also feel free to write your own js to interface with jquery-file-upload. You might want to do this to do custom validations on the files before it is sent to S3 for example.
+To do this remove `s3_direct_upload` from your application.js and include the necissary jquery-file-upload scripts (they are included in this gem automatically):
+```javascript
+//= require jquery-fileupload/basic
+//= require jquery-fileupload/vendor/tmpl
+```
+and use the `s3_direct_upload` script as a guide, the form helper will still work fine if thats all you need.
+
+### s3_uploader_form options and after upload callback
+After the upload is complete, the script will execute an ajax POST to the model_url given in the `post` option in the form helper. 
+The url to the file on S3 will be passed as a key to whatever is in the `as` option.
+
+You could have your create action render a javascript file like this:
+
+**create.js.erb**
+```ruby
+<% if @model.new_record? %>
+  alert("Failed to upload model: <%= j @model.errors.full_messages.join(', ').html_safe %>");
+<% else %>
+  $("#paintings").append("<%= j render(@model) %>");
+<% end %>
+```
+So that javascript code would be executed after the model instance is created, which would render your _model.html.erb template without a page reload if you wish.
+
+It is recommended that you persist the image_url as an attribute on the model. To do this To do this add `resources model` in the routes file, and add the 'image_url' attribute to your model (can be whatever you set it as in the as options)
+
+
+## Gotchas
+
+Right now you can only have one upload form on a page.
+Upload form is hardcoded with id '#fileupload'
+
+
+## Contributing / TODO
+
+This is just a simple gem that only really provides some javascript and a form helper. 
+This gem could go all sorts of ways based on what people want and how people contribute. 
+Ideas:
+More specs! 
+More options to control expiration, max filesize, file types etc.
+Create generators.
+Model methods.
+
+## Credit
+
+This gem is basically a small wrapper around code that [Ryan Bates](http://github.com/rbates) wrote for [Railscast#383](http://railscasts.com/episodes/383-uploading-to-amazon-s3). Most of the code in this gem was extracted from [gallery-jquery-fileupload](https://github.com/railscasts/383-uploading-to-amazon-s3/tree/master/gallery-jquery-fileupload). 
+
+Thank you Ryan Bates!
+
+This code also uses the excellecnt [jQuery-File-Upload](https://github.com/blueimp/jQuery-File-Upload), which is included in this gem by its rails counterpart [jquery-fileupload-rails](https://github.com/tors/jquery-fileupload-rails)

data/app/assets/javascripts/s3_direct_upload.js.coffee

@@ -0,0 +1,30 @@
+#= require jquery-fileupload/basic
+#= require jquery-fileupload/vendor/tmpl
+
+jQuery ->
+  $('#fileupload').fileupload
+    add: (e, data) ->
+      file = data.files[0]
+      data.context = $(tmpl("template-upload", file))
+      $('#fileupload').append(data.context)
+      data.submit()
+      
+    progress: (e, data) ->
+      if data.context
+        progress = parseInt(data.loaded / data.total * 100, 10)
+        data.context.find('.bar').css('width', progress + '%')
+    
+    done: (e, data) ->
+      file = data.files[0]
+      domain = $('#fileupload').attr('action')
+      path = $('#fileupload input[name=key]').val().replace('${filename}', file.name)
+      to = $('#fileupload').data('post')
+      content = {}
+      content[$('#fileupload').data('as')] = domain + path
+      $.post(to, content)
+      data.context.remove() if data.context # remove progress bar
+    
+    fail: (e, data) ->
+      alert("#{data.files[0].name} failed to upload.")
+      console.log("Upload failed:")
+      console.log(data)

data/app/assets/stylesheets/s3_direct_upload_progress_bars.css.scss

@@ -0,0 +1,17 @@
+.upload {
+  border-top: solid 1px #CCC;
+  width: 400px;
+  padding-top: 10px;
+  margin-top: 10px;
+
+  .progress {
+    margin-top: 8px;
+    border: solid 1px #555;
+    border-radius: 3px;
+    -moz-border-radius: 3px;
+    .bar {
+      height: 10px;
+      background: #3EC144;
+    }
+  }
+}

data/lib/s3_direct_upload.rb

@@ -0,0 +1,12 @@
+require 's3_direct_upload/version'
+require 'jquery-fileupload-rails' if defined?(Rails)
+
+require 'base64'
+require 'openssl'
+require 'digest/sha1'
+
+require 's3_direct_upload/config_aws'
+require 's3_direct_upload/form_helper'
+require 's3_direct_upload/engine' if defined?(Rails)
+
+ActionView::Base.send(:include, S3DirectUpload::UploadHelper) if defined?(ActionView::Base)

data/lib/s3_direct_upload/config_aws.rb

@@ -0,0 +1,18 @@
+require "singleton"
+
+module S3DirectUpload
+  class Config
+    include Singleton
+
+    ATTRIBUTES = [:access_key_id, :secret_access_key, :bucket]
+
+    attr_accessor *ATTRIBUTES
+  end
+
+  def self.config
+    if block_given?
+      yield Config.instance
+    end
+    Config.instance
+  end
+end

data/lib/s3_direct_upload/engine.rb

@@ -0,0 +1,4 @@
+module S3DirectUpload
+  class Engine < ::Rails::Engine 
+  end
+end

data/lib/s3_direct_upload/form_helper.rb

@@ -0,0 +1,84 @@
+module S3DirectUpload
+  module UploadHelper
+    def s3_uploader_form(options = {}, &block)
+      uploader = S3Uploader.new(options)
+      form_tag(uploader.url, uploader.form_options) do
+        uploader.fields.map do |name, value|
+          hidden_field_tag(name, value)
+        end.join.html_safe + capture(&block)
+      end
+    end
+
+    class S3Uploader
+      def initialize(options)
+        @options = options.reverse_merge(
+          id: "fileupload",
+          aws_access_key_id: S3DirectUpload.config.access_key_id,
+          aws_secret_access_key: S3DirectUpload.config.secret_access_key,
+          bucket: S3DirectUpload.config.bucket,
+          acl: "public-read",
+          expiration: 10.hours.from_now,
+          max_file_size: 500.megabytes,
+          as: "file"
+        )
+      end
+
+      def form_options
+        {
+          id: @options[:id],
+          method: "post",
+          authenticity_token: false,
+          multipart: true,
+          data: {
+            post: @options[:post],
+            as: @options[:as]
+          }
+        }
+      end
+
+      def fields
+        {
+          :key => key,
+          :acl => @options[:acl],
+          :policy => policy,
+          :signature => signature,
+          "AWSAccessKeyId" => @options[:aws_access_key_id],
+        }
+      end
+
+      def key
+        @key ||= "uploads/#{SecureRandom.hex}/${filename}"
+      end
+
+      def url
+        "https://#{@options[:bucket]}.s3.amazonaws.com/"
+      end
+
+      def policy
+        Base64.encode64(policy_data.to_json).gsub("\n", "")
+      end
+
+      def policy_data
+        {
+          expiration: @options[:expiration],
+          conditions: [
+            ["starts-with", "$utf8", ""],
+            ["starts-with", "$key", ""],
+            ["content-length-range", 0, @options[:max_file_size]],
+            {bucket: @options[:bucket]},
+            {acl: @options[:acl]}
+          ]
+        }
+      end
+
+      def signature
+        Base64.encode64(
+          OpenSSL::HMAC.digest(
+            OpenSSL::Digest::Digest.new('sha1'),
+            @options[:aws_secret_access_key], policy
+          )
+        ).gsub("\n", "")
+      end
+    end
+  end
+end

data/lib/s3_direct_upload/version.rb

@@ -0,0 +1,3 @@
+module S3DirectUpload
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: s3_direct_upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- WayneH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: jquery-fileupload-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description: Direct Upload to Amazon S3 With CORS and jquery-file-upload
+email:
+- wayne@blissofbeing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/s3_direct_upload/config_aws.rb
+- lib/s3_direct_upload/engine.rb
+- lib/s3_direct_upload/form_helper.rb
+- lib/s3_direct_upload/version.rb
+- lib/s3_direct_upload.rb
+- app/assets/javascripts/s3_direct_upload.js.coffee
+- app/assets/stylesheets/s3_direct_upload_progress_bars.css.scss
+- LICENSE
+- README.md
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gives a form helper for Rails which allows direct uploads to s3. Based on
+  RailsCast#383
+test_files: []