s3_file_field 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00afb2600de317ec414528792d3c598e8d945fc7
-  data.tar.gz: 56bdc45396d2aa291cdebd741c384d2c71b9bfa8
+  metadata.gz: 0477893ffeba70b2ce4e91f5ef57dfa5be7097f9
+  data.tar.gz: aeee37b0690800a1fa341fdb1435c67f2efd64db
 SHA512:
-  metadata.gz: 64472f94db2b2ac849d1ccb56b21572bb51f6e92d933c1d99eb11e7644cea2be0701d917557237d50a3b30d8b6c1cc645fe44a0592e55970beb6a489484b35b8
-  data.tar.gz: e8d0dd88f0af447594b0fc77a5664b8c6102caad6475b1cc14f497dcdf6fc31510a3f2ca8a695145384029404056ece98881c01aa2375c31c8ba8f178c9256c5
+  metadata.gz: 4cc2f163a26a087323d7732e8d0d6c74967f41a6ca18bb36f340fb73b5243de23e00cdd5c908161a21e0b23472ff4a22289d85b40a26554916f8a7c3c4614719
+  data.tar.gz: 3f4adacd07301e307c67c2779ca9547ba8cad406174bf435a7609add0deee99baa01939b1a62f6801d5bd8872f6cdc5d6fbd8eed486173c55a80ef6162e78d3d

data/README.md

@@ -8,13 +8,15 @@ Note: Since 1.0.2 gem works with both Rails 3 and Rails 4.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
+**Gemfile**
 ```ruby
 gem 's3_file_field'
 ```
 
-Then add a new initializer with your AWS credentials:
+**application.coffee**
+```coffeescript
+#= require s3_file_field
+```
 
 **config/initializers/s3_file_field.rb**
 ```ruby
@@ -22,9 +24,16 @@ 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']
+  # c.acl = "public-read"
+  # c.expiration = 10.hours.from_now.utc.iso8601
+  # c.max_file_size = 500.megabytes
+  # c.conditions = []
+  # c.key_starts_with = 'uploads/
 end
 ```
 
+### S3 configuration
+
 Make sure your AWS S3 CORS Settings for your bucket look like this:
 ```xml
 <CORSConfiguration>
@@ -63,31 +72,31 @@ Also ensure you've added `PutObject` and `PutObjectAcl` permission in your bucke
 }
 ```
 
-Add the following js to your asset pipeline:
+## Basic usage
 
-**application.js.coffee**
-```coffeescript
-#= require s3_file_field
-```
-
-## Usage
-
-Create a new view that uses the form helper `s3_uploader_form`:
 ```haml
-= form_for :user do |form|
-  = form.s3_file_field :scrapbook, :class => 'js-s3_file_field'
+= form_for :user do |f|
+  = f.s3_file_field :avatar, :class => 'js-s3_file_field'
   .progress
     .meter{ :style => "width: 0%" }
 ```
 
-Then in your application.js.coffee something like:
-
 ```coffeescript
 jQuery.ready ->
-  $('.js-s3_file_field').S3FileField()
+  $('.js-s3_file_field').S3FileField
+    done: (e, data) -> console.log(data.result.url)
 ```
 
-or
+# Advanced usage
+
+```haml
+= form_for :user do |f|
+  = f.s3_file_field :avatar,
+    :class => 'js-s3_file_field',
+    :key => "/uploads/${timestamp}/${filename}"
+  .progress
+    .meter{ :style => "width: 0%" }
+```
 
 ```coffeescript
 ready = ->
@@ -113,20 +122,18 @@ $(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.
 
+For full list of options reference [jQuery File Field wiki page](https://github.com/blueimp/jQuery-File-Upload/wiki/Options)
+
 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",
+  "filepath": "uploads/v3w3qzcb1d78pvi/something.gif",
   "filename": "something.gif",
   "filesize": 184387,
   "filetype": "image\/gif",

data/lib/s3_file_field/form_helper.rb

@@ -14,92 +14,16 @@ module S3FileField
     end
 
     def s3_file_field(object_name, method, options = {})
-      uploader = S3Uploader.new(options)
-      options = options.reverse_merge(uploader.field_options)
+      options = S3Uploader.new(options).field_options
+
       if ::Rails.version.to_i >= 4
         ActionView::Helpers::Tags::FileField.new(
           object_name, method, self, options
         ).render
       else
         ActionView::Helpers::InstanceTag.new(
-          object_name, method, self,
-          options.reverse_merge(uploader.field_options).delete(:object)
-        ).to_input_field_tag("file", options.update({:size => nil}))
-      end
-    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", "")
+          object_name, method, self, options.delete(:object)
+        ).to_input_field_tag("file", options.update(:size => nil))
       end
     end
   end

data/lib/s3_file_field/s3_uploader.rb

@@ -0,0 +1,93 @@
+module S3FileField
+  class S3Uploader  # :nodoc:
+    attr_accessor :options
+
+    def initialize(original_options = {})
+
+      default_options = {
+        access_key_id: S3FileField.config.access_key_id,
+        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,
+        conditions: [],
+        key_starts_with: 'uploads/'
+      }
+
+      @key = original_options[:key]
+      @original_options = original_options
+
+      # Remove s3_file_field specific options from original options
+      extracted_options = @original_options.extract!(*default_options.keys).
+        reject { |k, v| v.nil? }
+
+      @options = default_options.merge(extracted_options)
+
+      unless @options[:access_key_id]
+        raise Error.new("Please configure access_key_id option.")
+      end
+
+      unless @options[:secret_access_key]
+        raise Error.new("Please configure secret_access_key option.")
+      end
+
+      unless @options[:bucket]
+        raise Error.new("Please configure bucket name.")
+      end
+    end
+
+    def field_options
+      @original_options.merge(data: field_data_options)
+    end
+
+    def field_data_options
+      {
+        url: url,
+        key: key,
+        acl: @options[:acl],
+        aws_access_key_id: @options[:access_key_id],
+        policy: policy,
+        signature: signature
+      }.merge(@options[:data] || {})
+    end
+
+    private
+
+    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[:secret_access_key], policy
+        )
+      ).gsub("\n", '')
+    end
+  end
+end

data/lib/s3_file_field/version.rb

@@ -1,3 +1,3 @@
 module S3FileField
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/s3_file_field.rb

@@ -4,8 +4,10 @@ require 'jquery-fileupload-rails'
 require 'base64'
 require 'openssl'
 require 'digest/sha1'
+require 'active_support/core_ext'
 
 require 's3_file_field/config_aws'
+require 's3_file_field/s3_uploader'
 require 's3_file_field/form_helper'
 require 's3_file_field/railtie'
 require 's3_file_field/engine'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_file_field
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Adam Stankiewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: jQuery File Upload extension for direct uploading to Amazon S3 using
   CORS
 email:
@@ -106,6 +134,7 @@ files:
 - lib/s3_file_field/engine.rb
 - lib/s3_file_field/form_helper.rb
 - lib/s3_file_field/railtie.rb
+- lib/s3_file_field/s3_uploader.rb
 - lib/s3_file_field/version.rb
 - lib/s3_file_field.rb
 - app/assets/javascripts/s3_file_field.js.coffee