s3_browser_uploads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d11949c33c4d40cd6f60105ab513b4a86e3a0174
+  data.tar.gz: ebc1978bc5ce720a5f935ce489d19c0359ac2502
+SHA512:
+  metadata.gz: f28057c0ddec32a220adfbf448240a816ea1fc85c240d1a34b997cb2fc27f1255f12ebe119d3e0381bc6c4521e53c0b5ba67692fdd89737de37fefb8eb7ea598
+  data.tar.gz: 8ca98453654043da7aec1c5d0ff6bfde99ab6ae35012955a5fd76d51578c58b8cbf704d681347f7dc3438e320ddf4f62283b43ab225f9269214c16bf7c408976

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3_browser_uploads.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Frederick Cheung
+
+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,32 @@
+# S3BrowserUploads
+
+Easy straight-to-s3 uploads from your browser for rails. Takes care of policy documents and all that jazz
+
+## Example Usage
+
+In your controller
+
+    @form_definition = S3BrowserUploads::FormDefinition.new :aws_access_key_id => 'Somekey'
+    @form_definition.add_field('x-amz-server-side-encryption', 'AES256')
+    @form_definition.add_field('key', 'users/fred/${filename}')
+    @form_definition.add_condition('key', 'starts-with' => 'users/fred/')
+
+In your view
+
+    <%= s3_form @form_definition do %> 
+
+      <%= file_field_tag :file %>
+      <%= submit_tag 'Upload' %>
+    <% end %>
+
+
+## Details
+
+Every field in your form must be signed as part of the policy document in order for S3 to accept the upload.
+
+Call `add_field` to add a hidden field both to the form and to the policy document. If you want to add the field yourself then call `add_condition` to add the field to the policy document. For example if you wanted to allow the user to choose the acl for the file then you would do
+
+    @form_definition.add_condition 'acl', 'starts-with' => ''
+
+This adds `acl` to the policy document and states that it can take any value. Then you'd need to add an input to the form that would allow the user to choose the acl.
+ 

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/s3_browser_uploads.rb

@@ -0,0 +1,10 @@
+require "s3_browser_uploads/version"
+require "s3_browser_uploads/form_definition"
+
+module S3BrowserUploads
+  # Your code goes here...
+end
+
+if defined?(Rails)
+  require 's3_browser_uploads/railtie'
+end

data/lib/s3_browser_uploads/form_definition.rb

@@ -0,0 +1,85 @@
+require 'time'
+require 'base64'
+require 'json'
+module S3BrowserUploads
+  class FormDefinition
+    attr_accessor :region, :aws_secret_access_key, :expires, :fields, :conditions
+
+
+    def aws_access_key_id= value
+      fields['AWSAccessKeyID'] = value #access key id is not included in the policy
+    end
+
+    def aws_access_key_id
+      fields['AWSAccessKeyID'] #access key id is not included in the policy
+    end
+
+
+    def aws_session_token
+      fields['x-amz-security-token']
+    end
+
+    def aws_session_token= value
+      add_field 'x-amz-security-token', value
+    end
+
+
+    def bucket
+      fields['bucket']
+    end
+
+    def bucket= value
+      add_field 'bucket', value
+    end
+
+    def add_field key, value
+      fields[key] = value
+      add_condition key, value
+      value
+    end
+
+    def add_condition key, condition
+      @conditions[key] = case condition
+      when String then {key => condition} 
+      when Hash then 
+        [condition.keys.first, "$#{key}", condition.values.first]
+      when Range then
+        [key, condition.begin, condition.end]
+      else
+        raise ArgumentError, "unknown condition type #{condition}"
+      end
+    end
+
+    def restrict_content_length range
+      add_condition 'content-length-range', range
+    end
+
+    def initialize(options={})
+      @fields = {}
+      @conditions = {}
+      options.each {|key, value| public_send("#{key}=", value)}
+      @digest = OpenSSL::Digest::Digest.new('sha1')
+      @hmac = lambda {|data| OpenSSL::HMAC.digest(@digest, @aws_secret_access_key, data)}
+    end
+
+    def signature
+      Base64.strict_encode64(@hmac[encoded_policy])
+    end
+
+    def endpoint
+      "https://#{bucket}.s3-#{region}.amazonaws.com"
+    end
+
+    def encoded_policy
+      Base64.strict_encode64(policy_document.to_json)
+    end
+
+    def policy_document
+      {
+        'expiration' => expires.xmlschema,
+        'conditions' => @conditions.values
+      }
+    end
+
+  end
+end

data/lib/s3_browser_uploads/railtie.rb

@@ -0,0 +1,9 @@
+module S3BrowserUploads
+  class Railtie < ::Rails::Railtie
+    initializer "will_paginate" do |app|
+      ActiveSupport.on_load :action_view do
+        require 's3_browser_uploads/view_helpers'
+      end
+    end
+  end
+end

data/lib/s3_browser_uploads/version.rb

@@ -0,0 +1,3 @@
+module S3BrowserUploads
+  VERSION = "0.1.0"
+end

data/lib/s3_browser_uploads/view_helpers.rb

