aws-sdk 1.4.1 → 1.5.0

data/lib/aws/simple_db/attribute.rb

@@ -44,7 +44,7 @@ module AWS
       # @example Setting an array of values
       #   attributes['colors'].set ['red', 'blue']
       #
-      # @param *values An array or list of attribute values to set.
+      # @param [String] values A list of attribute values to set.
       # @return [nil]
       def set *values
         put(values, true)
@@ -62,7 +62,7 @@ module AWS
       #
       #   attributes['colors'].add ['red', 'blue']
       #
-      # @param *values An array or list of attribute values to add.
+      # @param [String] values A list of attribute values to add.
       # @return [nil]
       def add *values
         put(values, false)

data/lib/aws/simple_db/attribute_collection.rb

@@ -21,7 +21,7 @@ module AWS
       include PutAttributes
       include DeleteAttributes
 
-      # @param [Item] The item to create an attribute collection for.
+      # @param [Item] item The item to create an attribute collection for.
       # @return [AttributeCollection]
       def initialize item, options = {}
         @item = item
@@ -201,12 +201,22 @@ module AWS
 
       # Delete one or more attributes from {#item}.
       #
-      # @example Delete a list of attributes by name
+      # @example Delete a list of attributes by name (accepts a list or array)
       #   item.attributes.delete 'size', 'color'
       #   item.attributes.delete %w(size color)
       #
-      # @param attribute_names An array or list of attribute names to delete.
-      # @return [nil]
+      # @example Delete a specific list of attribute values
+      #   item.attributes.delete(:color => 'red', :tags => %w(special limited))
+      #
+      # @overload delete(attributes)
+      #   @param [Hash] attributes A hash of attribute names and values to
+      #     delete.
+      #   @return [nil]
+      #
+      # @overload delete(*attribute_names)
+      #   @param [String] A list of attribute names to delete.
+      #   @return [nil]
+      #
       def delete *args
         if args.size == 1 and args.first.kind_of?(Hash)
           delete_attribute_values(args.first)

data/lib/aws/simple_db/client.rb

@@ -11,40 +11,339 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require 'time'
-
 module AWS
   class SimpleDB
-    
-    # @private
-    class Client < Core::Client
-
-      AWS.register_autoloads(self, 'aws/simple_db/client') do
-        autoload :Options, 'options'
-        autoload :XML,     'xml'
-      end
 
-      include Core::ConfiguredClientMethods
+    # Client class for Amazon SimpleDB.
+    class Client < Core::Client
 
       API_VERSION = '2009-04-15'
 
+      extend Core::Client::QueryXML
+
+      # @private
       REGION_US_E1 = 'sdb.amazonaws.com'
+
+      # @private
       REGION_US_W1 = 'sdb.us-west-1.amazonaws.com'
+
+      # @private
       REGION_EU_W1 = 'sdb.eu-west-1.amazonaws.com'
-      REGION_APAC_SE1 = 'sdb.ap-southeast-1.amazonaws.com'
 
-      REQUEST_CLASS = SimpleDB::Request
+      # @private
+      REGION_APAC_SE1 = 'sdb.ap-southeast-1.amazonaws.com'
 
-      configure_client
+      # @private
+      CACHEABLE_REQUESTS = Set[
+        :domain_metadata,
+        :get_attributes,
+        :list_domains,
+        :select,
+      ]
 
+      # @param [String] name
+      # @return [Boolean] Returns true if the given name is a valid
+      #   Amazon SimpleDB domain name.
+      # @private
       def valid_domain_name? name
         self.class.valid_domain_name?(name)
       end
 
+      # @param [String] name
+      # @return [Boolean] Returns true if the given name is a valid
+      #   Amazon SimpleDB domain name.
       def self.valid_domain_name? name
         name.to_s =~ /^[a-z_\-\.]{3,255}$/i ? true : false
       end
 
+      ## client methods ##
+
+      # Calls the BatchDeleteAttributes API operation.
+      # @method batch_delete_attributes(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain in
+      #   which the attributes are being deleted.
+      # * +:items+ - *required* - (Array<Hash>) A list of items on which to
+      #   perform the operation.
+      #   * +:name+ - *required* - (String)
+      #   * +:attributes+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String) The name of the attribute.
+      #     * +:value+ - *required* - (String) The value of the attribute.
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :batch_delete_attributes, 'BatchDeleteAttributes'
+
+      # Calls the BatchPutAttributes API operation.
+      # @method batch_put_attributes(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain in
+      #   which the attributes are being stored.
+      # * +:items+ - *required* - (Array<Hash>) A list of items on which to
+      #   perform the operation.
+      #   * +:name+ - *required* - (String) The name of the replaceable item.
+      #   * +:attributes+ - *required* - (Array<Hash>) The list of attributes
+      #     for a replaceable item.
+      #     * +:name+ - *required* - (String) The name of the replaceable
+      #       attribute.
+      #     * +:value+ - *required* - (String) The value of the replaceable
+      #       attribute.
+      #     * +:replace+ - (Boolean) A flag specifying whether or not to
+      #       replace the attribute/value pair or to add a new attribute/value
+      #       pair. The default setting is +false+ .
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :batch_put_attributes, 'BatchPutAttributes'
+
+      # Calls the CreateDomain API operation.
+      # @method create_domain(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain to
+      #   create. The name can range between 3 and 255 characters and can
+      #   contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :create_domain, 'CreateDomain'
+
+      # Calls the DeleteAttributes API operation.
+      # @method delete_attributes(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain in
+      #   which to perform the operation.
+      # * +:item_name+ - *required* - (String) The name of the item. Similar to
+      #   rows on a spreadsheet, items represent individual objects that
+      #   contain one or more value-attribute pairs.
+      # * +:attributes+ - (Array<Hash>) A list of Attributes. Similar to
+      #   columns on a spreadsheet, attributes represent categories of data
+      #   that can be assigned to items.
+      #   * +:name+ - *required* - (String) The name of the attribute.
+      #   * +:value+ - (String) The value of the attribute.
+      # * +:expected+ - (Hash) The update condition which, if specified,
+      #   determines whether the specified attributes will be deleted or not.
+      #   The update condition must be satisfied in order for this request to
+      #   be processed and the attributes to be deleted.
+      #   * +:name+ - (String) The name of the attribute involved in the
+      #     condition.
+      #   * +:value+ - (String) The value of an attribute. This value can only
+      #     be specified when the Exists parameter is equal to +true+ .
+      #   * +:exists+ - (Boolean) A value specifying whether or not the
+      #     specified attribute must exist with the specified value in order
+      #     for the update condition to be satisfied. Specify +true+ if the
+      #     attribute must exist for the update condition to be satisfied.
+      #     Specify +false+ if the attribute should not exist in order for the
+      #     update condition to be satisfied.
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :delete_attributes, 'DeleteAttributes'
+
+      # Calls the DeleteDomain API operation.
+      # @method delete_domain(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain to
+      #   delete.
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :delete_domain, 'DeleteDomain'
+
+      # Calls the DomainMetadata API operation.
+      # @method domain_metadata(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain for
+      #   which to display the metadata of.
+      #
+      # === Response Structure:
+      #
+      # * +:item_count+ - (Integer)
+      # * +:item_names_size_bytes+ - (Integer)
+      # * +:attribute_name_count+ - (Integer)
+      # * +:attribute_names_size_bytes+ - (Integer)
+      # * +:attribute_value_count+ - (Integer)
+      # * +:attribute_values_size_bytes+ - (Integer)
+      # * +:timestamp+ - (Integer)
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :domain_metadata, 'DomainMetadata'
+
+      # Calls the GetAttributes API operation.
+      # @method get_attributes(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain in
+      #   which to perform the operation.
+      # * +:item_name+ - *required* - (String) The name of the item.
+      # * +:attribute_names+ - (Array<String>) The names of the attributes.
+      # * +:consistent_read+ - (Boolean) Determines whether or not strong
+      #   consistency should be enforced when data is read from SimpleDB. If
+      #   +true+ , any data previously written to SimpleDB will be returned.
+      #   Otherwise, results will be consistent eventually, and the client may
+      #   not see data that was written immediately before your read.
+      #
+      # === Response Structure:
+      #
+      # * +:attributes+ - (Array<Hash>)
+      #   * +:name+ - (String)
+      #   * +:alternate_name_encoding+ - (String)
+      #   * +:value+ - (String)
+      #   * +:alternate_value_encoding+ - (String)
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :get_attributes, 'GetAttributes'
+
+      # Calls the ListDomains API operation.
+      # @method list_domains(options = {})
+      #
+      # === Options:
+      #
+      # * +:max_number_of_domains+ - (Integer) The maximum number of domain
+      #   names you want returned. The range is 1 to 100. The default setting
+      #   is 100.
+      # * +:next_token+ - (String) A string informing Amazon SimpleDB where to
+      #   start the next list of domain names.
+      #
+      # === Response Structure:
+      #
+      # * +:domain_names+ - (Array<String>)
+      # * +:next_token+ - (String)
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :list_domains, 'ListDomains'
+
+      # Calls the PutAttributes API operation.
+      # @method put_attributes(options = {})
+      #
+      # === Options:
+      #
+      # * +:domain_name+ - *required* - (String) The name of the domain in
+      #   which to perform the operation.
+      # * +:item_name+ - *required* - (String) The name of the item.
+      # * +:attributes+ - *required* - (Array<Hash>) The list of attributes.
+      #   * +:name+ - *required* - (String) The name of the replaceable
+      #     attribute.
+      #   * +:value+ - *required* - (String) The value of the replaceable
+      #     attribute.
+      #   * +:replace+ - (Boolean) A flag specifying whether or not to replace
+      #     the attribute/value pair or to add a new attribute/value pair. The
+      #     default setting is +false+ .
+      # * +:expected+ - (Hash) The update condition which, if specified,
+      #   determines whether the specified attributes will be updated or not.
+      #   The update condition must be satisfied in order for this request to
+      #   be processed and the attributes to be updated.
+      #   * +:name+ - (String) The name of the attribute involved in the
+      #     condition.
+      #   * +:value+ - (String) The value of an attribute. This value can only
+      #     be specified when the Exists parameter is equal to +true+ .
+      #   * +:exists+ - (Boolean) A value specifying whether or not the
+      #     specified attribute must exist with the specified value in order
+      #     for the update condition to be satisfied. Specify +true+ if the
+      #     attribute must exist for the update condition to be satisfied.
+      #     Specify +false+ if the attribute should not exist in order for the
+      #     update condition to be satisfied.
+      #
+      # === Response Structure:
+      #
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :put_attributes, 'PutAttributes'
+
+      # Calls the Select API operation.
+      # @method select(options = {})
+      #
+      # === Options:
+      #
+      # * +:select_expression+ - *required* - (String) The expression used to
+      #   query the domain.
+      # * +:next_token+ - (String) A string informing Amazon SimpleDB where to
+      #   start the next list of ItemNames.
+      # * +:consistent_read+ - (Boolean) Determines whether or not strong
+      #   consistency should be enforced when data is read from SimpleDB. If
+      #   +true+ , any data previously written to SimpleDB will be returned.
+      #   Otherwise, results will be consistent eventually, and the client may
+      #   not see data that was written immediately before your read.
+      #
+      # === Response Structure:
+      #
+      # * +:items+ - (Array<Hash>)
+      #   * +:name+ - (String)
+      #   * +:alternate_name_encoding+ - (String)
+      #   * +:attributes+ - (Array<Hash>)
+      #     * +:name+ - (String)
+      #     * +:alternate_name_encoding+ - (String)
+      #     * +:value+ - (String)
+      #     * +:alternate_value_encoding+ - (String)
+      # * +:next_token+ - (String)
+      # * +:response_metadata+ - (Hash)
+      #   * +:box_usage+ - (Numeric)
+      #   * +:response_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :select, 'Select'
+
+      ## end client methods ##
+
     end
   end
 end

data/lib/aws/simple_db/domain.rb

@@ -33,7 +33,7 @@ module AWS
 
       include Core::Model
 
-      # @param [String] The name of a SimpleDB domain to reference.
+      # @param [String] name The name of a SimpleDB domain to reference.
       def initialize(name, options = {})
         super(options)
         @name = name

data/lib/aws/simple_db/domain_collection.rb

@@ -86,14 +86,14 @@ module AWS
             [total_limit - received, batch_size].min : 
             batch_size
 
-          list_options = { :limit => limit }
+          list_options = { :max_number_of_domains => limit }
           list_options[:next_token] = next_token if next_token
           list = client.list_domains(list_options)
 
-          next_token = list.next_token
-          received += list.domain_names.length
+          next_token = list[:next_token]
+          received += list[:domain_names].size
 
-          list.domain_names.each do |name|
+          list[:domain_names].each do |name|
             yield(domain_named(name))
           end
         

data/lib/aws/simple_db/domain_metadata.rb

@@ -48,7 +48,7 @@ module AWS
         :timestamp,
       ]
 
-      # @param [Domain] The domain to fetch metadata for.
+      # @param [Domain] domain The domain to fetch metadata for.
       # @return [DomainMetadata]
       def initialize domain, options = {}
         @domain = domain

data/lib/aws/simple_db/errors.rb

@@ -35,8 +35,20 @@ module AWS
     # service are instances of either {ClientError} or {ServerError}.
     # @private
     module Errors
-      BASE_ERROR_GRAMMAR = Client::XML::BaseError
-      include Core::LazyErrorClasses
+
+      # @private
+      GRAMMAR = Core::XML::Grammar.customize do
+        element("Errors") do
+          ignore
+          element("Error") do
+            ignore
+            element("BoxUsage") { float_value }
+          end
+        end
+      end
+
+      extend Core::LazyErrorClasses
+
     end
 
   end