s3_direct_upload 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac508f7f1f70b53e01a6aec5262aaa6cf0917b8
-  data.tar.gz: 90a7b3026a49c8a7750f24fb783544474685e4a1
+  metadata.gz: 6055f6f92f61ced275e84e740a348ad62113b645
+  data.tar.gz: 4a6c469db655a9fa46393dffcb4f5d5eab39902f
 SHA512:
-  metadata.gz: 798ccce1f9b4f316df8f1b66028dad0a46e1331f8c87410cb5a1e57d16652aef642f48a96dea008ed1a8a71f3d69f9629ba1110d54219abd75fca9f2a8c0a68e
-  data.tar.gz: 3abaa659fe3cea8190d143904eb1b6ed7c222da37cc49451199ad601e2fa07a492e05580efb57db93f7616a86304623b2abeea078ff118aaaf8b7c855d053c16
+  metadata.gz: 5eb5f0027b3b157a671d5b18642ac701bef3cce5b5f040c7d356d4a6dac281cfb1ff8c8926af138bef8150ea4ef6900d51d164ff1ed7b58f60bc857e7c0271f2
+  data.tar.gz: b4ba9c5092b06d35018b116660e260f433a39c26186261d92d4fa90b783b57be65c84200ec49489698968d6318c2f0251e7fbfc1d036c9fe0d7ada347ce51107

data/README.md

@@ -1,5 +1,7 @@
 # S3DirectUpload
 
+[![Build Status](https://travis-ci.org/waynehoover/s3_direct_upload.png)](https://travis-ci.org/waynehoover/s3_direct_upload)
+
 Easily generate a form that allows you to upload directly to Amazon S3.
 Multi file uploading supported by jquery-fileupload.
 
@@ -18,7 +20,7 @@ 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
-  c.region = nil             # region prefix of your bucket url (optional), eg. "s3-eu-west-1"
+  c.region = nil             # region prefix of your bucket url. This is _required_ for the non-default AWS region, eg. "s3-eu-west-1"
   c.url = nil                # S3 API endpoint (optional), eg. "https://#{c.bucket}.s3.amazonaws.com/"
 end
 ```
@@ -53,7 +55,7 @@ Add the following js and css to your asset pipeline:
 ## Usage
 Create a new view that uses the form helper `s3_uploader_form`:
 ```ruby
-<%= s3_uploader_form callback_url: model_url, callback_param: "model[image_url]", id: "myS3Uploader" do %>
+<%= s3_uploader_form callback_url: model_url, callback_param: "model[image_url]", id: "s3-uploader" do %>
   <%= file_field_tag :file, multiple: true %>
 <% end %>
 ```
@@ -63,7 +65,7 @@ Note: Its required that the file_field_tag is named 'file'.
 Then in your application.js.coffee, call the S3Uploader jQuery plugin on the element you created above:
 ```coffeescript
 jQuery ->
-  $("#myS3Uploader").S3Uploader()
+  $("#s3-uploader").S3Uploader()
 ```
 
 Optionally, you can also place this template in the same view for the progress bars:
@@ -77,21 +79,38 @@ Optionally, you can also place this template in the same view for the progress b
 ```
 
 ## Options for form helper
-* `callback_url:` url that is POST'd to after file is uploaded to S3. If you don't specify this option, no callback to the server will be made after the file has uploaded to S3.
-* `callback_method:` Defaults to POST. Use PUT and remove the multiple option from your file field to update a model.
-* `callback_param:` parameter value for the POST in which the key will be the URL of the file on S3. If for example this is set to "model[image_url]" then the data posted would be `model[image_url] : http://bucketname.s3.amazonws.com/filename.ext`
-* `key:` key on s3. defaults to `"uploads/{timestamp}-{unique_id}-#{SecureRandom.hex}/${filename}"`. `{timestamp}` and `{unique_id}` are special substitution params that will be populated by the javascript with values for the current upload. `${filename}` is a special s3 param that will be populated with the original upload file name. Needs to be at least `"${filename}"`. It is highly recommended to use both `{unique_id}`, which will prevent collisions when uploading files with the same name (such as from a mobile device, where every photo is named image.jpg), and a server-generated random value such as `#{SecureRandom.hex}`, which adds further collision protection with other uploaders.
-* `key_starts_with:` constraint on key on s3. Defaults to `uploads/`. if you change the `key` option, make sure this starts with what you put there. If you set this as a blank string the upload path to s3 can be anything - not recommended!
-* `acl:` acl for files uploaded to s3, defaults to "public-read"
-* `max_file_size:` maximum file size, defaults to 500.megabytes
-* `id:` html id for the form, its recommended that you give the form an id so you can reference with the jQuery plugin.
-* `class:` optional html class for the form.
-* `data:` Optional html data
-
-### Persisting the S3 url
-It is recommended that you persist the image_url that is sent back from the POST request (to the url given to the `post` option and as the key given in the `as` option). So to access your files later.
-
-One way to do this is to make sure you have `resources model` in your routes file, and add the `image_url` (or whatever you would like to name it) attribute to your model, and then make sure you have the create action in your controller for that model.
+* `callback_url:` No default. The url that is POST'd to after file is uploaded to S3. If you don't specify this option, no callback to the server will be made after the file has uploaded to S3.
+* `callback_method:` Defaults to `POST`. Use PUT and remove the multiple option from your file field to update a model.
+* `callback_param:` Defaults to `file`. Parameter key for the POST to `callback_url` the value will be the full s3 url of the file. If for example this is set to "model[image_url]" then the data posted would be `model[image_url] : http://bucketname.s3.amazonws.com/filename.ext`
+* `key:` Defaults to `uploads/{timestamp}-{unique_id}-#{SecureRandom.hex}/${filename}`. It is the key, or filename used on s3. `{timestamp}` and `{unique_id}` are special substitution strings that will be populated by javascript with values for the current upload. `${filename}` is a special s3 string that will be populated with the original uploaded file name. Needs to be at least `"${filename}"`. It is highly recommended to use both `{unique_id}`, which will prevent collisions when uploading files with the same name (such as from a mobile device, where every photo is named image.jpg), and a server-generated random value such as `#{SecureRandom.hex}`, which adds further collision protection with other uploaders.
+* `key_starts_with:` Defaults to `uploads/`. Constraint on the key on s3.  if you change the `key` option, make sure this starts with what you put there. If you set this as a blank string the upload path to s3 can be anything - not recommended!
+* `acl:` Defaults to `public-read`. The AWS acl for files uploaded to s3.
+* `max_file_size:` Defaults to `500.megabytes`. Maximum file size allowed.
+* `id:` Optional html id for the form, its recommended that you give the form an id so you can reference with the jQuery plugin.
+* `class:` Optional html class for the form.
+* `data:` Optional html data attribute hash.
+* `bucket:` Optional (defaults to bucket used in config).
+
+### Example with all options
+```ruby
+<%= s3_uploader_form callback_url: model_url, 
+                     callback_method: "POST", 
+                     callback_param: "model[image_url]", 
+                     key: "files/{timestamp}-{unique_id}-#{SecureRandom.hex}/${filename}", 
+                     key_starts_with: "files/", 
+                     acl: "public-read", 
+                     max_file_size: 50.megabytes, 
+                     id: "s3-uploader", 
+                     class: "upload-form", 
+                     data: {:key => :val} do %>
+  <%= file_field_tag :file, multiple: true %>
+<% end %>
+```
+
+### Example to persist the S3 url in your rails app
+It is recommended that you persist the url that is sent via the POST request (to the url given to the `callback_url` option and as the key given in the `callback_param` option).
+
+One way to do this is to make sure you have `resources model` in your routes file, and add a `s3_url` (or something similar) attribute to your model. Then make sure you have the create action in your controller for that model that saves the url from the callback_param.
 
 You could then have your create action render a javascript file like this:
 **create.js.erb**
@@ -130,14 +149,14 @@ Use the javascript in `s3_direct_upload` as a guide.
 * `progress_bar_target:` The jQuery selector for the element where you want the progress bars to be appended to. Default is the form element.
 * `click_submit_target:` The jQuery selector for the element you wish to add a click handler to do the submitting instead of submiting on file open.
 
-### Example with all options.
+### Example with all options
 ```coffeescript
 jQuery ->
   $("#myS3Uploader").S3Uploader
     path: 'path/to/my/files/on/s3'
     additional_data: {key: 'value'}
     remove_completed_progress_bar: false
-    before_add: myCallBackFunction() # must return true or false if set
+    before_add: myCallBackFunction # must return true or false if set
     progress_bar_target: $('.js-progress-bars')
     click_submit_target: $('.submit-target')
 ```
@@ -230,7 +249,7 @@ rake task.
 
 First, add the fog gem to your `Gemfile` and run `bundle`:
 ```ruby
-  require 'fog'
+  gem 'fog'
 ```
 
 Then, run the rake task to delete uploads older than 2 days:
@@ -254,6 +273,15 @@ Alternately, if you'd prefer for S3 to delete your old uploads automatically, yo
 so by setting your bucket's
 [Lifecycle Configuration](http://docs.aws.amazon.com/AmazonS3/latest/UG/LifecycleConfiguration.html).
 
+## A note on IE support
+IE file uploads are working but with a couple caveats.
+
+* The before_add callback doesn't work.
+* The progress bar doesn't work on IE.
+
+But IE should still upload your files fine.
+
+
 ## 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.

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

@@ -101,10 +101,17 @@ $.fn.S3Uploader = (options) ->
           name: "content-type"
           value: fileType
 
-        key = $uploadForm.data("key").replace('{timestamp}', new Date().getTime()).replace('{unique_id}', @files[0].unique_id)
+        key = $uploadForm.data("key")
+          .replace('{timestamp}', new Date().getTime())
+          .replace('{unique_id}', @files[0].unique_id)
+          .replace('{extension}', @files[0].name.split('.').pop())
 
         # substitute upload timestamp and unique_id into key
-        data[1].value = settings.path + key
+        key_field = $.grep data, (n) ->
+          n if n.name == "key"
+
+        if key_field.length > 0
+          key_field[0].value = settings.path + key
 
         # IE <= 9 doesn't have XHR2 hence it can't use formData
         # replace 'key' field to submit form
@@ -115,18 +122,19 @@ $.fn.S3Uploader = (options) ->
   build_content_object = ($uploadForm, file, result) ->
     content = {}
     if result # Use the S3 response to set the URL to avoid character encodings bugs
-      content.url      = $(result).find("Location").text()
-      content.filepath = $('<a />').attr('href', content.url)[0].pathname
-    else # IE <= 9 return a null result object so we use the file object instead
-      domain           = $uploadForm.attr('action')
-      content.filepath = $uploadForm.find('input[name=key]').val().replace('/${filename}', '')
-      content.url      = domain + content.filepath + '/' + encodeURIComponent(file.name)
-
-    content.filename   = file.name
-    content.filesize   = file.size if 'size' of file
-    content.filetype   = file.type if 'type' of file
-    content.unique_id  = file.unique_id if 'unique_id' of file
-    content.relativePath = build_relativePath(file) if has_relativePath(file)
+      content.url            = $(result).find("Location").text()
+      content.filepath       = $('<a />').attr('href', content.url)[0].pathname
+    else # IE <= 9 retu      rn a null result object so we use the file object instead
+      domain                 = $uploadForm.attr('action')
+      content.filepath       = $uploadForm.find('input[name=key]').val().replace('/${filename}', '')
+      content.url            = domain + content.filepath + '/' + encodeURIComponent(file.name)
+
+    content.filename         = file.name
+    content.filesize         = file.size if 'size' of file
+    content.lastModifiedDate = file.lastModifiedDate if 'lastModifiedDate' of file
+    content.filetype         = file.type if 'type' of file
+    content.unique_id        = file.unique_id if 'unique_id' of file
+    content.relativePath     = build_relativePath(file) if has_relativePath(file)
     content = $.extend content, settings.additional_data if settings.additional_data
     content
 

data/lib/s3_direct_upload/form_helper.rb

@@ -15,7 +15,7 @@ module S3DirectUpload
         @options = options.reverse_merge(
           aws_access_key_id: S3DirectUpload.config.access_key_id,
           aws_secret_access_key: S3DirectUpload.config.secret_access_key,
-          bucket: S3DirectUpload.config.bucket,
+          bucket: options[:bucket] || S3DirectUpload.config.bucket,
           region: S3DirectUpload.config.region || "s3",
           url: S3DirectUpload.config.url,
           ssl: true,
@@ -76,7 +76,7 @@ module S3DirectUpload
             ["starts-with", "$key", @options[:key_starts_with]],
             ["starts-with", "$x-requested-with", ""],
             ["content-length-range", 0, @options[:max_file_size]],
-            ["starts-with","$content-type",""],
+            ["starts-with","$content-type", @options[:content_type_starts_with] ||""],
             {bucket: @options[:bucket]},
             {acl: @options[:acl]},
             {success_action_status: "201"}
@@ -87,7 +87,7 @@ module S3DirectUpload
       def signature
         Base64.encode64(
           OpenSSL::HMAC.digest(
-            OpenSSL::Digest::Digest.new('sha1'),
+            OpenSSL::Digest.new('sha1'),
             @options[:aws_secret_access_key], policy
           )
         ).gsub("\n", "")

data/lib/s3_direct_upload/version.rb

@@ -1,3 +1,3 @@
 module S3DirectUpload
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: s3_direct_upload
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Wayne Hoover
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.5
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: jquery-fileupload-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
 description: Direct Upload to Amazon S3 With CORS and jquery-file-upload
@@ -73,17 +73,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- app/assets/javascripts/s3_direct_upload.js.coffee
+- app/assets/stylesheets/s3_direct_upload_progress_bars.css.scss
+- lib/s3_direct_upload.rb
 - lib/s3_direct_upload/config_aws.rb
 - lib/s3_direct_upload/engine.rb
 - lib/s3_direct_upload/form_helper.rb
 - lib/s3_direct_upload/railtie.rb
 - lib/s3_direct_upload/version.rb
-- lib/s3_direct_upload.rb
 - lib/tasks/s3_direct_upload.rake
-- app/assets/javascripts/s3_direct_upload.js.coffee
-- app/assets/stylesheets/s3_direct_upload_progress_bars.css.scss
-- LICENSE
-- README.md
 homepage: ''
 licenses: []
 metadata: {}
@@ -93,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gives a form helper for Rails which allows direct uploads to s3. Based on