dynamoid 3.2.0 → 3.6.0

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)
@@ -62,11 +70,16 @@ module Dynamoid
           end
           resp = client.create_table(client_opts)
           options[:sync] = true if !options.key?(:sync) && ls_indexes.present? || gs_indexes.present?
-          UntilPastTableStatus.new(table_name, :creating).call if options[:sync] &&
-                                                                  (status = PARSE_TABLE_STATUS.call(resp, :table_description)) &&
-                                                                  status == TABLE_STATUSES[:creating]
+
+          if options[:sync]
+            status = PARSE_TABLE_STATUS.call(resp, :table_description)
+            if status == TABLE_STATUSES[:creating]
+              UntilPastTableStatus.new(client, table_name, :creating).call
+            end
+          end
+
           # Response to original create_table, which, if options[:sync]
-          #   may have an outdated table_description.table_status of "CREATING"
+          # may have an outdated table_description.table_status of "CREATING"
           resp
         end
 
@@ -75,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
@@ -118,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 = []
@@ -140,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)
@@ -201,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))

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,12 +5,14 @@ require_relative 'middleware/limit'
 require_relative 'middleware/start_key'
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       class Query
         OPTIONS_KEYS = %i[
           limit hash_key hash_value range_key consistent_read scan_index_forward
           select index_name batch_size exclusive_start_key record_limit scan_limit
+          project
         ].freeze
 
         attr_reader :client, :table, :options, :conditions
@@ -28,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
@@ -63,10 +65,11 @@ module Dynamoid
           batch_size = options[:batch_size]
           limit = [record_limit, scan_limit, batch_size].compact.min
 
-          request[:limit]          = limit if limit
-          request[:table_name]     = table.name
-          request[:key_conditions] = key_conditions
-          request[:query_filter]   = query_filter
+          request[:limit]             = limit if limit
+          request[:table_name]        = table.name
+          request[:key_conditions]    = key_conditions
+          request[:query_filter]      = query_filter
+          request[:attributes_to_get] = attributes_to_get
 
           request
         end
@@ -117,6 +120,12 @@ module Dynamoid
             result
           end
         end
+
+        def attributes_to_get
+          return if options[:project].nil?
+
+          options[:project].map(&:to_s)
+        end
       end
     end
   end

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

@@ -5,6 +5,7 @@ require_relative 'middleware/limit'
 require_relative 'middleware/start_key'
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       class Scan
@@ -21,8 +22,8 @@ module Dynamoid
           request = build_request
 
           Enumerator.new do |yielder|
-            api_call = -> (request) do
-              client.scan(request).tap do |response|
+            api_call = lambda do |req|
+              client.scan(req).tap do |response|
                 yielder << response
               end
             end
@@ -54,9 +55,10 @@ module Dynamoid
           batch_size = options[:batch_size]
           limit = [record_limit, scan_limit, batch_size].compact.min
 
-          request[:limit]       = limit if limit
-          request[:table_name]  = table.name
-          request[:scan_filter] = scan_filter
+          request[:limit]             = limit if limit
+          request[:table_name]        = table.name
+          request[:scan_filter]       = scan_filter
+          request[:attributes_to_get] = attributes_to_get
 
           request
         end
@@ -75,10 +77,18 @@ module Dynamoid
               comparison_operator: AwsSdkV3::FIELD_MAP[cond.keys[0]],
               attribute_value_list: AwsSdkV3.attribute_value_list(AwsSdkV3::FIELD_MAP[cond.keys[0]], cond.values[0].freeze)
             }
+            # nil means operator doesn't require attribute value list
+            conditions.delete(:attribute_value_list) if conditions[:attribute_value_list].nil?
             result[attr] = condition
             result
           end
         end
+
+        def attributes_to_get
+          return if options[:project].nil?
+
+          options[:project].map(&:to_s)
+        end
       end
     end
   end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       # Represents a table. Exposes data from the "DescribeTable" API call, and also

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

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module AdapterPlugin
     class AwsSdkV3
       class UntilPastTableStatus
-        attr_reader :table_name, :status
+        attr_reader :client, :table_name, :status
 
-        def initialize(table_name, status = :creating)
+        def initialize(client, table_name, status = :creating)
+          @client = client
           @table_name = table_name
           @status = status
         end
@@ -31,7 +33,7 @@ module Dynamoid
           # See: http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#describe_table-instance_method
           rescue Aws::DynamoDB::Errors::ResourceNotFoundException => e
             case status
