aws-record 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7800be1064f00422e1512670962d2af0b0579aa
-  data.tar.gz: 3ca62f412897b8e315affc5b50244be4e770a64b
+  metadata.gz: 7d74cea18f658e37fa6d0859826cbf76cb013a17
+  data.tar.gz: 8c624c68f54659a10c48231a70be86608254fe49
 SHA512:
-  metadata.gz: 4d4889d7a3a5d7903eaf4c1d90b704e366f8768246641e264fbe8d7491bec45ebba2c0eccfdf1c3d6c1da5d320773f00ce2ef6ec9a9b8d89c56796ffa41c1d87
-  data.tar.gz: e1838d4e4dfda379da766e68de68618f9832520b05e62aa8dfb55eb3916d3861b35a1b2ae2f456d8e0f670ee9f5a109336a5e48ba1d488cbc1d79d11581c9c63
+  metadata.gz: b420c83918fc9306243df3e2b2f3cbb2226893763317bd84f97851c1cd9f7e34d1136929546417f627328ad275f4eb50e8621aa428ca49aa760e2d5e9a005b84
+  data.tar.gz: 1139b5b759c65e1b6387046ba0ad139cb695e438f1e8dc5cab7d343a74a0473f3e24da5b173cb9e5bfa227f3648401e276462a616a70a30bb4ff7830c91f572a

data/lib/aws-record.rb

@@ -33,6 +33,7 @@ require_relative 'aws-record/record/marshalers/integer_marshaler'
 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/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

@@ -219,6 +219,27 @@ module Aws
           attr(name, Marshalers::DateTimeMarshaler.new(opts), opts)
         end
 
+        # Define a time-type attribute for your model.
+        #
+        # @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 time_attr(name, opts = {})
+          opts[:dynamodb_type] = "S"
+          attr(name, Marshalers::TimeMarshaler.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
@@ -339,12 +360,12 @@ module Aws
           attr(name, Marshalers::NumericSetMarshaler.new(opts), opts)
         end
 
-        # @return [Symbol,nil]
+        # @return [Symbol,nil] The symbolic name of the table's hash key.
         def hash_key
           @keys.hash_key
         end
 
-        # @return [Symbol,nil]
+        # @return [Symbol,nil] The symbloc name of the table's range key, or nil if there is no range key.
         def range_key
           @keys.range_key
         end

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

@@ -0,0 +1,73 @@
+# 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 'time'
+
+module Aws
+  module Record
+    module Marshalers
+
+      class TimeMarshaler
+        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?(::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)
+            @formatter.format(time)
+          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
+
+      module Iso8601Formatter
+        def self.format(time)
+          time.iso8601
+        end
+      end
+
+    end
+  end
+end

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

@@ -31,7 +31,7 @@ module Aws
       def initialize(model, opts = {})
         _assert_model_valid(model)
         @model = model
-        @client = opts[:client] || Aws::DynamoDB::Client.new
+        @client = opts[:client] || model.dynamodb_client || Aws::DynamoDB::Client.new
       end
 
       # This method calls

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

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = '2.0.1'
+    VERSION = '2.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -51,6 +51,7 @@ files:
 - lib/aws-record/record/marshalers/numeric_set_marshaler.rb
 - lib/aws-record/record/marshalers/string_marshaler.rb
 - lib/aws-record/record/marshalers/string_set_marshaler.rb
+- lib/aws-record/record/marshalers/time_marshaler.rb
 - lib/aws-record/record/model_attributes.rb
 - lib/aws-record/record/query.rb
 - lib/aws-record/record/secondary_indexes.rb