happening 0.0.7 → 0.0.8

data/README.md

@@ -124,6 +124,31 @@ Happening support the simple S3 PUT upload:
 
 Amazon returns no content on delete, so having a success handler is usually not needed for delete operations.
 
+SSL Support
+=============
+
+Happening will use SSL/HTTPS by default. What it cannot do by default is verify the SSL certificate. This means 
+that traffic is encrypted but nobody can say if the SSL-endpoint is the one you except. In order to verify the 
+SSL certificate you need to provide Happening with the path to a certificate CA collection in PEM format:
+
+    Happening::S3.ssl_options[:cert_chain_file] = '/etc/ca-bundle.crt'
+    
+You can also set this option on each item:
+
+    Happening::S3::Item.new('bucket', 'item_id', 
+      :aws_access_key_id => 'A', 
+      :aws_secret_access_key => 'B',
+      :ssl => {
+        :cert_chain_file => '/etc/ca-bundle.crt'
+      }
+      
+Or even on the request:
+
+    item.get(:ssl => {:cert_chain_file => '/etc/ca-bundle.crt'})
+    
+The SSL options are directly passed to EventMachine, see the [EventMachine documentation](http://eventmachine.rubyforge.org/EventMachine/Connection.html#M000296) for more information on the SSL support.
+
+
 Credits
 =============
 

data/lib/happening/s3/item.rb

@@ -18,9 +18,10 @@ module Happening
           :aws_access_key_id => nil,
           :aws_secret_access_key => nil,
           :retry_count => 4,
-          :permissions => 'private'
+          :permissions => 'private',
+          :ssl => Happening::S3.ssl_options
         }.update(options.symbolize_keys)
-        options.assert_valid_keys(:timeout, :server, :protocol, :aws_access_key_id, :aws_secret_access_key, :retry_count, :permissions)
+        options.assert_valid_keys(:timeout, :server, :protocol, :aws_access_key_id, :aws_secret_access_key, :retry_count, :permissions, :ssl)
         @aws_id = aws_id.to_s
         @bucket = bucket.to_s
       
@@ -31,21 +32,21 @@ module Happening
         headers = needs_to_sign? ? aws.sign("GET", path) : {}
         request_options[:on_success] = blk if blk
         request_options.update(:headers => headers)
-        Happening::S3::Request.new(:get, url, request_options).execute
+        Happening::S3::Request.new(:get, url, {:ssl => options[:ssl]}.update(request_options)).execute
       end
       
       def put(data, request_options = {}, &blk)
         headers = construct_aws_headers('PUT', request_options.delete(:headers) || {})
         request_options[:on_success] = blk if blk
         request_options.update(:headers => headers, :data => data)
-        Happening::S3::Request.new(:put, url, request_options).execute
+        Happening::S3::Request.new(:put, url, {:ssl => options[:ssl]}.update(request_options)).execute
       end
       
       def delete(request_options = {}, &blk)
         headers = needs_to_sign? ? aws.sign("DELETE", path, {'url' => path}) : {}
         request_options[:on_success] = blk if blk
         request_options.update(:headers => headers)
-        Happening::S3::Request.new(:delete, url, request_options).execute
+        Happening::S3::Request.new(:delete, url, {:ssl => options[:ssl]}.update(request_options)).execute
       end
     
       def url

data/lib/happening/s3/request.rb

@@ -13,9 +13,13 @@ module Happening
           :headers => {},
           :on_error => nil,
           :on_success => nil,
-          :data => nil
+          :data => nil,
+          :ssl => {
+            :cert_chain_file => nil,
+            :verify_peer => false
+          }
         }.update(options)
-        options.assert_valid_keys(:timeout, :on_success, :on_error, :retry_count, :headers, :data)
+        options.assert_valid_keys(:timeout, :on_success, :on_error, :retry_count, :headers, :data, :ssl)
         @http_method = http_method
         @url = url
         
@@ -24,7 +28,7 @@ module Happening
       
       def execute
         Happening::Log.debug "#{http_method.to_s.upcase} #{url}"
-        @response = http_class.new(url).send(http_method, :timeout => options[:timeout], :head => options[:headers], :body => options[:data])
+        @response = http_class.new(url).send(http_method, :timeout => options[:timeout], :head => options[:headers], :body => options[:data], :ssl => options[:ssl])
 
         @response.errback { error_callback }
         @response.callback { success_callback }

data/lib/happening/s3.rb

@@ -0,0 +1,16 @@
+module Happening
+  module S3
+
+    def self.ssl_options
+      @_ssl_options ||= {
+        :cert_chain_file => nil,
+        :verify_peer => false
+      }
+    end
+  
+    def self.ssl_options=(val)
+      @_ssl_options = val
+    end
+
+  end
+end

data/lib/happening.rb

@@ -5,6 +5,7 @@ require 'active_support'
 
 require File.dirname(__FILE__) + '/happening/log'
 require File.dirname(__FILE__) + '/happening/aws'
+require File.dirname(__FILE__) + '/happening/s3'
 require File.dirname(__FILE__) + '/happening/s3/request'
 require File.dirname(__FILE__) + '/happening/s3/item'
 

data/test/s3/item_test.rb

@@ -454,5 +454,36 @@ class ItemTest < Test::Unit::TestCase
       
     end
     
