aws-sdk-v1 1.52.0

data/lib/aws/simple_db/config.rb

@@ -0,0 +1,20 @@
+# Copyright 2011-2013 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'SimpleDB', 'simple_db', 'sdb'
+
+  add_option :simple_db_consistent_reads, false, :boolean => true
+
+end

data/lib/aws/simple_db/consistent_read_option.rb

@@ -0,0 +1,42 @@
+# Copyright 2011-2013 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
+
+    # @api 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,62 @@
+# Copyright 2011-2013 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
+
+    # @api private
+    module DeleteAttributes
+
+      include ExpectConditionOption
+
+      # @api 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
+
+      # @api 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

data/lib/aws/simple_db/domain.rb

@@ -0,0 +1,123 @@
+# Copyright 2011-2013 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
+
+    # Represents a domain in SimpleDB.
+    #
+    # Domains, like database tables, must exist before you can write to one.
+    #
+    # @example Creating a domain
+    #
+    #   domain = SimpleDB.new.domains.create('mydomain')
+    #
+    # @example Getting a domain
+    #
+    #   domain = SimpleDB.new.domains['mydomain']
+    #
+    # @see DomainCollection
+    #
+    class Domain
+
+      # @api private
+      class NonEmptyDeleteError < StandardError; end
+
+      include Core::Model
+
+      # @param [String] name The name of a SimpleDB domain to reference.
+      def initialize(name, options = {})
+        super(options)
+        @name = name
+      end
+
+      # Returns the name for this domain.
+      #
+      # @return [String] The name of this domain.
+      attr_reader :name
+
+      # Returns true if the domain has no items, false otherwise.
+      #
+      # @return [Boolean] Returns true if the domain has no items.
+      def empty?
+        metadata.item_count == 0
+      end
+
+      # Deletes the (empty) domain.
+      #
+      # @note If you need to delete a domain with items, call {#delete!}
+      # @raise [NonEmptyDeleteError] Raises if the domain is not empty.
+      # @return [nil]
+      def delete
+        unless empty?
+          raise NonEmptyDeleteError, "delete called without :force " +
+           "on a non-empty domain"
+        end
+        client.delete_domain(:domain_name => name)
+        nil
+      end
+
+      # Deletes the domain and all of its items.
+      #
+      # @return [nil]
+      def delete!
+        client.delete_domain(:domain_name => name)
+        nil
+      end
+
+      # Returns true if this domain exists, false otherwise.
+      #
+      # @return [Boolean] Returns true if the domain exists.
+      def exists?
+        begin
+          client.domain_metadata(:domain_name => name)
+          true
+        rescue Errors::NoSuchDomain
+          false
+        end
+      end
+
+      # Returns a metadata object that can provide information about
+      # this domain.
+      #
+      # @return [DomainMetadata]
+      def metadata
+        DomainMetadata.new(self)
+      end
+
+      # Returns a collection that represents all of the items in this domain.
+      #
+      # @return [ItemCollection]
+      def items
+        ItemCollection.new(self)
+      end
+
+      # @return [Boolean] Returns true if the domains are the same.
+      def == other
+        other.is_a?(Domain) and
+        other.name == name and
+        other.config.simple_db_endpoint == config.simple_db_endpoint
+      end
+      alias_method :eql?, :==
+
+      # An irb-friendly string representation of this object.
+      #
+      # @return [String]
+      # @api private
+      def inspect
+        "#<#{self.class}:#{name}>"
+      end
+
+    end
+  end
+end

data/lib/aws/simple_db/domain_collection.rb

