aws-sdk 1.9.0 → 1.9.1

data/lib/aws/record/hash_model.rb

@@ -80,7 +80,7 @@ module AWS
         end
 
         # @return [DynamoDB::Table]
-        # @private
+        # @api private
         def dynamo_db_table shard_name = nil
           table = dynamo_db.tables[dynamo_db_table_name(shard_name)]
           table.hash_key = [:id, :string]
@@ -101,7 +101,7 @@ module AWS
 
       # @return [DynamoDB::Item] Returns a reference to the item as stored in
       #   simple db.
-      # @private
+      # @api private
       private
       def dynamo_db_item
         dynamo_db_table.items[id]

data/lib/aws/record/model.rb

@@ -315,7 +315,7 @@ module AWS
         end
 
         # @return [AWS::SimpleDB::Domain]
-        # @private
+        # @api private
         def sdb_domain shard_name = nil
           sdb.domains[sdb_domain_name(shard_name)]
         end
@@ -334,7 +334,7 @@ module AWS
 
       # @return [SimpleDB::Item] Returns a reference to the item as stored in
       #   simple db.
-      # @private
+      # @api private
       private
       def sdb_item
         sdb_domain.items[id]
@@ -350,7 +350,7 @@ module AWS
       # This function accepts a hash of item data (as returned from
       # AttributeCollection#to_h or ItemData#attributes) and returns only
       # the key/value pairs that are configured attribues for this class.
-      # @private
+      # @api private
       private
       def deserialize_item_data item_data
 
@@ -374,14 +374,14 @@ module AWS
         data
       end
 
-      # @private
+      # @api private
       protected
       def create_storage
         to_add = serialize_attributes
         sdb_item.attributes.add(to_add.merge(opt_lock_conditions))
       end
 
-      # @private
+      # @api private
       private
       def update_storage
 
@@ -411,7 +411,7 @@ module AWS
       end
 
       # @return [true]
-      # @private
+      # @api private
       private
       def delete_storage
         sdb_item.delete(opt_lock_conditions)

data/lib/aws/record/model/scope.rb

@@ -60,7 +60,7 @@ module AWS
       #
       class Scope < Record::Scope
 
-        # @private
+        # @api private
         def initialize base_class, options = {}
           super
           @options[:where] ||= []
@@ -132,7 +132,7 @@ module AWS
           _with(:order => [attribute_name, order])
         end
 
-        # @private
+        # @api private
         private
         def _each_object &block
 
@@ -151,7 +151,7 @@ module AWS
         # @param [Scope] scope A scope to merge with this one.
         # @return [Scope] Returns a new scope with merged conditions and
         #   overriden order and limit.
-        # @private
+        # @api private
         private
         def _merge_scope scope
           merged = self
@@ -177,7 +177,7 @@ module AWS
         # @option options [Integer] :limit
         # @return [Scope] Returns a new scope with the hash of scope
         #   options applied.
-        # @private
+        # @api private
         private
         def _handle_options options
           scope = self
@@ -194,7 +194,7 @@ module AWS
 
         # Converts this scope object into an AWS::SimpleDB::ItemCollection
         # @return [SimpleDB::ItemCollection]
-        # @private
+        # @api private
         private
         def _item_collection
           items = base_class.sdb_domain(_shard).items

data/lib/aws/record/naming.rb

@@ -14,13 +14,13 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     module Naming
 
       # This method should only ever get called in a Rails 3+ context
       # where active model and active support have been loaded.  Rails 2
       # does not call model name on object.
-      # @private
+      # @api private
       def model_name
         @_model_name ||=
           ActiveModel::Name.new(self.kind_of?(Class) ? self : self.class)

data/lib/aws/record/scope.rb

@@ -23,7 +23,7 @@ module AWS
       # @param base_class A class that extends {AWS::Record::AbstractBase}.
       # @param [Hash] options
       # @option options :
-      # @private
+      # @api private
       def initialize base_class, options = {}
 
         @base_class = base_class
@@ -154,19 +154,19 @@ module AWS
       end
       alias_method :domain, :shard
 
-      # @private
+      # @api private
       private
       def _each_object &block
         raise NotImplementedError
       end
 
-      # @private
+      # @api private
       private
       def _with options
         self.class.new(base_class, @options.merge(options))
       end
 
-      # @private
+      # @api private
       private
       def method_missing scope_name, *args
         # @todo only proxy named scope methods
@@ -176,7 +176,7 @@ module AWS
       # Merges the one scope with the current scope, returning a 3rd.
       # @param [Scope] scope
       # @return [Scope]
-      # @private
+      # @api private
       private
       def _merge_scope scope
         raise NotImplementedError
@@ -185,13 +185,13 @@ module AWS
       # Consumes a hash of options (e.g. `:shard`, +:limit) and returns
       # a new scope with those applied.
       # @return [Scope]
