aws-sdk 1.5.7 → 1.5.8

data/lib/aws/core/resource.rb

@@ -17,69 +17,69 @@ module AWS
 
     # @private
     class Resource
-  
+
       include Model
       include Cacheable
-  
+
       # @private
       class NotFound < StandardError; end
-  
+
       # @private
       def initialize *args
-  
+
         super
-  
+
         # cache static attributes passed into options
-  
+
         options = args.last.is_a?(Hash) ? args.last : {}
         options.each_pair do |opt_name,opt_value|
-          if 
+          if
             self.class.attributes.has_key?(opt_name) and
             self.class.attributes[opt_name].static?
           then
             static_attributes[opt_name] = opt_value
           end
         end
-  
+
       end
-  
+
       # @return [String] Returns a simple string representation of this resource.
       def inspect
-  
+
         identifiers = []
         resource_identifiers.each do |key, value|
-          if attr = self.class.attributes.values.find{|a| a.get_as == key }
+          if attr = self.class.attributes.values.find{|a| a.from == key }
             identifiers << "#{attr.name}:#{value}"
           else
             identifiers << "#{key}:#{value}"
           end
         end
-  
+
         "<#{self::class} #{identifiers.join(' ')}>"
-  
+
       end
-  
+
       # @return [Boolean] Returns true if the objects references the same
       #   AWS resource.
       def eql? other
-        other.kind_of?(self.class) and 
+        other.kind_of?(self.class) and
         other.resource_identifiers == resource_identifiers
       end
       alias_method :==, :eql?
-  
+
       # @private
       protected
       def get_resource attr_name
         raise NotImplementedError
       end
-  
+
       # @private
       protected
       def update_resource attr, value
         raise NotImplementedError
       end
-  
-      # Overide this method is subclasses of Resource.  This method should 
+
+      # Overide this method is subclasses of Resource.  This method should
       # return an array of identifying key/value pairs.
       #
       #   # @private
@@ -87,37 +87,37 @@ module AWS
       #   def resource_identifiers
       #     [[:user_name, name]]
       #   end
-      # 
+      #
       # @private
       protected
       def resource_identifiers
         raise NotImplementedError
       end
-  
+
       # @protected
       protected
       def resource_options(additional = {})
         Hash[resource_identifiers].merge(additional)
       end
-  
+
       # @private
       protected
       def local_cache_key
         resource_identifiers.collect{|name,value| value.to_s }.join(":")
       end
-  
+
       # @private
       protected
       def static_attributes
         @static_attributes ||= {}
       end
-  
+
       # @private
       protected
       def ruby_name
         @ruby_name ||= Inflection.ruby_name(self.class.name)
       end
-  
+
       # @private
       public
       def attributes_from_response resp
@@ -137,7 +137,7 @@ module AWS
 
         # merge the attributes together into a single hash
         attributes = attributes.inject({}) {|hash,attribs| hash.merge(attribs) }
-  
+
         # cache static attributes
         attributes.each_pair do |attr_name,value|
           if self.class.attributes[attr_name].static?
@@ -146,9 +146,9 @@ module AWS
         end
 
         attributes
-  
+
       end
-  
+
       # @private
       protected
       def cache_static_attributes request_type, resp_obj
@@ -161,7 +161,7 @@ module AWS
           end
         end
       end
-  
+
       class << self
 
         # @private
@@ -169,7 +169,7 @@ module AWS
           class_eval <<-METHODS
 
             def self.#{type_name}_attributes
-              @#{type_name}_attributes ||= {}  
+              @#{type_name}_attributes ||= {}
             end
 
             def self.#{type_name}_attribute name, options = {}, &block
@@ -179,33 +179,33 @@ module AWS
 
           METHODS
         end
-  
+
         # @private
         def new_from request_type, resp_obj, *args
-          resource = new(*args)  
+          resource = new(*args)
           resource.send(:cache_static_attributes, request_type, resp_obj)
           resource
         end
-  
+
         # @private
         def attributes
           @attributes ||= Hash.new do |hash,attr_name|
             raise "uknown attribute #{attr_name}"
           end
         end
-  
+
         # @private
         def attribute_providers
           @attribute_providers ||= []
         end
-  
+
         # @private
         def attribute_providers_for request_type
           attribute_providers.select do |provider|
             provider.request_types.include?(request_type)
           end
         end
