s3-upnow 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c130dadc4b2ed0be86811b4b029c7539a3265cd8
-  data.tar.gz: a8c1aba09a3f422360bbe1abdc5b58f151a7dab4
+SHA256:
+  metadata.gz: 041a97c9289dd68106c4fd1696f7cfa55542e6f02faa1e90d69a4bb871e65265
+  data.tar.gz: a45b9f03c72ea6e1475db27424824fbdfe4a441980e0cfbdf451583c50da6b5e
 SHA512:
-  metadata.gz: f3936e913d8dbeb45fea532dc0c1dbb7d6ce2871b404acfb8b685f8920a473b8bb336f87b525bca0fd18971af5b73c290a75b5bdab9791c8c9e0cf57904fbde0
-  data.tar.gz: 136f94792ef3951b6e58212b6a42f460e42fca936bb6efc6c8a7c44c06797aebafefb422be88bf35f4a9adcba794d308bdce7e8d2de42b6cd542b70e136e9165
+  metadata.gz: f58f2ddc561a708f87f359a394433d201aea642fd31067df50f981c7193844ca71226b2504134ecbfae19a60dee9ef7900a85af77fa24ff9222763d89d464921
+  data.tar.gz: 3a116c2f0b3de222d172512271f4d2dca4dfd78727f20356fa4bca83be614ffcdae897d5ce708ce5661fedbd1603ff72a15736b85d8e271e85bd4daeef97b237

data/README.md