-            when :creating then
+            when :creating
               if counter >= Dynamoid::Config.sync_retry_max_times
                 Dynamoid.logger.warn "Waiting on table metadata for #{table_name} (check #{counter})"
                 retry # start over at first line of begin, does not reset counter

data/lib/dynamoid/application_time_zone.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dynamoid
+  # @private
   module ApplicationTimeZone
     def self.at(value)
       case Dynamoid::Config.application_timezone

data/lib/dynamoid/associations.rb

@@ -25,12 +25,55 @@ module Dynamoid
     end
 
     module ClassMethods
-      # create a has_many association for this document.
+      # Declare a +has_many+ association for this document.
       #
-      # @param [Symbol] name the name of the association
-      # @param [Hash] options options to pass to the association constructor
+      #   class Category
+      #     include Dynamoid::Document
+      #
+      #     has_many :posts
+      #   end
+      #
+      # Association is an enumerable collection and supports following addition
+      # operations:
+      #
+      # * +create+
+      # * +create!+
+      # * +destroy_all+
+      # * +delete_all+
+      # * +delete+
+      # * +<<+
+      # * +where+
+      # * +all+
+      # * +empty?+
+      # * +size+
+      #
+      # When a name of an associated class doesn't match an association name a
+      # class name should be specified explicitly either with +class+ or
+      # +class_name+ option:
+      #
+      #   has_many :labels, class: Tag
+      #   has_many :labels, class_name: 'Tag'
+      #
+      # When associated class has own +belongs_to+ association to
+      # the current class and the name doesn't match a name of the current
+      # class this name can be specified with +inverse_of+ option:
+      #
+      #   class Post
+      #     include Dynamoid::Document
+      #
+      #     belongs_to :item, class_name: 'Tag'
+      #   end
+      #
+      #   class Tag
+      #     include Dynamoid::Document
+      #
+      #     has_many :posts, inverse_of: :item
+      #   end
+      #
+      # @param name [Symbol] the name of the association
+      # @param options [Hash] options to pass to the association constructor
       # @option options [Class] :class the target class of the has_many association; that is, the belongs_to class
-      # @option options [Symbol] :class_name the name of the target class of the association; that is, the name of the belongs_to class
+      # @option options [String] :class_name the name of the target class of the association; that is, the name of the belongs_to class
       # @option options [Symbol] :inverse_of the name of the association on the target class; that is, if the class has a belongs_to association, the name of that association
       #
       # @since 0.2.0
@@ -38,12 +81,47 @@ module Dynamoid
         association(:has_many, name, options)
       end
 
-      # create a has_one association for this document.
+      # Declare a +has_one+ association for this document.
+      #
+      #   class Image
+      #     include Dynamoid::Document
       #
-      # @param [Symbol] name the name of the association
-      # @param [Hash] options options to pass to the association constructor
+      #     has_one :post
+      #   end
+      #
+      # Association supports following operations:
+      #
+      # * +create+
+      # * +create!+
+      # * +delete+
+      #
+      # When a name of an associated class doesn't match an association name a
+      # class name should be specified explicitly either with +class+ or
+      # +class_name+ option:
+      #
+      #   has_one :item, class: Post
+      #   has_one :item, class_name: 'Post'
+      #
+      # When associated class has own +belong_to+ association to the current
+      # class and the name doesn't match a name of the current class this name
+      # can be specified with +inverse_of+ option:
+      #
+      #   class Post
+      #     include Dynamoid::Document
+      #
+      #     belongs_to :logo, class_name: 'Image'
+      #   end
+      #
+      #   class Image
+      #     include Dynamoid::Document
+      #
+      #     has_one :post, inverse_of: :logo
+      #   end
+      #
+      # @param name [Symbol] the name of the association
+      # @param options [Hash] options to pass to the association constructor
       # @option options [Class] :class the target class of the has_one association; that is, the belongs_to class
-      # @option options [Symbol] :class_name the name of the target class of the association; that is, the name of the belongs_to class
+      # @option options [String] :class_name the name of the target class of the association; that is, the name of the belongs_to class
       # @option options [Symbol] :inverse_of the name of the association on the target class; that is, if the class has a belongs_to association, the name of that association
       #
       # @since 0.2.0
@@ -51,25 +129,110 @@ module Dynamoid
         association(:has_one, name, options)
       end
 
-      # create a belongs_to association for this document.
+      # Declare a +belongs_to+ association for this document.
+      #
+      #   class Post
+      #     include Dynamoid::Document
       #
