policia 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,51 @@
+= Policia
+
+== Information
+
+Policia is a simple generator of Amazon S3 policy document signatures for use in authenticating POST/REST/API uploads to you S3 buckets.
+
+For more information on Amazon S3 Policy Documents {see the their documentation}[http://docs.amazonwebservices.com/AmazonS3/latest/dev/S3_Authentication.html].
+
+== Installation
+
+Install the latest stable release:
+
+    [sudo] gem install policia
+
+Or if using bundler add the following to your Gemfile:
+
+    gem 'policia'
+
+
+== Example use
+
+An quick example, note to at least change YOUR-S3-BUCKET-NAME, YOUR-S3-ACCESS-KEY and YOUR-S3-SECRET-KEY
+
+   @document = { "expiration" => "2012-12-12T00:00:00Z",
+                 "conditions" => [ {"bucket" => "YOUR-S3-BUCKET-NAME"},
+                                   ["starts-with", "$key", ""],
+                                   {"acl" => "public-read"},
+                                   {"success_action_redirect" => "YOUR-CHOICE-OF-CALLBACK"},
+                                   ["starts-with", "$Content-Type", "image"] ] }
+
+   @policy_document = Policia.new("YOUR-S3-SECRET-KEY", @document)
+
+Then in your form (i.e. using ERB template)
+
+    <form action="http://YOUR-S3-BUCKET-NAME.s3.amazonaws.com/" method="post" enctype="multipart/form-data">
+      <input type="hidden" name="key" value="${filename}">
+      <input type="hidden" name="AWSAccessKeyId" value="YOUR-S3-ACCESS-KEY">
+      <input type="hidden" name="acl" value="public-read">
+      <input type="hidden" name="success_action_redirect" value="YOUR-CHOICE-OF-CALLBACK">
+
+      <input type="hidden" name="policy" value="<%= @policy_document.policy %>">
+      <input type="hidden" name="signature" value="<%= @policy_document.signature %>">
+
+      <input type="hidden" name="Content-Type" value="image/jpeg">
+      <!-- Include any additional input fields here -->
+
+      File to upload to S3: <input name="file" type="file"> <input type="submit">
+    </form>
+
+
+The example above will post your file to your amazon s3 bucket root and then return to your given callback with parameters containing file info.

data/lib/policia.rb

@@ -10,10 +10,10 @@ class Policia
   end
 
   def policy
-    Base64.encode64(@document).gsub(/\n|\r/, '')
+    @policy ||= Base64.encode64(@document).gsub(/\n|\r/, '')
   end
 
   def signature
-    Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), @secret, policy)).gsub(/\n| |\r/, '')
+    @signature ||= Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), @secret, policy)).gsub(/\n| |\r/, '')
   end
 end

data/lib/policia/version.rb

@@ -1,3 +1,3 @@
 module Policia
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/policia.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Antony Sastre"]
   s.email       = ["antony@adotapart.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/antonysastre/policia"
   s.summary     = %q{Policia is a simple Amazon S3 Policy Document Signature generator.}
-  s.description = %q{Amazons uses a policy document protocol to allow things like regular forms and resful api to upload files to your buckets. The policy document can be a bit of a hassle to get encoded into a signature - this gem makes it easier. It gives you the choice of providing the document as a nice good'ol ruby Hash. Currently only supports ruby 1.9}
+  s.description = %q{Amazon uses a policy document protocol to allow i.e. regular forms to upload files to your S3 buckets. The policy document can be a bit of a hassle to manage and encode into the nescessary signature - this gem aims to make it easier. Currently only supports ruby 1.9.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -2,7 +2,7 @@
 name: policia
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Antony Sastre
@@ -14,7 +14,7 @@ date: 2011-05-05 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Amazons uses a policy document protocol to allow things like regular forms and resful api to upload files to your buckets. The policy document can be a bit of a hassle to get encoded into a signature - this gem makes it easier. It gives you the choice of providing the document as a nice good'ol ruby Hash. Currently only supports ruby 1.9
+description: Amazon uses a policy document protocol to allow i.e. regular forms to upload files to your S3 buckets. The policy document can be a bit of a hassle to manage and encode into the nescessary signature - this gem aims to make it easier. Currently only supports ruby 1.9.
 email: 
 - antony@adotapart.com
 executables: []
@@ -26,6 +26,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - example/policia_application.rb
 - example/views/index.erb
@@ -35,7 +36,7 @@ files:
 - policia.gemspec
 - test/policia_test.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/antonysastre/policia
 licenses: []
 
 post_install_message: 
@@ -58,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Policia is a simple Amazon S3 Policy Document Signature generator.