-  
+
         # @private
         protected
         def attribute name, options = {}, &block
@@ -213,33 +213,34 @@ module AWS
           attr.instance_eval(&block) if block_given?
           define_attribute_getter(attr)
           define_attribute_setter(attr) if attr.mutable?
+          alias_method(options[:alias], name) if options[:alias]
           attributes[attr.name] = attr
         end
-  
+
         # @private
         protected
         def mutable_attribute name, options = {}, &block
           attribute(name, options.merge(:mutable => true), &block)
         end
-  
+
         # @private
         protected
         def define_attribute_getter attribute
           define_method(attribute.name) do
-            
-            return static_attributes[attribute.name] if 
+
+            return static_attributes[attribute.name] if
               static_attributes.has_key?(attribute.name)
-  
+
             begin
               retrieve_attribute(attribute) { get_resource(attribute) }
             rescue Cacheable::NoData => e
               name = ruby_name.tr("_", " ")
               raise NotFound, "unable to find the #{name}"
             end
-  
+
           end
         end
-  
+
         # @private
         protected
         def define_attribute_setter attribute
@@ -253,7 +254,7 @@ module AWS
             value
           end
         end
-  
+
         # @private
         protected
         def populates_from *request_types, &block
@@ -262,7 +263,7 @@ module AWS
           provider.provides(*attributes.keys)
           provider
         end
-  
+
         # @private
         protected
         def provider *request_types, &block
@@ -270,100 +271,100 @@ module AWS
           if block_given?
             yield(provider)
           end
-          attribute_providers << provider 
+          attribute_providers << provider
           provider
         end
-  
+
       end
-  
+
       # @private
       class Attribute
-  
+
         def initialize name, options = {}
           @name = name
           @options = options
           @request_types = []
         end
-  
+
         attr_reader :name
-  
+
         attr_reader :request_types
-  
-        def get_as
-          @get_as ||= (@options[:get_as] || @options[:as] || name)
+
+        def from
+          @from ||= (@options[:from] || name)
         end
-  
+
         def set_as
-          @set_as ||= (@options[:set_as] || @options[:as] || name)
+          @set_as ||= (@options[:set_as] || @options[:from] || name)
         end
-  
+
         def mutable?
           @options[:mutable] == true
         end
-  
+
         def static?
           @options[:static] == true
         end
-  
+
         def translates_input &block
           @input_translator = block
         end
-  
+
         def translates_output options = {}, &block
           @translates_nil = options[:nil]
           @output_translator = block
         end
-  
+
         def translate_input_value value
           @input_translator ? @input_translator.call(value) : value
         end
-  
+
         def translate_output_value value
-  
+
           # by default nil values are not translated
           return nil if value.nil? and @translates_nil != true
-  
+
           case
           when @options[:to_sym]    then value.tr('-','_').downcase.to_sym
           when @options[:timestamp] then Time.at(value.to_i)
           when @output_translator   then @output_translator.call(value)
           else value
           end
-  
+
         end
-  
+
       end
-  
+
       # @private
       class AttributeProvider
-  
+
         def initialize klass, request_types
           @klass = klass
           @id = klass.attribute_providers.length
           @request_types = request_types
           @provides = {}
         end
-  
+
         attr_reader :request_types
-  
+
         def find &block
           @klass.send(:define_method, finder_method, &block)
         end
-  
+
         def finder_method
           "_find_in_#{request_types.join('_or_')}_response_#{@id}"
         end
-  
+
         # Indicates that all of the the named attributes can be retrieved
         # from an appropriate response object.
-        # 
+        #
         # @overload provides(*attr_names, options = {})
         #   @param [Symbol] attr_names A list of attributes provided
         #   @param [Hash] options
         #   @option options [Boolean] :value_wrapped (false) If true, then
         #     the value returned by the response object will also receive
         #     the message :value before it is translated and returned.
-        #   @option options [Symbol] :get_as Defaults to the method named
+        #   @option options [Symbol] :from Defaults to the method named
         #     by the attribute.  This is useful when you have two providers
         #     for the same attribute but their response object name
         #     them differently.
@@ -375,7 +376,7 @@ module AWS
             @provides[attr_name] = options
           end
         end
-  
+
         def attributes_from_response resource, response
           if response_object = resource.send(finder_method, response)
             attributes_from_response_object(response_object)
