dynamoid 3.3.0 → 3.7.0

data/lib/dynamoid.rb

@@ -57,6 +57,7 @@ module Dynamoid
     @included_models ||= []
   end
 
+  # @private
   def adapter
     @adapter ||= Adapter.new
   end

data/lib/dynamoid/adapter.rb

@@ -3,7 +3,7 @@
 # require only 'concurrent/atom' once this issue is resolved:
 #   https://github.com/ruby-concurrency/concurrent-ruby/pull/377
 require 'concurrent'
-require "dynamoid/adapter_plugin/aws_sdk_v3"
+require 'dynamoid/adapter_plugin/aws_sdk_v3'
 
 # encoding: utf-8
 module Dynamoid
@@ -11,6 +11,7 @@ module Dynamoid
   # 1) For the rest of Dynamoid, the gateway to DynamoDB.
   # 2) Allows switching `config.adapter` to ease development of a new adapter.
   # 3) Caches the list of tables Dynamoid knows about.
+  # @private
   class Adapter
     def initialize
       @adapter_ = Concurrent::Atom.new(nil)
@@ -78,8 +79,8 @@ module Dynamoid
     #
     # @param [String] table the name of the table to write the object to
     # @param [Array] ids to fetch, can also be a string of just one id
-    # @param [Hash] options: Passed to the underlying query. The :range_key option is required whenever the table has a range key,
-    #                        unless multiple ids are passed in.
+    # @param [Hash] options Passed to the underlying query. The :range_key option is required whenever the table has a range key,
+    #                       unless multiple ids are passed in.
     #
     # @since 0.2.0
     def read(table, ids, options = {}, &blk)
@@ -94,7 +95,9 @@ module Dynamoid
     #
     # @param [String] table the name of the table to write the object to
     # @param [Array] ids to delete, can also be a string of just one id
-    # @param [Array] range_key of the record to delete, can also be a string of just one range_key
+    # @param [Hash] options allowed only +range_key+ - range key or array of
+    #                       range keys of the record to delete, can also be
+    #                       a string of just one range_key, and +conditions+
     #
     def delete(table, ids, options = {})
       range_key = options[:range_key] # array of range keys that matches the ids passed in
@@ -115,7 +118,7 @@ module Dynamoid
     # Scans a table. Generally quite slow; try to avoid using scan if at all possible.
     #
     # @param [String] table the name of the table to write the object to
-    # @param [Hash] scan_hash a hash of attributes: matching records will be returned by the scan
+    # @param [Hash] query a hash of attributes: matching records will be returned by the scan
     #
     # @since 0.2.0
     def scan(table, query = {}, opts = {})
@@ -124,8 +127,12 @@ module Dynamoid
 
     def create_table(table_name, key, options = {})
       unless tables.include?(table_name)
-        benchmark('Create Table') { adapter.create_table(table_name, key, options) }
+        result = nil
+        benchmark('Create Table') { result = adapter.create_table(table_name, key, options) }
         tables << table_name
+        result
+      else
+        false
       end
     end
 
@@ -151,8 +158,14 @@ module Dynamoid
     #
     # @since 0.2.0
     def method_missing(method, *args, &block)
-      return benchmark(method, *args) { adapter.send(method, *args, &block) } if adapter.respond_to?(method)
+      # Don't use keywork arguments delegating (with **kw). It works in
+      # different way in different Ruby versions: <= 2.6, 2.7, 3.0 and in some
+      # future 3.x versions. Providing that there are no downstream methods
+      # with keyword arguments in adapter.
+      #
+      # https://eregon.me/blog/2019/11/10/the-delegation-challenge-of-ruby27.html
 
+      return benchmark(method, *args) { adapter.send(method, *args, &block) } if adapter.respond_to?(method)
       super
     end
 

data/lib/dynamoid/adapter_plugin/aws_sdk_v3.rb