@@ -0,0 +1,86 @@
+# Copyright 2011-2013 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
+
+    # An Enumerable collection representing all your domains in SimpleDB.
+    #
+    # Use a DomainCollection to create, get and list domains.
+    #
+    # @example Creating a domain in SimpleDB
+    #
+    #   sdb = SimpleDB.new
+    #   domain = sdb.domains.create('mydomain')
+    #
+    # @example Getting a domain with indifferent access
+    #
+    #   domain = sdb.domains[:mydomain]
+    #   domain = sdb.domains['mydomain']
+    #
+    # @example Enumerating domains
+    #
+    #   sdb.domains.each do |domain|
+    #     puts domain.name
+    #   end
+    #
+    # @see Core::Collection
+    #
+    class DomainCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # Creates a domain in SimpleDB and returns a domain object.
+      #
+      # @note This operation might take 10 or more seconds to complete.
+      # @note Creating a domain in SimpleDB is an idempotent operation;
+      #   running it multiple times using the same domain name will not
+      #   result in an error.
+      # @note You can create up to 250 domains per account.
+      # @param [String] domain_name
+      # @return [Domain] Returns a new domain with the given name.
+      def create(domain_name)
+        client.create_domain(:domain_name => domain_name)
+        self[domain_name]
+      end
+
+      # Returns a domain object with the given name.
+      #
+      # @note This does not attempt to create the domain if it does not
+      #   already exist in SimpleDB.  Use {#create} to add a domain to SDB.
+      #
+      # @param [String] domain_name The name of the domain to return.
+      # @return [Domain] Returns the domain with the given name.
+      def [] domain_name
+        Domain.new(domain_name.to_s, :config => config)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}
+
+        options[:next_token] = next_token if next_token
+        options[:max_number_of_domains] = limit if limit
+
+        resp = client.list_domains(options)
+        resp.data[:domain_names].each do |name|
+          yield(self[name])
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/simple_db/domain_metadata.rb

@@ -0,0 +1,110 @@
+# Copyright 2011-2013 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
+
+    # SimpleDB can report on the amount of data stored in a domain,
+    # the number of items, etc.
+    #
+    # @example
+    #
+    #  sdb = SimpleDB.new
+    #  sdb.domains['mydomain'].metadata.to_h
+    #
+    #  # the hash returned above might look like:
+    #  {
+    #    :timestamp => 1300841880,
+    #    :attribute_names_size_bytes => 12,
+    #    :item_count => 1,
+    #    :attribute_value_count => 6,
+    #    :attribute_values_size_bytes => 25,
+    #    :item_names_size_bytes => 3,
+    #    :attribute_name_count => 3
+    #  }
+    #
+    class DomainMetadata
+
+      include Core::Model
+
+      # @api private
+      ATTRIBUTES = [
+        :item_count,
+        :item_names_size_bytes,
+        :attribute_name_count,
+        :attribute_names_size_bytes,
+        :attribute_value_count,
+        :attribute_values_size_bytes,
+        :timestamp,
+      ]
+
+      # @param [Domain] domain The domain to fetch metadata for.
+      # @return [DomainMetadata]
+      def initialize domain, options = {}
+        @domain = domain
+        super
+      end
+
+      # @return [Domain] The domain this metadata is describing.
+      attr_reader :domain
+
+      # @return [Integer] The number of all items in the {#domain}.
+      def item_count
+        self.to_h[:item_count]
+      end
+
+      # @return [Integer] The total size of all item names in the {#domain},
+      #   in bytes.
+      def item_names_size_bytes
+        self.to_h[:item_names_size_bytes]
+      end
+
+      # @return [Integer] The number of unique attribute names in the
+      #   {#domain}.
+      def attribute_name_count
+        self.to_h[:attribute_name_count]
+      end
+
+      # @return [Integer] The total size of all unique attribute names,
+      #   in bytes.
+      def attribute_names_size_bytes
+        self.to_h[:attribute_names_size_bytes]
+      end
+
+      # @return [Integer] The number of all attribute name/value pairs in
+      #   the {#domain}.
+      def attribute_value_count
+        self.to_h[:attribute_value_count]
+      end
+
+      # @return [Integer] The total size of all attribute values, in bytes.
+      def attribute_values_size_bytes
+        self.to_h[:attribute_values_size_bytes]
+      end
+
+      # @return [Integer] The data and time when metadata was calculated
+      #   in Epoch (UNIX) time.
+      def timestamp
+        self.to_h[:timestamp]
+      end
+
+      # @return [Hash] A hash of all of the metadata attributes for
+      #   this {#domain}.
+      def to_h
+        meta = client.domain_metadata(:domain_name => domain.name)
+        ATTRIBUTES.inject({}) {|h,attr| h[attr] = meta.send(attr); h }
+      end
+
+    end
+  end
+end