ungulate 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,8 +2,20 @@
 
 According to Wikipedia, this can mean "hoofed animal". Camels have hooves.
 
-This is a simple queue runner that expects a YAML-encoded job description for RMagick. Documentation: read the code, for now.
+This is a gem for uploading and processing images using an Amazon Web Services stack.
+
+It comes with a few goodies:
+
+* ungulate_server.rb - simple queue runner that expects a YAML-encoded job description for RMagick
+* Ungulate::FileUpload - a model for e.g. Rails that does some cryptography stuff - example to follow
+
+And some planned goodies for the future:
+
+* A view helper for Rails that makes it easy to use Ungulate::FileUpload
  
+== Installation
+gem install ungulate
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -13,6 +13,7 @@ begin
     gem.add_dependency "activesupport", ">= 2.3.5"
     gem.add_dependency "right_aws", ">= 1.10.0"
     gem.add_dependency "rmagick", ">= 2.12.2"
+    gem.add_dependency "mime-types", ">= 1.16"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "cucumber", ">= 0.6.2"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/ungulate/file_upload.rb

@@ -1,35 +1,41 @@
 require 'active_support'
-require 'hmac/sha1'
 class Ungulate::FileUpload
   attr_accessor(
-    :access_key_id,
     :bucket_url,
     :key,
-    :policy,
+    :policy
+  )
+
+  cattr_accessor(
+    :access_key_id,
+    :queue_name,
     :secret_access_key
   )
 
   def initialize(params)
-    self.access_key_id = params[:access_key_id]
     self.bucket_url = params[:bucket_url]
     self.key = params[:key]
     self.policy = params[:policy]
-    self.secret_access_key = params[:secret_access_key]
   end
 
   def acl
     condition 'acl'
   end
 
+  def condition(key)
+    conditions.find {|condition| condition.first == key}.second
+  end
+
   def conditions
     @conditions ||=
-      ActiveSupport::JSON.decode(@policy_json)['conditions'].
-        map {|condition| condition.to_a.flatten}
+      @policy_ruby['conditions'].map {|condition| condition.to_a.flatten}
   end
 
-  def policy=(json)
-    @policy_json = json
-    @policy = Base64.encode64(json).gsub("\n", '')
+  def policy=(policy)
+    @policy_ruby = policy
+    @policy_ruby['expiration'].utc
+    policy_json = ActiveSupport::JSON.encode(@policy_ruby)
+    @policy = Base64.encode64(policy_json).gsub("\n", '')
   end
 
   def success_action_redirect
@@ -37,14 +43,10 @@ class Ungulate::FileUpload
   end
 
   def signature
-    sha1 = HMAC::SHA1.new(secret_access_key)
-    sha1 << policy
-    Base64.encode64(sha1.digest).strip
-  end
-
-  protected
-
-  def condition(key)
-    conditions.find {|condition| condition.first == key}.second
+    Base64.encode64(
+      OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'),
+                           secret_access_key, 
+                           policy)
+    ).gsub("\n", '')
   end
 end

data/lib/ungulate.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'right_aws'
 require 'RMagick'
+require 'mime/types'
 
 module Ungulate
   def self.logger
@@ -71,7 +72,11 @@ module Ungulate
       processed_versions.each do |version, image|
         version_key = version_key version
         @logger.info "Storing #{version} @ #{version_key}"
-        bucket.put(version_key, image.to_blob, {}, 'public-read')
+        bucket.put(version_key, 
+                   image.to_blob, 
+                   {},
+                   'public-read',
+                   {'Content-Type' => MIME::Types.type_for(image.format).to_s})
       end
     end
 

data/spec/ungulate/file_upload_spec.rb

@@ -3,29 +3,34 @@ require 'ungulate/file_upload'
 
 module Ungulate
   describe FileUpload do
-    subject do
+    before do
+      @expiration = 10.hours.from_now
       @bucket_url = "http://images.bob.com/"
-      @access_key_id = "asdf"
       @key = "new-file"
 
