aws-sdk 1.1.3 → 1.1.4

data/lib/aws/{common.rb → core.rb}

@@ -11,15 +11,111 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'aws/configuration'
-require 'aws/resource_cache'
-require 'aws/response_cache'
+require 'aws/core/autoloader'
 
-# Root namespace for the AWS SDK for Ruby.
+# AWS is the root module for all of the Amazon Web Services.  It is also 
+# where you can configure you access to AWS.  
+#
+# = Supported Services
+#
+# The currently supported services are:
+#
+# * {EC2}
+# * {S3}
+# * {SimpleDB}
+# * {SimpleEmailService}
+# * {SNS}
+# * {SQS}
+# * {IAM}
+#
+# = AWS::Record
+#
+# In addition to the above services, bundled is an ORM based on AWS services
+# See {AWS::Record} for more information.
+#
+# = Configuration
+#
+# You call {AWS.config} with a hash of options to configure your 
+# access to the Amazon Web Services.  
+#
+# At a minimum you need to set your access credentials. See {AWS.config} 
+# for additional configuration options.
+#
+#    AWS.config(
+#      :access_key_id => 'ACCESS_KEY_ID',
+#      :secret_access_key => 'SECRET_ACCESS_KEY') 
+#
+# == Rails
+# 
+# If you are loading AWS inside a Rails web application, it is recomended to 
+# place your configuration inside:
+#
+#   config/initializers/aws.rb
+#
 module AWS
 
   # Current version of the AWS SDK for Ruby
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
+
+  register_autoloads(self) do
+    autoload :Errors, 'errors'
+  end
+
+  module Core
+
+    AWS.register_autoloads(self) do
+      autoload :ApiConfig,                 'api_config'
+      autoload :ApiConfigTransform,        'api_config_transform'
+      autoload :AsyncHandle,               'async_handle'
+      autoload :AuthorizeV2,               'authorize_v2'
+      autoload :AuthorizeV3,               'authorize_v3'
+      autoload :AuthorizeWithSessionToken, 'authorize_with_session_token'
+      autoload :Cacheable,                 'cacheable'
+      autoload :Client,                    'client'
+      autoload :ClientLogging,             'client_logging'
+      autoload :Collections,               'collections'
+      autoload :Configuration,             'configuration'
+      autoload :ConfiguredClientMethods,   'configured_client_methods'
+      autoload :ConfiguredGrammars,        'configured_grammars'
+      autoload :ConfiguredOptionGrammars,  'configured_option_grammars'
+      autoload :ConfiguredXmlGrammars,     'configured_xml_grammars'
+      autoload :DefaultSigner,             'default_signer'
+      autoload :IgnoreResultElement,       'ignore_result_element'
+      autoload :IndifferentHash,           'indifferent_hash'
+      autoload :Inflection,                'inflection'
+      autoload :LazyErrorClasses,          'lazy_error_classes'
+      autoload :MetaUtils,                 'meta_utils'
+      autoload :Model,                     'model'
+      autoload :Naming,                    'naming'
+      autoload :OptionGrammar,             'option_grammar'
+      autoload :Policy,                    'policy'
+      autoload :Resource,                  'resource'
+      autoload :ResourceCache,             'resource_cache'
+      autoload :Response,                  'response'
+      autoload :ResponseCache,             'response_cache'
+      autoload :ServiceInterface,          'service_interface'
+      autoload :UriEscape,                 'uri_escape'
+      autoload :XmlGrammar,                'xml_grammar'
+    end
+
+    module Http
+      AWS.register_autoloads(self) do
+        autoload :Handler,         'handler'
+        autoload :NetHttpHandler,  'net_http_handler'
+        autoload :HTTPartyHandler, 'httparty_handler' # non-standard inflection
+        autoload :Request,         'request'
+        autoload :Response,        'response'
+      end
+    end
+
+  end
+
+  # the http party handler should still be accessible from its old namespace
+  module Http
+    AWS.register_autoloads(self, 'aws/core/http') do
+      autoload :HTTPartyHandler, 'httparty_handler'
+    end
+  end
 
   class << self
 
@@ -147,9 +243,9 @@ module AWS
     #   append to all requets against AWS services.  This should be set
     #   for clients and applications built ontop of the aws-sdk gem.
     # 
-    # @return [Configuration] Returns the new configuration.
+    # @return [Core::Configuration] Returns the new configuration.
     def config options = {}
-      @@config ||= Configuration.new
+      @@config ||= Core::Configuration.new
       @@config = @@config.with(options) unless options.empty?
       @@config
     end
@@ -255,7 +351,7 @@ module AWS
     def resource_cache
       if memoizing?
         Thread.current[:aws_memoization][:resource_cache] ||=
-          ResourceCache.new
+          Core::ResourceCache.new
       end
     end
 
@@ -263,10 +359,25 @@ module AWS
     def response_cache
       if memoizing?
         Thread.current[:aws_memoization][:response_cache] ||=
-          ResponseCache.new
+          Core::ResponseCache.new
       end
     end
 
+    def add_service name, ruby_name, default_endpoint
+
+      create_block = lambda do |config| 
+        AWS.const_get(name)::Client.new(:config => config)
+      end
+
+      needs = [:signer, :http_handler, :"#{ruby_name}_endpoint"]
+
+      Core::Configuraiton.add_option :"#{ruby_name}_endpoint", default_endpoint
+
+      Core::Configuraiton.add_option_with_needs(
+        :"#{ruby_name}_client", needs, &create_block)
+
+    end
+
     # Causes all requests to return empty responses without making any
     # requests against the live services.  This does not attempt to
     # mock the services.

data/lib/aws/{api_config.rb → core/api_config.rb}

@@ -11,35 +11,34 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'aws/naming'
-
-require 'pathname'
 require 'yaml'
+require 'pathname'
 
 module AWS
+  module Core
 
-  # @private
-  module ApiConfig
+    # @private
+    module ApiConfig
 
-    include Naming
+      include Naming
 
-    protected
-    def api_config
+      protected
+      def api_config
 
-      config_file = $:.map do |load_path|
-        if config_dir = Pathname.new(load_path) +
-            "aws" + "api_config" and
-            config_dir.directory?
-          config_dir.children.select do |child|
-            child.basename.to_s =~ /^#{service_name}/
-          end.sort.last
-        end
-      end.compact.sort.last
+        config_file = $:.map do |load_path|
+          if config_dir = Pathname.new(load_path) +
+              "aws" + "api_config" and
+              config_dir.directory?
+            config_dir.children.select do |child|
+              child.basename.to_s =~ /^#{service_name}/
+            end.sort.last
+          end
+        end.compact.sort.last
 
-      YAML.load(config_file.read)
+        YAML.load(config_file.read)
 
-    end
+      end
 
+    end
   end
-
 end

data/lib/aws/core/api_config_transform.rb

@@ -0,0 +1,36 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'yaml'
+
+module AWS
+  module Core
+
+    # @private
+    class ApiConfigTransform
+
+      def self.rename_input_list_to_membered_list api_config
+        api_config[:operations].each_pair do |name,customizations|
+
+          input = api_config[:operations][name][:input]
+          fixed_input = input.to_yaml.gsub(/:list:/, ':membered_list:')
+
+          api_config[:operations][name][:input] = YAML.load(fixed_input)
+
+        end
+        api_config
+      end
+
+    end
+  end
+end

data/lib/aws/core/async_handle.rb

