aws-record 2.11.0 → 2.12.0

data/lib/aws-record/record/item_operations.rb

@@ -11,20 +11,27 @@ module Aws
       # Saves this instance of an item to Amazon DynamoDB. If this item is "new"
       # as defined by having new or altered key attributes, will attempt a
       # conditional
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
       # Aws::DynamoDB::Client#put_item} call, which will not overwrite an existing
       # item. If the item only has altered non-key attributes, will perform an
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
       # Aws::DynamoDB::Client#update_item} call. Uses this item instance's attributes
       # in order to build the request on your behalf.
       #
       # You can use the +:force+ option to perform a simple put/overwrite
       # without conditional validation or update logic.
       #
-      # @param [Hash] opts
+      # @param [Hash] opts Options to pass through to the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      #  Aws::DynamoDB::Client#put_item} call or the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      #  Aws::DynamoDB::Client#update_item} call. +:put_item+ is used when
+      #  +:force+ is true or when the item is new. +:update_item+ is used when
+      #  the item is not new.
       # @option opts [Boolean] :force if true, will save as a put operation and
       #  overwrite any existing item on the remote end. Otherwise, and by
       #  default, will either perform a conditional put or an update call.
+      #
       # @raise [Aws::Record::Errors::KeyMissing] if a required key attribute
       #  does not have a value within this item instance.
       # @raise [Aws::Record::Errors::ConditionalWriteFailed] if a conditional
@@ -34,30 +41,35 @@ module Aws
       #  cause is dependent on the validation library you are using.
       def save!(opts = {})
         ret = save(opts)
-        if ret
-          ret
-        else
-          raise Errors::ValidationError, 'Validation hook returned false!'
-        end
+        raise Errors::ValidationError, 'Validation hook returned false!' unless ret
+
+        ret
       end
 
       # Saves this instance of an item to Amazon DynamoDB. If this item is "new"
       # as defined by having new or altered key attributes, will attempt a
       # conditional
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
       # Aws::DynamoDB::Client#put_item} call, which will not overwrite an
       # existing item. If the item only has altered non-key attributes, will perform an
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
       # Aws::DynamoDB::Client#update_item} call. Uses this item instance's attributes
       # in order to build the request on your behalf.
       #
       # You can use the +:force+ option to perform a simple put/overwrite
       # without conditional validation or update logic.
       #
-      # @param [Hash] opts
+      # @param [Hash] opts Options to pass through to the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      #  Aws::DynamoDB::Client#put_item} call or the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      #  Aws::DynamoDB::Client#update_item} call. +:put_item+ is used when
+      #  +:force+ is true or when the item is new. +:update_item+ is used when
+      #  the item is not new.
       # @option opts [Boolean] :force if true, will save as a put operation and
       #  overwrite any existing item on the remote end. Otherwise, and by
       #  default, will either perform a conditional put or an update call.
+      #
       # @return false if the record is invalid as defined by an attempt to call
       #  +valid?+ on this item, if that method exists. Otherwise, returns client
       #  call return value.
@@ -98,6 +110,7 @@ module Aws
           field = field.to_sym
           setter = "#{field}="
           raise ArgumentError, "Invalid field: #{field} for model" unless respond_to?(setter)
+
           public_send(setter, new_value)
         end
       end
@@ -132,12 +145,19 @@ module Aws
       #   model.dirty? # => false
       #
       #
-      # @param [Hash] new_param, contains the new parameters for the model
+      # @param [Hash] new_params Contains the new parameters for the model.
       #
-      # @param [Hash] opts
+      # @param [Hash] opts Options to pass through to the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      #  Aws::DynamoDB::Client#put_item} call or the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      #  Aws::DynamoDB::Client#update_item} call. +:put_item+ is used when
+      #  +:force+ is true or when the item is new. +:update_item+ is used when
+      #  the item is not new.
       # @option opts [Boolean] :force if true, will save as a put operation and
       #  overwrite any existing item on the remote end. Otherwise, and by
       #  default, will either perform a conditional put or an update call.
+      #
       # @return false if the record is invalid as defined by an attempt to call
       #  +valid?+ on this item, if that method exists. Otherwise, returns client
       #  call return value.
@@ -155,12 +175,18 @@ module Aws
       # but this will be interpreted as persisting a new item to your DynamoDB
       # table
       #
-      # @param [Hash] new_param, contains the new parameters for the model
-      #
-      # @param [Hash] opts
+      # @param [Hash] new_params Contains the new parameters for the model.
+      # @param [Hash] opts Options to pass through to the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      #  Aws::DynamoDB::Client#put_item} call or the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
+      #  Aws::DynamoDB::Client#update_item} call. +:put_item+ is used when
+      #  +:force+ is true or when the item is new. +:update_item+ is used when
+      #  the item is not new.
       # @option opts [Boolean] :force if true, will save as a put operation and
       #  overwrite any existing item on the remote end. Otherwise, and by
       #  default, will either perform a conditional put or an update call.
+      #
       # @return The update mode if the update is successful
       #
       # @raise [Aws::Record::Errors::ValidationError] if any new values
@@ -172,18 +198,23 @@ module Aws
 
       # Deletes the item instance that matches the key values of this item
       # instance in Amazon DynamoDB. Uses the
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#delete_item-instance_method
       # Aws::DynamoDB::Client#delete_item} API.
-      def delete!
-        dynamodb_client.delete_item(
+      #
+      # @param [Hash] opts Options to pass through to the
+      #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#delete_item-instance_method
+      #  Aws::DynamoDB::Client#delete_item} call.
+      def delete!(opts = {})
+        delete_opts = {
           table_name: self.class.table_name,
           key: key_values
-        )
+        }
+        dynamodb_client.delete_item(opts.merge(delete_opts))
         instance_variable_get('@data').destroyed = true
       end
 
       # Validates and generates the key values necessary for API operations such as the
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method
+      # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#delete_item-instance_method
       # Aws::DynamoDB::Client#delete_item} operation.
       def key_values
         validate_key_values
@@ -207,36 +238,35 @@ module Aws
 
       def _invalid_record?(_opts)
         if respond_to?(:valid?)
-          if !valid?
-            true
-          else
-            false
-          end
+          !valid?
         else
           false
         end
       end
 
       def _perform_save(opts)
-        force = opts[:force]
+        force = opts.delete(:force)
         expect_new = expect_new_item?
         if force
-          dynamodb_client.put_item(
+          put_opts = {
             table_name: self.class.table_name,
             item: _build_item_for_save
-          )
+          }
+          dynamodb_client.put_item(opts.merge(put_opts))
         elsif expect_new
           put_opts = {
             table_name: self.class.table_name,
             item: _build_item_for_save
           }.merge(prevent_overwrite_expression)
           begin
-            dynamodb_client.put_item(put_opts)
-          rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
-            raise Errors::ConditionalWriteFailed,
-                  'Conditional #put_item call failed! Check that conditional write'\
-                  ' conditions are met, or include the :force option to clobber'\
-                  ' the remote item.'
+            dynamodb_client.put_item(opts.merge(put_opts))
+          rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+            raise Errors::ConditionalWriteFailed.new(
+              'Conditional #put_item call failed! Check that conditional write ' \
+              'conditions are met, or include the :force option to clobber ' \
+              'the remote item.',
+              e
+            )
           end
         else
           update_pairs = _dirty_changes_for_update
@@ -246,20 +276,20 @@ module Aws
           )
           if update_tuple
             uex, exp_attr_names, exp_attr_values = update_tuple
-            request_opts = {
+            update_opts = {
               table_name: self.class.table_name,
               key: key_values,
               update_expression: uex,
               expression_attribute_names: exp_attr_names
             }
-            request_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
-            dynamodb_client.update_item(request_opts)
+            update_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
           else
-            dynamodb_client.update_item(
+            update_opts = {
               table_name: self.class.table_name,
               key: key_values
-            )
+            }
           end
+          dynamodb_client.update_item(opts.merge(update_opts))
         end
         data = instance_variable_get('@data')
         data.destroyed = false
@@ -311,11 +341,10 @@ module Aws
       end
 
       def _dirty_changes_for_update
-        ret = dirty.each_with_object({}) do |attr_name, acc|
+        dirty.each_with_object({}) do |attr_name, acc|
           acc[attr_name] = @data.raw_value(attr_name)
           acc
         end
-        ret
       end
 
       module ItemOperationsClassMethods
@@ -350,9 +379,8 @@ module Aws
           key = opts.delete(:key)
           check_key = {}
           @keys.keys.each_value do |attr_sym|
-            unless key[attr_sym]
-              raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}"
-            end
+            raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}" unless key[attr_sym]
+
             attr_name = attributes.storage_name_for(attr_sym)
             check_key[attr_name] = attributes.attribute_for(attr_sym)
                                              .serialize(key[attr_sym])
@@ -374,9 +402,8 @@ module Aws
           key = opts.delete(:key)
           request_key = {}
           @keys.keys.each_value do |attr_sym|
-            unless key[attr_sym]
-              raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}"
-            end
+            raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}" unless key[attr_sym]
+
             attr_name = attributes.storage_name_for(attr_sym)
             request_key[attr_name] = attributes.attribute_for(attr_sym)
                                                .serialize(key[attr_sym])
@@ -468,30 +495,33 @@ module Aws
         # supports the options you are including, and avoid adding options not
         # recognized by the underlying client to avoid runtime exceptions.
         #
-        # @param [Hash] opts Options to pass through to the DynamoDB #get_item
-        #  request. The +:key+ option is a special case where attributes are
-        #  serialized and translated for you similar to the #find method.
+        # @param [Hash] opts Options to pass through to the
+        #  {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#get_item-instance_method
+        #  Aws::DynamoDB::Client#get_item} request. The +:key+ option is a
+        #  special case where attributes are serialized and translated for you
+        #  similar to the #find method.
         # @option opts [Hash] :key attribute-value pairs for the key you wish to
         #  search for.
+        #
         # @return [Aws::Record] builds and returns an instance of your model.
+        #
         # @raise [Aws::Record::Errors::KeyMissing] if your option parameters do
         #  not include all table keys.
         def find_with_opts(opts)
           key = opts.delete(:key)
           request_key = {}
           @keys.keys.each_value do |attr_sym|
-            unless key[attr_sym]
-              raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}"
-            end
+            raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{key}" unless key[attr_sym]
+
             attr_name = attributes.storage_name_for(attr_sym)
             request_key[attr_name] = attributes.attribute_for(attr_sym)
                                                .serialize(key[attr_sym])
           end