@@ -9,8 +9,18 @@ require_relative 'aws_sdk_v3/table'
 require_relative 'aws_sdk_v3/until_past_table_status'
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     # The AwsSdkV3 adapter provides support for the aws-sdk version 2 for ruby.
+
+    # Note: Don't use keyword arguments in public methods as far as method
+    # calls on adapter are delegated to the plugin.
+    #
+    # There are breaking changes in Ruby related to delegating keyword
+    # arguments so we have decided just to avoid them when use delegation.
+    #
+    # https://eregon.me/blog/2019/11/10/the-delegation-challenge-of-ruby27.html
+
     class AwsSdkV3
       EQ = 'EQ'
       RANGE_MAP = {
@@ -61,6 +71,25 @@ module Dynamoid
 
       attr_reader :table_cache
 
+      # Build an array of values for Condition
+      # Is used in ScanFilter and QueryFilter
+      # https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html
+      # @param [String] operator value of RANGE_MAP or FIELD_MAP hash, e.g. "EQ", "LT" etc
+      # @param [Object] value scalar value or array/set
+      def self.attribute_value_list(operator, value)
+        # For BETWEEN and IN operators we should keep value as is (it should be already an array)
+        # NULL and NOT_NULL require absence of attribute list
+        # For all the other operators we wrap the value with array
+        # https://docs.aws.amazon.com/en_us/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Conditions.html
+        if %w[BETWEEN IN].include?(operator)
+          [value].flatten
+        elsif %w[NULL NOT_NULL].include?(operator)
+          nil
+        else
+          [value]
+        end
+      end
+
       # Establish the connection to DynamoDB.
       #
       # @return [Aws::DynamoDB::Client] the DynamoDB connection
@@ -75,19 +104,28 @@ module Dynamoid
         (Dynamoid::Config.settings.compact.keys & CONNECTION_CONFIG_OPTIONS).each do |option|
           @connection_hash[option] = Dynamoid::Config.send(option)
         end
-        if Dynamoid::Config.access_key?
-          @connection_hash[:access_key_id] = Dynamoid::Config.access_key
-        end
-        if Dynamoid::Config.secret_key?
-          @connection_hash[:secret_access_key] = Dynamoid::Config.secret_key
+
+        # if credentials are passed, they already contain access key & secret key
+        if Dynamoid::Config.credentials?
+          @connection_hash[:credentials] = Dynamoid::Config.credentials
+        else
+          # otherwise, pass access key & secret key for credentials creation
+          if Dynamoid::Config.access_key?
+            @connection_hash[:access_key_id] = Dynamoid::Config.access_key
+          end
+          if Dynamoid::Config.secret_key?
+            @connection_hash[:secret_access_key] = Dynamoid::Config.secret_key
+          end
         end
 
-        # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/plugins/logging.rb
-        # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/log/formatter.rb
-        formatter = Aws::Log::Formatter.new(':operation | Request :http_request_body | Response :http_response_body')
         @connection_hash[:logger] = Dynamoid::Config.logger
         @connection_hash[:log_level] = :debug
-        @connection_hash[:log_formatter] = formatter
+
+        # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/plugins/logging.rb
+        # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/log/formatter.rb
+        if Dynamoid::Config.log_formatter
+          @connection_hash[:log_formatter] = Dynamoid::Config.log_formatter
+        end
 
         @connection_hash
       end
@@ -115,9 +153,9 @@ module Dynamoid
       #   end
       #
       # @param [String] table_name the name of the table
-      # @param [Array]  items to be processed
-      # @param [Hash]   additional options
-      # @param [Proc]   optional block
+      # @param [Array]  objects to be processed
+      # @param [Hash]   options additional options
+      # @yield [true|false] invokes an optional block with argument - whether there are unprocessed items
       #
       # See:
       # * http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html
@@ -172,9 +210,9 @@ module Dynamoid
       #     end
       #   end
       #
-      # @param [Hash] table_ids the hash of tables and IDs to retrieve
+      # @param [Hash] table_names_with_ids the hash of tables and IDs to retrieve
       # @param [Hash] options to be passed to underlying BatchGet call
-      # @param [Proc] optional block can be passed to handle each batch of items
+      # @param [Proc] block optional block can be passed to handle each batch of items
       #
       # @return [Hash] a hash where keys are the table names and the values are the retrieved items
       #
@@ -246,8 +284,22 @@ module Dynamoid
       def create_table(table_name, key = :id, options = {})
         Dynamoid.logger.info "Creating #{table_name} table. This could take a while."
         CreateTable.new(client, table_name, key, options).call
+        true
       rescue Aws::DynamoDB::Errors::ResourceInUseException => e
         Dynamoid.logger.error "Table #{table_name} cannot be created as it already exists"
+        false
+      end
+
+      def update_time_to_live(table_name, attribute)
+        request = {
+          table_name: table_name,
+          time_to_live_specification: {
+            attribute_name: attribute,
+            enabled: true,
+          }
+        }
+
+        client.update_time_to_live(request)
       end
 
       # Create a table on DynamoDB *synchronously*.
@@ -504,11 +556,11 @@ module Dynamoid
         hk    = table.hash_key
         rk    = table.range_key
 
-        scan(table_name, {}, {}).flat_map{ |i| i }.each do |attributes|
-          opts = {}
-          opts[:range_key] = attributes[rk.to_sym] if rk
-          delete_item(table_name, attributes[hk], opts)
+        ids = scan(table_name, {}, {}).flat_map { |i| i }.map do |attributes|
+          rk ? [attributes[hk], attributes[rk.to_sym]] : attributes[hk]
         end
+
+        batch_delete_item(table_name => ids)
       end
 
       def count(table_name)
@@ -566,25 +618,6 @@ module Dynamoid
         end
       end
 
-      # Build an array of values for Condition
-      # Is used in ScanFilter and QueryFilter
-      # https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html
-      # @params [String] operator: value of RANGE_MAP or FIELD_MAP hash, e.g. "EQ", "LT" etc
-      # @params [Object] value: scalar value or array/set
-      def self.attribute_value_list(operator, value)
-        # For BETWEEN and IN operators we should keep value as is (it should be already an array)
-        # NULL and NOT_NULL require absence of attribute list
-        # For all the other operators we wrap the value with array
-        # https://docs.aws.amazon.com/en_us/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Conditions.html
-        if %w[BETWEEN IN].include?(operator)
-          [value].flatten
-        elsif %w[NULL NOT_NULL].include?(operator)
-          nil
-        else
-          [value]
-        end
-      end
-
       def sanitize_item(attributes)
         config_value = Dynamoid.config.store_attribute_with_nil_value
         store_attribute_with_nil_value = config_value.nil? ? false : !!config_value

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/batch_get_item.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       # Documentation

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/create_table.rb

@@ -3,6 +3,7 @@
 require_relative 'until_past_table_status'
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       class CreateTable
@@ -16,6 +17,7 @@ module Dynamoid
         end
 
         def call
+          billing_mode = options[:billing_mode]
           read_capacity = options[:read_capacity] || Dynamoid::Config.read_capacity
           write_capacity = options[:write_capacity] || Dynamoid::Config.write_capacity
 
@@ -41,14 +43,20 @@ module Dynamoid
 
           client_opts = {
             table_name: table_name,
-            provisioned_throughput: {
-              read_capacity_units: read_capacity,
-              write_capacity_units: write_capacity
-            },
             key_schema: key_schema,
             attribute_definitions: attribute_definitions
           }
 
+          if billing_mode == :on_demand
+            client_opts[:billing_mode] = 'PAY_PER_REQUEST'
+          else
+            client_opts[:billing_mode] = 'PROVISIONED'
+            client_opts[:provisioned_throughput] = {
+              read_capacity_units: read_capacity,
+              write_capacity_units: write_capacity
+            }
+          end
+
           if ls_indexes.present?
             client_opts[:local_secondary_indexes] = ls_indexes.map do |index|
               index_to_aws_hash(index)
@@ -80,9 +88,9 @@ module Dynamoid
         # Builds aws attributes definitions based off of primary hash/range and
         # secondary indexes
         #
-        # @param key_data
-        # @option key_data [Hash] hash_key_schema - eg: {:id => :string}
-        # @option key_data [Hash] range_key_schema - eg: {:created_at => :number}
+        # @param key_schema
+        # @option key_schema [Hash] hash_key_schema - eg: {:id => :string}
+        # @option key_schema [Hash] range_key_schema - eg: {:created_at => :number}
         # @param [Hash] secondary_indexes
         # @option secondary_indexes [Array<Dynamoid::Indexes::Index>] :local_secondary_indexes
         # @option secondary_indexes [Array<Dynamoid::Indexes::Index>] :global_secondary_indexes
@@ -123,8 +131,8 @@ module Dynamoid
         end
 
         # Builds an attribute definitions based on hash key and range key
-        # @params [Hash] hash_key_schema - eg: {:id => :string}
-        # @params [Hash] range_key_schema - eg: {:created_at => :datetime}
+        # @param [Hash] hash_key_schema - eg: {:id => :string}
+        # @param [Hash] range_key_schema - eg: {:created_at => :datetime}
         # @return [Array]
         def build_attribute_definitions(hash_key_schema, range_key_schema = nil)
           attrs = []
@@ -145,8 +153,8 @@ module Dynamoid
         end
 
         # Builds an aws attribute definition based on name and dynamoid type
-        # @params [Symbol] name - eg: :id
-        # @params [Symbol] dynamoid_type - eg: :string
+        # @param [Symbol] name - eg: :id
+        # @param [Symbol] dynamoid_type - eg: :string
         # @return [Hash]
         def attribute_definition_element(name, dynamoid_type)
           aws_type = api_type(dynamoid_type)
@@ -206,7 +214,7 @@ module Dynamoid
           end
 
           # Only global secondary indexes have a separate throughput.
-          if index.type == :global_secondary
+          if index.type == :global_secondary && options[:billing_mode] != :on_demand
             hash[:provisioned_throughput] = {
               read_capacity_units: index.read_capacity,
               write_capacity_units: index.write_capacity

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/item_updater.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       # Mimics behavior of the yielded object on DynamoDB's update_item API (high level).
@@ -20,8 +21,8 @@ module Dynamoid
         # Adds the given values to the values already stored in the corresponding columns.
         # The column must contain a Set or a number.
         #
-        # @param [Hash] vals keys of the hash are the columns to update, vals are the values to
-        #               add. values must be a Set, Array, or Numeric
+        # @param [Hash] values keys of the hash are the columns to update, values
+        #                      are the values to add. values must be a Set, Array, or Numeric
         #
         def add(values)
           @additions.merge!(sanitize_attributes(values))
@@ -58,9 +59,9 @@ module Dynamoid
           end
           @deletions.each do |k, v|
             ret[k.to_s] = {
-              action: DELETE,
-              value: v
+              action: DELETE
             }
+            ret[k.to_s][:value] = v unless v.nil?
           end
           @updates.each do |k, v|
             ret[k.to_s] = {

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/backoff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       module Middleware
@@ -14,11 +15,10 @@ module Dynamoid
             response = @next_chain.call(request)
             @backoff.call if @backoff
 
-            return response
+            response
           end
         end
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/limit.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       module Middleware
@@ -46,12 +47,10 @@ module Dynamoid
             @scan_count += response.scanned_count
             throw :stop_pagination if @scan_limit && @scan_count >= @scan_limit
 
-            return response
+            response
           end
         end
-
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/middleware/start_key.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       module Middleware
@@ -18,11 +19,10 @@ module Dynamoid
               throw :stop_pagination
             end
 
-            return response
+            response
           end
         end
       end
     end
   end
 end
-

data/lib/dynamoid/adapter_plugin/aws_sdk_v3/query.rb

@@ -5,6 +5,7 @@ require_relative 'middleware/limit'
 require_relative 'middleware/start_key'
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       class Query
@@ -29,8 +30,8 @@ module Dynamoid
           request = build_request
 
           Enumerator.new do |yielder|
-            api_call = -> (request) do
-              client.query(request).tap do |response|
+            api_call = lambda do |req|
+              client.query(req).tap do |response|
                 yielder << response
               end
             end
@@ -122,6 +123,7 @@ module Dynamoid
 
         def attributes_to_get
           return if options[:project].nil?
+
           options[:project].map(&:to_s)
         end
       end