happening 0.0.6 → 0.0.7

data/README.md

@@ -90,6 +90,23 @@ Setting permissions looks like this:
       item = Happening::S3::Item.new('bucket', 'item_id', :aws_access_key_id => 'Your-ID', :aws_secret_access_key => 'secret', :permissions => 'public-write')
       item.get(:on_success => on_success, :on_error => on_error)
     end
+    
+Custom headers:
+
+    EM.run do
+      on_error = Proc.new {|http| puts "An error occured: #{http.response_header.status}"; EM.stop }
+      on_success = Proc.new {|http| puts "the response is: #{http.response}"; EM.stop }
+      item = Happening::S3::Item.new('bucket', 'item_id', :aws_access_key_id => 'Your-ID', :aws_secret_access_key => 'secret', :permissions => 'public-write')
+      item.put(:on_success => on_success, 
+               :on_error => on_error, 
+               :headers => {
+                 'Cache-Control' => "max-age=252460800", 
+                 'Content-Type' => 'text/html', 
+                 'Expires' => 'Fri, 16 Nov 2018 22:09:29 GMT', 
+                 'x-amz-meta-abc' => 'ABC'
+                })
+    end
+
 
 Deleting
 =============

data/lib/happening/s3/item.rb

@@ -6,6 +6,7 @@ module Happening
     class Item
     
       REQUIRED_FIELDS = [:server]
+      VALID_HEADERS = ['Cache-Control', 'Content-Disposition', 'Content-Encoding', 'Content-Length', 'Content-MD5', 'Content-Type', 'Expect', 'Expires']
     
       attr_accessor :bucket, :aws_id, :options
     
@@ -34,8 +35,7 @@ module Happening
       end
       
       def put(data, request_options = {}, &blk)
-        permissions = options[:permissions] != 'private' ? {'x-amz-acl' => options[:permissions] } : {}
-        headers = needs_to_sign? ? aws.sign("PUT", path, permissions.update({'url' => path})) : {}
+        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
@@ -93,6 +93,18 @@ module Happening
       def aws
         @aws ||= Happening::AWS.new(options[:aws_access_key_id], options[:aws_secret_access_key])
       end
+      
+      def construct_aws_headers(http_method, headers = {})
+        unless headers.keys.all?{|header| VALID_HEADERS.include?(header) || header.to_s.match(/\Ax-amz-/) }
+          raise ArgumentError, "invalid headers. All headers must either one of #{VALID_HEADERS} or start with 'x-amz-'" 
+        end
+        
+        permissions = options[:permissions] != 'private' ? {'x-amz-acl' => options[:permissions] } : {}
+        headers.update(permissions)
+        headers.update({'url' => path})
+        
+        headers = needs_to_sign? ? aws.sign(http_method, path, headers) : headers
+      end
     
     end
   end

data/test/s3/item_test.rb

@@ -329,6 +329,53 @@ class ItemTest < Test::Unit::TestCase
         end
       end
       
+      should "allow to set custom headers" do
+       EventMachine::MockHttpRequest.register('https://bucket.s3.amazonaws.com:443/the-key', :put, {
+         "Authorization"=>"AWS abc:wrPkGKrlwH2AtNzBVS80vU73TDc=", 
+         'date' => @time, 
+         'url' => "/bucket/the-key",
+         "x-amz-acl" => 'public-read',
+         'Cache-Control' => "max-age=252460800",
+         'Expires' => 'Fri, 16 Nov 2018 22:09:29 GMT',
+         'x-amz-meta-abc' => 'ABC'}, fake_response("data-here"))
+         
+        @item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', 
+                                                             :aws_secret_access_key => '123' , 
+                                                             :permissions => 'public-read')
+        run_in_em_loop do
+          @item.put('content', :headers => { 
+             'Expires' => 'Fri, 16 Nov 2018 22:09:29 GMT',
+             'Cache-Control' => "max-age=252460800",
+             'x-amz-meta-abc' => 'ABC'})
+
+          EM.add_timer(1) {
+            EM.stop_event_loop
+            assert_equal 1, EventMachine::MockHttpRequest.count('https://bucket.s3.amazonaws.com:443/the-key', :put, {
+              "Authorization"=>"AWS abc:wrPkGKrlwH2AtNzBVS80vU73TDc=", 
+              'date' => @time, 
+              'url' => "/bucket/the-key",
+              'x-amz-acl' => 'public-read',
+              'Cache-Control' => "max-age=252460800",
+              'Expires' => 'Fri, 16 Nov 2018 22:09:29 GMT',
+              'x-amz-meta-abc' => 'ABC'})
+          }
+
+        end
+      end
+      
+      should "validate the headers" do
+
+        @item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', 
+                                                             :aws_secret_access_key => '123' , 
+                                                             :permissions => 'public-read')
+                                                             
+        assert_raise(ArgumentError) do
+          @item.put('content', :headers => { 
+             'expires' => 'Fri, 16 Nov 2018 22:09:29 GMT',
+             'cache_control' => "max-age=252460800"})
+        end                                                    
+      end
+      
       should "re-post to a new location" do
         EventMachine::MockHttpRequest.register('https://bucket.s3.amazonaws.com:443/the-key', :put, {
           "Authorization"=>"AWS abc:lZMKxGDKcQ1PH8yjbpyN7o2sPWg=", 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jonathan Weiss