aws-s3 0.1.0

data/lib/aws/s3/owner.rb

@@ -0,0 +1,44 @@
+module AWS
+  module S3
+    # Entities in S3 have an associated owner (the person who created them). The owner is a canonical representation of an 
+    # entity in the S3 system. It has an <tt>id</tt> and a <tt>display_name</tt>. 
+    # 
+    # These attributes can be used when specifying a ACL::Grantee for an ACL::Grant.
+    #
+    # You can retrieve the owner of the current account by calling Owner.current.
+    class Owner
+      undef_method :id # Get rid of Object#id
+      include SelectiveAttributeProxy
+      
+      class << self
+        # The owner of the current account.
+        def current
+          response = Service.get('/')
+          new(response.parsed['owner']) if response.parsed['owner']
+        end
+        memoized :current
+      end
+      
+      def initialize(attributes = {}) #:nodoc:
+        @attributes = attributes
+      end
+      
+      def ==(other_owner) #:nodoc:
+        hash == other_owner.hash
+      end
+      
+      def hash #:nodoc
+        [id, display_name].join.hash
+      end
+      
+      private
+        def proxiable_attribute?(name)
+          valid_attributes.include?(name)
+        end
+        
+        def valid_attributes
+          %w(id display_name)
+        end
+    end
+  end
+end

data/lib/aws/s3/parsing.rb

@@ -0,0 +1,138 @@
+#:stopdoc:
+module AWS
+  module S3
+    module Parsing
+      class << self
+        def parser=(parsing_library)
+          XmlParser.parsing_library = parsing_library
+        end
+        
+        def parser
+          XmlParser.parsing_library
+        end
+      end
+      
+      module Typecasting
+        def typecast(object)
+          case object
+          when Hash
+            typecast_hash(object)
+          when Array
+            object.map {|element| typecast(element)}
+          when String
+            CoercibleString.coerce(object)
+          else
+            object
+          end
+        end
+        
+        def typecast_hash(hash)
+          if content = hash['__content__']  
+            typecast(content)
+          else
+            keys   = hash.keys.map {|key| key.underscore}
+            values = hash.values.map {|value| typecast(value)}
+            keys.inject({}) do |new_hash, key|
+              new_hash[key] = values.shift
+              new_hash
+            end
+          end
+        end
+      end
+
+      class CoercibleString < String
+        attr_accessor :generator
+        class << self
+          def coerce(string)
+            new(string).coerce
+          end
+        end
+        
+        def coerce
+          attempt = nil
+          break unless (attempt = coercions.next).nil? while coercions.next?
+          attempt.nil? ? self : attempt
+        end
+        
+        private
+        
+          def coercions
+            Generator.new do |self.generator|
+              try { self == 'true' }
+              try { [self == 'false', false] }
+              try { Integer(self) }
+              try { Time.parse(self) } if appears_to_be_date?
+            end
+          end
+          memoized :coercions
+        
+          def try
+            attempt, desired = yield
+            generator.yield(desired.nil? ? attempt : desired) if attempt
+          rescue ArgumentError
+            generator.yield nil
+          end
+          
+          # Lame hack since Date._parse is so accepting. S3 dates are of the form: '2006-10-29T23:14:47.000Z'
+          # so unless the string looks like that, don't even try, otherwise it might convert an object's
+          # key from something like '03 1-2-3-Apple-Tree.mp3' to Sat Feb 03 00:00:00 CST 2001.
+          def appears_to_be_date?
+            self =~ /^\d{4}-\d{2}-\d{2}\w\d{2}:\d{2}:\d{2}/
+          end
+      end
+      
+      class XmlParser < Hash
+        include Typecasting
+        
+        class << self
+          attr_accessor :parsing_library
+        end
+        
+        attr_reader :body, :xml_in, :root
+        
+        def initialize(body)
+          @body = body
+          parse
+          set_root
+          typecast_xml_in
+        end
+      
+        private
+      
+          def parse
+            @xml_in = self.class.parsing_library.xml_in(body, parsing_options)
+          end
+          
+          def parsing_options
+            {
+              # Includes the enclosing tag as the top level key
+              'keeproot'      => true, 
+              # Makes tag value available via the '__content__' key
+              'contentkey'    => '__content__', 
+              # Always parse tags into a hash, even when there are no attributes 
+              # (unless there is also no value, in which case it is nil)
+              'forcecontent'  => true, 
+              # If a tag is empty, makes its content nil
+              'suppressempty' => nil,
+              # Force nested elements to be put into an array, even if there is only one of them
+              'forcearray'    => ['Contents', 'Bucket', 'Grant']
+            }
+          end
+          
+          def set_root
+            @root = @xml_in.keys.first.underscore
+          end
+          
+          def typecast_xml_in
+            typecast_xml = {}
+            @xml_in.dup.each do |key, value| # Some typecasting is destructive so we dup
+              typecast_xml[key.underscore] = typecast(value)
+            end
+            # An empty body will try to update with a string so only update if the result is a hash
+            update(typecast_xml[root]) if typecast_xml[root].is_a?(Hash)
+          end
+      end
+    end
+  end
+end
+#:startdoc:

