dynamoid 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a156ccd69a903440d15d65b4eeb89f5f875d9e
-  data.tar.gz: f4cfabc262d301f92bed990a217f188ac7956c8c
+  metadata.gz: 0a6f0df676274e985818f75e1800d007f4f8e296
+  data.tar.gz: 613a8af57da76c4cb7b896e5fa4db86607eb9d26
 SHA512:
-  metadata.gz: 1f3d1a4e7fad25f44a098c1cbcfbe5807ddc49f6558835b1411c4abe1171f51980b653b3391eab0d761d37650d38e0cca428dfa5e078d5f58688e95e1f023961
-  data.tar.gz: fae777d74e2b1477ae8c688491ad48b2a6f8f0fd4c2dc2b229a40970ceae1aeaa54fd9fc8a490534fc1013db877eb3a4abe23ffbadd8fbe674d7c3f9a1af9984
+  metadata.gz: 37716f3cb495c6de57ddc51ef1cbf4933319ba78f003e77a53f69c232268f49709c3a8e420abc9ec7093643328925811e82f68380a821f774e4071b317d37d48
+  data.tar.gz: 2e192af7a28032a4458eaaf293d0bd03704d31094b861859a931e4c81e46ba1ba09e3a3e5b75a6a8befa34f55037d4a90f2f8da389402643e561a18ff79c8a5d

data/.gitignore

@@ -60,7 +60,7 @@ rdoc
 .tags
 .tags_sorted_by_file
 