-      @policy = '{ "expiration": "2007-12-01T12:00:00.000Z",
-  "conditions": [
-    {"bucket": "johnsmith" },
-    ["starts-with", "$key", "user/eric/"],
-    {"acl": "public-read" },
-    {"success_action_redirect": "http://johnsmith.s3.amazonaws.com/successful_upload.html" },
-    ["starts-with", "$Content-Type", "image/"],
-    {"x-amz-meta-uuid": "14365123651274"},
-    ["starts-with", "$x-amz-meta-tag", ""]
-  ]
-}
-'
+      @policy = { 
+        "expiration" => @expiration,
+        "conditions" => [
+          {"bucket" => "johnsmith" },
+          ["starts-with", "$key", "user/eric/"],
+          {"acl" => "public-read" },
+          {"success_action_redirect" => "http://johnsmith.s3.amazonaws.com/successful_upload.html" },
+          ["starts-with", "$Content-Type", "image/"],
+          {"x-amz-meta-uuid" => "14365123651274"},
+          ["starts-with", "$x-amz-meta-tag", ""] 
+        ]
+      }
+
+      @access_key_id = "asdf"
       @secret_access_key = 'uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o'
+      FileUpload.access_key_id = @access_key_id
+      FileUpload.secret_access_key = @secret_access_key
+      FileUpload.queue_name = 'some-queue-name'
+    end
 
+    subject do
       FileUpload.new(
         :bucket_url => @bucket_url,
-        :access_key_id => @access_key_id,
-        :secret_access_key => @secret_access_key,
         :policy => @policy,
         :key => @key
       )
@@ -44,15 +49,72 @@ module Ungulate
     ] }
     its(:access_key_id) { should == @access_key_id }
     its(:key) { should == @key }
+    its(:queue_name) { should == 'some-queue-name' }
     its(:success_action_redirect) { should == 'http://johnsmith.s3.amazonaws.com/successful_upload.html' }
-    its(:signature) { should == '4lCsX4TTdC/69HTJE7RWwEdJFgk=' }
-    its(:policy) { should == 'eyAiZXhwaXJhdGlvbiI6ICIyMDA3LTEyLTAxVDEyOjAwOjAwLjAwMFoiLAogICJjb25kaXRpb25zIjogWwogICAgeyJidWNrZXQiOiAiam9obnNtaXRoIiB9LAogICAgWyJzdGFydHMtd2l0aCIsICIka2V5IiwgInVzZXIvZXJpYy8iXSwKICAgIHsiYWNsIjogInB1YmxpYy1yZWFkIiB9LAogICAgeyJzdWNjZXNzX2FjdGlvbl9yZWRpcmVjdCI6ICJodHRwOi8vam9obnNtaXRoLnMzLmFtYXpvbmF3cy5jb20vc3VjY2Vzc2Z1bF91cGxvYWQuaHRtbCIgfSwKICAgIFsic3RhcnRzLXdpdGgiLCAiJENvbnRlbnQtVHlwZSIsICJpbWFnZS8iXSwKICAgIHsieC1hbXotbWV0YS11dWlkIjogIjE0MzY1MTIzNjUxMjc0In0sCiAgICBbInN0YXJ0cy13aXRoIiwgIiR4LWFtei1tZXRhLXRhZyIsICIiXQogIF0KfQo=' }
+
+    describe "condition" do
+      before do
+        subject.stub(:conditions).
+          and_return([ ['colour', 'blue'], ['predicate', 'subject', 'object'] ])
+      end
+
+      it "should return the value of a tuple" do
+        subject.condition('colour').should == 'blue'
+      end
+    end
 
     describe "conditions" do
       it "should memoize" do
         subject.instance_variable_set('@conditions', :cache)
         subject.conditions.should == :cache
       end