-      # @param [Symbol] name the name of the association
-      # @param [Hash] options options to pass to the association constructor
+      #     belongs_to :categories
+      #   end
+      #
+      # Association supports following operations:
+      #
+      # * +create+
+      # * +create!+
+      # * +delete+
+      #
+      # When a name of an associated class doesn't match an association name a
+      # class name should be specified explicitly either with +class+ or
+      # +class_name+ option:
+      #
+      #   belongs_to :item, class: Post
+      #   belongs_to :item, class_name: 'Post'
+      #
+      # When associated class has own +has_many+ or +has_one+ association to
+      # the current class and the name doesn't match a name of the current
+      # class this name can be specified with +inverse_of+ option:
+      #
+      #   class Category
+      #     include Dynamoid::Document
+      #
+      #     has_many :items, class_name: 'Post'
+      #   end
+      #
+      #   class Post
+      #     include Dynamoid::Document
+      #
+      #     belongs_to :categories, inverse_of: :items
+      #   end
+      #
+      # By default a hash key attribute name is +id+. If an associated class
+      # uses another name for a hash key attribute it should be specified in
+      # the +belongs_to+ association:
+      #
+      #   belongs_to :categories, foreign_key: :uuid
+      #
+      # @param name [Symbol] the name of the association
+      # @param options [Hash] options to pass to the association constructor
       # @option options [Class] :class the target class of the has_one association; that is, the has_many or has_one class
-      # @option options [Symbol] :class_name the name of the target class of the association; that is, the name of the has_many or has_one class
+      # @option options [String] :class_name the name of the target class of the association; that is, the name of the has_many or has_one class
       # @option options [Symbol] :inverse_of the name of the association on the target class; that is, if the class has a has_many or has_one association, the name of that association
+      # @option options [Symbol] :foreign_key the name of a hash key attribute in the target class
       #
       # @since 0.2.0
       def belongs_to(name, options = {})
         association(:belongs_to, name, options)
       end
 
-      # create a has_and_belongs_to_many association for this document.
+      # Declare a +has_and_belongs_to_many+ association for this document.
+      #
+      #   class Post
+      #     include Dynamoid::Document
+      #
+      #     has_and_belongs_to_many :tags
+      #   end
+      #
+      # Association is an enumerable collection and supports following addition
+      # operations:
+      #
+      # * +create+
+      # * +create!+
+      # * +destroy_all+
+      # * +delete_all+
+      # * +delete+
+      # * +<<+
+      # * +where+
+      # * +all+
+      # * +empty?+
+      # * +size+
+      #
+      # When a name of an associated class doesn't match an association name a
+      # class name should be specified explicitly either with +class+ or
+      # +class_name+ option:
+      #
+      #   has_and_belongs_to_many :labels, class: Tag
+      #   has_and_belongs_to_many :labels, class_name: 'Tag'
+      #
+      # When associated class has own +has_and_belongs_to_many+ association to
+      # the current class and the name doesn't match a name of the current
+      # class this name can be specified with +inverse_of+ option:
+      #
+      #   class Tag
+      #     include Dynamoid::Document
+      #
+      #     has_and_belongs_to_many :items, class_name: 'Post'
+      #   end
+      #
+      #   class Post
+      #     include Dynamoid::Document
+      #
+      #     has_and_belongs_to_many :tags, inverse_of: :items
+      #   end
       #
-      # @param [Symbol] name the name of the association
-      # @param [Hash] options options to pass to the association constructor
+      # @param name [Symbol] the name of the association
+      # @param options [Hash] options to pass to the association constructor
       # @option options [Class] :class the target class of the has_and_belongs_to_many association; that is, the belongs_to class
-      # @option options [Symbol] :class_name the name of the target class of the association; that is, the name of the belongs_to class
+      # @option options [String] :class_name the name of the target class of the association; that is, the name of the belongs_to class
       # @option options [Symbol] :inverse_of the name of the association on the target class; that is, if the class has a belongs_to association, the name of that association
       #
       # @since 0.2.0
@@ -81,9 +244,9 @@ module Dynamoid
 
       # create getters and setters for an association.
       #
-      # @param [Symbol] symbol the type (:has_one, :has_many, :has_and_belongs_to_many, :belongs_to) of the association
-      # @param [Symbol] name the name of the association
-      # @param [Hash] options options to pass to the association constructor; see above for all valid options
+      # @param type [Symbol] the type (:has_one, :has_many, :has_and_belongs_to_many, :belongs_to) of the association
+      # @param name [Symbol] the name of the association
+      # @param options [Hash] options to pass to the association constructor; see above for all valid options
       #
       # @since 0.2.0
       def association(type, name, options = {})