aws-sdk 1.0.1 → 1.0.2

data/lib/aws/base_client.rb

@@ -70,10 +70,11 @@ module AWS
         options[:"#{self.class.service_ruby_name}_endpoint"] = 
           options.delete(:endpoint)
       end
-      
-      @config = options[:config]
+
+      options_without_config = options.dup
+      @config = options_without_config.delete(:config)
       @config ||= AWS.config
-      @config = @config.with(options)
+      @config = @config.with(options_without_config)
       @signer = @config.signer
       @http_handler = @config.http_handler
       @stubs = {}
@@ -155,8 +156,8 @@ module AWS
     def new_request
       req = self.class::REQUEST_CLASS.new
       req.http_method = 'POST'
-      req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-      req.add_param 'Timestamp', Time.now.utc.strftime('%Y-%m-%dT%TZ')
+      req.headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=utf-8'
+      req.add_param 'Timestamp', Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
       req.add_param 'Version', self.class::API_VERSION
       req
     end
@@ -221,8 +222,7 @@ module AWS
     private
     def make_async_request response
 
-      pauses = async_request_with_retries(response,
-                                          response.http_request)
+      pauses = async_request_with_retries(response, response.http_request)
 
       response
 
@@ -378,12 +378,15 @@ module AWS
           opts = options.dup
           opts.delete(:async)
 
-          # configure the http request
           http_request = new_request
+
+          # configure the http request
           http_request.host = endpoint
+          http_request.proxy_uri = config.proxy_uri
           http_request.use_ssl = config.use_ssl?
           http_request.ssl_verify_peer = config.ssl_verify_peer?
           http_request.ssl_ca_file = config.ssl_ca_file
+
           send("configure_#{name}_request", http_request, opts, &block)
           http_request.headers["user-agent"] = user_agent_string
           http_request.add_authorization!(signer)

data/lib/aws/cacheable.rb

@@ -81,10 +81,9 @@ module AWS
 
     end
 
-    def self.included(mod)
+    def self.included mod
       mod.extend ClassMethods
-      mod.extend Naming unless
-        mod.respond_to?(:service_ruby_name)
+      mod.extend Naming unless mod.respond_to?(:service_ruby_name)
     end
 
   end

data/lib/aws/common.rb

@@ -41,7 +41,7 @@ module AWS
     #   sqs.config.max_retries #=> 2
     #
     # If you want to change a configuration value for a single instance you
-    # pass the new configuration value to that objects initializer:
+    # pass the new configuration value to that object's initializer:
     #
     #   AWS::SQS.new(:max_retries => 0)
     #
@@ -65,6 +65,12 @@ module AWS
     #   messages generated by service requets.  A logger needs to respond to
     #   #log and must accept a severity (e.g. :info, :error, etc) and
     #   a string message.
+    # @option options [String, URI, nil] :proxy_uri (nil) The URI of the proxy 
+    #    to send service requests through.  You can pass a URI object or a 
+    #    URI string:
+    #
+    #       AWS.config(:proxy_uri => 'https://user:password@my.proxy:443/path?query')
+    # 
     # @option options [String] :s3_endpoint ('s3.amazonaws.com') The
     #   service endpoint to use when communicating with Amazon S3.
     # @option [Integer] :s3_multipart_threshold (16777216) When uploading

data/lib/aws/configuration.rb

@@ -14,6 +14,7 @@
 require 'aws/default_signer'
 require 'aws/http/httparty_handler'
 require 'set'
+require 'uri'
 
 module AWS
 
@@ -81,6 +82,7 @@ module AWS
         :sns_endpoint => 'sns.us-east-1.amazonaws.com',
         :sqs_endpoint => 'sqs.us-east-1.amazonaws.com',
         :stub_requests => false,
+        :proxy_uri => nil,
         :use_ssl => true,
         :user_agent_prefix => nil,
         :ssl_verify_peer => true,
@@ -259,6 +261,12 @@ module AWS
       @options[:ssl_ca_file]
     end
 
+    # @return [URI::HTTP, URI::HTTPS, nil] Returns the URI for the configured
+    #   proxy if there is one.  Defaults to nil.
+    def proxy_uri
+      @options[:proxy_uri] ? URI.parse(@options[:proxy_uri].to_s) : nil
+    end
+
     # @private
     def inspect
       "<#{self.class}>"