+
+      it "should convert mixed hash and array policy to nested arrays" do
+        subject.
+          instance_variable_set('@policy_ruby', 
+                                { 
+                                  'conditions' => [ 
+                                    {'colour' => 'blue'}, 
+                                    ['predicate', 'subject', 'object'] 
+                                  ]
+                                })
+        subject.conditions.should == [ ['colour', 'blue'], ['predicate', 'subject', 'object'] ]
+      end
+    end
+
+    describe "policy=" do
+      it "should store the ruby version for later use" do
+        subject.policy = @policy
+        subject.instance_variable_get('@policy_ruby').should_not be_blank
+      end
+
+      it "should store the base64 encoded JSON" do
+        subject # load subject without stubs
+
+        ActiveSupport::JSON.stub(:encode).with(@policy).and_return(:some_json)
+        Base64.stub(:encode64).with(:some_json).and_return("ENCODED\nLINE\nLINE")
+        subject.policy = @policy
+        subject.policy.should == "ENCODEDLINELINE"
+      end
+
+      it "should ensure the expiration is utc" do
+        @expiration.should_receive(:utc).at_least(:once)
+        subject.policy = @policy
+      end
+    end
+
+    describe "signature" do
+      before do
+        subject.stub(:policy).and_return(:policy)
+        @sha1 = mock('SHA1')
+        OpenSSL::Digest::Digest.stub(:new).with('sha1').and_return(@sha1)
+        OpenSSL::HMAC.stub(:digest).with(@sha1, @secret_access_key, :policy).and_return(:digest)
+        Base64.stub(:encode64).with(:digest).and_return("str\nipme\n")
+      end
+
+      it "should return the stripped base64 encoded digest" do
+        subject.signature.should == "stripme"
+      end
     end
   end
 end

data/spec/ungulate_spec.rb

@@ -193,8 +193,10 @@ module Ungulate
     describe :process do
       subject do
         job = Job.new
-        @big = mock('Image', :to_blob => 'bigdata')
-        @little = mock('Image', :to_blob => 'littledata')
+        @big = mock('Image', :to_blob => 'bigdata', :format => 'JPEG')
+        @little = mock('Image', :to_blob => 'littledata', :format => 'JPEG')
+        @mime_type = mock('MimeType', :to_s => 'image/jpeg')
+        MIME::Types.stub(:type_for).with('JPEG').and_return(@mime_type)
         job.stub(:processed_versions).and_return([[:big, @big], [:little, @little]])
         job.stub(:bucket).and_return(@bucket)
         job.stub(:version_key).with(:big).and_return('path/to/someimage_big.jpg')
@@ -208,11 +210,13 @@ module Ungulate
         @bucket.should_receive(:put).with('path/to/someimage_big.jpg', 
                                           'bigdata',
                                           {},
-                                          'public-read')
+                                          'public-read',
+                                          {'Content-Type' => 'image/jpeg'})
         @bucket.should_receive(:put).with('path/to/someimage_little.jpg', 
                                           'littledata',
                                           {},
-                                          'public-read')
+                                          'public-read',
+                                          {'Content-Type' => 'image/jpeg'})
       end
 
       context "empty array" do

data/ungulate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ungulate}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Bruce"]
-  s.date = %q{2010-04-08}
+  s.date = %q{2010-04-11}
   s.default_executable = %q{ungulate_server.rb}
   s.description = %q{WIP}
   s.email = %q{andrew@camelpunch.com}
@@ -60,12 +60,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_runtime_dependency(%q<right_aws>, [">= 1.10.0"])
       s.add_runtime_dependency(%q<rmagick>, [">= 2.12.2"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 1.16"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<cucumber>, [">= 0.6.2"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_dependency(%q<right_aws>, [">= 1.10.0"])
       s.add_dependency(%q<rmagick>, [">= 2.12.2"])
+      s.add_dependency(%q<mime-types>, [">= 1.16"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<cucumber>, [">= 0.6.2"])
     end
@@ -73,6 +75,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, [">= 2.3.5"])
     s.add_dependency(%q<right_aws>, [">= 1.10.0"])
     s.add_dependency(%q<rmagick>, [">= 2.12.2"])
+    s.add_dependency(%q<mime-types>, [">= 1.16"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<cucumber>, [">= 0.6.2"])
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andrew Bruce
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 +01:00
+date: 2010-04-11 00:00:00 +01:00
 default_executable: ungulate_server.rb
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,9 +60,22 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: mime-types
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 16
+        version: "1.16"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -72,11 +85,11 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: cucumber
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -86,7 +99,7 @@ dependencies:
         - 2
         version: 0.6.2
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: WIP
 email: andrew@camelpunch.com
 executables: