s3_cors_fileupload 0.1.2 → 0.1.4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.1.4
+
+  - Added a `data-confirmation` option to the delete buttons and functionality to the jQuery-File-Upload UI's destroy callback that picks up the contents of that attribute to use as a confirmation dialog.  (Fixed the implementation from v0.1.3)  [See the README notes for more details](https://github.com/fullbridge-batkins/s3_cors_fileupload#notes).
+
+## 0.1.3 (Yanked)
+  
+  - Improving install generator so that generation of the migration file is optional.
+  - Removed some unnecessary code on some of the generator templates.
+  
 ## 0.1.2
 
   - Modified the FormHelper so that view helper method is named `s3_cors_fileupload_form_tag` (instead of `s3_cors_fileupload_form`) to maintain consistency with the rest of ActionView's view helpers.

data/README.md

@@ -16,7 +16,12 @@ and views for the file uploading.
 
     bundle exec rails generate s3_cors_fileupload:install
 
-Now run the migration that was just generated:
+If you don't want to generate a migration (for instance if you've already run the install generator in the past),
+you can pass in an options `--skip-migration` like so:
+
+   bundle exec rails generate s3_cors_fileupload:install --skip-migration
+
+If you chose to generate a migration, run it now:
 
     bundle exec rake db:migrate
 
@@ -88,12 +93,12 @@ the UI version of the [jQuery-File-Upload javascript](http://blueimp.github.com/
 This view helper accepts the following options:
 
 * `:access_key_id` - The AWS Access Key ID of the owner of the bucket.  Defaults to the `Config.access_key_id` (read from the `config/amazon_s3.yml` config file).
-* `:acl` - One of S3's Canned Access Control Lists, must be one of: 'private', 'public-read', 'public-read-write', 'authenticated-read'.  Defaults to `'public-read'`.
+* `:acl` - One of S3's Canned Access Control Lists, must be one of: `'private'`, `'public-read'`, `'public-read-write'`, `'authenticated-read'`.  Defaults to `'public-read'`.
 * `:max_file_size` - The max file size (in bytes) that you wish to allow to be uploaded.  Defaults to `Config.max_file_size` (read from the `config/amazon_s3.yml` config file) or, if no value is set on the `config/amazon_s3.yml` file, defaults to `524288000` (500 MB)
 * `:bucket` - The name of the bucket on S3 you wish for the files to be uploaded to.  Defaults to `Config.bucket` (read from the `config/amazon_s3.yml` config file).
 * Any other key creates standard HTML options for the form tag.
 
-For an example of how to use the helper, see the file located at `app/views/s3_uploads/index.html.erb` that
+For an example of how to use the form view helper, see the file located at `app/views/s3_uploads/index.html.erb` that
 the install generator produces.
 
 ## Notes
@@ -106,6 +111,14 @@ places throughout your application, you may want look into using a gem such as
 [twitter-bootstrap-rails](https://github.com/seyhunak/twitter-bootstrap-rails), which allows you to inject
 the stylesheets and javascripts from bootstrap into the asset pipeline.
 
+I have made a slight modification to the jQuery-File-Upload-UI so that the destroy button accepts an optional `data-confirmation`
+attribute, which in turn causes it to show a confirmation dialog to the user before the destroy action happens.  This functionality
+mimics that of Rails's built in [jquery-ujs behavior for `data-confirm`](https://github.com/rails/jquery-ujs/wiki/Unobtrusive-scripting-support-for-jQuery)
+attributes on forms (I named this one `data-confirmation` to prevent jquery-ujs from conflicts).
+The code for this was based off of [pull request #1127 to the jQuery-File-Upload project](https://github.com/blueimp/jQuery-File-Upload/pull/1127),
+which appears to have been rejected by the author of jQuery-File-Upload, but seems appropriate for rails.  If you wish not to use it,
+simply remove the `data-confirm` attribute from the destroy button on `_template_uploaded.html.erb` in the views directory.
+
 ## Contributing to S3CorsFileupload
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/generators/s3_cors_fileupload/install/install_generator.rb

@@ -9,7 +9,7 @@ module S3CorsFileupload
       extend ActiveRecord::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
-      # class_option :with_controller, :type => :boolean, :default => false, :desc => "Generate controller, views, and routes"
+      class_option :migration, :type => :boolean, :default => true, :desc => "Generate a migration for the SourceFile model."
 
       desc('Creates a config file, then generates (but does not run) a migration to add a source_files table and ' +
             'a corresponding model, as well as a controller, routes, and views for the file uploading.')
@@ -19,7 +19,7 @@ module S3CorsFileupload
       end
 
       def create_migration_file
-        migration_template 'create_source_files.rb', 'db/migrate/create_source_files.rb'
+        migration_template 'create_source_files.rb', 'db/migrate/create_source_files.rb' if options.migration?
       end
 
       def create_model_file
@@ -27,7 +27,6 @@ module S3CorsFileupload
       end
 
       def create_controller
-        # if options.with_controller?
         copy_file 's3_uploads_controller.rb', 'app/controllers/s3_uploads_controller.rb'
         copy_file 's3_uploads.js', 'app/assets/javascripts/s3_uploads.js'
       end

data/lib/generators/s3_cors_fileupload/install/templates/s3_uploads_controller.rb

@@ -1,11 +1,4 @@
-require 'base64'
-require 'openssl'
-require 'digest/sha1'
-
 class S3UploadsController < ApplicationController
-
-  helper_method :s3_upload_policy_document, :s3_upload_signature
-
   # GET /source_files
   # GET /source_files.json
   def index
@@ -58,33 +51,4 @@ class S3UploadsController < ApplicationController
       success_action_redirect: "/"
     }
   end
-
-  # ---- Helpers ----
-  # generate the policy document that amazon is expecting.
-  def s3_upload_policy_document
-    Base64.encode64(
-      {
-        expiration: 1.hour.from_now.utc.strftime('%Y-%m-%dT%H:%M:%S.000Z'),
-        conditions: [
-          { bucket: S3CorsFileupload::Config.bucket },
-          { acl: 'public-read' },
-          { success_action_status: '201' },
-          ["starts-with", "$key", ""],
-          ["starts-with", "$Content-Type", ""]
-        ]
-      }.to_json
-    ).gsub(/\n|\r/, '')
-  end
-
-  # sign our request by Base64 encoding the policy document.
-  def s3_upload_signature
-    Base64.encode64(
-      OpenSSL::HMAC.digest(
-        OpenSSL::Digest::Digest.new('sha1'),
-        S3CorsFileupload::Config.secret_access_key,
-        s3_upload_policy_document
-      )
-    ).gsub(/\n/, '')
-  end
-
 end

data/lib/generators/s3_cors_fileupload/install/templates/views/_template_download.html.erb

@@ -18,7 +18,7 @@
         <td colspan="2"></td>
         {% } %}
       <td class="delete">
-        <button class="btn btn-danger" data-type="{%=file.delete_type%}" data-url="{%=file.delete_url%}">
+        <button class="btn btn-danger" data-type="{%=file.delete_type%}" data-url="{%=file.delete_url%}" data-confirmation="Are you sure?">
           <i class="icon-trash icon-white"></i>
           <span>Delete</span>
         </button>

data/lib/generators/s3_cors_fileupload/install/templates/views/_template_uploaded.html.erb

@@ -15,7 +15,7 @@
     <td class="size"><span>{%=formatFileSize(o.size)%}</span></td>
     <td colspan="2"></td>
     <td class="delete">
-      <button class="btn btn-danger" data-type="DELETE" data-url="{%=o.delete_url%}">
+      <button class="btn btn-danger" data-type="DELETE" data-url="{%=o.delete_url%}" data-confirmation="Are you sure?">
         <i class="icon-trash icon-white"></i>
         <span>Delete</span>
       </button>

data/lib/s3_cors_fileupload/rails/config.rb

@@ -1,6 +1,7 @@
+require 'yaml'
+
 module S3CorsFileupload
   module Config
-    require 'yaml'
 
     # this allows us to lazily instantiate the configuration by reading it in when it needs to be accessed
     class << self

data/lib/s3_cors_fileupload/rails/form_helper.rb

@@ -34,13 +34,13 @@ module S3CorsFileupload
     end
 
     alias_method :s3_cors_fileupload_form, :s3_cors_fileupload_form_tag
-    
+
     private
-    
+
     def build_form_options(options = {})
       { :id => 'fileupload' }.merge(options).merge(:multipart => true, :authenticity_token => false)
     end
-    
+
     # hidden fields argument should be a hash of key value pairs (values may be blank if desired)
     def construct_form_html(hidden_fields, bucket, html_options = {}, &block)
       # now build the html for the form

data/lib/s3_cors_fileupload/rails/policy_helper.rb

@@ -6,7 +6,7 @@ require 'json'
 module S3CorsFileupload
   class PolicyHelper
     attr_reader :options
-    
+
     def initialize(_options = {})
       # default max_file_size to 500 MB if nothing is received
       @options = {
@@ -15,7 +15,7 @@ module S3CorsFileupload
         :bucket => Config.bucket
       }.merge(_options).merge(:secret_access_key => Config.secret_access_key)
     end
-    
+
     # generate the policy document that amazon is expecting.
     def policy_document
       Base64.encode64(

data/lib/s3_cors_fileupload/version.rb

@@ -1,5 +1,5 @@
 module S3CorsFileupload
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
   JQUERY_FILEUPLOAD_VERSION = '5.19'
   JQUERY_FILEUPLOAD_UI_VERSION = '6.10'
 end

data/s3_cors_fileupload.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["benatkins@fullbridge.com"]
   s.homepage    = "http://github.com/fullbridge-batkins/s3_cors_fileupload"
   s.summary     = "File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload script"
-  s.description = "A gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload script"
+  s.description = "Provides file uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload javascript"
   s.licenses    = ["MIT"]
   
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=

data/vendor/assets/javascripts/s3_cors_fileupload/jquery.fileupload-ui.js

@@ -293,6 +293,8 @@
             },
             // Callback for file deletion:
             destroy: function (e, data) {
+                if (data.confirm && !confirm(data.confirm))
+                  return; // abort the deletion if the user rejects the confirmation dialog
                 var that = $(this).data('fileupload');
                 if (data.url) {
                     $.ajax(data);
@@ -537,6 +539,7 @@
                 context: button.closest('.template-download'),
                 url: button.attr('data-url'),
                 type: button.attr('data-type') || 'DELETE',
+                confirm: button.attr('data-confirmation'),
                 dataType: this.options.dataType
             });
         },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_cors_fileupload
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-30 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,8 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via CORS
-  using the jQuery-File-Upload script
+description: Provides file uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload
+  javascript
 email:
 - benatkins@fullbridge.com
 executables: []