s3_form_presenter 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    s3_form_presenter (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  s3_form_presenter!

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 {Lance Carlson}[http://github.com/lancecarlson]
+
+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,10 @@
+= S3 Form Presenter = 
+
+Generates a simple form that is compatible with S3's form API. You can upload S3 assets directly to S3 without hitting your server.
+
+= Usage =
+
+	<% S3FormPresenter::Form.new("some/key/path.ext") do %>
+		 <input name="file" type="file">
+		 <input type="submit" value="Save File">
+	<% end %>

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'bundler/setup'
+
+def gemspec
+  $s3_form_presenter_gemspec ||= Gem::Specification.load("s3_form_presenter.gemspec")
+end
+
+task :gem => :gemspec
+
+desc %{Validate the gemspec file.}
+task :gemspec do
+  gemspec.validate
+end
+
+desc %{Release the gem to RubyGems.org}
+task :release => :gem do
+  sh "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build s3_form_presenter.gemspec"
+  sh "mv s3_form_presenter-#{S3FormPresenter::VERSION}.gem pkg"
+end

data/lib/s3_form_presenter/version.rb

@@ -0,0 +1,3 @@
+module S3FormPresenter
+  VERSION = "0.0.1"
+end

data/lib/s3_form_presenter.rb

@@ -0,0 +1,84 @@
+require 'json'
+require 'base64'
+require 'openssl'
+
+module S3FormPresenter
+  class Form
+    HIDDEN_FIELD_NAMES = :key, :access_key, :secret_key, :acl, :redirect_url, :policy, :signature
+    ACCESSOR_FIELDS = HIDDEN_FIELD_NAMES - [:policy, :signature]
+    RENAMED_FIELDS = {:redirect_url => "success_action_redirect", :access_key => "AWSAccessKeyId"}
+    attr_accessor :bucket, :inner_content
+
+    def initialize(key, options={}, &block)
+      @key = key
+      @access_key = options[:access_key] || ENV["AWS_ACCESS_KEY_ID"]
+      @secret_key = options[:secret_key] || ENV["AWS_SECRET_ACCESS_KEY"]
+      @bucket = options[:bucket] || ENV["AWS_S3_BUCKET"]
+      @acl = options[:acl]
+      if block_given?
+        @inner_content = block.call
+      else
+        @inner_content = %Q(<input name="file" type="file"><input type="submit" value="Upload File" class="btn btn-primary">)
+      end
+      generate_hidden_field_accessors
+    end
+
+    def header
+      %Q(<form action="http://#{bucket}.s3.amazonaws.com/" method="post" enctype="multipart/form-data">)
+    end
+
+    def footer
+      %Q(</form>)
+    end
+
+    def hidden_fields
+      HIDDEN_FIELD_NAMES.map do |field|
+        hidden_field(field, send(field))
+      end
+    end
+    
+    def hidden_field(name, value)
+      %Q(<input type="hidden" name="#{name}" value="#{value}">)
+    end
+
+    def to_html
+      content = ""
+      content += header
+      content += hidden_fields.join
+      content += inner_content
+      content += footer
+    end
+
+    def policy
+      Base64.encode64(policy_object.to_json).gsub(/\n|\r/, '')
+    end
+
+    def signature
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), secret_key, policy)).gsub("\n","")
+    end
+
+    def policy_object
+      {
+        "expiration" => policy_expiration,
+        "conditions" => [
+                         {"bucket" => bucket},
+                         ["starts-with", "$key", "#{key}"],
+                         {"acl" => acl},
+                         {"success_action_redirect" => redirect_url}
+                        ]
+      }
+    end
+
+    private
+
+    def policy_expiration
+      (Time.now + (10*60*60)).utc.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+    end
+
+    def generate_hidden_field_accessors
+      ACCESSOR_FIELDS.each do |field|
+        self.class.send(:attr_accessor, field) unless self.class.respond_to?(field)
+      end
+    end
+  end
+end

data/s3_form_presenter.gemspec

