happening 0.1.0 → 0.2.0

data/README.md

@@ -124,6 +124,21 @@ 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.
 
+Head
+=============
+
+You can also just load the headers of an S3 item:
+  
+    EM.run do
+      on_error = Proc.new {|response| puts "An error occured: #{response.response_header.status}"; EM.stop }
+      item = Happening::S3::Item.new('bucket', 'item_id', :aws_access_key_id => 'Your-ID', :aws_secret_access_key => 'secret')
+      item.head(:on_error => on_error) do |response|
+        puts "Headers: #{response.inspect}"
+        EM.stop
+      end
+    end
+
+
 SSL Support
 =============
 

data/lib/happening/aws.rb

@@ -1,5 +1,7 @@
+require 'time'
 module Happening
   class AWS
+    include Utils
     
     AMAZON_HEADER_PREFIX   = 'x-amz-'
     AMAZON_METADATA_PREFIX = 'x-amz-meta-'
@@ -10,12 +12,12 @@ module Happening
     def initialize(aws_access_key_id, aws_secret_access_key)
       @aws_access_key_id = aws_access_key_id
       @aws_secret_access_key = aws_secret_access_key
-      raise ArgumentError, "need AWS Access Key Id and AWS Secret Key" unless aws_access_key_id.present? && aws_secret_access_key.present?
+      raise ArgumentError, "need AWS Access Key Id and AWS Secret Key" if blank?(aws_access_key_id) || blank?(aws_secret_access_key)
     end
     
     def sign(method, path, headers={})
       headers = {
-        'date' => Time.now.httpdate
+        'date' => utc_httpdate
       }.update(headers)
       
       request_description = canonical_request_description(method, path, headers)
@@ -24,6 +26,10 @@ module Happening
     
   protected
         
+    def utc_httpdate
+      Time.now.utc.httpdate
+    end
+
     def generate_signature(request_description)
       Base64.encode64(OpenSSL::HMAC.digest(DIGEST, aws_secret_access_key, request_description)).strip
     end
@@ -56,4 +62,4 @@ module Happening
     end
     
   end
-end
+end

data/lib/happening/s3/item.rb

@@ -4,12 +4,13 @@ require 'cgi'
 module Happening
   module S3
     class Item
+      include Utils
     
       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
-    
+
       def initialize(bucket, aws_id, options = {})
         @options = {
           :timeout => 10,
@@ -20,14 +21,21 @@ module Happening
           :retry_count => 4,
           :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, :ssl)
+        }.update(symbolize_keys(options))
+        assert_valid_keys(options, :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
       
         validate
       end
     
+      def head(request_options = {}, &blk)
+        headers = needs_to_sign? ? aws.sign("HEAD", path) : {}
+        request_options[:on_success] = blk if blk
+        request_options.update(:headers => headers)
+        Happening::S3::Request.new(:head, url, {:ssl => options[:ssl]}.update(request_options)).execute
+      end
+
       def get(request_options = {}, &blk)
         headers = needs_to_sign? ? aws.sign("GET", path) : {}
         request_options[:on_success] = blk if blk
@@ -64,7 +72,7 @@ module Happening
     protected
         
       def needs_to_sign?
-        options[:aws_access_key_id].present?
+        present?(options[:aws_access_key_id])
       end
     
       def dns_bucket?
@@ -81,11 +89,11 @@ module Happening
       end
     
       def validate
-        raise ArgumentError, "need a bucket name" unless bucket.present?
-        raise ArgumentError, "need a AWS Key" unless aws_id.present?
+        raise ArgumentError, "need a bucket name" unless present?(bucket)
+        raise ArgumentError, "need a AWS Key" unless present?(aws_id)
       
         REQUIRED_FIELDS.each do |field|
-          raise ArgumentError, "need field #{field}" unless options[field].present?
+          raise ArgumentError, "need field #{field}" unless present?(options[field])
         end
       
         raise ArgumentError, "unknown protocoll #{options[:protocol]}" unless ['http', 'https'].include?(options[:protocol])

data/lib/happening/s3/request.rb

@@ -1,8 +1,9 @@
 module Happening
   module S3
     class Request
+      include Utils
       
-      VALID_HTTP_METHODS = [:get, :put, :delete]
+      VALID_HTTP_METHODS = [:head, :get, :put, :delete]
       
       attr_accessor :http_method, :url, :options, :response
       
@@ -19,7 +20,7 @@ module Happening
             :verify_peer => false
           }
         }.update(options)
-        options.assert_valid_keys(:timeout, :on_success, :on_error, :retry_count, :headers, :data, :ssl)
+        assert_valid_keys(options, :timeout, :on_success, :on_error, :retry_count, :headers, :data, :ssl)
         @http_method = http_method
         @url = url
         
@@ -99,7 +100,7 @@ module Happening
       
       def handle_redirect
         new_location = response.response_header['LOCATION'] rescue ''
