aws-record 1.0.0.pre.8 → 1.0.0.pre.9

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

@@ -21,17 +21,17 @@ module Aws
       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 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 Aws::DynamoDB::Client#update_item}
-      #  call. Uses this item instance's attributes in order to build the
-      #  request on your behalf.
+      # 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 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 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.
+      # without conditional validation or update logic.
       #
       # @param [Hash] opts
       # @option opts [Boolean] :force if true, will save as a put operation and
@@ -54,17 +54,17 @@ module Aws
       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 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 Aws::DynamoDB::Client#update_item}
-      #  call. Uses this item instance's attributes in order to build the
-      #  request on your behalf.
+      # 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 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 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.
+      # without conditional validation or update logic.
       #
       # @param [Hash] opts
       # @option opts [Boolean] :force if true, will save as a put operation and
@@ -112,12 +112,12 @@ module Aws
         if force
           dynamodb_client.put_item(
             table_name: self.class.table_name,
-            item: build_item_for_save
+            item: _build_item_for_save
           )
         elsif expect_new
           put_opts = {
             table_name: self.class.table_name,
-            item: build_item_for_save
+            item: _build_item_for_save
           }.merge(prevent_overwrite_expression)
           begin
             dynamodb_client.put_item(put_opts)
@@ -129,25 +129,52 @@ module Aws
             )
           end
         else
-          dynamodb_client.update_item(
-            table_name: self.class.table_name,
-            key: key_values,
-            attribute_updates: dirty_changes_for_update
+          update_pairs = _dirty_changes_for_update
+          update_tuple = self.class.send(
+            :_build_update_expression,
+            update_pairs
           )
+          if update_tuple
+            uex, exp_attr_names, exp_attr_values = update_tuple
+            dynamodb_client.update_item(
+              table_name: self.class.table_name,
+              key: key_values,
+              update_expression: uex,
+              expression_attribute_names: exp_attr_names,
+              expression_attribute_values: exp_attr_values
+            )
+          else
+            dynamodb_client.update_item(
+              table_name: self.class.table_name,
+              key: key_values
+            )
+          end
         end
       end
 
-      def build_item_for_save
+      def _build_item_for_save
         validate_key_values
         attributes = self.class.attributes
+        _populate_default_values(attributes)
         @data.inject({}) do |acc, name_value_pair|
           attr_name, raw_value = name_value_pair
-          db_name = attributes[attr_name].database_name
-          acc[db_name] = attributes[attr_name].serialize(raw_value)
+          attribute = attributes[attr_name]
+          if !raw_value.nil? || attribute.persist_nil?
+            db_name = attribute.database_name
+            acc[db_name] = attribute.serialize(raw_value)
+          end
           acc
         end
       end
 
+      def _populate_default_values(attributes)
+        attributes.each do |attr_name, attribute|
+          if !attribute.default_value.nil? && @data[attribute.name].nil?
+            @data[attr_name] = attribute.default_value
+          end
+        end
+      end
+
       def key_values
         validate_key_values
         attributes = self.class.attributes
@@ -198,15 +225,10 @@ module Aws
         }
       end
 
-      def dirty_changes_for_update
+      def _dirty_changes_for_update
         attributes = self.class.attributes
         ret = dirty.inject({}) do |acc, attr_name|
-          key = attributes[attr_name].database_name
-          value = {
-            value: attributes[attr_name].serialize(@data[attr_name]),
-            action: "PUT"
-          }
-          acc[key] = value
+          acc[attr_name] = @data[attr_name]
           acc
         end
         ret
@@ -289,32 +311,54 @@ module Aws
             table_name: table_name,
             key: key
           }
-          update_expressions = []
+          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
+          end
+          dynamodb_client.update_item(request_opts)
+        end
+
+        private
+        def _build_update_expression(attr_value_pairs)
+          set_expressions = []
+          remove_expressions = []
           exp_attr_names = {}
           exp_attr_values = {}
-          name_sub_token = "A"
-          value_sub_token = "a"
-          opts.each do |attr_sym, value|
+          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_token = name_sub_token.succ
             value_sub_token = value_sub_token.succ
 
-            attr_name = attributes[attr_sym].database_name
-            update_expressions << "#{name_sub} = #{value_sub}"
+            attribute = attributes[attr_sym]
+            attr_name = attribute.database_name
             exp_attr_names[name_sub] = attr_name
-            exp_attr_values[value_sub] = attributes[attr_sym].serialize(value)
+            if _update_type_remove?(attribute, value)
+              remove_expressions << "#{name_sub}"
+            else
+              set_expressions << "#{name_sub} = #{value_sub}"
+              exp_attr_values[value_sub] = attribute.serialize(value)
+            end
           end
-          unless update_expressions.empty?
-            uex = "SET " + update_expressions.join(", ")
-            request_opts[:update_expression] = uex
-            request_opts[:expression_attribute_names] = exp_attr_names
-            request_opts[:expression_attribute_values] = exp_attr_values
+          update_expressions = []
+          unless set_expressions.empty?
+            update_expressions << "SET " + set_expressions.join(", ")
+          end
+          unless remove_expressions.empty?
+            update_expressions << "REMOVE " + remove_expressions.join(", ")
+          end
+          if update_expressions.empty?
+            nil
+          else
+            [update_expressions.join(" "), exp_attr_names, exp_attr_values]
           end
-          dynamodb_client.update_item(request_opts)
         end
 
-        private
         def build_item_from_resp(resp)
           record = new
           data = record.instance_variable_get("@data")
@@ -323,6 +367,10 @@ module Aws
           end
           record
         end
+
+        def _update_type_remove?(attribute, value)
+          value.nil? && !attribute.persist_nil?
+        end
       end
 
     end

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

@@ -0,0 +1,53 @@
+# Copyright 2016 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
+  module Record
+    module Marshalers
+
+      class BooleanMarshaler
+        def initialize(opts = {})
+        end
+
+        def type_cast(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ''
+            nil
+          when false, 'false', '0', 0
+            false
+          else
+            true
+          end
+        end
+
+        def serialize(raw_value)
+          boolean = type_cast(raw_value)
+          case boolean
+          when nil
+            nil
+          when false
+            false
+          when true
+            true
+          else
+            msg = "expected a boolean value or nil, got #{boolean.class}"
+            raise ArgumentError, msg
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# Copyright 2016 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 'date'
+
+module Aws
+  module Record
+    module Marshalers
+
+      class DateMarshaler
+        def initialize(opts = {})
+          @formatter = opts[:formatter] || Iso8601Formatter
+        end
+
+        def type_cast(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ''
+            nil
+          when Date
+            raw_value
+          when Integer
+            Date.parse(Time.at(raw_value).to_s) # assumed timestamp
+          else
+            Date.parse(raw_value.to_s) # Time, DateTime or String
+          end
+        end
+
+        def serialize(raw_value)
+          date = type_cast(raw_value)
+          if date.nil?
+            nil
+          elsif date.is_a?(Date)
+            @formatter.format(date)
+          else
+            raise ArgumentError, "expected a Date value or nil, got #{date.class}"
+          end
+        end
+
+      end
+
+      module Iso8601Formatter
+        def self.format(date)
+          date.iso8601
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# Copyright 2016 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 'date'
+
+module Aws
+  module Record
+    module Marshalers
+
+      class DateTimeMarshaler
+        def initialize(opts = {})
+          @formatter = opts[:formatter] || Iso8601Formatter
+          @use_local_time = opts[:use_local_time] ? true : false
+        end
+
+        def type_cast(raw_value)
+          value = _format(raw_value)
+          if !@use_local_time && value.is_a?(::DateTime)
+            value.new_offset(0)
+          else
+            value
+          end
+        end
+
+        def serialize(raw_value)
+          datetime = type_cast(raw_value)
+          if datetime.nil?
+            nil
+          elsif datetime.is_a?(::DateTime)
+            @formatter.format(datetime)
+          else
+            msg = "expected a DateTime value or nil, got #{datetime.class}"
+            raise ArgumentError, msg
+          end
+        end
+
+        private
+        def _format(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ''
+            nil
+          when ::DateTime
+            raw_value
+          when Integer # timestamp
+            ::DateTime.parse(Time.at(raw_value).to_s)
+          else # Time, Date or String
+            ::DateTime.parse(raw_value.to_s)
+          end
+        end
+      end
+
+      module Iso8601Formatter
+        def self.format(datetime)
+          datetime.iso8601
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# Copyright 2016 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
+  module Record
+    module Marshalers
+
+      class FloatMarshaler
+        def initialize(opts = {})
+        end
+
+        def type_cast(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ''
+            nil
+          when Float
+            raw_value
+          else
+            raw_value.respond_to?(:to_f) ?
+              raw_value.to_f :
+              raw_value.to_s.to_f
+          end
+        end
+
+        def serialize(raw_value)
+          float = type_cast(raw_value)
+          if float.nil?
+            nil
+          elsif float.is_a?(Float)
+            float
+          else
+            msg = "expected a Float value or nil, got #{float.class}"
+            raise ArgumentError, msg
+          end
+        end
+      end
+
+    end
+  end
+end