@@ -0,0 +1,91 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+  
+    # Mixin that provides a generic callback facility for asynchronous
+    # tasks that can either succeed or fail.
+    # @private
+    module AsyncHandle
+  
+      # Called to signal success and fire off the success and complete callbacks.
+      def signal_success
+        __send_signal(:success)
+      end
+  
+      # Called to signal failure and fire off the failure and complete callbacks.
+      def signal_failure
+        __send_signal(:failure)
+      end
+  
+      # Registers a callback to be called on successful completion of
+      # the task.
+      #
+      #  handle.on_success { puts "It worked!" }
+      #
+      # If this is called when the task has already completed
+      # successfully, it will call the callback immediately.
+      def on_success(&blk)
+        if @_async_status == :success
+          blk.call
+        else
+          (@_async_callbacks ||= []) << { :success => blk }
+        end
+      end
+  
+      # Registers a callback to be called when the task fails.
+      #
+      #  handle.on_failure { puts "It didn't work!" }
+      #
+      # If this is called when the task has already failed, it will
+      # call the callback immediately.
+      def on_failure(&blk)
+        if @_async_status == :failure
+          blk.call
+        else
+          (@_async_callbacks ||= []) << { :failure => blk }
+        end
+      end
+  
+      # Registers a callback to be called when the task is complete,
+      # regardless of its status.  Yields the status to the block.
+      #
+      #  handle.on_complete do |status|
+      #    puts "It #{status == :success ? 'did' : 'did not'} work!"
+      #  end
+      #
+      # If this is called when the task has already completed, it will
+      # call the callback immediately.
+      def on_complete(&blk)
+        if !@_async_status.nil?
+          blk.call(@_async_status)
+        else
+          (@_async_callbacks ||= []) << {
+            :failure => lambda { blk.call(:failure) },
+            :success => lambda { blk.call(:success) }
+          }
+        end
+      end
+  
+      private
+      def __send_signal(kind)
+        @_async_status = kind
+        @_async_callbacks.map do |cb|
+          cb[kind]
+        end.compact.each { |blk| blk.call } if @_async_callbacks
+      end
+  
+    end
+  end
+end

data/lib/aws/core/authorize_v2.rb

@@ -0,0 +1,39 @@
+# Copyright 2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  module Core
+    
+    # Mixed into clients that use v2 authorization.
+    # @private
+    module AuthorizeV2
+
+      def string_to_sign
+        parts = [http_method,
+                 host,
+                 path,
+                 params.sort.collect { |p| p.encoded }.join('&')]
+        parts.join("\n")
+      end
+
+      def add_authorization! signer
+        self.access_key_id = signer.access_key_id
+        add_param('AWSAccessKeyId', access_key_id)
+        add_param('SignatureVersion', '2')
+        add_param('SignatureMethod', 'HmacSHA256')
+        add_param('Signature', signer.sign(string_to_sign))
+      end
+
+    end
+  end
+end

data/lib/aws/{authorize_v3.rb → core/authorize_v3.rb}

@@ -11,27 +11,28 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'base64'
 require 'time'
 
 module AWS
+  module Core
   
-  # Mixed into clients that use v3 authorization.
-  # @private
-  module AuthorizeV3
+    # Mixed into clients that use v3 authorization.
+    # @private
+    module AuthorizeV3
 
-    def string_to_sign
-      headers['date'] ||= Time.now.rfc822
-    end
+      def string_to_sign
+        headers['date'] ||= Time.now.rfc822
+      end
 
-    def add_authorization! signer
-      self.access_key_id = signer.access_key_id
-      parts = []
-      parts << "AWS3-HTTPS AWSAccessKeyId=#{access_key_id}"
-      parts << "Algorithm=HmacSHA256"
-      parts << "Signature=#{signer.sign(string_to_sign)}"
-      headers['x-amzn-authorization'] = parts.join(',')
-    end
+      def add_authorization! signer
+        self.access_key_id = signer.access_key_id
+        parts = []
+        parts << "AWS3-HTTPS AWSAccessKeyId=#{access_key_id}"
+        parts << "Algorithm=HmacSHA256"
+        parts << "Signature=#{signer.sign(string_to_sign)}"
+        headers['x-amzn-authorization'] = parts.join(',')
+      end
 
+    end
   end
 end

data/lib/aws/{api_config_transform.rb → core/authorize_with_session_token.rb}

@@ -12,21 +12,18 @@
 # language governing permissions and limitations under the License.
 
 module AWS
+  module Core
 
-  # @private
-  class ApiConfigTransform
-
-    def self.rename_input_list_to_membered_list api_config
-      api_config[:operations].each_pair do |name,customizations|
-
-        input = api_config[:operations][name][:input]
-        fixed_input = input.to_yaml.gsub(/:list:/, ':membered_list:')
-
-        api_config[:operations][name][:input] = YAML.load(fixed_input)
+    # @private
+    module AuthorizeWithSessionToken
 
+      def add_authorization! signer
+        if signer.respond_to?(:session_token) and token = signer.session_token
+          add_param("SecurityToken", token)
+        end
+        super
       end
-      api_config
-    end
 
+    end
   end
 end