@@ -0,0 +1,21 @@
+module S3BrowserUploads
+  module ViewHelpers
+    def s3_form form_definition, html_options={}, &block
+      options = {'action' => form_definition.endpoint, 'method' => 'POST', 'enctype' => "multipart/form-data",'accept-charset' => "UTF-8"}
+      options.merge! html_options
+
+      output = ActiveSupport::SafeBuffer.new
+      output.safe_concat(tag(:form, options, true).html_safe)
+      output << hidden_field_tag( 'x-ignore-utf8', '&#x2713;'.html_safe)
+      form_definition.fields.each  do |name, value|
+        output << hidden_field_tag( name, value)
+      end
+      output << hidden_field_tag('policy', form_definition.encoded_policy)
+      output << hidden_field_tag('signature', form_definition.signature)
+      output << capture(&block)
+      output.safe_concat("</form>")
+    end
+    ::ActionView::Base.send :include, self
+
+  end
+end

data/s3_browser_uploads.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_browser_uploads/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_browser_uploads"
+  spec.version       = S3BrowserUploads::VERSION
+  spec.authors       = ["Frederick Cheung"]
+  spec.email         = ["frederick.cheung@gmail.com"]
+  spec.description   = %q{Easy straight-to-s3 uploads from your browser}
+  spec.summary       = %q{Easy straight-to-s3 uploads from your browser}
+  spec.homepage      = "https://github.com/fcheung/s3_browser_uploads"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "rspec-rails", "~> 2.13.0"
+  spec.add_development_dependency "rails", "~> 3.2.13"
+  spec.add_development_dependency "capybara", "~> 2.1.0"
+end

