s3ff 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f22ad02b8e3eeca86cbd5349b62531a764b43614
-  data.tar.gz: 43199824a91fbad288a0507b8f0391d951946089
+  metadata.gz: 804b22add6dbaad3b44df45846e522113b9c848e
+  data.tar.gz: 290fe54e2b6ede4b2d914af03534eb019945b442
 SHA512:
-  metadata.gz: 8ad7fdfba1a7ba04ab13530c8d049d41cf9360605e7db8d6aa8e4072891594f824302d4750e8dbd016fe6c66955802b076d10a9b3063f003912b7ac9c9ffd5d6
-  data.tar.gz: dc89543f7ef182df36d1c94183fb18287de533f536ac34983ebf25524db944c1ece6fb7b6ad7df644409aa7886115af942c19e9bc9648a3ab47392f76ffecad3
+  metadata.gz: 1263f70cfdb4dd17e6284aebbc8d8cc9d588ba3d422f4b15c044ea7dc1503246becdfbbfb09e70ff7aa75bb74ab4e6e151e5f58ec4aed4484cbe10455264d393
+  data.tar.gz: 51cf9eb3149442474c227fcd93042152462cc9c46aaa4ccb8b84c890a0455f57e61a155a8b8fb373feabcab519e75612d1140cde4e20c2d1c3a56e92536e2428

data/README.md

@@ -21,35 +21,11 @@ Or install it yourself as:
 
 ## Usage
 
-### 0. Add initializer for s3_file_field:
-
-```ruby
-if defined?(S3FileField) && ENV['AWS_KEY']
-  cdn_hostname = ENV.fetch('CDN_HOSTNAME') { ENV['S3_BUCKET'] && "#{ENV['S3_BUCKET']}.s3.amazonaws.com" }
-  S3FileField.config do |c|
-    c.access_key_id = ENV['AWS_KEY']
-    c.secret_access_key = ENV['AWS_SECRET']
-    c.bucket = ENV['S3_BUCKET']
-    c.region = ENV['S3_BUCKET_REGION'] || 'us-west-2'
-    c.url = "//#{cdn_hostname}" if cdn_hostname # S3 API endpoint (optional), eg. "https://#{c.bucket}.s3.amazonaws.com/"
-    # c.acl = "public-read"
-    # c.expiration = 10.hours.from_now.utc.iso8601
-    # c.max_file_size = 100.megabytes
-    # c.conditions = []
-    # c.key_starts_with = 'uploads/
-    # c.ssl = true # if true, force SSL connection
-  end
+### 1. Configure s3_file_field
 
-elsif defined?(S3FileField) # for when no S3 is configured, fallback to regular `file_field`
-  S3FileField::FormBuilder.class_eval do
-    def s3_file_field(method, options = {})
-      @template.file_field(@object_name, method, options)
-    end
-  end
-end
-```
+add a config like `sample/config_s3_file_field.rb` into your Rails `config/initializers/` directory
 
-### 1. Add javascript
+### 2. Add javascript
 
 in your application.js
 
@@ -57,24 +33,24 @@ in your application.js
 //= require s3ff
 ```
 
-### 2. Change `file_field` input to use `s3_file_field`
+### 3. Change `file_field` input to use `s3_file_field`
 
-```
+``` haml
 = form_for :user do |f|
   = f.s3_file_field :avatar
 ```
 
 or if you're using `simple_form`
 
-```
+``` haml
 = simple_form_for :user do |f|
   = f.input :avatar do
     = f.s3_file_field :avatar, :class => "form-control"
 ```
 
-### 3. Add footer
+### 4. Add footer
 
-```
+``` haml
 = include_s3ff_templates
 ```
 
@@ -84,22 +60,19 @@ NOTE: Feel free to modify & render the templates manually, but keep the `s3ff_`
 
 To illustate, if you have a file field like this
 
-```
+``` html
 <input type="file" name="user[avatar]">
 ```
 
-When `s3ff` kicks in, it would upgrade the field to a `s3_file_field`. When your user chooses a file, it will be uploaded, with a progress indicator, directly into your S3 bucket (see `s3_file_field` gem for configuration). Your `form` will be disabled during the upload and re-enabled once upload completes. After this process, 4 new hidden form fields will be attached to your form:
+When `s3ff` kicks in, it would upgrade the field to a `s3_file_field`. When your user chooses a file, it will be uploaded, with a progress indicator, directly into your S3 bucket (see `s3_file_field` gem for configuration). Your `form` will be disabled during the upload and re-enabled once upload completes. After this process, a new hidden form field will be attached to your form:
 
-```
+``` html
 <input type="file" name="user[avatar_direct_url]" value="https://....">
-<input type="file" name="user[avatar_file_name]" value="face.png">
-<input type="file" name="user[avatar_file_size]" value="162534">
-<input type="file" name="user[avatar_content_type]" value="image/png">
 ```
 
 ## Code changes to your app
 
-`s3ff` designed to minimize moving parts and code changes to your Rails app - all it does is give you 4 form fields in return for every direct s3 file upload that happened in your user's browser.
+`s3ff` designed to minimize moving parts and code changes to your Rails app - all it does is give you new hidden form fields in return for every direct s3 file upload that happened in your user's browser.
 
 How you deal with these form fields are entirely up to you. Here's a simple way:
 
@@ -107,44 +80,53 @@ How you deal with these form fields are entirely up to you. Here's a simple way:
 
 If your controller was specifying
 
-```
+``` ruby
 params.require(:user).permit(:avatar)
 ```
 
 It would need to be changed to accept the new form fields
 
-```
-params.require(:user).permit(:avatar,
-  :avatar_direct_url,
-  :avatar_file_name,
-  :avatar_file_size,
-  :avatar_content_type
-)
+``` ruby
+params.require(:user).permit(:avatar, :avatar_direct_url)
 ```
 
 #### 2. Upgrade model to also accept direct url
 
 If your model was originally
 
-```
+``` ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
 end
 ```
 
-Download the file from S3 when given `avatar_direct_url`. This leave all your existing Paperclip code and logic unchanged.
+Download the file from S3 when given `avatar_direct_url`. This leaves all your existing Paperclip code and logic unchanged.
 
-```
+``` ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+
+  # s3ff changes
 
-  attr_accessor :avatar_direct_url
   def avatar_direct_url=(value)
-    self.avatar = open(value) if value.present?
+    self.avatar =
+      ActionDispatch::Http::UploadedFile.new(
+        tempfile: open(value),
+        filename: File.basename(value),
+      ).tap do |upload|
+      upload.content_type = Paperclip::ContentTypeDetector.new(upload.path).detect
+    end
   end
 end
 ```
 
+#### CAVEAT
+
+It isn't ideal to handle your attachment processing synchronously during the web request. For usage with `Sidekiq` or `DelayedJob`, look at the reference code in `sample/user.*.rb`
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/jollygoodcode/s3ff/fork )

data/lib/s3ff/version.rb

@@ -1,3 +1,3 @@
 module S3FF
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/lib/s3ff/view_helper.rb

@@ -1,6 +1,6 @@
 module S3FF
   module ViewHelper
-    def include_s3ff_templates(map = { _direct_url: 'result.url', _file_name: 'result.filename', _file_size: 'result.filesize', _content_type: 'result.filetype' })
+    def include_s3ff_templates(map = { _direct_url: 'result.url' }) # extras: , _file_name: 'result.filename', _file_size: 'result.filesize', _content_type: 'result.filetype' })
       <<-EOM
       <div style="display:none;">
         <script id="s3ff_label" type="text/x-tmpl">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3ff
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Chew Choon Keat