+    context "SSL options" do
+      setup do
+        Happening::S3.ssl_options[:verify_peer] = true
+        Happening::S3.ssl_options[:cert_chain_file] = '/etc/foo.ca'
+      end
+      
+      should "re-use the global options" do
+        item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', :aws_secret_access_key => '123')
+        assert item.options[:ssl][:verify_peer]
+        assert_equal '/etc/foo.ca', item.options[:ssl][:cert_chain_file]
+      end
+      
+      should "allow to override global options" do
+        item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', :aws_secret_access_key => '123', :ssl => {:cert_chain_file => nil, :verify_peer => false})
+        assert !item.options[:ssl][:verify_peer]
+        assert_nil item.options[:ssl][:cert_chain_file]
+      end
+      
+      should "pass the options to the Request" do
+        item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', :aws_secret_access_key => '123')
+        Happening::S3::Request.expects(:new).with(:get, anything, {:ssl => {:cert_chain_file => '/etc/foo.ca', :verify_peer => true}, :headers => {'Authorization' => 'AWS abc:LGLdCdGTuLAHs+InbMWEnQR6djc=', 'date' => 'Thu, 25 Feb 2010 10:00:00 GMT'}}).returns(stub(:execute => nil))
+        item.get
+      end
+      
+      should "allow to override the options per request" do
+        item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', :aws_secret_access_key => '123')
+        Happening::S3::Request.expects(:new).with(:get, anything, {:ssl => {:foo => :bar}, :headers => {'Authorization' => 'AWS abc:LGLdCdGTuLAHs+InbMWEnQR6djc=', 'date' => 'Thu, 25 Feb 2010 10:00:00 GMT'}}).returns(stub(:execute => nil))
+        item.get(:ssl => {:foo => :bar})
+      end
+    end
+    
   end
 end

data/test/s3/request_test.rb

@@ -45,18 +45,25 @@ class ItemTest < Test::Unit::TestCase
       
       should "pass the given headers and options" do
         request = mock('em-http-request')
-        request.expects(:get).with(:timeout => 10, :head => {'a' => 'b'}, :body => nil).returns(@response_stub)
+        request.expects(:get).with(:timeout => 10, :head => {'a' => 'b'}, :body => nil,  :ssl => {:verify_peer => false, :cert_chain_file => nil}).returns(@response_stub)
         EventMachine::MockHttpRequest.expects(:new).with('https://www.example.com').returns(request)
         Happening::S3::Request.new(:get, 'https://www.example.com', :headers => {'a' => 'b'}).execute
       end
       
       should "post any given data" do
         request = mock('em-http-request')
-        request.expects(:put).with(:timeout => 10, :body => 'the-data', :head => {}).returns(@response_stub)
+        request.expects(:put).with(:timeout => 10, :body => 'the-data', :head => {},  :ssl => {:verify_peer => false, :cert_chain_file => nil}).returns(@response_stub)
         EventMachine::MockHttpRequest.expects(:new).with('https://www.example.com').returns(request)
         Happening::S3::Request.new(:put, 'https://www.example.com', :data => 'the-data').execute
       end
       
+      should "pass SSL options to em-http-request" do
+        request = mock('em-http-request')
+        request.expects(:put).with(:timeout => 10, :body => 'the-data', :head => {}, :ssl => {:verfiy_peer => true, :cert_chain_file => '/tmp/server.crt'}).returns(@response_stub)
+        EventMachine::MockHttpRequest.expects(:new).with('https://www.example.com').returns(request)
+        Happening::S3::Request.new(:put, 'https://www.example.com', :data => 'the-data', :ssl => {:verfiy_peer => true, :cert_chain_file => '/tmp/server.crt'}).execute
+      end
+      
       context "when handling errors" do
         should "call the user error handler" do
           EventMachine::MockHttpRequest.register('http://www.example.com:80/', :get, {}, error_response(400))

data/test/s3_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class S3Test < Test::Unit::TestCase
+  context "The Happening::S3 module" do
+    
+    should "allow to set global SSL options" do
+      assert Happening::S3.respond_to?(:ssl_options)
+      assert Happening::S3.respond_to?(:ssl_options=)
+    end
+    
+    should "set and get verify_peer" do
+      Happening::S3.ssl_options[:verify_peer] = true
+      assert Happening::S3.ssl_options[:verify_peer]
+      Happening::S3.ssl_options[:verify_peer] = false
+      assert !Happening::S3.ssl_options[:verify_peer]
+    end
+    
+    should "set and get cert_chain_file" do
+      Happening::S3.ssl_options[:cert_chain_file] = '/etc/cacert'
+      assert_equal '/etc/cacert', Happening::S3.ssl_options[:cert_chain_file]
+      Happening::S3.ssl_options[:cert_chain_file] = nil
+      assert_nil Happening::S3.ssl_options[:cert_chain_file]
+    end
+    
+    should "default to no certificate file and no verification" do
+      Happening::S3.instance_variable_set("@_ssl_options", nil)
+      assert !Happening::S3.ssl_options[:verify_peer]
+      assert_nil Happening::S3.ssl_options[:cert_chain_file]
+    end
+    
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Jonathan Weiss
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 +02:00
+date: 2010-04-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - lib/happening.rb
 - lib/happening/aws.rb
 - lib/happening/log.rb
+- lib/happening/s3.rb
 - lib/happening/s3/item.rb
 - lib/happening/s3/request.rb
 has_rdoc: true
@@ -92,4 +93,5 @@ test_files:
 - test/aws_test.rb
 - test/s3/item_test.rb
 - test/s3/request_test.rb
+- test/s3_test.rb
 - test/test_helper.rb