data/spec/form_definition_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe S3BrowserUploads::FormDefinition do
+
+  let(:expires_at) {Time.now + 1800}
+  [:region, :aws_access_key_id, :aws_secret_access_key, :aws_session_token, :bucket, :expires].each do |key|
+    it "should set #{key} from hash passed to" do
+      form = S3BrowserUploads::FormDefinition.new(key => 'foo')
+      form.send(key).should == 'foo'
+    end
+  end
+
+  describe 'endpoint' do
+    it 'should return the url for the bucket' do
+      S3BrowserUploads::FormDefinition.new(:region => 'eu-west-1', :bucket => 'some-bucket').endpoint.should  ==
+        "https://some-bucket.s3-eu-west-1.amazonaws.com"
+    end
+  end
+
+  describe 'aws_session_token' do
+    it 'should be added as the x-amz-security-token field' do
+      form = S3BrowserUploads::FormDefinition.new(:region => 'eu-west-1', :bucket => 'some-bucket', :aws_session_token => 'token')
+      form.fields['x-amz-security-token'].should == 'token'
+      form.conditions['x-amz-security-token'].should == {'x-amz-security-token' => 'token'}
+    end
+  end
+  describe 'encoded_policy' do
+    subject { S3BrowserUploads::FormDefinition.new(:region => 'eu-west-1', :bucket => 'some-bucket', :expires => expires_at)}
+
+    its(:encoded_policy) {should == Base64.strict_encode64(subject.policy_document.to_json)}
+    its(:encoded_policy) {should_not include("\n") }
+
+  end
+
+  describe 'signature' do
+    #base64 hmac of the encoded policy
+    subject { S3BrowserUploads::FormDefinition.new(:aws_secret_access_key => '123XYZ', :region => 'eu-west-1', :bucket => 'some-bucket', :expires => expires_at)}
+    its(:signature) {should == Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), '123XYZ', subject.encoded_policy))}
+    context 'with sample data' do
+      subject do 
+        form = S3BrowserUploads::FormDefinition.new(:aws_secret_access_key => '123XYZ', :region => 'eu-west-1', :bucket => 'some-bucket', :expires => Time.utc(2012,1,1,1,1,1))
+        form.add_field 'acl', 'public-read'
+        form.add_condition 'key', 'starts-with' => 'users/fred/'
+        form
+      end
+      its(:signature) {should == 'uxKt7EExauvCe41l6O44RnMlZmQ='}
+    end
+
+  end
+
+  describe 'policy_document' do
+    let(:form) { S3BrowserUploads::FormDefinition.new(:region => 'eu-west-1', :bucket => 'some-bucket', :expires => expires_at)}
+
+    it 'should contain expiration and conditions' do
+      form.policy_document.keys.should =~ %w(conditions expiration)
+    end
+
+    it 'should set expiration to the xml schema representation of the expiry date' do
+      form.policy_document['expiration'].should == expires_at.xmlschema
+    end
+
+    context 'with no conditions added' do
+      it 'should have a condition on the bucket' do
+        form.policy_document['conditions'].should == [{'bucket' => 'some-bucket'}]
+      end
+    end
+
+    context 'with a strict condition added' do
+      it 'should have the condition' do
+        form.add_condition 'key', 'abc'
+        form.policy_document['conditions'].should =~ [{'bucket' => 'some-bucket'}, {'key' => 'abc'}]
+      end
+    end
+
+    context 'with a starts-with condition' do
+      it 'should have the condition' do
+        form.add_condition 'key', 'starts-with' => 'abc'
+        form.policy_document['conditions'].should =~ [{'bucket' => 'some-bucket'}, ['starts-with', '$key', 'abc']]
+      end
+    end
+
+
+    context 'with a content-length condition' do
+      it 'should have the condition' do
+        form.restrict_content_length 0..1024
+        form.policy_document['conditions'].should =~ [{'bucket' => 'some-bucket'}, ['content-length-range', 0,1024]]
+      end
+    end
+
+    context 'with an eq condition' do
+      it 'should have the condition' do
+        form.add_condition 'key', 'eq' => 'abc'
+        form.policy_document['conditions'].should =~ [{'bucket' => 'some-bucket'}, ['eq', '$key', 'abc']]
+      end
+    end
+
+    context 'when a field has been added' do
+      it 'should add a strict match condition on the field' do
+        form.add_field('acl', 'private')
+        form.policy_document['conditions'].should == [{'bucket' => 'some-bucket'}, {'acl' => 'private'}]
+      end
+
+      it 'should the condition to be overriden' do
+        form.add_field('key', 'users/bob/${filename}')
+        form.add_condition('key', 'starts-with' => 'users/bob/')
+        form.policy_document['conditions'].should == [{'bucket' => 'some-bucket'}, ['starts-with', '$key', 'users/bob/']]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 's3_browser_uploads'
+require 'action_controller'
+module Rails
+  module VERSION
+    STRING = '3.2.13'
+  end
+end
+require 'rspec/rails/adapters'
+require 'rspec/rails/example/rails_example_group'
+require 'rspec/rails/example/view_example_group'
+require 'rspec/rails/example/helper_example_group'
+require 's3_browser_uploads/view_helpers'
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/view_helpers_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe S3BrowserUploads::ViewHelpers, :type => 'helper' do
+  include Capybara::RSpecMatchers
+  include RSpec::Rails::HelperExampleGroup
+  let(:form_definition) do 
+    S3BrowserUploads::FormDefinition.new(:region => 'eu-west-1', 
+                                         :bucket => 'some-bucket',
+                                         :expires => Time.now + 1800,
+                                         :aws_access_key_id => 'AnAccessKey',
+                                         :aws_secret_access_key => 'ASecretKey')
+  end
+
+  describe 's3_form' do
+    let(:content) {helper.s3_form(form_definition) {}}
+
+    describe 'form tag' do
+      subject {Capybara.string(content).find('form')}
+      its([:action]) { should == form_definition.endpoint }
+      its([:enctype]) { should == 'multipart/form-data' }
+      its([:method]) { should == 'POST' }
+
+      context 'html options are passed' do
+        it 'should add them to the form' do
+          helper.s3_form(form_definition, :id => 'a-form'){}.should have_css 'form#a-form'
+        end
+      end
+    end
+
+    describe 'form contents' do
+      subject {content}
+      it 'should include a utf8 enforcer tag' do
+        should have_hidden_input("x-ignore-utf8").with_value("\u2713")
+      end
+
+      it { should  have_hidden_input('AWSAccessKeyID').with_value("AnAccessKey") } 
+      it { should  have_hidden_input('signature').with_value(form_definition.signature) } 
+      it { should  have_hidden_input('policy').with_value(form_definition.encoded_policy) } 
+      it { should  have_hidden_input('bucket').with_value(form_definition.bucket) } 
+
+
+      context 'a field was added to the form' do 
+        before(:each) { form_definition.add_field 'Content-Disposition', 'inline'}
+        it { should have_hidden_input('Content-Disposition').with_value('inline')}
+      end
+
+      context 'the block has content' do
+        let(:content) {helper.s3_form(form_definition) {submit_tag 'Upload'}}
+        
+        it 'should include it in the form' do
+          content.should have_css('input[type=submit][value=Upload]')
+        end
+
+        it 'should include it after the autogenerated inputs' do
+          Capybara.string(content).all('input').last['type'].should == 'submit'
+          Capybara.string(content).all('input').last['value'].should == 'Upload'
+        end
+      end
+
+    end
+  end
+
+  RSpec::Matchers.define :have_hidden_input do |name|
+
+    chain :with_value do |value|
+      @value = value
+    end
+
+    match do |x|
+      selector = "input[type=hidden][name='#{name}']"
+      selector += "[value='#{@value}']" if @value
+      x.should have_css(selector)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: s3_browser_uploads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frederick Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Easy straight-to-s3 uploads from your browser
+email:
+- frederick.cheung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/s3_browser_uploads.rb
+- lib/s3_browser_uploads/form_definition.rb
+- lib/s3_browser_uploads/railtie.rb
+- lib/s3_browser_uploads/version.rb
+- lib/s3_browser_uploads/view_helpers.rb
+- s3_browser_uploads.gemspec
+- spec/form_definition_spec.rb
+- spec/spec_helper.rb
+- spec/view_helpers_spec.rb
+homepage: https://github.com/fcheung/s3_browser_uploads
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: Easy straight-to-s3 uploads from your browser
+test_files:
+- spec/form_definition_spec.rb
+- spec/spec_helper.rb
+- spec/view_helpers_spec.rb