@@ -2,10 +2,16 @@
 
 [![Build Status](https://travis-ci.org/cerdiogenes/s3-upnow.svg)](https://travis-ci.org/cerdiogenes/s3-upnow)
 
-Easily generate a form that allows you to upload directly to Amazon S3.
-Multi file uploading supported by jquery-fileupload.
+This is a fork of [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload).
 
-Code extracted from Ryan Bates' [gallery-jquery-fileupload](https://github.com/railscasts/383-uploading-to-amazon-s3/tree/master/gallery-jquery-fileupload).
+It's also has code from [refile](https://github.com/elabs/refile), mainly
+related with the frontend.
+
+The general idea of this gem is to be backend agnostic. I'd liked how
+s3_direct_upload interact with S3 and I'd liked how refile interact with the
+form and the backend, so I made a hybrid.
+
+For now it's only works with [paperclip](https://github.com/thoughtbot/paperclip).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -40,47 +46,57 @@ Make sure your AWS S3 CORS settings for your bucket look something like this:
 ```
 In production the AllowedOrigin key should be your domain.
 
-Add the following js and css to your asset pipeline:
+Add the following js to your asset pipeline:
 
 **application.js.coffee**
 ```coffeescript
 #= require s3-upnow
 ```
 
-**application.css**
-```css
-//= require s3-upnow_progress_bars
-```
-
 ## Usage
-Create a new view that uses the form helper `s3_uploader_form`:
+Create a new view that uses the form helper `s3_upnow_field`:
 ```ruby
-<%= s3_uploader_form callback_url: model_url, callback_param: "model[image_url]", id: "s3-uploader" do %>
-  <%= file_field_tag :file, multiple: true %>
-<% end %>
+= simple_form_for @model do |f|
+  = f.s3_upnow_field :avatar
+  = f.button :submit
 ```
 
-* It is required that the file_field_tag is named 'file'.
-* A unique :id should be added to file_field_tag if there is many 's3_uploader_form' in the page
+It will create a file field as well a hidden field with `s3_key` suffix. The
+code above will generate something like:
 
+``` html
+<form action="/models" enctype="multipart/form-data" method="post">
+  <input name="model[avatar_s3_key]" type="hidden">
+  <input name="model[avatar]" type="file">
+</form>
+```
+
+As refile, it will also remove the name attribute of the file field on a
+successful upload to S3, so it doesn't get submitted with your form. By the way,
+this doesn't play well with remote forms. For now I use the following code to
+handle this:
 
-Then in your application.js.coffee, call the S3Uploader jQuery plugin on the element you created above:
 ```coffeescript
-jQuery ->
-  $("#s3-uploader").S3Uploader()
+$(document).on('upload:success', 'form', (event) ->
+  input = $(event.target)
+  form = input.parents('form').clone()
+  form.find(input).remove()
+  $.rails.handleRemote(form)
+)
 ```
 
-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 id="file-{%=o.unique_id%}" class="upload">
-  {%=o.name%}
-  <div class="progress"><div class="bar" style="width: 0%"></div></div>
-</div>
-</script>
-```
+I just have one field, and I want to submit it right after I receive the
+upload:success event. I don't know how this will be used in frontends, so I
+want to have minimal policies for now. So, be warned and write your own code :)
+
+And that's it! All your models that have `has_attached_file :avatar` will copy
+the file specified by s3_key to the path expected by paperclip.
 
 ## Options for form helper
+
+All these options are still used in code, but the callbacks options doesn't have
+any effect. I will polish it when I have some tests written.
+
 * `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`
@@ -93,158 +109,10 @@ Optionally, you can also place this template in the same view for the progress b
 * `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**
-```ruby
-<% if @model.new_record? %>
-  alert("Failed to upload model: <%= j @model.errors.full_messages.join(', ').html_safe %>");
-<% else %>
-  $("#container").append("<%= j render(@model) %>");
-<% end %>
-```
-So that javascript code would be executed after the model instance is created, without a page refresh. See [@rbates's gallery-jquery-fileupload](https://github.com/railscasts/383-uploading-to-amazon-s3/tree/master/gallery-jquery-fileupload)) for an example of that method.
-
-Note: the POST request to the rails app also includes the following parameters `filesize`, `filetype`, `filename` and `filepath`.
-
-### Advanced Customizations
-Feel free to override the styling for the progress bars in s3-upnow_progress_bars.css, 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-upnow` from your application.js and include the necessary jquery-file-upload scripts in your asset pipeline (they are included in this gem automatically):
-```cofeescript
-#= require jquery-fileupload/basic
-#= require jquery-fileupload/vendor/tmpl
-```
-Use the javascript in `s3-upnow` 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: 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.
-* `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
-```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
-    progress_bar_target: $('.js-progress-bars')
-    click_submit_target: $('.submit-target')
-```
-### Example with single file upload bar without script template
-
-This demonstrates how to use progress_bar_target and allow_multiple_files (only works with false option - single file) to show only one progress bar without script template.
-
-```coffeescript
-jQuery ->
-  $("#myS3Uploader").S3Uploader
-    progress_bar_target: $('.js-progress-bars')
-    allow_multiple_files: false
-```
-
-Target for progress bar
-
-```html
-<div class="upload js-progress-bars">
-  <div class="progress">
-    <div class="bar"> </div>
-  </div>
-</div>
-```
-
-
-
-
-### Public methods
-You can change the settings on your form later on by accessing the jQuery instance:
-
-```coffeescript
-jQuery ->
-  v = $("#myS3Uploader").S3Uploader()
-  ...
-  v.path("new/path/") #only works when the key_starts_with option is blank. Not recommended.
-  v.additional_data("newdata")
-```
-
-### Javascript Events Hooks
-
-#### First upload started
-`s3_uploads_start` is fired once when any batch of uploads is starting.
-```coffeescript
-$('#myS3Uploader').bind 's3_uploads_start', (e) ->
-  alert("Uploads have started")
-```
-
-#### Successfull upload
-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.
-* `filepath`  The path to the file (without the filename or domain)
-* `filesize`  The size of the uploaded file.
-* `filetype`  The type of the uploaded file.
-
-This hook could be used for example to fill a form hidden field with the returned S3 url :
-```coffeescript
-$('#myS3Uploader').bind "s3_upload_complete", (e, content) ->
-  $('#someHiddenField').val(content.url)
-```
-
-#### Failed upload
-When an error occured during the transferm the `s3_upload_failed` is triggered on the form with the same `content` object is passed for the successful upload with the addition of the `error_thrown` attribute. The most basic way to handle this error would be to display an alert message to the user in case the upload fails :
-```coffeescript
-$('#myS3Uploader').bind "s3_upload_failed", (e, content) ->
-  alert("#{content.filename} failed to upload : #{content.error_thrown}")
-```
-
-#### All uploads completed
-When all uploads finish in a batch an `s3_uploads_complete` event will be triggered on `document`, so you could do something like:
-```coffeescript
-$(document).bind 's3_uploads_complete', ->
-    alert("All Uploads completed")
-```
-
-#### Rails AJAX Callbacks
-
-In addition, the regular rails ajax callbacks will trigger on the form with regards to the POST to the server.
+## Cleaning old uploads on S3
 
-```coffeescript
-$('#myS3Uploader').bind "ajax:success", (e, data) ->
-  alert("server was notified of new file on S3; responded with '#{data}")
-```
+PS.: I don't test if it's already working, but I intend to do it soon.
 
-## Cleaning old uploads on S3
 You may be processing the files upon upload and reuploading them to another
 bucket or directory. If so you can remove the originali files by running a
 rake task.
@@ -262,7 +130,9 @@ Then, run the rake task to delete uploads older than 2 days:
   $
 ```
 
-Optionally customize the prefix used for cleaning (default is `uploads/#{2.days.ago.strftime('%Y%m%d')}`):
+Optionally customize the prefix used for cleaning (default is
+`uploads/#{2.days.ago.strftime('%Y%m%d')}`):
+
 **config/initalizers/s3-upnow.rb**
 ```ruby
 S3UpNow.config do |c|
@@ -271,34 +141,21 @@ S3UpNow.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).
-
-## 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.
-
+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.
+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 file types, ability to batch upload.
-* More convention over configuration on rails side
-* Create generators.
-* Model methods.
-* Model method to delete files from s3
+* More convention over configuration on frontend side
 
 
 ## 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)
+This gem is a hybrid of [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload)
+and [refile](https://github.com/elabs/refile). Maybe it have more personality in
+the future.

data/app/assets/javascripts/{s3-upnow.js.coffee → s3-upnow.coffee.erb}

@@ -3,6 +3,10 @@ $(document).on 'change', (e) ->
   if (input.prop('tagName') == "INPUT" && input.prop('type') == "file" && input.data('upnow'))
     return if (!input.prop('files'))
     file = input.prop('files')[0]
+    max_file_size = Number(input.attr('max_file_size') || <%= 500.megabytes %>)
+    if Number(file.size) > max_file_size
+      alert("<%= I18n.t('s3_upnow.max_file_size') %>: #{max_file_size/1024/1024}mb")
+      return
     file.unique_id = Math.random().toString(36).substr(2,16)
 
     dispatchEvent = (name, detail) ->

data/lib/s3-upnow/paperclip.rb

@@ -10,7 +10,8 @@ module S3UpNow
         end
 
         def s3_upnow_destination_bucket(name)
-          s3_upnow_attachment(name).options[:bucket].call
+          attachment = s3_upnow_attachment(name)
+          attachment.options[:s3_credentials].try(:[], :bucket) || attachment.options[:bucket].call
         end
 
         def s3_upnow_destination_path(name)
@@ -26,17 +27,21 @@ module S3UpNow
 
   module ClassMethods
     def has_attached_file(name, options = {})
-      puts "here"
       self.class_eval do
         attr_accessor "#{name}_s3_key"
 
-        before_validation "s3_upnow_copy_metadata_from_#{name}".to_sym, unless: "#{name}_s3_key.blank?"
-        after_save "s3_upnow_copy_file_from_#{name}".to_sym, unless: "#{name}_s3_key.blank?"
+        before_validation "s3_upnow_copy_metadata_from_#{name}".to_sym, unless: -> { send("#{name}_s3_key").blank? }
+        after_save "s3_upnow_copy_file_from_#{name}".to_sym, unless: -> { send("#{name}_s3_key").blank? }
 
         private
 
+        def s3_upnow_client
+          endpoint = "#{S3UpNow.config.region ? S3UpNow.config.region : 's3'}.amazonaws.com"
+          AWS::S3.new(s3_endpoint: endpoint)
+        end
+
         define_method "s3_upnow_copy_metadata_from_#{name}" do
-          s3 = AWS::S3.new
+          s3 = s3_upnow_client
           s3_head = s3.buckets[S3UpNow.config.bucket].objects[instance_variable_get("@#{name}_s3_key")].head
 
           s3_upnow_attachment(name).clear
@@ -47,15 +52,19 @@ module S3UpNow
         end
 
         define_method "s3_upnow_copy_file_from_#{name}" do
-          s3 = AWS::S3.new
+          s3 = s3_upnow_client
           orig_bucket = s3.buckets[S3UpNow.config.bucket]
           orig_object = orig_bucket.objects[instance_variable_get("@#{name}_s3_key")]
           dest_bucket = s3.buckets[s3_upnow_destination_bucket(name)]
           dest_object = dest_bucket.objects[s3_upnow_destination_path(name)]
           dest_object.copy_from(orig_object, acl: s3_upnow_destination_permissions(name))
+          if s3_upnow_attachment(name).styles.present?
+            remove_instance_variable("@#{name}_s3_key")
+            s3_upnow_attachment(name).reprocess!
+          end
         end
       end
       super(name, options)
     end
   end
-end
+end

data/lib/s3-upnow/version.rb

@@ -1,3 +1,3 @@
 module S3UpNow
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3-upnow
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carlos Eduardo Rodrigues Diógenes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,7 +75,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- app/assets/javascripts/s3-upnow.js.coffee
+- app/assets/javascripts/s3-upnow.coffee.erb
 - app/assets/stylesheets/s3-upnow-progress-bar.css.scss
 - lib/s3-upnow.rb
 - lib/s3-upnow/config_aws.rb
@@ -89,7 +89,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Gives a form helper for Rails which allows direct uploads to s3. Based on
   RailsCast#383