-        raise "Could not find the location to redirect to, empty location header?" if new_location.blank?
+        raise "Could not find the location to redirect to, empty location header?" if blank?(new_location)
 
         new_request = self.class.new(http_method, new_location, options)
         new_request.execute
@@ -107,4 +108,4 @@ module Happening
     
     end
   end
-end
+end

data/lib/happening/utils.rb

@@ -0,0 +1,26 @@
+module Happening
+  module Utils
+    protected
+
+    def symbolize_keys(hash)
+      hash.inject({}) do |h, kv|
+        h[kv[0].to_sym] = kv[1]
+        h
+      end
+    end
+
+    def assert_valid_keys(hash, *valid_keys)
+      unknown_keys = hash.keys - [valid_keys].flatten
+      raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+    end
+
+    def present?(obj)
+      !blank?(obj)
+    end
+
+    def blank?(obj)
+      obj.respond_to?(:empty?) ? obj.empty? : !obj
+    end
+
+  end
+end

data/lib/happening.rb

@@ -3,11 +3,7 @@ require 'em-http'
 require 'openssl'
 require 'logger'
 
-require 'active_support'
-unless {}.respond_to?(:assert_valid_keys)
-  require 'active_support/core_ext'
-end
-
+require File.dirname(__FILE__) + '/happening/utils'
 require File.dirname(__FILE__) + '/happening/log'
 require File.dirname(__FILE__) + '/happening/aws'
 require File.dirname(__FILE__) + '/happening/s3'

data/test/aws_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/test_helper"
+require File.expand_path('../test_helper', __FILE__)
 
 class ItemTest < Test::Unit::TestCase
   context "An Happening::AWS instance" do

data/test/s3/item_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../test_helper"
+require File.expand_path('../../test_helper', __FILE__)
 
 class ItemTest < Test::Unit::TestCase
   context "An Happening::S3::Item instance" do
@@ -8,7 +8,8 @@ class ItemTest < Test::Unit::TestCase
       @item = Happening::S3::Item.new('the-bucket', 'the-key', :aws_access_key_id => '123', :aws_secret_access_key => 'secret', :server => '127.0.0.1')
       
       @time = "Thu, 25 Feb 2010 10:00:00 GMT"
-      Time.stubs(:now).returns(stub(:httpdate => @time, :to_i => 99, :usec => 88))
+      Time.stubs(:now).returns(Time.parse(@time))
+      #stub(:utc_httpdate => @time, :to_i => 99, :usec => 88))
     end
     
     context "validation" do
@@ -106,7 +107,7 @@ class ItemTest < Test::Unit::TestCase
 
       should "sign requests if AWS credentials are passend" do
         time = "Thu, 25 Feb 2010 12:06:33 GMT"
-        Time.stubs(:now).returns(mock(:httpdate => time))
+        Time.stubs(:now).returns(Time.parse(time))
         EventMachine::MockHttpRequest.register('https://bucket.s3.amazonaws.com:443/the-key', :get, {"Authorization"=>"AWS abc:3OEcVbE//maUUmqh3A5ETEcr9TE=", 'date' => time}, fake_response("data-here"))
         
         @item = Happening::S3::Item.new('bucket', 'the-key', :aws_access_key_id => 'abc', :aws_secret_access_key => '123')
@@ -254,7 +255,24 @@ class ItemTest < Test::Unit::TestCase
         end
       end
     end
-    
+
+    context "when loading the headers" do
+      should "request via HEAD" do
+        EventMachine::MockHttpRequest.register('https://bucket.s3.amazonaws.com:443/the-key', :head, {}, fake_response('hy there'))
+
+        @item = Happening::S3::Item.new('bucket', 'the-key')
+        run_in_em_loop do
+          @item.head
+
+          EM.add_timer(1) {
+            EM.stop_event_loop
+            assert_equal 1, EventMachine::MockHttpRequest.count('https://bucket.s3.amazonaws.com:443/the-key', :head, {})
+          }
+
+        end
+      end
+    end
+
     context "when saving an item" do
       
       should "post to the desired location" do

data/test/s3/request_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../test_helper"
+require File.expand_path('../../test_helper', __FILE__)
 
 class ItemTest < Test::Unit::TestCase
   context "An Happening::S3::Request instance" do

data/test/s3_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/test_helper"
+require File.expand_path('../test_helper', __FILE__)
 
 class S3Test < Test::Unit::TestCase
   context "The Happening::S3 module" do

data/test/test_helper.rb

@@ -91,4 +91,4 @@ module EventMachine
   class MockHttpRequest
     @@pass_through_requests = false
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: happening
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jonathan Weiss
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 +02:00
+date: 2011-05-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: jeweler
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,8 +44,36 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: An EventMachine based S3 client - using em-http-request
 email: info@peritor.com
 executables: []
@@ -64,6 +92,7 @@ files:
 - lib/happening/s3.rb
 - lib/happening/s3/item.rb
 - lib/happening/s3/request.rb
+- lib/happening/utils.rb
 - test/aws_test.rb
 - test/s3/item_test.rb
 - test/s3/request_test.rb