s3_direct_upload 0.0.8 → 0.1.0

data/README.md

@@ -66,7 +66,7 @@ jQuery ->
 Optionally, you can also place this template in the same view for the progress bars:
 ```js+erb
 <script id="template-upload" type="text/x-tmpl">
-<div class="upload">
+<div id="file-{%=o.unique_id%}" class="upload">
   {%=o.name%}
   <div class="progress"><div class="bar" style="width: 0%"></div></div>
 </div>
@@ -77,6 +77,7 @@ Optionally, you can also place this template in the same view for the progress b
 * `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.
 * `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.
@@ -116,12 +117,13 @@ Use the javascript in `s3_direct_upload` as a guide.
 ## Options for S3Upload jQuery Plugin
 
 * `path:` manual path for the files on your s3 bucket. Example: `path/to/my/files/on/s3`
-  Note: the file path in your s3 bucket will effectively be `path + key`.
-* `additional_data:` You can send additional data to your rails app in the persistence POST request. This would be accessable in your params hash as  `params[:key][:value]`
+  Note: Your path MUST start with the option you put in your form builder for `key_starts_with`, or else you will get S3 permission errors. The file path in your s3 bucket will be `path + key`.
+* `additional_data:` You can send additional data to your rails app in the persistence POST request. This would be accessible in your params hash as  `params[:key][:value]`
   Example: `{key: value}`
 * `remove_completed_progress_bar:` By default, the progress bar will be removed once the file has been successfully uploaded. You can set this to `false` if you want to keep the progress bar.
 * `remove_failed_progress_bar:` By default, the progress bar will not be removed when uploads fail. You can set this to `true` if you want to remove the progress bar.
 * `before_add:` Callback function that executes before a file is added to the queue. It is passed file object and expects `true` or `false` to be returned. This could be useful if you would like to validate the filenames of files to be uploaded for example. If true is returned file will be uploaded as normal, false will cancel the upload.
+* `progress_bar_target:` The jQuery selector for the element where you want the progress bars to be appended to. Default is the form element.
 
 ### Example with all options.
 ```coffeescript
@@ -131,6 +133,7 @@ jQuery ->
     additional_data: {key: 'value'}
     remove_completed_progress_bar: false
     before_add: myCallBackFunction() # must return true or false if set
+    progress_bar_target: $('.js-progress-bars')
 ```
 
 ### Public methods
@@ -140,7 +143,7 @@ You can change the settings on your form later on by accessing the jQuery instan
 jQuery ->
   v = $("#myS3Uploader").S3Uploader()
   ...
-  v.path("new/path/")
+  v.path("new/path/") #only works when the key_starts_with option is blank. Not recommended.
   v.additional_data("newdata")
 ```
 
@@ -154,7 +157,7 @@ $('#myS3Uploader').bind 's3_uploads_start', (e) ->
 ```
 
 #### Successfull upload
-When a file has been successfully to S3, the `s3_upload_complete` is triggered on the form. A `content` object is passed along with the following attributes :
+When a file has been successfully uploaded to S3, the `s3_upload_complete` is triggered on the form. A `content` object is passed along with the following attributes :
 
 * `url`       The full URL to the uploaded file on S3.
 * `filename`  The original name of the uploaded file.

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

@@ -20,6 +20,7 @@ $.fn.S3Uploader = (options) ->
     before_add: null
     remove_completed_progress_bar: true
     remove_failed_progress_bar: false
+    progress_bar_target: null
 
   $.extend settings, options
 
@@ -31,9 +32,11 @@ $.fn.S3Uploader = (options) ->
       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)) if $('#template-upload').length > 0
-          $uploadForm.append(data.context)
+          $(data.context).appendTo(settings.progress_bar_target || $uploadForm)
           data.submit()
 
       start: (e) ->
@@ -100,6 +103,7 @@ $.fn.S3Uploader = (options) ->
     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 = $.extend content, settings.additional_data if settings.additional_data
     content
 

data/lib/s3_direct_upload/form_helper.rb

@@ -20,6 +20,7 @@ module S3DirectUpload
           expiration: 10.hours.from_now.utc.iso8601,
           max_file_size: 500.megabytes,
           as: "file",
+          key_starts_with: "uploads/",
           key: key
         )
       end
@@ -67,7 +68,7 @@ module S3DirectUpload
           expiration: @options[:expiration],
           conditions: [
             ["starts-with", "$utf8", ""],
-            ["starts-with", "$key", ""],
+            ["starts-with", "$key", @options[:key_starts_with]],
             ["starts-with", "$x-requested-with", ""],
             ["content-length-range", 0, @options[:max_file_size]],
             ["starts-with","$Content-Type",""],

data/lib/s3_direct_upload/version.rb

@@ -1,3 +1,3 @@
 module S3DirectUpload
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_direct_upload
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails