aws-record 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1183f72d5c4a9eb76cce79e3dc780651d33840a8
-  data.tar.gz: 9b003057c87a84aca97b35e1bbeb2c92f873cb53
+  metadata.gz: 3d5eae4de88bc967f473b49bf9294047a6ee6821
+  data.tar.gz: 5c2e4404ad3b47f909d572b546f3cd70a8e0e93d
 SHA512:
-  metadata.gz: 641f8d63bd27d4c77725cf09c67260e7ea46d11b1502778c180fdb356fd987ae4ded2267428f4466bcf8412aefcf57135a3ea56383fe017af076e67573af6daa
-  data.tar.gz: 6cd6d4756195610a012767c3f7a9b5a7818ab931a5c0b78ab47b8a895963a7378d90e38ee829f45399826e1648a7b78391b61d9be0fe70155933635625c3f0e6
+  metadata.gz: c261673f84aa256222fdd9c17f715ab9161c1a1a1fd23978b494c62627312d12dd314d824321ef43296f87fe92be35ab135de104b6094bb753b746fe3e7235f6
+  data.tar.gz: 7742ea625d83be44c72602f0d55b05f7614f87971cd69bcb402f02de0e7c55057b9870a77b43b0d2adfe02f428565b7be7e770317ba9220bc8b2386528306750

data/lib/aws-record.rb

@@ -34,6 +34,7 @@ require_relative 'aws-record/record/marshalers/float_marshaler'
 require_relative 'aws-record/record/marshalers/date_marshaler'
 require_relative 'aws-record/record/marshalers/date_time_marshaler'
 require_relative 'aws-record/record/marshalers/time_marshaler'
+require_relative 'aws-record/record/marshalers/epoch_time_marshaler'
 require_relative 'aws-record/record/marshalers/list_marshaler'
 require_relative 'aws-record/record/marshalers/map_marshaler'
 require_relative 'aws-record/record/marshalers/string_set_marshaler'

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

@@ -240,6 +240,28 @@ module Aws
           attr(name, Marshalers::TimeMarshaler.new(opts), opts)
         end
 
+        # Define a time-type attribute for your model which persists as
+        #   epoch-seconds.
+        #
+        # @param [Symbol] name Name of this attribute.  It should be a name
+        #   that is safe to use as a method.
+        # @param [Hash] opts
+        # @option opts [Boolean] :hash_key Set to true if this attribute is
+        #   the hash key for the table.
+        # @option opts [Boolean] :range_key Set to true if this attribute is
+        #   the range key for the table.
+        # @option opts [Boolean] :persist_nil Optional attribute used to
+        #   indicate whether nil values should be persisted. If true, explicitly
+        #   set nil values will be saved to DynamoDB as a "null" type. If false,
+        #   nil values will be ignored and not persisted. By default, is false.
+        # @option opts [Object] :default_value Optional attribute used to
+        #   define a "default value" to be used if the attribute's value on an
+        #   item is nil or not set at persistence time.
+        def epoch_time_attr(name, opts = {})
+          opts[:dynamodb_type] = "N"
+          attr(name, Marshalers::EpochTimeMarshaler.new(opts), opts)
+        end
+
         # Define a list-type attribute for your model.
         #
         # Lists do not have to be homogeneous, but they do have to be types that

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

