s3_direct_upload 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d19e2b36016e3829e3f284c860489d83aaacee7e
-  data.tar.gz: b30b925f450271bc8e6980df7c780056a26f40fc
+  metadata.gz: e1ed6e265b4f74392b3fc0ab3c58b22a19041e61
+  data.tar.gz: 60545e543bac0c5feadf0abd5e5ce268b276e214
 SHA512:
-  metadata.gz: ed39347ebba94448f41ca01a13fc92bcd4c2bfd4bc572b33ffd5e1838a83cda3bba8cc5a819f4727e298db9fcaa298404c80ca0f2e7492403519097b47e08ee0
-  data.tar.gz: c4c4a4c93ed56e2a97725c453f67c40465f3962dcf86b75f36d4c9990b5f4729a03ecdde0faa0c6fe311164dcf7ba3c40aaad111be338ae89314dda06fe2a34c
+  metadata.gz: 4550009b9508b104ec290b3c70a7a6f1263b183c262e1e2e519beb7c8d4ee1b69c747c67c51e0d3e8e6e0619e8de98b3daf666ebe1a536b824934800a41a6c59
+  data.tar.gz: 60c03de6349abdcceadc9e7a03212d26fad2a5c31b50e8d79d78800522e628607a6d3ef343e7801b0739f1ce46eafd9503479e4a14aba6e503a37f967d6da01a

data/README.md

@@ -52,7 +52,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 post: model_url, as: "model[image_url]", id: "myS3Uploader" do %>
+<%= s3_uploader_form callback_url: model_url, callback_param: "model[image_url]", id: "myS3Uploader" do %>
   <%= file_field_tag :file, multiple: true %>
 <% end %>
 ```
@@ -74,10 +74,11 @@ Optionally, you can also place this template in the same view for the progress b
 ```
 
 ## Options for form helper
-* `post:` url in which 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.
-* `as:` 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/#{SecureRandom.hex}/${filename}"`. needs to be at least `"${filename}"`.
-* `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, so be careful.
+* `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.
@@ -223,6 +224,10 @@ S3DirectUpload.config do |c|
 end
 ```
 
+Alternately, if you'd prefer for S3 to delete your old uploads automatically, you can do
+so by setting your bucket's 
+[Lifecycle Configuration](http://docs.aws.amazon.com/AmazonS3/latest/UG/LifecycleConfiguration.html).
+
 ## 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

@@ -28,25 +28,25 @@ $.fn.S3Uploader = (options) ->
   current_files = []
   forms_for_submit = []
   if settings.click_submit_target
-    settings.click_submit_target.click -> 
+    settings.click_submit_target.click ->
       form.submit() for form in forms_for_submit
-      false 
+      false
 
   setUploadForm = ->
     $uploadForm.fileupload
 
       add: (e, data) ->
-        current_files.push data
         file = data.files[0]
         file.unique_id = Math.random().toString(36).substr(2,16)
 
         unless settings.before_add and not settings.before_add(file)
-          data.context = $(tmpl("template-upload", file).trim()) if $('#template-upload').length > 0
+          current_files.push data
+          data.context = $($.trim(tmpl("template-upload", file))) if $('#template-upload').length > 0
           $(data.context).appendTo(settings.progress_bar_target || $uploadForm)
           if settings.click_submit_target
            forms_for_submit.push data
           else
-            data.submit()            
+            data.submit()
 
       start: (e) ->
         $uploadForm.trigger("s3_uploads_start", [e])
@@ -59,12 +59,12 @@ $.fn.S3Uploader = (options) ->
       done: (e, data) ->
         content = build_content_object $uploadForm, data.files[0], data.result
 
-        to = $uploadForm.data('post')
+        to = $uploadForm.data('callback-url')
         if to
-          content[$uploadForm.data('as')] = content.url
+          content[$uploadForm.data('callback-param')] = content.url
 
           $.ajax
-            type: 'POST'
+            type: $uploadForm.data('callback-method')
             url: to
             data: content
             beforeSend: ( xhr, settings )       -> $uploadForm.trigger( 'ajax:beforeSend', [xhr, settings] )
@@ -96,7 +96,9 @@ $.fn.S3Uploader = (options) ->
           name: "Content-Type"
           value: fileType
 
-        data[1].value = settings.path + data[1].value #the key
+        # substitute upload timestamp and unique_id into key
+        key = data[1].value.replace('{timestamp}', new Date().getTime()).replace('{unique_id}', @files[0].unique_id)
+        data[1].value = settings.path + key
         data
 
   build_content_object = ($uploadForm, file, result) ->

data/lib/s3_direct_upload/form_helper.rb

@@ -11,6 +11,7 @@ module S3DirectUpload
 
     class S3Uploader
       def initialize(options)
+        @key_starts_with = options[:key_starts_with] || "uploads/"
         @options = options.reverse_merge(
           aws_access_key_id: S3DirectUpload.config.access_key_id,
           aws_secret_access_key: S3DirectUpload.config.secret_access_key,
@@ -20,8 +21,9 @@ module S3DirectUpload
           acl: "public-read",
           expiration: 10.hours.from_now.utc.iso8601,
           max_file_size: 500.megabytes,
-          as: "file",
-          key_starts_with: "uploads/",
+          callback_method: "POST",
+          callback_param: "file",
+          key_starts_with: @key_starts_with,
           key: key
         )
       end
@@ -34,8 +36,9 @@ module S3DirectUpload
           authenticity_token: false,
           multipart: true,
           data: {
-            post: @options[:post],
-            as: @options[:as]
+            callback_url: @options[:callback_url],
+            callback_method: @options[:callback_method],
+            callback_param: @options[:callback_param]
           }.reverse_merge(@options[:data] || {})
         }
       end
@@ -53,7 +56,7 @@ module S3DirectUpload
       end
 
       def key
-        @key ||= "uploads/#{DateTime.now.utc.strftime("%Y%m%dT%H%MZ")}_#{SecureRandom.hex}/${filename}"
+        @key ||= "#{@key_starts_with}{timestamp}-{unique_id}-#{SecureRandom.hex}/${filename}"
       end
 
       def url

data/lib/s3_direct_upload/version.rb

@@ -1,3 +1,3 @@
 module S3DirectUpload
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_direct_upload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Wayne Hoover
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails