aws-sdk 1.0.0

data/lib/aws/simple_db/attribute_collection.rb

@@ -0,0 +1,227 @@
+# 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 'aws/model'
+require 'aws/simple_db/attribute'
+require 'aws/simple_db/consistent_read_option'
+require 'aws/simple_db/put_attributes'
+require 'aws/simple_db/delete_attributes'
+
+module AWS
+  class SimpleDB
+    class AttributeCollection
+
+      include Model
+      include Enumerable
+      include ConsistentReadOption
+      include PutAttributes
+      include DeleteAttributes
+
+      # @param [Item] The item to create an attribute collection for.
+      # @return [AttributeCollection]
+      def initialize item, options = {}
+        @item = item
+        super
+      end
+
+      # @return [Item] The item this collection belongs to.
+      attr_reader :item
+
+      # Retuns an Attribute with the given name.
+      #
+      # @note This does not make a request to SimpleDB.
+      #
+      # You can ask for any attribute by name.  The attribute may or may not
+      # actually exist in SimpleDB.
+      # 
+      # @example Get an attribute by symbol or string name
+      #   colors = item.attributes[:colors]
+      #   colors = item.attributes['colors']
+      # @param [String, Symbol] attribute_name name of the attribute to get.
+      # @return [Item] An item with the given name.
+      def [] attribute_name
+        Attribute.new(item, attribute_name.to_s)
+      end
+
+      # Sets the values for a given attribute.
+      #
+      # @example Replace all of the values for the named attribute.
+      #   item.attributes[:color] = 'red', 'blue'
+      # @return This method returns the values passed to it.
+      def []= attribute_name, *values
+        self[attribute_name].set(*values)
+      end
+
+      # Yields all attribute values with their names.
+      #
+      # @example Getting all values for an item
+      #
+      #   item.attributes.each_value do |name, value|
+      #     puts "#{name}: #{value}"
+      #   end
+      #
+      # @yield [attribute_name, attribute_value] Yields once for every 
+      #   attribute value on the item.
+      # @yieldparam [String] attribute_name
+      # @yieldparam [String] attribute_value
+      # @param [Hash] options 
+      # @option options [Boolean] :consistent_read (false) Causes this 
+      #   method to yield the most current attributes for this item.
+      # @return [nil]
+      def each_value options = {}, &block
+
+        list = client.get_attributes(
+          :domain_name => item.domain.name,
+          :item_name => item.name,
+          :consistent_read => consistent_read(options))
+
+        list.attributes.each do |attribute|
+          attribute_name = attribute.name
+          attribute_value = attribute.value
+          yield(attribute_name, attribute_value)
+        end
+
+        nil
+
+      end
+
+      # Yields all attribute for this item.
+      #
+      # @example Getting all attributes for an item
+      #
+      #   item.attributes.each do |attribute|
+      #     puts attribute.name
+      #   end
+      #
+      # @yield [attribute] Yields once for every attribute
+      #   on the item.  Yields each attribute only one time, even it
+      #   has multiple values.
+      # @yieldparam [Attribute] attribute
+      # @param [Hash] options 
+      # @option options [Boolean] :consistent_read (false) Causes this 
+      #   method to yield the most current attributes for this item.
+      # @return [nil]
+      def each options = {}, &block
+        yielded = {}
+        each_value(options) do |attribute_name, attribute_value| 
+          unless yielded[attribute_name]
+            attribute = self[attribute_name]
+            yield(attribute)
+            yielded[attribute_name] = true
+          end
+        end
+        nil
+      end
+
+      # Replaces attributes for the {#item}.
+      #
+      # The +attributes_hash+ should have attribute names as keys.  The 
+      # hash values should be either strings or arrays of strings.
+      #
+      # Attributes not named in this hash are left alone.  Attributes named
+      # in this hash are replaced.
+      #
+      # @example
+      #
+      #   item.attributes.set(
+      #     'colors' => ['red', 'blue'],  
+      #     'category' => 'clearance')
+      #
+      # @param [Hash] attributes
+      # @return [nil]
+      def replace attributes
+        do_put(attribute_hashes(attributes, true), attributes)
+      end
+      alias_method :set, :replace
+
+      # Adds values to attributes on the {#item}.
+      #
+      # The +attributes_hash+ should have attribute names as keys.  The 
+      # hash values should be either strings or arrays of strings.
+      #
+      # @example
+      #
+      #   item.attributes.add(
+      #     'colors' => ['red', 'blue'],  
+      #     'category' => 'clearance')
+      #
+      # @param[Hash] attribute_hash
+      # @return [nil]
+      def add attributes
+        do_put(attribute_hashes(attributes, false), attributes)
+      end
+
+      # Perform a mixed update of added and replace attribues.
+      #
+      #   item.attributes.put(
+      #     :add => { 'colors' => %w(green blue), 'tags' => 'cool' }
+      #     :replace => { 'quantity' => 5 }
+      #   )
+      #
+      # @param [Hash] options
+      # @option options [Hash] :add A hash of attribute names and values to
+      #   append to this item.
+      # @option options [Hash] :replace A hash of attribute names and values to
+      #   add to this item.  If there are currently attributes of the same
+      #   name they will be replaced (not appended to).
+      # @option options [Hash] :replace
+      # @return [nil]
+      def put options = {}
+        add = options[:add] || {}
+        replace = options[:replace] || {}
+        attributes = attribute_hashes(add, false)
+        attributes += attribute_hashes(replace, true)
+        do_put(attributes, options)
+      end
+
+      # Returns a hash of all attributes (names and values).
+      # The attribute names are strings and the values are
+      # arrays of strings.
+      #
+      # @example
+      #   item.attributes.to_h
+      #   #=> { 'colors' => ['red','blue'], 'size' => ['large'] }
+      #
+      # @param [Hash] options 
+      # @option options [Boolean] :consistent_read (false) Causes this 
+      #   method to return the most current attributes values.
+      # @return [Hash]
+      def to_h options = {}
+        hash = {}
+        each_value(options) do |attribute_name,attribute_value|
+          hash[attribute_name] ||= []
+          hash[attribute_name] << attribute_value
+        end
+        hash
+      end
+
+      # Delete one or more attributes from {#item}.
+      #
+      # @example Delete a list of attributes by name
+      #   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]
+      def delete *args
+        if args.size == 1 and args.first.kind_of?(Hash)
+          delete_attribute_values(args.first)
+        else
+          delete_named_attributes(*args)
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/simple_db/client.rb

@@ -0,0 +1,52 @@
+# 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 'aws/base_client'
+require 'aws/configured_client_methods'
+require 'aws/simple_db/request'
+require 'aws/simple_db/client/xml'
+require 'aws/simple_db/client/options'
+require 'aws/inflection'
+require 'aws/simple_db/errors'
+require 'time'
+
+module AWS
+  class SimpleDB
+    
+    # @private
+    class Client < BaseClient
+
+      include ConfiguredClientMethods
+
+      API_VERSION = '2009-04-15'
+
+      REGION_US_E1 = 'sdb.amazonaws.com'
+      REGION_US_W1 = 'sdb.us-west-1.amazonaws.com'
+      REGION_EU_W1 = 'sdb.eu-west-1.amazonaws.com'
+      REGION_APAC_SE1 = 'sdb.ap-southeast-1.amazonaws.com'
+
+      REQUEST_CLASS = SimpleDB::Request
+
+      configure_client
+
+      def valid_domain_name? name
+        self.class.valid_domain_name?(name)
+      end
+
+      def self.valid_domain_name? name
+        name.to_s =~ /^[a-z_\-\.]{3,255}$/i ? true : false
+      end
+
+    end
+  end
+end

data/lib/aws/simple_db/client/options.rb

@@ -0,0 +1,34 @@
+# 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 'aws/configured_option_grammars'
+
+module AWS
+  class SimpleDB
+    class Client < BaseClient
+
+      # @private
+      module Options
+
+        include ConfiguredOptionGrammars
+
+        define_configured_grammars
+
+        CustomizedListDomains =
+          ListDomains.customize("MaxNumberOfDomains" =>
+                                [{ :rename => "limit" }])
+
+      end
+    end
+  end
+end