-/Gemfile.lock
+Gemfile.lock
 /doc/
 /spec/reports/
 /tmp/

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.2.1
+
+* Remove accidental Gemfile.lock; fix .gitignore (#95, @pboling)
+* Allow options to put_items (#95, @alexperto)
+* Support range key in secondary index queries (#95, @pboling)
+* Better handling of options generally (#95, @pboling)
+* Support for batch_delete_item API (#95, @pboling)
+* Support for batch_write_item API (#95, @alexperto)
+
 # 1.2.0
 
 * Add create_table_syncronously, and sync: option to regular create_table (@pboling)

data/README.md

@@ -178,7 +178,7 @@ This is especially important if you want to use your custom field as a numeric r
 number-oriented queries.  By default custom fields are persisted as a string attribute, but
 your custom class can override this with a `.dynamoid_field_type` class method, which would
 return either `:string` or `:number`.
-(DynamoDB supports some other attribute types, but Dynamoid yet does not.)
+(DynamoDB supports some other attribute types, but Dynamoid does not yet.)
 
 
 ### Associations

data/lib/dynamoid/adapter.rb

@@ -132,15 +132,15 @@ module Dynamoid
     end
 
     # @since 0.2.0
-    def delete_table(table_name, *args)
+    def delete_table(table_name, options = {})
       if tables.include?(table_name)
-        benchmark('Delete Table') { adapter.delete_table(table_name, *args) }
+        benchmark('Delete Table') { adapter.delete_table(table_name, options) }
         idx = tables.index(table_name)
         tables.delete_at(idx)
       end
     end
 
-    [:batch_get_item, :delete_item, :get_item, :list_tables, :put_item, :truncate].each do |m|
+    [:batch_get_item, :delete_item, :get_item, :list_tables, :put_item, :truncate, :batch_write_item, :batch_delete_item].each do |m|
       # Method delegation with benchmark to the underlying adapter. Faster than relying on method_missing.
       #
       # @since 0.2.0

data/lib/dynamoid/adapter_plugin/aws_sdk_v2.rb

@@ -51,10 +51,39 @@ module Dynamoid
         @client
       end
 
+      # Puts or deletes multiple items in one or more tables
+      #
+      # @param [String] table_name the name of the table
+      # @param [Array]  items to be processed
+      # @param [Hash]   additional options
+      #
+      #See: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method
+      def batch_write_item table_name, objects, options = {}
+        request_items = []
+        options ||= {}
+        objects.each do |o|
+          request_items << { "put_request" => { item: o } }
+        end
+
+        begin
+          client.batch_write_item(
+            {
+              request_items: {
+                table_name => request_items,
+              },
+              return_consumed_capacity: "TOTAL",
+              return_item_collection_metrics: "SIZE"
+            }.merge!(options)
+          )
+        rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+          raise Dynamoid::Errors::ConditionalCheckFailedException, e
+        end
+      end
+
       # Get many items at once from DynamoDB. More efficient than getting each item individually.
       #
       # @example Retrieve IDs 1 and 2 from the table testtable
-      #   Dynamoid::Adapter::AwsSdkV2.batch_get_item({'table1' => ['1', '2']})
+      #   Dynamoid::AdapterPlugin::AwsSdkV2.batch_get_item({'table1' => ['1', '2']})
       #
       # @param [Hash] table_ids the hash of tables and IDs to retrieve
       # @param [Hash] options to be passed to underlying BatchGet call
@@ -103,9 +132,9 @@ module Dynamoid
       # Delete many items at once from DynamoDB. More efficient than delete each item individually.
       #
       # @example Delete IDs 1 and 2 from the table testtable
-      #   Dynamoid::Adapter::AwsSdk.batch_delete_item('table1' => ['1', '2'])
+      #   Dynamoid::AdapterPlugin::AwsSdk.batch_delete_item('table1' => ['1', '2'])
       #or
-      #   Dynamoid::Adapter::AwsSdkV2.batch_delete_item('table1' => [['hk1', 'rk2'], ['hk1', 'rk2']]]))
+      #   Dynamoid::AdapterPlugin::AwsSdkV2.batch_delete_item('table1' => [['hk1', 'rk2'], ['hk1', 'rk2']]]))
       #
       # @param [Hash] options the hash of tables and IDs to delete
       #
@@ -222,6 +251,7 @@ module Dynamoid
       #
       # @todo: Provide support for various options http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method
       def delete_item(table_name, key, options = {})
+        options ||= {}
         range_key = options[:range_key]
         conditions = options[:conditions]
         table = describe_table(table_name)
@@ -269,6 +299,7 @@ module Dynamoid
       #
       # @todo Provide support for various options http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#get_item-instance_method
       def get_item(table_name, key, options = {})
+        options ||= {}
         table    = describe_table(table_name)
         range_key = options.delete(:range_key)
 
@@ -324,9 +355,10 @@ module Dynamoid
       #
       # @since 1.0.0
       #
-      # @todo: Provide support for various options http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method
-      def put_item(table_name, object, options = nil)
+      # See: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#put_item-instance_method
+      def put_item(table_name, object, options = {})
         item = {}
+        options ||= {}
 
         object.each do |k, v|
           next if v.nil? || (v.respond_to?(:empty?) && v.empty?)
@@ -334,9 +366,12 @@ module Dynamoid
         end
 
         begin
-          client.put_item(table_name: table_name,
-            item: item,
-            expected: expected_stanza(options)
+          client.put_item(
+            {
+              table_name: table_name,
+              item: item,
+              expected: expected_stanza(options)
+            }.merge!(options)
           )
         rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
           raise Dynamoid::Errors::ConditionalCheckFailedException, e
@@ -556,10 +591,10 @@ module Dynamoid
         expected = Hash.new { |h,k| h[k] = {} }
         return expected unless conditions
 
-        conditions[:unless_exists].try(:each) do |col|
+        conditions.delete(:unless_exists).try(:each) do |col|
           expected[col.to_s][:exists] = false
         end
-        conditions[:if].try(:each) do |col,val|
+        conditions.delete(:if).try(:each) do |col,val|
           expected[col.to_s][:value] = val
         end
 

data/lib/dynamoid/finders.rb

@@ -128,8 +128,7 @@ module Dynamoid
       #
       # @param [Hash] eg: {:age => 5}
       # @param [Hash] eg: {"rank.lte" => 10}
-      # @param [Hash] options - @TODO support more options in future such as
-      #               query filter, projected keys etc
+      # @param [Hash] options - query filter, projected keys, scan_index_forward etc
       # @return [Array] an array of all matching items
       def find_all_by_secondary_index(hash, options = {})
         range = options[:range] || {}
@@ -148,7 +147,7 @@ module Dynamoid
 
         # Find the index
         index = self.find_index(hash_key_field, range_key_field)
-        raise Dynamoid::Errors::MissingIndex if index.nil?
+        raise Dynamoid::Errors::MissingIndex.new("attempted to find #{[hash_key_field, range_key_field]}") if index.nil?
 
         # query
         opts = {
@@ -160,7 +159,8 @@ module Dynamoid
           opts[:range_key] = range_key_field
           opts[range_op_mapped] = range_key_value
         end
-        Dynamoid.adapter.query(self.table_name, opts).map do |item|
+        dynamo_options = opts.merge(options.reject {|key, _| key == :range })
+        Dynamoid.adapter.query(self.table_name, dynamo_options).map do |item|
           from_database(item)
         end
       end

data/lib/dynamoid/version.rb

@@ -1,3 +1,3 @@
 module Dynamoid
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamoid
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Josh Symonds