@@ -0,0 +1,66 @@
+# Copyright 2018 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 'time'
+
+module Aws
+  module Record
+    module Marshalers
+
+      class EpochTimeMarshaler
+        def initialize(opts = {})
+          @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?(::Time)
+            value.utc
+          else
+            value
+          end
+        end
+
+        def serialize(raw_value)
+          time = type_cast(raw_value)
+          if time.nil?
+            nil
+          elsif time.is_a?(::Time)
+            time.to_i
+          else
+            msg = "expected a Time value or nil, got #{time.class}"
+            raise ArgumentError, msg
+          end
+        end
+
+        private
+
+        def _format(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ''
+            nil
+          when ::Time
+            raw_value
+          when Integer # timestamp
+            ::Time.at(raw_value)
+          else # Date, DateTime, or String
+            ::Time.parse(raw_value.to_s)
+          end
+        end
+      end
+
+    end
+  end
+end

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

@@ -74,6 +74,19 @@ module Aws
     #     end
     #   end
     #
+    #  @example A model with a Time to Live attribute
+    #    class ExpiringTokens
+    #      string_attr :token_uuid, hash_key: true
+    #      epoch_time_attr :ttl
+    #    end
+    #
+    #    table_config = Aws::Record::TableConfig.define do |t|
+    #      t.model_class ExpiringTokens
+    #      t.read_capacity_units 10
+    #      t.write_capacity_units 1
+    #      t.ttl_attribute :ttl
+    #    end
+    #
     class TableConfig
 
       attr_accessor :client
@@ -92,6 +105,8 @@ module Aws
         #     index.
         #   * +#write_capacity_units+ Sets the write capacity units for the
         #     index.
+        # * +#ttl_attribute+ Sets the attribute ID to be used as the TTL
+        #     attribute, and if present, TTL will be enabled for the table.
         #
         # @example Defining a migration with a GSI.
         #   class Forum
@@ -170,6 +185,16 @@ module Aws
         @client = Aws::DynamoDB::Client.new(@client_options)
       end
 
+      # @api private
+      def ttl_attribute(attribute_symbol)
+        attribute = @model_class.attributes.attribute_for(attribute_symbol)
+        if attribute
+          @ttl_attribute = attribute.database_name
+        else
+          raise ArgumentError, "Invalid attribute #{attribute_symbol} for #{@model_class}"
+        end
+      end
+
       # Performs a migration, if needed, against the remote table. If
       # +#compatible?+ would return true, the remote table already has the same
       # throughput, key schema, attribute definitions, and global secondary
@@ -210,6 +235,22 @@ module Aws
           @client.create_table(_create_table_opts)
           @client.wait_until(:table_exists, table_name: @model_class.table_name)
         end
+        # At this stage, we have a table and need to check for after-effects to
+        # apply.
+        # First up is TTL attribute. Since this migration is not exact match,
+        # we will only alter TTL status if we have a TTL attribute defined. We
+        # may someday support explicit TTL deletion, but we do not yet do this.
+        if @ttl_attribute
+          if !_ttl_compatibility_check
+            client.update_time_to_live(
+              table_name: @model_class.table_name,
+              time_to_live_specification: {
+                enabled: true,
+                attribute_name: @ttl_attribute
+              }
+            )
+          end # Else TTL is compatible and we are done.
+        end # Else our work is done.
       end
 
       # Checks the remote table for compatibility. Similar to +#exact_match?+,
@@ -224,7 +265,7 @@ module Aws
       def compatible?
         begin
           resp = @client.describe_table(table_name: @model_class.table_name)
-          _compatible_check(resp)
+          _compatible_check(resp) && _ttl_compatibility_check
         rescue DynamoDB::Errors::ResourceNotFoundException
           false
         end
@@ -242,13 +283,41 @@ module Aws
           _throughput_equal(resp) &&
             _keys_equal(resp) &&
             _ad_equal(resp) &&
-            _gsi_equal(resp)
+            _gsi_equal(resp) &&
+            _ttl_match_check
         rescue DynamoDB::Errors::ResourceNotFoundException
           false
         end
       end
 
       private
+      def _ttl_compatibility_check
+        if @ttl_attribute
+          ttl_status = @client.describe_time_to_live(
+            table_name: @model_class.table_name
+          )
+          desc = ttl_status.time_to_live_description
+          ["ENABLED", "ENABLING"].include?(desc.time_to_live_status) &&
+            desc.attribute_name == @ttl_attribute
+        else
+          true
+        end
+      end
+
+      def _ttl_match_check
+        ttl_status = @client.describe_time_to_live(
+          table_name: @model_class.table_name
+        )
+        desc = ttl_status.time_to_live_description
+        if @ttl_attribute
+          ["ENABLED", "ENABLING"].include?(desc.time_to_live_status) &&
+            desc.attribute_name == @ttl_attribute
+        else
+          !["ENABLED", "ENABLING"].include?(desc.time_to_live_status) ||
+            desc.attribute_name == nil
+        end
+      end
+
       def _compatible_check(resp)
         _throughput_equal(resp) &&
           _keys_equal(resp) &&

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

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = '2.1.0'
+    VERSION = '2.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -44,6 +44,7 @@ files:
 - lib/aws-record/record/marshalers/boolean_marshaler.rb
 - lib/aws-record/record/marshalers/date_marshaler.rb
 - lib/aws-record/record/marshalers/date_time_marshaler.rb
+- lib/aws-record/record/marshalers/epoch_time_marshaler.rb
 - lib/aws-record/record/marshalers/float_marshaler.rb
 - lib/aws-record/record/marshalers/integer_marshaler.rb
 - lib/aws-record/record/marshalers/list_marshaler.rb