data/lib/aws/default_signer.rb

@@ -16,16 +16,31 @@ require 'openssl'
 
 module AWS
 
-  # @private
+  # Computes signatures using credentials that are stored in memory.
   class DefaultSigner
 
-    attr_reader :access_key_id, :secret_access_key
+    # @return [String] The Access Key ID used to sign requests.
+    attr_reader :access_key_id
 
+    # @return [String] The Secret Access Key used to sign requests.
+    attr_reader :secret_access_key
+
+    # @param [String] access_key_id The Access Key ID used to sign
+    #   requests.
+    #
+    # @param [String] secret_access_key The Secret Access Key used to
+    #   sign requests.
     def initialize(access_key_id, secret_access_key)
       @access_key_id = access_key_id
       @secret_access_key = secret_access_key
     end
 
+    # Signs a string using the credentials stored in memory.
+    #
+    # @param [String] string_to_sign The string to sign.
+    #
+    # @param [String] digest_method The digest method to use when
+    #   computing the HMAC digest.
     def sign(string_to_sign, digest_method = 'sha256')
       Base64.encode64(
         OpenSSL::HMAC.digest(

data/lib/aws/ec2/client.rb

@@ -31,21 +31,23 @@ module AWS
       REQUEST_CLASS = EC2::Request
 
       # @private
-      CACHEABLE_REQUESTS = Set[:describe_instances,
-                               :describe_instance_attribute,
-                               :describe_images,
-                               :describe_image_attribute,
-                               :describe_volumes,
-                               :describe_security_groups,
-                               :describe_addresses,
-                               :describe_key_pairs,
-                               :describe_regions,
-                               :describe_availability_zones,
-                               :describe_reserved_instances,
-                               :describe_reserved_instances_offerings,
-                               :describe_snapshots,
-                               :describe_snapshot_attribute,
-                               :describe_tags]
+      CACHEABLE_REQUESTS = Set[
+        :describe_instances,
+        :describe_instance_attribute,
+        :describe_images,
+        :describe_image_attribute,
+        :describe_volumes,
+        :describe_security_groups,
+        :describe_addresses,
+        :describe_key_pairs,
+        :describe_regions,
+        :describe_availability_zones,
+        :describe_reserved_instances,
+        :describe_reserved_instances_offerings,
+        :describe_snapshots,
+        :describe_snapshot_attribute,
+        :describe_tags
+      ]
 
       configure_client
 

data/lib/aws/ec2/image.rb

@@ -94,6 +94,9 @@ module AWS
     #   [delete_on_termination] True if the Amazon EBS volume is
     #                           deleted on instance termination.
     #
+    # @attr_reader [Array<String>] product_codes Returns an array of
+    #   product codes attached to this instance.
+    #
     # @attr_reader [Symbol] virtualization_type The type of
     #   virtualization of the AMI.  Possible values:
     #
@@ -229,6 +232,30 @@ module AWS
         end
       end
 
+      describe_call_attribute :product_codes, :memoize => true do
+        translate_output do |list|
+          (list || []).collect{|item| item.product_code }
+        end
+      end
+
+      # Adds one or more product codes:
+      #
+      #   image.add_product_codes 'ABCXYZ', 'MNOPQR'
+      #
+      # You can also pass an array of product codes:
+      # 
+      #   image.add_product_codes ['ABCXYZ', 'MNOPQR']
+      #
+      # @param [Array<String>] product_codes 
+      # @return [nil]
+      def add_product_codes *product_codes
+        opts = {}
+        opts[:image_id] = self.id
+        opts[:product_codes] = product_codes.flatten
+        client.modify_image_attribute(opts)
+        nil
+      end
+
       # @private
       def __permissions_attribute__
         "launchPermission"

data/lib/aws/ec2/resource.rb

@@ -26,11 +26,9 @@ module AWS
       def initialize(*args)
         super
         @memoized_attributes = {}
-        if options = args.last and
-            options.kind_of?(Hash)
+        if options = args.last and options.kind_of?(Hash)
           self.class.memoized_attributes.each do |att|
-            @memoized_attributes[att] = options[att] if
-              options.key?(att)
+            @memoized_attributes[att] = options[att] if options.key?(att)
           end
         end
       end
@@ -311,10 +309,12 @@ module AWS
           request_name = Inflection.class_name(name.to_s)
           request_name = request_name[0,1].downcase + request_name[1..-1]
 
-          # define the getter and setter
+          # define getter
           define_method(getter) do
             retrieve_attribute(getter) { describe_attribute_call(request_name) }
           end
+
+          # define setter
           define_method(setter) do |input_value|
             set_mutable_attribute(name, input_value)
           end unless opts[:setter] == false

data/lib/aws/http/curb_handler.rb

@@ -85,11 +85,15 @@ module AWS
         url = request.use_ssl? ? 
           "https://#{request.host}:443#{request.uri}" :
           "http://#{request.host}#{request.uri}"
-        puts url
 
         curl = Curl::Easy.new(url)
         curl.headers = request.headers
 
+        if proxy = request.proxy_uri
+          curl.proxy_url = proxy.to_s
+          curl.proxy_port = proxy.port
+        end
+
         curl.on_header {|header_data|
           name, value = header_data.strip.split(/:\s+/, 2)
           response.headers[name] = value

data/lib/aws/http/httparty_handler.rb

@@ -16,9 +16,38 @@ require 'httparty'
 module AWS
   module Http
 
-    # @private
+    # Makes HTTP requests using HTTParty.  This is the default
+    # handler, so you don't need to do anything special to configure
+    # it.  However, you can directly instantiate this class in order
+    # to send extra options to HTTParty, for example to enable an HTTP
+    # proxy:
+    #
+    #   AWS.config(
+    #     :http_handler => AWS::Http::HTTPartyHandler.new(
+    #       :http_proxyaddr => "http://myproxy.com",
+    #       :http_proxyport => 80
+    #     )
+    #   )
+    #
     class HTTPartyHandler
 
+      # @return [Hash] The default options to send to HTTParty on each
+      #   request.
+      attr_reader :default_request_options
+
+      # Constructs a new HTTP handler using HTTParty.
+      #
+      # @param [Hash] options Default options to send to HTTParty on
+      #   each request.  These options will be sent to +get+, +post+,
+      #   +head+, +put+, or +delete+ when a request is made.  Note
+      #   that +:body+, +:headers+, +:parser+, and +:ssl_ca_file+ are
+      #   ignored.  If you need to set the CA file, you should use the
+      #   +:ssl_ca_file+ option to {AWS.config} or
+      #   {AWS::Configuration} instead.
+      def initialize options = {}
+        @default_request_options = options
+      end
+
       include HTTParty
 
       class NoOpParser < HTTParty::Parser
@@ -27,10 +56,15 @@ module AWS
 
       def handle(request, response)
 
-        opts = {
+        opts = default_request_options.merge({
           :body => request.body,
           :parser => NoOpParser
-        }
+        })
+
+        if request.proxy_uri
+          opts[:http_proxyaddr] = request.proxy_uri.to_s
+          opts[:http_proxyport] = request.proxy_uri.port
+        end
 
         if request.use_ssl?
           url = "https://#{request.host}:443#{request.uri}"

data/lib/aws/http/request.rb

@@ -18,7 +18,6 @@ module AWS
   module Http
 
     # Base class for all service reqeusts.
-    # @private
     class Request
 
       # Returns a new empty http request object.
@@ -51,6 +50,10 @@ module AWS
       #   request
       attr_accessor :access_key_id
 
+      # @return [nil, URI] The URI to the proxy server requests are 
+      #   sent through if configured.  Returns nil if there is no proxy.
+      attr_accessor :proxy_uri
+
       # @param [Boolean] ssl If the request should be sent over ssl or not.
       def use_ssl= use_ssl
         @use_ssl = use_ssl

data/lib/aws/http/request_param.rb

@@ -17,6 +17,10 @@ module AWS
   module Http
     class Request
 
+      # Represents a single request paramater.  Some services accept this
+      # in a form encoded body string, others as query parameters.
+      # It is up to each service's Request class to determine how to
+      # consume these params.
       # @private
       class Param
 
@@ -52,10 +56,13 @@ module AWS
           end
         end
 
+        # @private
+        protected
         def escape value
+          value = value.encode("UTF-8") if
+            value.respond_to?(:encode)
           CGI::escape(value.to_s).gsub('+', '%20')
         end
-        protected :escape
         
       end
     end

data/lib/aws/http/response.rb

@@ -12,19 +12,16 @@
 # language governing permissions and limitations under the License.
 
 module AWS
-  
-  # @private
+
   module Http
 
     # Represents the http response from a service request.
     #
     # Responses have:
-    # 
+    #
     # * status (200, 404, 500, etc)
     # * headers (hash of response headers)
     # * body (the response body)
-    #
-    # @private
     class Response
 
       # @return [Integer] (200) response http status code 
@@ -41,7 +38,7 @@ module AWS
       attr_accessor :timeout
       alias_method :timeout?, :timeout
 
-      # @param [Hash] options 
+      # @param [Hash] options
       # @option options [Integer] :status (200) HTTP status code
       # @option options [Hash] :headers ({}) HTTP response headers
       # @option options [String] :body ('') HTTP response body

data/lib/aws/naming.rb

@@ -19,7 +19,6 @@ module AWS
   module Naming
 
     def service_name
-      debugger if self.name == nil
       self.name.split(/::/)[1]
     end
 

data/lib/aws/policy.rb

@@ -17,7 +17,7 @@ require 'date'
 
 module AWS
 
-  # Represents an access policy for S3 operations and resources.  For example:
+  # Represents an access policy for AWS operations and resources.  For example:
   #
   #   policy = Policy.new do |policy|
   #     policy.allow(:actions => ['s3:PutObject'],

data/lib/aws/rails.rb

@@ -17,6 +17,7 @@ module AWS
 
   if Object.const_defined?(:Rails) and Rails.const_defined?(:Railtie)
 
+    # @private
     class Railtie < Rails::Railtie
 
       # configure our plugin on boot. other extension points such
@@ -125,17 +126,20 @@ module AWS
       path = Pathname.new("#{rails_root}/config/aws.yml")
   
       if File.exists?(path)
-        cfg = YAML::load(ERB.new(File.read(path)).result)[rails_env]
-        AWS.config(cfg)
+        cfg = YAML::load(ERB.new(File.read(path)).result)
+        unless cfg[rails_env]
+          raise "config/aws.yml is missing a section for `#{rails_env}`"
+        end
+        AWS.config(cfg[rails_env])
       end
   
     end
   
     # Adds a delivery method to ActionMailer that uses {AWS::SimplEmailService}.
     #
-    # Once you have an SES delivery method you can configure Rails to use this
-    # for ActionMailer in your environment configuration (e.g. 
-    # RAILS_ROOT/config/environments/production.rb)
+    # Once you have an SES delivery method you can configure Rails to
+    # use this for ActionMailer in your environment configuration
+    # (e.g.  RAILS_ROOT/config/environments/production.rb)
     #
     #   config.action_mailer.delivery_method = :amazon_ses
     #
@@ -153,21 +157,23 @@ module AWS
     #   AWS.add_action_mailer_delivery_method(:ses, custom_options)
     #
     # @param [Hash] options
-    # @param [Symbol] name (:amazon_ses) The name of the delivery 
-    #   method.  The name used here should be the same as you set in your
-    #   environment config.  If you name the delivery method +:amazon_ses+ then
-    #   you could do something like this in your config/environments/ENV.rb file:
-    #   
+    #
+    # @param [Symbol] name (:amazon_ses) The name of the delivery
+    #   method.  The name used here should be the same as you set in
+    #   your environment config.  If you name the delivery method
+    #   +:amazon_ses+ then you could do something like this in your
+    #   config/environments/ENV.rb file:
+    #
     #     config.action_mailer.delivery_method = :amazon_ses
     #
-    # @param [Hash] options ({}) A hash of options that are passes to 
-    #   {AWS::SimpleEmailService#new} before delivering email.  
+    # @param [Hash] options A hash of options that are passes to
+    #   {AWS::SimpleEmailService#new} before delivering email.
     #
-    # @return [nil] 
+    # @return [nil]
     def self.add_action_mailer_delivery_method name = :amazon_ses, options = {}
-  
+
       amb = ::ActionMailer::Base
-  
+
       if ::Rails.version.to_f >= 3
         amb.add_delivery_method(name, AWS::SimpleEmailService, options)
       else
@@ -175,11 +181,11 @@ module AWS
           AWS::SimpleEmailService.new(options).send_raw_email(mail)
         end
       end
-  
+
       nil
-  
+
     end
-  
+
     # Configures AWS to log to the Rails defualt logger.
     # @return [nil]
     def self.log_to_rails_logger