-      # @private
+      # @api private
       private
       def _handle_options options
         raise NotImplementedError
       end
 
-      # @private
+      # @api private
       private
       def _item_collection
         raise NotImplementedError

data/lib/aws/record/validations.rb

@@ -683,7 +683,7 @@ module AWS
         validators << PresenceValidator.new(self, *args)
       end
 
-      # @private
+      # @api private
       private
       def validators
         @validators ||= []

data/lib/aws/record/validator.rb

@@ -15,7 +15,7 @@ module AWS
   module Record
 
     # Base class for all validators
-    # @private
+    # @api private
     class Validator
 
       # these should be defined in subclasses
@@ -53,12 +53,12 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def setup klass
       end
 
-      # @private
+      # @api private
       protected
       def each_value value, &block
         case value
@@ -67,7 +67,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def add_accessors klass, *accessors
 
@@ -92,7 +92,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       protected
       def validate_attributes record
         attribute_names.each do |attribute_name|
@@ -111,13 +111,13 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def read_attribute_for_validation(record, attribute_name)
         record.send(attribute_name)
       end
 
-      # @private
+      # @api private
       def reject_unknown_options
         invalid_keys = options.keys - self.class::ACCEPTED_OPTIONS
         if invalid_keys.length == 1
@@ -128,7 +128,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def passes_if_condition? record
         case options[:if]
@@ -140,7 +140,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def passes_unless_condition? record
         case options[:unless]
@@ -152,7 +152,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def passes_on_condition? record
         case options[:on]
@@ -165,7 +165,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def ensure_type type_or_types, *keys
 
@@ -198,7 +198,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def ensure_exclusive *key_groups
         key_groups.each do |key_group|
@@ -214,7 +214,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def ensure_present *keys
         keys.each do |k|
@@ -224,7 +224,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def ensure_at_least_one *keys
         found = keys.select{|k| options.has_key?(k) }

data/lib/aws/record/validators/acceptance.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class AcceptanceValidator < Validator
 
       ACCEPTED_OPTIONS = [:accept, :message, :allow_nil, :allow_blank, :on, :if, :unless]

data/lib/aws/record/validators/block.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class BlockValidator < Validator
 
       ACCEPTED_OPTIONS = [:allow_nil, :allow_blank, :on, :if, :unless]

data/lib/aws/record/validators/confirmation.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class ConfirmationValidator < Validator
 
       ACCEPTED_OPTIONS = [:message, :on, :if, :unless]

data/lib/aws/record/validators/count.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class CountValidator < Validator
 
       ACCEPTED_OPTIONS = [
@@ -69,7 +69,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       protected
       def wrong_number exactly, got
         msg = options[:wrong_number] ||
@@ -77,14 +77,14 @@ module AWS
         interpolate(msg, :exactly => exactly, :count => got)
       end
 
-      # @private
+      # @api private
       protected
       def too_few min, got
         msg = options[:too_few] || "has too few values (minimum is %{minimum})"
         interpolate(msg, :minimum => min, :count => got)
       end
 
-      # @private
+      # @api private
       protected
       def too_many max, got
         msg = options[:too_many] || "has too many values (maximum is %{maximum})"

data/lib/aws/record/validators/exclusion.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class ExclusionValidator < InclusionValidator
 
       ACCEPTED_OPTIONS = [:in, :message, :allow_nil, :allow_blank, :on, :if, :unless]

data/lib/aws/record/validators/format.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class FormatValidator < Validator
 
       ACCEPTED_OPTIONS = [

data/lib/aws/record/validators/inclusion.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class InclusionValidator < Validator
 
       ACCEPTED_OPTIONS = [:in, :message, :allow_nil, :allow_blank, :on, :if, :unless]

data/lib/aws/record/validators/length.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class LengthValidator < Validator
 
       ACCEPTED_OPTIONS = [
@@ -66,7 +66,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def wrong_length exactly, got
         msg = options[:wrong_length] ||
@@ -74,7 +74,7 @@ module AWS
         interpolate(msg, :exactly => exactly, :length => got)
       end
 
-      # @private
+      # @api private
       protected
       def too_short min, got
         msg = options[:too_short] ||
@@ -82,7 +82,7 @@ module AWS
         interpolate(msg, :minimum => min, :length => got)
       end
 
-      # @private
+      # @api private
       protected
       def too_long max, got
         msg = options[:too_long] ||

data/lib/aws/record/validators/method.rb

@@ -15,7 +15,7 @@ module AWS
   module Record
 
     # Uses the base validator class to call user-defined validation methods.
-    # @private
+    # @api private
     class MethodValidator < Validator
 
       ACCEPTED_OPTIONS = [:on, :if, :unless]