@@ -0,0 +1,17 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 's3_form_presenter/version'
+
+Gem::Specification.new do |gem|
+  gem.name = "s3_form_presenter"
+  gem.version = S3FormPresenter::VERSION
+  gem.rubyforge_project = 's3_form_presenter'
+  gem.summary = %Q{Generates a simple form that is compatible with S3's form API.}
+  gem.description = %Q{Generates a simple form that is compatible with S3's form API. You can upload S3 assets directly to S3 without hitting your server.}
+  gem.email = ["lancecarlson@gmail.com"]
+  gem.homepage = "http://github.com/lancecarlson/s3_form_presenter"
+  gem.authors = ["Lance Carlson"]
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {tests}/*`.split("\n")
+  gem.require_paths = ['lib']
+end

data/test/form_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+
+include S3FormPresenter
+
+describe S3FormPresenter::Form do
+  before do
+    @form = Form.new("some/test/key.ext") do
+      %Q(<input name="file" type="file"><input type="submit" value="Upload File" class="btn btn-primary">)
+    end
+    @form.bucket = "test_bucket"
+    @form.access_key = "test_access_key"
+    @form.secret_key = "test_secret_key"
+    @form.acl = :private
+    @form.redirect_url = "http://www.some-test-redirect.com/some/path"
+  end
+
+  describe "initializer" do
+    it "allows an empty block and provides a sane default" do
+      @form = Form.new("some/test/key.ext").inner_content.must_equal %Q(<input name="file" type="file"><input type="submit" value="Upload File" class="btn btn-primary">)
+    end
+
+    it "should let you override access_key, secret_key and bucket with ENV" do
+      ENV["AWS_ACCESS_KEY_ID"] = "overridden_env_access_key"
+      ENV["AWS_SECRET_ACCESS_KEY"] = "overridden_env_secret_key"
+      ENV["AWS_S3_BUCKET"] = "overridden_env_bucket"
+      @form = Form.new("some/test/key.ext").access_key.must_equal "overridden_env_access_key"
+      @form = Form.new("some/test/key.ext").secret_key.must_equal "overridden_env_secret_key"
+      @form = Form.new("some/test/key.ext").bucket.must_equal "overridden_env_bucket"
+    end
+
+    it "should let you override access_key, secret_key and bucket and acl with options in the initializer" do
+      @form = Form.new("some/test/key.ext", :access_key => "overridden_options_access_key").access_key.must_equal "overridden_options_access_key"
+      @form = Form.new("some/test/key.ext", :secret_key => "overridden_options_secret_key").secret_key.must_equal "overridden_options_secret_key"
+      @form = Form.new("some/test/key.ext", :bucket => "overridden_options_bucket").bucket.must_equal "overridden_options_bucket"
+      @form = Form.new("some/test/key.ext", :acl => "overridden_options_acl").acl.must_equal "overridden_options_acl"
+    end
+  end
+
+  describe "header" do
+    it "generates a multi-part post form with the correct path" do
+      @form.header.must_equal %Q(<form action="http://test_bucket.s3.amazonaws.com/" method="post" enctype="multipart/form-data">)
+    end
+  end
+
+  describe "footer" do
+    it "generates an ending form tag" do
+      @form.footer.must_equal %Q(</form>)
+    end
+  end
+
+  describe "accessor_fields" do
+    it "generates accessors for all accessor_fields after initialize" do
+      Form::ACCESSOR_FIELDS.each do |field|
+        @form.must_respond_to(field)
+        @form.must_respond_to("#{field}=")
+      end
+    end
+  end
+
+  describe "hidden_field" do
+    it "generates HTML for a hidden field tag" do
+      @form.hidden_field("some_name", "some_value").must_equal %Q(<input type="hidden" name="some_name" value="some_value">)
+    end
+  end
+
+  describe "hidden_fields" do
+    it "generates HTML for each hidden_field" do
+      #@form.hidden_fields.must_equal []
+    end
+  end
+
+  describe "policy_json" do
+    it "generates the plain json for the policy" do
+      obj = @form.policy_object
+      conditions = obj["conditions"]
+      obj["expiration"].must_equal (Time.now + (10*60*60)).utc.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+      conditions[0]["bucket"].must_equal "test_bucket"
+      conditions[1].must_equal ["starts-with", "$key", "some/test/key.ext"]
+      conditions[2]["acl"].must_equal :private
+      conditions[3]["success_action_redirect"].must_equal "http://www.some-test-redirect.com/some/path"
+    end
+  end
+
+  describe "policy" do
+    it "generates the base64 encoded policy used in the form" do
+      @form.policy.length.must_equal 288
+    end
+  end
+
+  describe "signature" do
+    it "generates the signature" do
+      @form.signature.length.must_equal 28
+    end
+  end
+
+  describe "inner_content" do
+    it "should grab content from a block if passed" do
+      @form.inner_content.must_equal %Q(<input name="file" type="file"><input type="submit" value="Upload File" class="btn btn-primary">)
+    end
+  end
+
+  describe "to_html" do
+    it "generates the full html of the form" do
+      content = @form.header + @form.hidden_fields.join + @form.inner_content + @form.footer
+      #content = "" # comment out if you want to see real output
+      @form.to_html.must_equal content
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require File.dirname(__FILE__) + '/../lib/s3_form_presenter'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: s3_form_presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lance Carlson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies: []
+description: Generates a simple form that is compatible with S3's form API. You can
+  upload S3 assets directly to S3 without hitting your server.
+email:
+- lancecarlson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/s3_form_presenter.rb
+- lib/s3_form_presenter/version.rb
+- s3_form_presenter.gemspec
+- test/form_test.rb
+- test/test_helper.rb
+homepage: http://github.com/lancecarlson/s3_form_presenter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1406833252476802253
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1406833252476802253
+requirements: []
+rubyforge_project: s3_form_presenter
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Generates a simple form that is compatible with S3's form API.
+test_files: []