s3_file_field 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43c8582febac6a41acc7a7a6659ed960dd421401
+  data.tar.gz: 721a25cdfb745e5c28dabece3f4e0a7ec80126f7
+SHA512:
+  metadata.gz: b62187a0b2aa25f71cd286447cfdf6bf0b5682993ec0d7d0a66469f5aeab3fcf77ea6b5f0cdfd5cdc78bd7b9342d7c2a5cad0027e1b21e55a868b49d70c7d8d9
+  data.tar.gz: 862e28d624869c3d534fb467d22005559042812f222e72f21b32046a96e40fae302e9b9363f211fc7c512f7eab5a0084138d561295a7b711d7349c9f221d09e2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Wayne
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# S3 File Field
+
+Stand-alone file field for S3 Direct Upload working with Rails nested forms.
+
+Works as an extension of [jQuery File Upload](http://blueimp.github.io/jQuery-File-Upload/) JavaScript plugin and supports IE 7-10.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_direct_upload'
+```
+
+Then add a new initalizer with your AWS credentials:
+
+**config/initalizers/s3_file_field.rb**
+```ruby
+S3FileField.config do |c|
+  c.access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  c.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  c.bucket = ENV['AWS_BUCKET']
+end
+```
+
+Make sure your AWS S3 CORS Settings for your bucket look like this:
+```xml
+<CORSConfiguration>
+  <CORSRule>
+    <AllowedOrigin>*</AllowedOrigin>
+    <AllowedMethod>GET</AllowedMethod>
+    <AllowedMethod>POST</AllowedMethod>
+    <AllowedMethod>PUT</AllowedMethod>
+    <AllowedHeader>*</AllowedHeader>
+  </CORSRule>
+</CORSConfiguration>
+```
+
+In production the AllowedOrigin key should be your base url like `http://example.com`
+
+Also ensure you've added `PutObject` and `PutObjectAcl` permission in your bucket policy. Here is mine:
+```json
+{
+  "Version": "2008-10-17",
+  "Id": "Policy1372930880859",
+  "Statement": [
+    {
+      "Sid": "Stmt1372930877007",
+      "Effect": "Allow",
+      "Principal": {
+        "AWS": "*"
+      },
+      "Action": [
+        "s3:GetObject",
+        "s3:PutObjectAcl",
+        "s3:PutObject"
+      ],
+      "Resource": "arn:aws:s3:::BUCKET_NAME/*"
+    }
+  ]
+}
+```
+
+Add the following js to your asset pipeline:
+
+**application.js.coffee**
+```coffeescript
+#= require s3_file_field
+```
+
+## Usage
+
+Create a new view that uses the form helper `s3_uploader_form`:
+```haml
+= form.s3_file_field :movie, :class => 'js-s3_file_field'
+.progress
+  .meter{ :style => "width: 0%" }
+```
+
+Then in your application.js.coffee something like:
+```coffeescript
+ready = ->
+  $(".js-s3_file_field").each ->
+    id = $(this).attr('id')
+    $this = -> $("##{id}")
+    $progress = $(this).siblings('.progress').hide()
+    $meter = $progress.find('.meter')
+    $(this).S3FileField
+      add: (e, data) ->
+        $progress.show()
+        data.submit()
+      done: (e, data) ->
+        $progress.hide()
+        $this().attr(type: 'text', value: data.result.url, readonly: true)
+      fail: (e, data) ->
+        alert(data.failReason)
+      progress: (e, data) ->
+        progress = parseInt(data.loaded / data.total * 100, 10)
+        $meter.css(width: "#{progress}%")
+
+$(document).ready(ready)
+$(document).on('page:load', ready)
+```
+
+Notice that after upload you have to re-fetch file field from DOM by its ID. That's becase
+jQuery File Upload clones it somewhere else and `$(this)` reference points to the original input.
+
+
+## Advanced customization
+
+You can use any options / API available for jQuery File Upload plugin.
+
+After successful upload, you'll find file data in `data.result` field:
+
+```json
+{
+  "filepath": "uploads/v3w3qzcb1d78pvi/something.gif",
+  "url": "https://foobar.s3.amazonaws.com/uploads/v3w3qzcb1d78pvi/something.gif",
+  "filename": "something.gif",
+  "filesize": 184387,
+  "filetype": "image\/gif",
+  "unique_id": "v3w3qzcb1d78pvi"
+}
+```
+
+## Cleaning old uploads on S3
+
+[Check out this article on Lifecycle Configuration](http://docs.aws.amazon.com/AmazonS3/latest/UG/LifecycleConfiguration.html).
+
+## Thanks
+
+* [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload)
+* [gallery-jquery-fileupload](https://github.com/railscasts/383-uploading-to-amazon-s3/tree/master/gallery-jquery-fileupload)
+
+## License
+
+This repository is MIT-licensed. You are awesome.

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

@@ -0,0 +1,96 @@
+#= require jquery-fileupload/basic
+#= require jquery-fileupload/vendor/tmpl
+
+jQuery.fn.S3FileField = (options) ->
+
+  # support multiple elements
+  if @length > 1
+    @each -> $(this).S3Uploader options if @length > 1
+    return this
+
+  $this = this
+
+  extractOption = (key) ->
+    extracted = options[key]
+    delete options[key]
+    extracted
+
+  getFormData = (data, form) ->
+    formData = undefined
+    return data(form) if typeof data is "function"
+    return data if $.isArray(data)
+    if $.type(data) is "object"
+      formData = []
+      $.each data, (name, value) ->
+        formData.push
+          name: name
+          value: value
+      return formData
+    return []
+
+  url = extractOption('url')
+  add = extractOption('add')
+  done = extractOption('done')
+  fail = extractOption('fail')
+  formData = extractOption('formData')
+
+  delete options['paramName']
+  delete options['singleFileUploads']
+
+  finalFormData = undefined
+
+  settings =
+    # File input name must be "file"
+    paramName: 'file'
+
+    # S3 doesn't support multiple file uploads
+    singleFileUploads: true
+
+    # We don't want to send it to default form url
+    url: url || $this.data('url')
+
+    # For IE <= 9 force iframe transport
+    forceIframeTransport: do ->
+      userAgent = navigator.userAgent.toLowerCase()
+      msie = /msie/.test( userAgent ) && !/opera/.test( userAgent )
+      msie_version = parseInt((userAgent.match( /.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/ ) || [])[1], 10)
+      msie && msie_version <= 9
+
+    add: (e, data) ->
+      data.files[0].unique_id = Math.random().toString(36).substr(2,16)
+      if add? then add(e, data) else data.submit()
+
+    done: (e, data) ->
+      data.result = build_content_object $this, data.files[0], data.result
+      done(e, data) if done?
+
+    fail: (e, data) ->
+      fail(e, data) if fail?
+
+    formData: (form) ->
+      finalFormData =
+        key: $this.data('key').replace('{timestamp}', new Date().getTime()).replace('{unique_id}', @files[0].unique_id)
+        'Content-Type': @files[0].type
+        acl: $this.data('acl')
+        'AWSAccessKeyId': $this.data('aws-access-key-id')
+        policy: $this.data('policy')
+        signature: $this.data('signature')
+        success_action_status: "201"
+        'X-Requested-With': 'xhr'
+
+      getFormData(finalFormData).concat(getFormData(formData))
+
+  jQuery.extend settings, options
+
+  build_content_object = ($this, file, result) ->
+    domain = settings.url.replace(/\/+$/, '').replace(/^(https?:)?/, 'https:')
+    content = {}
+    content.filepath   = finalFormData['key'].replace('/${filename}', '')
+    content.url        = domain + '/' + content.filepath + '/' + file.name
+    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
+
+  $this.fileupload settings

data/lib/s3_file_field/config_aws.rb

@@ -0,0 +1,18 @@
+require "singleton"
+
+module S3FileField
+  class Config
+    include Singleton
+
+    ATTRIBUTES = [:access_key_id, :secret_access_key, :bucket, :prefix_to_clean, :region, :url]
+
+    attr_accessor *ATTRIBUTES
+  end
+
+  def self.config
+    if block_given?
+      yield Config.instance
+    end
+    Config.instance
+  end
+end

data/lib/s3_file_field/engine.rb

@@ -0,0 +1,4 @@
+module S3FileField
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/s3_file_field/form_helper.rb

@@ -0,0 +1,99 @@
+module S3FileField
+  class Error < StandardError; end
+
+  module FormBuilder
+    def s3_file_field(method, options = {})
+      self.multipart = true
+      @template.s3_file_field(@object_name, method, objectify_options(options))
+    end
+  end
+
+  module FormHelper
+    def self.included(arg)
+      ActionView::Helpers::FormBuilder.send(:include, S3FileField::FormBuilder)
+    end
+
+    def s3_file_field(object_name, method, options = {})
+      uploader = S3Uploader.new(options)
+      ActionView::Helpers::Tags::FileField.new(
+        object_name, method, self,
+        options.reverse_merge(uploader.field_options)
+      ).render
+    end
+
+    class S3Uploader
+      def initialize(options)
+        @options = options.reverse_merge(
+          aws_access_key_id: S3FileField.config.access_key_id,
+          aws_secret_access_key: S3FileField.config.secret_access_key,
+          bucket: S3FileField.config.bucket,
+          acl: "public-read",
+          expiration: 10.hours.from_now.utc.iso8601,
+          max_file_size: 500.megabytes,
+          key_starts_with: options[:key_starts_with] || "uploads/"
+        )
+
+        unless @options[:aws_access_key_id]
+          raise Error.new("Please configure aws_access_key_id option.")
+        end
+
+        unless @options[:aws_secret_access_key]
+          raise Error.new("Please configure aws_secret_access_key option.")
+        end
+
+        unless @options[:bucket]
+          raise Error.new("Please configure bucket name.")
+        end
+      end
+
+      def field_options
+        {
+          data: {
+            :url => url,
+            :key => @options[:key] || key,
+            :acl => @options[:acl],
+            :'aws-access-key-id' => @options[:aws_access_key_id],
+            :policy => policy,
+            :signature => signature
+          }.reverse_merge(@options[:data] || {})
+        }
+      end
+
+      def key
+        @key ||= "#{@options[:key_starts_with]}{timestamp}-{unique_id}-#{SecureRandom.hex}/${filename}"
+      end
+
+      def url
+        "//#{@options[:bucket]}.s3.amazonaws.com/"
+      end
+
+      def policy
+        Base64.encode64(policy_data.to_json).gsub("\n", "")
+      end
+
+      def policy_data
+        {
+          expiration: @options[:expiration],
+          conditions: [
+            ["starts-with", "$key", @options[:key_starts_with]],
+            ["starts-with", "$x-requested-with", ""],
+            ["content-length-range", 0, @options[:max_file_size]],
+            ["starts-with","$Content-Type",""],
+            {bucket: @options[:bucket]},
+            {acl: @options[:acl]},
+            {success_action_status: "201"}
+          ] + (@options[:conditions] || [])
+        }
+      end
+
+      def signature
+        Base64.encode64(
+          OpenSSL::HMAC.digest(
+            OpenSSL::Digest::Digest.new('sha1'),
+            @options[:aws_secret_access_key], policy
+          )
+        ).gsub("\n", "")
+      end
+    end
+  end
+end

data/lib/s3_file_field/railtie.rb

@@ -0,0 +1,7 @@
+module S3FileField
+  class Railtie < Rails::Railtie
+    initializer "railtie.configure_rails_initialization" do |app|
+      app.middleware.use JQuery::FileUpload::Rails::Middleware
+    end
+  end
+end

data/lib/s3_file_field/version.rb

@@ -0,0 +1,3 @@
+module S3FileField
+  VERSION = "1.0.0"
+end

data/lib/s3_file_field.rb

@@ -0,0 +1,13 @@
+require 's3_file_field/version'
+require 'jquery-fileupload-rails'
+
+require 'base64'
+require 'openssl'
+require 'digest/sha1'
+
+require 's3_file_field/config_aws'
+require 's3_file_field/form_helper'
+require 's3_file_field/railtie'
+require 's3_file_field/engine'
+
+ActionView::Base.send(:include, S3FileField::FormHelper)

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: s3_file_field
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Stankiewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.5
+- !ruby/object:Gem::Dependency
+  name: jquery-fileupload-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Form helper for Direct Uploading to Amazon S3 using CORS and jquery-file-upload
+email:
+- sheerun@sher.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/s3_file_field/config_aws.rb
+- lib/s3_file_field/engine.rb
+- lib/s3_file_field/form_helper.rb
+- lib/s3_file_field/railtie.rb
+- lib/s3_file_field/version.rb
+- lib/s3_file_field.rb
+- app/assets/javascripts/s3_file_field.js.coffee
+- LICENSE
+- README.md
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Form helper for Direct Uploading to Amazon S3 using CORS and jquery-file-upload
+test_files: []