s3-upload 0.1

data/CHANGELOG

@@ -0,0 +1,4 @@
+
+*0.1*
+
+* First public release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010, 2011 Niklas Holmgren, Sutajio
+
+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 @@
+S3-Upload
+=========
+
+S3-Upload is a simple helper for creating a signed S3 upload policy, useful
+for allowing untrusted 3rd parties to upload to your bucket. Through, for
+example, a HTML form.
+
+Setup
+-----
+
+    $ gem install s3-upload
+
+    require 's3-upload'
+    S3Upload.access_key_id = ...
+    S3Upload.secret_access_key = ...
+    S3Upload.bucket = 'my-upload-bucket'
+    S3Upload.default_key_prefix = 'uploads/'
+
+Example usage
+-------------
+
+    upload = S3Upload.new(
+      :key_prefix => Time.now.to_s,
+      :expiration_date => 1.year.from_now # Default is 1 hour
+    )
+    render :json => upload
+
+Author
+------
+
+Created by Niklas Holmgren (niklas@sutajio.se) and released under
+the MIT license.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+$LOAD_PATH.unshift 'lib'
+
+task :default => [:test]
+
+task :test do
+  Dir.glob('test/**/*_test.rb').each do |file|
+    require File.expand_path(file)
+  end
+end

data/lib/s3-upload.rb

@@ -0,0 +1,77 @@
+require 'base64'
+require 'hmac-sha1'
+require 'json'
+
+require 's3-upload/version'
+
+class S3Upload
+
+  class<<self
+    attr_accessor :access_key_id
+    attr_accessor :secret_access_key
+    attr_accessor :bucket
+    attr_accessor :default_key_prefix
+  end
+
+  def initialize(options = {})
+    @options = options
+    @options[:AWSAccessKeyId] ||= self.class.access_key_id
+    @options[:AWSSecretAccessKey] ||= self.class.secret_access_key
+    @options[:bucket] ||= self.class.bucket
+    @options[:key_prefix] ||= self.class.default_key_prefix
+    @options[:expiration_date] ||= Time.now + 60*60
+    @options[:success_action_status] = '201'
+  end
+
+  def url
+    "http://#{@options[:bucket]}.s3.amazonaws.com/"
+  end
+
+  def file_param
+    'file'
+  end
+
+  def policy
+    conditions = []
+    conditions << { :bucket => @options[:bucket].to_s }
+    conditions << ['starts-with', '$key', @options[:key_prefix].to_s]
+    conditions << { :success_action_redirect => @options[:success_action_redirect].to_s } if @options[:success_action_redirect]
+    conditions << { :success_action_status => @options[:success_action_status].to_s } if @options[:success_action_status]
+    conditions << ['starts-with', '$Filename', '']
+    if @options[:meta_fields]
+      @options[:meta_fields].sort.each do |meta_field|
+        conditions << ['starts-with', "$#{meta_field}", '']
+      end
+    end
+    Base64.encode64(
+    "{ 
+       'expiration': '#{self.class.expiration_date(@options[:expiration_date])}',
+       'conditions': #{conditions.to_json}
+     }").gsub(/\n|\r/, '')
+  end
+
+  def signature
+    Base64.encode64(HMAC::SHA1.digest(@options[:AWSSecretAccessKey],policy)).strip
+  end
+
+  def params
+    { :success_action_status => @options[:success_action_status],
+      :AWSAccessKeyId => @options[:AWSAccessKeyId],
+      :key => "#{@options[:key_prefix]}${filename}",
+      :policy => self.policy,
+      :signature => self.signature }
+  end
+
+  def as_json(options = {})
+    { :url => self.url,
+      :file_param => self.file_param,
+      :params => self.params }
+  end
+
+private
+
+  def self.expiration_date(seconds_from_now)
+    seconds_from_now.utc.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+  end
+
+end

data/lib/s3-upload/version.rb

@@ -0,0 +1,3 @@
+class S3Upload
+  Version = VERSION = '0.1'
+end

data/test/s3_upload_test.rb

@@ -0,0 +1,26 @@
+require File.expand_path('test/test_helper')
+
+class S3UploadTest < Test::Unit::TestCase
+
+  def setup
+    S3Upload.access_key_id = '...'
+    S3Upload.secret_access_key = '...'
+    S3Upload.bucket = 'my-upload-bucket'
+    S3Upload.default_key_prefix = 'uploads/'
+  end
+
+  def test_can_create_an_upload
+    upload = S3Upload.new(
+      :key_prefix => 'test/',
+      :expiration_date => Time.now + 60
+    )
+    assert_equal 'http://my-upload-bucket.s3.amazonaws.com/', upload.as_json[:url]
+    assert_equal 'file', upload.as_json[:file_param]
+    assert_equal '...', upload.as_json[:params][:AWSAccessKeyId]
+    assert_match /^test\//, upload.as_json[:params][:key]
+    assert_equal '201', upload.as_json[:params][:success_action_status]
+    assert upload.as_json[:params][:policy]
+    assert upload.as_json[:params][:signature]
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'test/unit'
+require 's3-upload'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: s3-upload
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Niklas Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+description: |-
+  S3-Upload is a simple helper for creating a signed S3 upload policy, useful
+    for allowing untrusted 3rd parties to upload to your bucket. Through, for
+    example, a HTML form.
+email: niklas@sutajio.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- README.md
+- Rakefile
+- LICENSE
+- CHANGELOG
+- lib/s3-upload/version.rb
+- lib/s3-upload.rb
+- test/s3_upload_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/sutajio/s3-upload/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: S3-Upload is a simple helper for creating a signed S3 upload policy
+test_files: []
+