@@ -383,14 +384,14 @@ module AWS
             nil
           end
         end
-  
+
         def attributes_from_response_object resp_obj
-          
+
           @provides.inject({}) do |attributes,(attr_name,options)|
 
             attr = @klass.attributes[attr_name]
 
-            methods = [options[:get_as] || attr.get_as].flatten
+            methods = [options[:from] || attr.from].flatten
 
             v = resp_obj
             methods.each do |method|
@@ -403,9 +404,9 @@ module AWS
             attributes.merge(attr_name => v)
 
           end
-  
+
         end
-  
+
       end
     end
   end

data/lib/aws/core/response.rb

@@ -34,7 +34,7 @@ module AWS
     #   instance = response.data[:reservation_set].first[:instance_set].first
     #
     #   instance[:status] #=> 'running'
-    # 
+    #
     # == Response Metadata
     #
     # In addition to the response data, there is additional information
@@ -53,34 +53,34 @@ module AWS
     #   response.http_response #=> #<AWS::Core::Http::Response>
     #
     class Response
-  
+
       include AsyncHandle
 
       # @return [Hash] Returns the response data as a hash.
       attr_accessor :data
-  
-      # @return [Symbol] The name of the client request method that 
+
+      # @return [Symbol] The name of the client request method that
       #   returned this response.
       attr_accessor :request_type
-      
+
       # @return [Hash] Returns the hash of options passed to the client
       #   request method that generated this response.
       attr_accessor :request_options
-      
+
       # @return [Core::Http::Request]
       attr_accessor :http_request
-  
+
       # @return [Core::Http::Response]
       attr_accessor :http_response
-  
+
       # @return [Boolean] true if the response was generated from a
       #   another cached response.
       attr_accessor :cached
 
       alias_method :cached?, :cached
-  
+
       # @return [AWS::Error,nil] Returns nil unless the request failed.
-      #   Normally this will be nil unless you are using the Asynchronous 
+      #   Normally this will be nil unless you are using the Asynchronous
       #   interface.
       attr_accessor :error
 
@@ -91,7 +91,7 @@ module AWS
       # @return [Float] The total number of seconds taken to make the
       #   request and return the response.
       attr_accessor :duration
-  
+
       # @param [Http::Request] http_request
       # @param [Http::Response] http_response
       def initialize http_request = nil, http_response = nil, &block
@@ -112,12 +112,12 @@ module AWS
       def [] key
         data[key]
       end
-  
+
       # @return [Boolean] Returns true if there is no response error.
       def successful?
         error.nil?
       end
-  
+
       # @return [Boolean] Returns true if the http request was throttled
       #   by AWS.
       def throttled?
@@ -129,18 +129,18 @@ module AWS
           false
         end
       end
-  
+
       # @return [Boolean] Returns true if the http request timed out.
       def timeout?
         http_response.timeout?
       end
-  
+
       # @return [String]
       # @private
       def inspect
         data.inspect
       end
-  
+
       # @return [String]
       # @private
       def cache_key
@@ -151,7 +151,7 @@ module AWS
           serialized_options
         ].join(":")
       end
-  
+
       # Rebuilds the HTTP request using the block passed to the initializer.
       # This is primarily used by the client when a request must be retried
       # (throttling, server errors, socket errors, etc).
@@ -163,7 +163,7 @@ module AWS
       protected
 
       # @note The prefered method to get as response data is to use {#[]}.
-      # 
+      #
       # This provides a backwards-compat layer to the old response objects
       # where each response value had a method extended onto this object.
       # Now all response data is accessible as a hash.
@@ -174,17 +174,17 @@ module AWS
       def method_missing *args, &block
         Core::Data.new(data).send(*args, &block)
       end
-  
+
       def serialized_options
         serialize_options_hash(request_options)
       end
-  
+
       def serialize_options_hash(hash)
         "(" + hash.keys.sort_by(&:to_s).map do |key|
           "#{key}=#{serialize_options_value(hash[key])}"
         end.join(" ") + ")"
       end
-  
+
       def serialize_options_value(value)
         case value
         when Hash  then serialize_options_hash(value)
@@ -192,11 +192,11 @@ module AWS
         else value.inspect
         end
       end
-  
+
       def serialize_options_array array
         "[" + array.map{|v| serialize_options_value(v) }.join(" ") + "]"
       end
-  
+
     end
   end
 end