-          request_opts = {
+          get_opts = {
             table_name: table_name,
             key: request_key
           }.merge(opts)
-          resp = dynamodb_client.get_item(request_opts)
+          resp = dynamodb_client.get_item(get_opts)
           if resp.item.nil?
             nil
           else
@@ -547,7 +577,7 @@ module Aws
         #   MyModel.update(id: 1, name: "First", body: "Hello!")
         #
         # Performs an
-        # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_item-instance_method
+        # {http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#update_item-instance_method
         # Aws::DynamoDB::Client#update_item} call immediately on the table,
         # using the attribute key/value pairs provided.
         #
@@ -555,6 +585,7 @@ module Aws
         #  wish to perform. You must include all key attributes for a valid
         #  call, then you may optionally include any other attributes that you
         #  wish to update.
+        #
         # @raise [Aws::Record::Errors::KeyMissing] if your option parameters do
         #  not include all table keys.
         def update(opts)
@@ -564,21 +595,22 @@ module Aws
               raise Errors::KeyMissing, "Missing required key #{attr_sym} in #{opts}"
 
             end
+
             attr_name = attributes.storage_name_for(attr_sym)
             key[attr_name] = attributes.attribute_for(attr_sym).serialize(value)
           end
-          request_opts = {
+          update_opts = {
             table_name: table_name,
             key: key
           }
           update_tuple = _build_update_expression(opts)
           unless update_tuple.nil?
             uex, exp_attr_names, exp_attr_values = update_tuple
-            request_opts[:update_expression] = uex
-            request_opts[:expression_attribute_names] = exp_attr_names
-            request_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
+            update_opts[:update_expression] = uex
+            update_opts[:expression_attribute_names] = exp_attr_names
+            update_opts[:expression_attribute_values] = exp_attr_values unless exp_attr_values.empty?
           end
-          dynamodb_client.update_item(request_opts)
+          dynamodb_client.update_item(update_opts)
         end
 
         private
@@ -591,8 +623,8 @@ module Aws
           name_sub_token = 'UE_A'
           value_sub_token = 'ue_a'
           attr_value_pairs.each do |attr_sym, value|
-            name_sub = '#' + name_sub_token
-            value_sub = ':' + value_sub_token
+            name_sub = "##{name_sub_token}"
+            value_sub = ":#{value_sub_token}"
             name_sub_token = name_sub_token.succ
             value_sub_token = value_sub_token.succ
 
@@ -607,12 +639,8 @@ module Aws
             end
           end
           update_expressions = []
-          unless set_expressions.empty?
-            update_expressions << 'SET ' + set_expressions.join(', ')
-          end
-          unless remove_expressions.empty?
-            update_expressions << 'REMOVE ' + remove_expressions.join(', ')
-          end
+          update_expressions << ("SET #{set_expressions.join(', ')}") unless set_expressions.empty?
+          update_expressions << ("REMOVE #{remove_expressions.join(', ')}") unless remove_expressions.empty?
           if update_expressions.empty?
             nil
           else

data/lib/aws-record/record/marshalers/boolean_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class BooleanMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when false, 'false', '0', 0
             false

data/lib/aws-record/record/marshalers/date_marshaler.rb

@@ -12,9 +12,7 @@ module Aws
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Date
             raw_value

data/lib/aws-record/record/marshalers/date_time_marshaler.rb

@@ -36,9 +36,7 @@ module Aws
 
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::DateTime
             raw_value

data/lib/aws-record/record/marshalers/epoch_time_marshaler.rb

@@ -35,15 +35,11 @@ module Aws
 
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::Time
             raw_value
-          when Integer # timestamp
-            ::Time.at(raw_value)
-          when BigDecimal
+          when Integer, BigDecimal # timestamp
             ::Time.at(raw_value)
           else # Date, DateTime, or String
             ::Time.parse(raw_value.to_s)

data/lib/aws-record/record/marshalers/float_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class FloatMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Float
             raw_value

data/lib/aws-record/record/marshalers/integer_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class IntegerMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Integer
             raw_value

data/lib/aws-record/record/marshalers/list_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class ListMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Array
             raw_value
@@ -18,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_a)
               raw_value.to_a
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into an array!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into an array!"
               raise ArgumentError, msg
             end
           end

data/lib/aws-record/record/marshalers/map_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class MapMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when Hash
             raw_value
@@ -18,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_h)
               raw_value.to_h
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a hash!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a hash!"
               raise ArgumentError, msg
             end
           end

data/lib/aws-record/record/marshalers/numeric_set_marshaler.rb

@@ -3,14 +3,14 @@
 module Aws
   module Record
     module Marshalers
-      class NumericSetMarshaler
-        def initialize(opts = {}); end
+      def initialize(opts = {})
+        # pass
+      end
 
+      class NumericSetMarshaler
         def type_cast(raw_value)
           case raw_value
-          when nil
-            Set.new
-          when ''
+          when nil, ''
             Set.new
           when Set
             _as_numeric(raw_value)
@@ -18,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_set)
               _as_numeric(raw_value.to_set)
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a Numeric Set!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a Numeric Set!"
               raise ArgumentError, msg
             end
           end

data/lib/aws-record/record/marshalers/string_marshaler.rb

@@ -4,7 +4,9 @@ module Aws
   module Record
     module Marshalers
       class StringMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value

data/lib/aws-record/record/marshalers/string_set_marshaler.rb

@@ -4,13 +4,13 @@ module Aws
   module Record
     module Marshalers
       class StringSetMarshaler
-        def initialize(opts = {}); end
+        def initialize(opts = {})
+          # pass
+        end
 
         def type_cast(raw_value)
           case raw_value
-          when nil
-            Set.new
-          when ''
+          when nil, ''
             Set.new
           when Set
             _as_strings(raw_value)
@@ -18,8 +18,8 @@ module Aws
             if raw_value.respond_to?(:to_set)
               _as_strings(raw_value.to_set)
             else
-              msg = "Don't know how to make #{raw_value} of type"\
-                " #{raw_value.class} into a String Set!"
+              msg = "Don't know how to make #{raw_value} of type " \
+                    "#{raw_value.class} into a String Set!"
               raise ArgumentError, msg
             end
           end

data/lib/aws-record/record/marshalers/time_marshaler.rb

@@ -36,9 +36,7 @@ module Aws
 
         def _format(raw_value)
           case raw_value
-          when nil
-            nil
-          when ''
+          when nil, ''
             nil
           when ::Time
             raw_value