data/lib/aws/s3/response.rb

@@ -0,0 +1,180 @@
+#:stopdoc:
+module AWS
+  module S3
+    class Base
+      class Response < String  
+        attr_reader :response, :body, :parsed
+        def initialize(response)
+          @response = response
+          @body     = response.body.to_s
+          super(body)
+        end
+    
+        def headers
+          headers = {}
+          response.each do |header, value|
+            headers[header] = value
+          end
+          headers
+        end
+        memoized :headers
+    
+        def [](header)
+          headers[header]
+        end
+    
+        def each(&block)
+          headers.each(&block)
+        end
+    
+        def code
+          response.code.to_i
+        end
+    
+        {:success      => 200..299, :redirect     => 300..399,
+         :client_error => 400..499, :server_error => 500..599}.each do |result, code_range|
+          class_eval(<<-EVAL, __FILE__, __LINE__)
+            def #{result}? 
+              return false unless response
+              (#{code_range}).include? code
+            end
+          EVAL
+        end
+    
+        def error?
+          !success? && response['content-type'] == 'application/xml' && parsed.root == 'error'
+        end
+    
+        def error
+          Error.new(parsed, self)
+        end
+        memoized :error
+    
+        def parsed
+          # XmlSimple is picky about what kind of object it parses, so we pass in body rather than self
+          Parsing::XmlParser.new(body)
+        end
+        memoized :parsed
+    
+        def inspect
+          "#<#{self.class}:0x#{object_id} #{response.code} #{response.message}>"
+        end
+      end
+    end
+    
+    class Bucket  
+      class Response < Base::Response
+        def bucket
+          parsed
+        end
+      end
+    end
+  
+    class S3Object
+      class Response < Base::Response
+        def etag
+          headers['etag'][1...-1]
+        end
+      end
+    end
+
+    class Service
+      class Response < Base::Response
+        def empty?
+          parsed['buckets'].nil?
+        end
+  
+        def buckets
+          parsed['buckets']['bucket'] || []
+        end
+      end
+    end
+    
+    module ACL
+      class Policy
+        class Response < Base::Response
+          alias_method :policy, :parsed
+        end
+      end
+    end
+    
+    # Requests whose response code is between 300 and 599 and contain an <Error></Error> in their body
+    # are wrapped in an Error::Response. This Error::Response contains an Error object which raises an exception
+    # that corresponds to the error in the response body. The exception object contains the ErrorResponse, so
+    # in all cases where a request happens, you can rescue ResponseError and have access to the ErrorResponse and
+    # its Error object which contains information about the ResponseError.
+    #
+    #   begin
+    #     Bucket.create(..)
+    #   rescue ResponseError => exception
+    #    exception.response
+    #    # => <Error::Response>
+    #    exception.response.error
+    #    # => <Error>
+    #   end
+    class Error
+      class Response < Base::Response
+        def error? 
+          true
+        end
+      
+        def inspect
+          "#<#{self.class.name}:0x#{object_id}  #{response.code} #{error.code}: '#{error.message}'>"
+        end
+      end
+    end
+
+    # Guess response class name from current class name. If the guessed response class doesn't exist
+    # do the same thing to the current class's parent class, up the inheritance heirarchy until either
+    # a response class is found or until we get to the top of the heirarchy in which case we just use 
+    # the the Base response class.
+    #
+    # Important: This implemantation assumes that the Base class has a corresponding Base::Response.
+    class FindResponseClass #:nodoc:
+      class << self
+        def for(start)
+          new(start).find
+        end
+      end
+  
+      def initialize(start)
+        @container     = AWS::S3
+        @current_class = start
+      end
+  
+      def find
+        self.current_class = current_class.superclass until response_class_found?            
+        target.const_get(class_to_find)
+      end
+  
+      private
+        attr_reader :container
+        attr_accessor :current_class
+        
+        def target
+          container.const_get(current_name)
+        end
+        
+        def target?
+          container.const_defined?(current_name)
+        end
+        
+        def response_class_found?
+          target? && target.const_defined?(class_to_find)
+        end
+        
+        def class_to_find
+          :Response
+        end
+        
+        def current_name
+          truncate(current_class)
+        end
+        
+        def truncate(klass)
+          klass.name[/[^:]+$/]
+        end
+      end
+  end
+end
+#:startdoc:

data/lib/aws/s3/service.rb

@@ -0,0 +1,43 @@
+module AWS
+  module S3
+    # The service lets you find out general information about your account, like what buckets you have. 
+    # 
+    #   Service.buckets
+    #   # => []
+    class Service < Base
+      @@response = nil #:nodoc:
+      
+      class << self
+        # List all your buckets
+        def buckets
+          response = get('/')
+          if response.empty?
+            []
+          else
+            response.buckets.map {|attributes| Bucket.new(attributes)}
+          end
+        end
+        memoized :buckets
+        
+        # Sometimes methods that make requests to the S3 servers return some object, like a Bucket or an S3Object. 
+        # Othertimes they return just <tt>true</tt>. Other times they raise an exception that you may want to rescue. Despite all these 
+        # possible outcomes, every method that makes a request stores its response object for you in Service.response. You can always 
+        # get to the last request's response via Service.response.
+        # 
+        #   objects = Bucket.objects('jukebox')
+        #   Service.response.success?
+        #   # => true
+        #
+        # This is also useful when an error exception is raised in the console which you weren't expecting. You can 
+        # root around in the response to get more details of what might have gone wrong.
+        def response
+          @@response
+        end
+        
+        def response=(response) #:nodoc:
+          @@response = response
+        end
+      end
+    end
+  end
+end

data/lib/aws/s3/version.rb

@@ -0,0 +1,12 @@
+module AWS
+  module S3
+    module VERSION #:nodoc:
+      MAJOR    = '0'
+      MINOR    = '1'
+      TINY     = '0'
+      REVISION = '$Revision: 66 $'[/\d+/]
+    end
+    
+    Version = [VERSION::MAJOR, VERSION::MINOR, VERSION::TINY || VERSION::REVISION] * '.'
+  end
+end

data/support/faster-xml-simple/lib/faster_xml_simple.rb

@@ -0,0 +1,115 @@
+# 
+# Copyright (c) 2006 Michael Koziarski
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in the
+# Software without restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+# AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'rubygems'
+require 'xml/libxml'
+
+class FasterXmlSimple
+  class << self
+    def xml_in(string, options={})
+      new(string, options).out
+    end
+  end
+  
+  attr_reader :doc, :options, :current_element
+  
+  def initialize(string, options)
+    @doc             = parse(string)
+    @options         = default_options.merge options
+    @current_element = nil
+  end
+  
+  def out
+    {doc.root.name => collapse(doc.root, doc.root.name)}
+  end
+  
+  private
+    def default_options
+      {'contentkey' => '__content__', 'forcearray' => []}
+    end
+  
+    def collapse(element, key_name)
+      result = hash_of_attributes(element) 
+      if text_node? element
+        text = collapse_text(element)
+        result.merge!(content_key => text) if text =~ /\S/
+      elsif element.children?
+        element.inject(result) do |hash, child|
+          (hash[child.name] ||= []) << collapse(child, element.name) unless child.text?
+          hash
+        end
+      end
+      return nil if result.empty?
+      # Compact them to ensure it complies with the user's requests
+      inline_single_element_arrays(result) 
+      suppress_empty(result) if suppress_empty?
+
+      result
+    end
+  
+    def content_key
+      options['contentkey']
+    end
+  
+    def force_array?(key_name)
+      options['forcearray'].include?(key_name)
+    end
+  
+    def inline_single_element_arrays(result)
+      result.each do |key, value|
+        if value.size == 1 && value.is_a?(Array) && !force_array?(key)
+          result[key] = value.first
+        end
+      end    
+    end
+  
+    def suppress_empty(result)
+      result.delete content_key if result[content_key] !~ /\S/ 
+    end
+  
+    def suppress_empty?
+      options.has_key? 'suppressempty'
+    end
+  
+    # a text node is one with 1 or more child nodes which are
+    # text nodes, and no non-text children
+    def text_node?(element)
+      !element.text? && element.all? {|c| c.text?}
+    end
+  
+    # takes a text node, and collapses it into a string
+    def collapse_text(element)
+      element.map {|c| c.content } * ''
+    end
+  
+    def hash_of_attributes(element)
+      result = {}
+      element.each_attr do |attribute| 
+        name = attribute.name
+        name = [attribute.ns, attribute.name].join(':') if attribute.ns?
+        result[name] = attribute.value 
+      end
+      result
+    end
+  
+    def parse(string)
+      XML::Parser.string(string).parse
+    end
+end