data/lib/aws/simple_db/client/xml.rb

@@ -0,0 +1,68 @@
+# 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 'aws/configured_xml_grammars'
+require 'aws/ignore_result_element'
+require 'aws/xml_grammar'
+
+module AWS
+  class SimpleDB
+    class Client < BaseClient
+
+      # @private
+      module XML
+
+        include ConfiguredXmlGrammars
+
+        extend IgnoreResultElement
+
+        BaseResponse = XmlGrammar.customize do
+          element "ResponseMetadata" do
+            element "BoxUsage" do
+              float_value
+            end
+          end
+        end
+
+        BaseError = XmlGrammar.customize do
+          element("Errors") do
+            ignore
+            element("Error") do
+              ignore
+              element("BoxUsage") { float_value }
+            end
+          end
+        end
+
+        define_configured_grammars
+
+        CustomizedSelect = Select.customize do
+          element "SelectResult" do
+            element "NextToken" do
+              force
+            end
+          end
+        end
+
+        CustomizedListDomains = ListDomains.customize do
+          element "ListDomainsResult" do
+            element "NextToken" do
+              force
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws/simple_db/consistent_read_option.rb

@@ -0,0 +1,42 @@
+# 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
+  class SimpleDB
+    
+    # @private
+    module ConsistentReadOption
+
+      # Determines if SimpleDB should be read consistently or not.
+      #
+      # Precedence is given to:
+      #
+      # * +:consistent_read+ option
+      # * SimpleDB.consistent_reads block value
+      # * AWS.config.simple_db_consistent_reads?
+      # 
+      # @return [Boolean] Returns true if a read should be made consistently
+      #   to SimpleDB.
+      def consistent_read options
+        if options.has_key?(:consistent_read)
+          options[:consistent_read] ? true : false  
+        elsif SimpleDB.send(:in_consistent_reads_block?)
+          SimpleDB.send(:consistent_reads_state)
+        else
+          config.simple_db_consistent_reads?
+        end
+      end
+        
+    end
+  end
+end

data/lib/aws/simple_db/delete_attributes.rb

@@ -0,0 +1,64 @@
+# 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 'aws/simple_db/expect_condition_option'
+
+module AWS
+  class SimpleDB
+
+    # @private
+    module DeleteAttributes
+
+      include ExpectConditionOption
+
+      # @private
+      protected
+      def delete_named_attributes *attribute_names
+        expect_opts = attribute_names.pop if attribute_names.last.kind_of?(Hash)
+        attributes = attribute_names.flatten.collect{|n| { :name => n.to_s } }
+        opts = {
+          :domain_name => item.domain.name,
+          :item_name => item.name,
+          :attributes => attributes,
+          :expected => expect_condition_opts(expect_opts || {})
+        }
+        opts.delete(:expected) if opts[:expected].empty?
+        client.delete_attributes(opts) unless attributes.empty?
+      end
+
+      # @private
+      protected
+      def delete_attribute_values(attributes)
+        opts = {
+          :domain_name => item.domain.name,
+          :item_name => item.name,
+          :attributes => [],
+          :expected => expect_condition_opts(attributes)
+        }
+        attributes.each do |name, values|
+          if name != :"if" && name != :"unless"
+            [values].flatten.each do |value|
+              attribute_value = { :name => name.to_s }
+              attribute_value[:value] = value unless value == :all
+              opts[:attributes] << attribute_value
+            end
+          end
+        end
+        opts.delete(:expected) if opts[:expected].empty?
+        client.delete_attributes(opts)
+      end
+
+    end
+
+  end
+end