aws-record 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6c46aec6c7a749fe6428fd36e7fa5bc8e205988
-  data.tar.gz: 91de72e195aa41c91e5804c6a48e6ba04e4f035b
+  metadata.gz: 1ad49e4e5f6ac03a577a97f00f2312c37dfbe3ed
+  data.tar.gz: f5bf877eb339d5206f24f3c26e78adefdd08ff30
 SHA512:
-  metadata.gz: 62a8c0327dde967851fc04bf89e42621fe05f59138aab1cdd084b230beb756d7178b18d107145737bbb1984ac08afdbbd87446fca6101a74f17895316e1d68ab
-  data.tar.gz: 2c74f91a4fa0f0e233ecc3c8dad80843faada5222bceff1f898c6acd1032131726abf7c3a1fe0c28a17f213e1ccde034df4d33b6461c01a3bc40b188f1d7cf97
+  metadata.gz: e816d83098562cf009da4c44520605260f22440d6f384fd55c94e30e47b789fa1106cda1b50c4a47fc314ee9b83c254e6e781edb464f46035fb63e42ab347c28
+  data.tar.gz: 6c501354f1de3358c4ee475ad8c8dd017d5e6a9b748af57b570114781d1b614a3f4ba27b9ea3944b2a0c36559ee76586ad2cfb92ae91feb46a9f1a46674aec04

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

@@ -237,21 +237,52 @@ module Aws
         # @raise [Aws::Record::Errors::KeyMissing] if your option parameters do
         #  not include all table keys.
         def find(opts)
-          key = {}
+          find_with_opts(key: opts)
+        end
+
+        # @example Usage Example
+        #   class MyModel
+        #     include Aws::Record
+        #     integer_attr :id,   hash_key: true
+        #     string_attr  :name, range_key: true
+        #   end
+        #
+        #   MyModel.find_with_opts(
+        #     key: { id: 1, name: "First" },
+        #     consistent_read: true
+        #   )
+        #
+        # Note that +#find_with_opts+ will pass through all options other than
+        # +:key+ unaltered to the underlying +Aws::DynamoDB::Client#get_item+
+        # request. You should ensure that you have an aws-sdk gem version which
+        # 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.
+        # @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 opts[attr_sym]
+            unless key[attr_sym]
               raise Errors::KeyMissing.new(
-                "Missing required key #{attr_sym} in #{opts}"
+                "Missing required key #{attr_sym} in #{key}"
               )
             end
             attr_name = attributes.storage_name_for(attr_sym)
-            key[attr_name] = attributes.attribute_for(attr_sym).
-              serialize(opts[attr_sym])
+            request_key[attr_name] = attributes.attribute_for(attr_sym).
+              serialize(key[attr_sym])
           end
           request_opts = {
             table_name: table_name,
-            key: key
-          }
+            key: request_key
+          }.merge(opts)
           resp = dynamodb_client.get_item(request_opts)
           if resp.item.nil?
             nil

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

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources