aws-record 2.4.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d017802e3f3023427a79e39fe59468a66f1fe138ef3a6bd173bdcc4d4a15c05c
-  data.tar.gz: c9efe98e3226977a5c381d16cf0dd9ffcd77e6c99d7d4407d58c2e20908c5be2
+  metadata.gz: 67f48531ca8b917f680a1d9a5d21afd1611aba0eb96916a5783addaf7939cda8
+  data.tar.gz: 7f6cbb16271455ada17a61f32106800b65d3b4103a5254e7686e06d5cf715cca
 SHA512:
-  metadata.gz: 0fd56a56605143708ee9f70074317452105860f86835f59653e484c0b1f700b9a7e587383fb9a9278c1eb3c0585cb6fde1024d07bf3d6bcefc1497fcd9ab5984
-  data.tar.gz: ba3f5889ca0954c294ca77b752ab45cb7151067c81369b3b303c86f72e32bc2f0eb7496ca6ccdfbfbf515ef6d04c1809cf32f839cc3574d35ff1f965646505a9
+  metadata.gz: 5bb474f4d13e469b9af991e061b10a54279f37d7390b9cb1bffafd40d039c649c12ca5423140d4a232a08536ec715df89db2e07f6670ef0242732cbe78d1d890
+  data.tar.gz: 9b61d0d93ce9b657989fefde1201aab35253e656035ffb87ccbebfbafe4ea423883146dd4dec510dfdf5deec74b274784f6490d86804cf76b09aeee58f41cdfb

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

@@ -53,9 +53,7 @@ module Aws
         @marshaler = options[:marshaler] || DefaultMarshaler
         @persist_nil = options[:persist_nil]
         dv = options[:default_value]
-        unless dv.nil?
-          @default_value_or_lambda = _is_lambda?(dv) ? dv : type_cast(dv)
-        end
+        @default_value_or_lambda = _is_lambda?(dv) ? dv : type_cast(dv)
       end
 
       # Attempts to type cast a raw value into the attribute's type. This call

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

@@ -0,0 +1,82 @@
+# Copyright 2015-2021 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.
+
+module Aws
+  module Record
+    class Batch
+      extend ClientConfiguration
+
+      class << self
+        # @example Usage Example
+        #   class Breakfast
+        #     include Aws::Record
+        #     integer_attr :id,   hash_key: true
+        #     string_attr  :name, range_key: true
+        #     string_attr  :body
+        #   end
+        #
+        #   # setup
+        #   eggs = Breakfast.new(id: 1, name: "eggs").save!
+        #   waffles = Breakfast.new(id: 2, name: "waffles")
+        #   pancakes = Breakfast.new(id: 3, name: "pancakes")
+        #
+        #   # batch operations
+        #   operation = Aws::Record::Batch.write(client: Breakfast.dynamodb_client) do |db|
+        #     db.put(waffles)
+        #     db.delete(eggs)
+        #     db.put(pancakes)
+        #   end
+        #
+        #   # unprocessed items can be retried by calling Aws::Record::BatchWrite#execute!
+        #   operation.execute! unless operation.complete?
+        #
+        # Provides a thin wrapper to the
+        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method Aws::DynamoDB::Client#batch_write_item}
+        # method. Up to 25 +PutItem+ or +DeleteItem+ operations are supported.
+        # A single rquest may write up to 16 MB of data, with each item having a
+        # write limit of 400 KB.
+        #
+        # *Note*: this operation does not support dirty attribute handling,
+        # nor does it enforce safe write operations (i.e. update vs new record
+        # checks).
+        #
+        # This call may partially execute write operations. Failed operations
+        # are returned as +Aws::Record::BatchWrite#unprocessed_items+ (i.e. the
+        # table fails to meet requested write capacity). Any unprocessed
+        # items may be retried by calling +Aws::Record::BatchWrite#execute!+
+        # again. You can determine if the request needs to be retried by calling
+        # the +Aws::Record::BatchWrite#complete?+ method - which returns +true+
+        # when all operations have been completed.
+        #
+        # Please see
+        # {https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.BatchOperations Batch Operations and Error Handling}
+        # in the DynamoDB Developer Guide for more details.
+        #
+        # @param [Hash] opts the options you wish to use to create the client.
+        #  Note that if you include the option +:client+, all other options
+        #  will be ignored. See the documentation for other options in the
+        #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby}.
+        # @option opts [Aws::DynamoDB::Client] :client allows you to pass in your
+        #  own pre-configured client.
+        #
+        # @return [Aws::Record::BatchWrite] An instance that contains any
+        #   unprocessed items and allows for a retry strategy.
+        def write(opts = {}, &block)
+          batch = BatchWrite.new(client: _build_client(opts))
+          block.call(batch)
+          batch.execute!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# Copyright 2015-2021 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.
+
+module Aws
+  module Record
+    class BatchWrite
+      # @param [Aws::DynamoDB::Client] client the DynamoDB SDK client.
+      def initialize(client:)
+        @client = client
+      end
+
+      # Append a +PutItem+ operation to a batch write request.
+      #
+      # @param [Aws::Record] record a model class that includes {Aws::Record}.
+      def put(record)
+        table_name, params = record_put_params(record)
+        operations[table_name] ||= []
+        operations[table_name] << { put_request: params }
+      end
+
+      # Append a +DeleteItem+ operation to a batch write request.
+      #
+      # @param [Aws::Record] record a model class that includes {Aws::Record}.
+      def delete(record)
+        table_name, params = record_delete_params(record)
+        operations[table_name] ||= []
+        operations[table_name] << { delete_request: params }
+      end
+
+      # Perform a +batch_write_item+ request.
+      #
+      # @return [Aws::Record::BatchWrite] an instance that provides access to
+      #   unprocessed items and allows for retries.
+      def execute!
+        result = @client.batch_write_item(request_items: operations)
+        @operations = result.unprocessed_items
+        self
+      end
+
+      # Indicates if all items have been processed.
+      #
+      # @return [Boolean] +true+ if +unprocessed_items+ is empty, +false+
+      #   otherwise
+      def complete?
+        unprocessed_items.values.none?
+      end
+
+      # Returns all +DeleteItem+ and +PutItem+ operations that have not yet been
+      # processed successfully.
+      #
+      # @return [Hash] All operations that have not yet successfully completed.
+      def unprocessed_items
+        operations
+      end
+
+      private
+
+      def operations
+        @operations ||= {}
+      end
+
+      def record_delete_params(record)
+        [record.class.table_name, { key: record.key_values }]
+      end
+
+      def record_put_params(record)
+        [record.class.table_name, { item: record.save_values }]
+      end
+    end
+  end
+end

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

@@ -101,9 +101,9 @@ module Aws
           @params[:expression_attribute_values] = {}
           values = @params[:expression_attribute_values]
         end
-        _key_pass(statement_str, names)
-        _apply_values(statement_str, subs, values)
-        @params[:key_condition_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        statement = _apply_values(prepared, subs, values)
+        @params[:key_condition_expression] = statement
         self
       end
 
@@ -123,7 +123,7 @@ module Aws
       #     "contains(:body, ?)",
       #     "bacon"
       #   ).complete!
-      # 
+      #
       def filter_expr(statement_str, *subs)
         names = @params[:expression_attribute_names]
         if names.nil?
@@ -135,9 +135,9 @@ module Aws
           @params[:expression_attribute_values] = {}
           values = @params[:expression_attribute_values]
         end
-        _key_pass(statement_str, names)
-        _apply_values(statement_str, subs, values)
-        @params[:filter_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        statement = _apply_values(prepared, subs, values)
+        @params[:filter_expression] = statement
         self
       end
 
@@ -167,8 +167,8 @@ module Aws
           @params[:expression_attribute_names] = {}
           names = @params[:expression_attribute_names]
         end
-        _key_pass(statement_str, names)
-        @params[:projection_expression] = statement_str
+        prepared = _key_pass(statement_str, names)
+        @params[:projection_expression] = prepared
         self
       end
 
@@ -178,6 +178,50 @@ module Aws
         self
       end
 
+      # Allows you to define a callback that will determine the model class
+      # to be used for each item, allowing queries to return an ItemCollection
+      # with mixed models.  The provided block must return the model class based on
+      # any logic on the raw item attributes or `nil` if no model applies and
+      # the item should be skipped.  Note: The block only has access to raw item
+      # data so attributes must be accessed using their names as defined in the
+      # table, not as the symbols defined in the model class(s).
+      #
+      # @example Scan with heterogeneous results:
+      #   # Example model classes
+      #   class Model_A
+      #     include Aws::Record
+      #     set_table_name(TABLE_NAME)
+      #
+      #     string_attr :uuid, hash_key: true
+      #     string_attr :class_name, range_key: true
+      #
+      #     string_attr :attr_a
+      #   end
+      #
+      #   class Model_B
+      #     include Aws::Record
+      #     set_table_name(TABLE_NAME)
+      #
+      #     string_attr :uuid, hash_key: true
+      #     string_attr :class_name, range_key: true
+      #
+      #     string_attr :attr_b
+      #   end
+      #
+      #   # use multi_model_filter to create a query on TABLE_NAME
+      #   items = Model_A.build_scan.multi_model_filter do |raw_item_attributes|
+      #     case raw_item_attributes['class_name']
+      #     when "A" then Model_A
+      #     when "B" then Model_B
+      #     else
+      #       nil
+      #     end
+      #   end.complete!
+      def multi_model_filter(proc = nil, &block)
+        @params[:model_filter] = proc || block
+        self
+      end
+
       # You must call this method at the end of any query or scan you build.
       #
       # @return [Aws::Record::ItemCollection] The item collection lazy
@@ -188,8 +232,8 @@ module Aws
 
       private
       def _key_pass(statement, names)
-        statement.gsub!(/:(\w+)/) do |match|
-          key = match.gsub!(':','').to_sym 
+        statement.gsub(/:(\w+)/) do |match|
+          key = match.gsub(':','').to_sym
           key_name = @model.attributes.storage_name_for(key)
           if key_name
             sub_name = _next_name
@@ -204,15 +248,16 @@ module Aws
 
       def _apply_values(statement, subs, values)
         count = 0
-        statement.gsub!(/[?]/) do |match|
+        statement.gsub(/[?]/) do |match|
           sub_value = _next_value
           raise "Substitution collision!" if values[sub_value]
           values[sub_value] = subs[count]
           count += 1
           sub_value
-        end
-        unless count == subs.size
-          raise "Expected #{count} values in the substitution set, but found #{subs.size}"
+        end.tap do
+          unless count == subs.size
+            raise "Expected #{count} values in the substitution set, but found #{subs.size}"
+          end
         end
       end
 

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

@@ -0,0 +1,63 @@
+# Copyright 2015-2021 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.
+
+module Aws
+  module Record
+    module ClientConfiguration
+      # Configures the Amazon DynamoDB client used by this class and all
+      # instances of this class.
+      #
+      # Please note that this method is also called internally when you first
+      # attempt to perform an operation against the remote end, if you have not
+      # already configured a client. As such, please read and understand the
+      # documentation in the AWS SDK for Ruby around
+      # {http://docs.aws.amazon.com/sdkforruby/api/index.html#Configuration configuration}
+      # to ensure you understand how default configuration behavior works. When
+      # in doubt, call this method to ensure your client is configured the way
+      # you want it to be configured.
+      #
+      # @param [Hash] opts the options you wish to use to create the client.
+      #  Note that if you include the option +:client+, all other options
+      #  will be ignored. See the documentation for other options in the
+      #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby}.
+      # @option opts [Aws::DynamoDB::Client] :client allows you to pass in your
+      #  own pre-configured client.
+      def configure_client(opts = {})
+        @dynamodb_client = _build_client(opts)
+      end
+
+      # Gets the
+      # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html}
+      # instance that Transactions use. When called for the first time, if
+      # {#configure_client} has not yet been called, will configure a new
+      # client for you with default parameters.
+      #
+      # @return [Aws::DynamoDB::Client] the Amazon DynamoDB client instance.
+      def dynamodb_client
+        @dynamodb_client ||= configure_client
+      end
+
+      private
+
+      def _build_client(opts = {})
+        provided_client = opts.delete(:client)
+        opts[:user_agent_suffix] = _user_agent(opts.delete(:user_agent_suffix))
+        provided_client || Aws::DynamoDB::Client.new(opts)
+      end
+
+      def _user_agent(custom)
+        custom || " aws-record/#{VERSION}"
+      end
+    end
+  end
+end

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

@@ -19,6 +19,7 @@ module Aws
       def initialize(search_method, search_params, model, client)
         @search_method = search_method
         @search_params = search_params
+        @model_filter = @search_params.delete(:model_filter)
         @model = model
         @client = client
       end
@@ -91,9 +92,11 @@ module Aws
       def _build_items_from_response(items, model)
         ret = []
         items.each do |item|
-          record = model.new
+          model_class = @model_filter ? @model_filter.call(item) : model
+          next unless model_class
+          record = model_class.new
           data = record.instance_variable_get("@data")
-          model.attributes.attributes.each do |name, attr|
+          model_class.attributes.attributes.each do |name, attr|
             data.set_attribute(name, attr.extract(item))
           end
           data.clean!

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

@@ -82,8 +82,7 @@ module Aws
       end
 
 
-      # Deletes the item instance that matches the key values of this item
-      # instance in Amazon DynamoDB.
+      # Assigns the attributes provided onto the model.
       #
       # @example Usage Example
       #   class MyModel
@@ -98,13 +97,13 @@ module Aws
       #   model.age    # => 4
       #   model.height # => 70.5
       #   model.save
-      #   model.dirty? # => false  
-      # 
+      #   model.dirty? # => false
+      #
       #   model.assign_attributes(age: 5, height: 150.75)
       #   model.age    # => 5
       #   model.height # => 150.75
       #   model.dirty? # => true
-      #   
+      #
       #
       # @param [Hash] opts
       def assign_attributes(opts)
@@ -138,14 +137,14 @@ module Aws
       #   model.age    # => 4
       #   model.height # => 70.5
       #   model.save
-      #   model.dirty? # => false  
-      # 
+      #   model.dirty? # => false
+      #
       #   model.update(age: 5, height: 150.75)
       #   model.age    # => 5
       #   model.height # => 150.75
       #   model.dirty? # => false
       #
-      # 
+      #
       # @param [Hash] new_param, contains the new parameters for the model
       #
       # @param [Hash] opts
@@ -168,7 +167,7 @@ module Aws
       # Note that aws-record allows you to change your model's key values,
       # but this will be interpreted as persisting a new item to your DynamoDB
       # table
-      # 
+      #
       # @param [Hash] new_param, contains the new parameters for the model
       #
       # @param [Hash] opts
@@ -196,6 +195,28 @@ module Aws
         self.instance_variable_get("@data").destroyed = true
       end
 
+      # Validates and generates the key values necessary for API operations such as the
+      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_item-instance_method Aws::DynamoDB::Client#delete_item}
+      # operation.
+      def key_values
+        validate_key_values
+        attributes = self.class.attributes
+        self.class.keys.values.each_with_object({}) do |attr_name, hash|
+          db_name = attributes.storage_name_for(attr_name)
+          hash[db_name] = attributes
+            .attribute_for(attr_name)
+            .serialize(@data.raw_value(attr_name))
+        end
+      end
+
+      # Validates key values and returns a hash consisting of the parameters
+      # to save the record using the
+      # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method Aws::DynamoDB::Client#batch_write_item}
+      # operation.
+      def save_values
+        _build_item_for_save
+      end
+
       private
       def _invalid_record?(opts)
         if self.respond_to?(:valid?)
@@ -266,17 +287,6 @@ module Aws
         @data.build_save_hash
       end
 
-      def key_values
-        validate_key_values
-        attributes = self.class.attributes
-        self.class.keys.inject({}) do |acc, (_, attr_name)|
-          db_name = attributes.storage_name_for(attr_name)
-          acc[db_name] = attributes.attribute_for(attr_name).
-            serialize(@data.raw_value(attr_name))
-          acc
-        end
-      end
-
       def validate_key_values
         missing = missing_key_values
         unless missing.empty?
@@ -340,7 +350,7 @@ module Aws
         #       ":v" => 1024
         #     }
         #   )
-        # 
+        #
         # Allows you to build a "check" expression for use in transactional
         # write operations.
         #
@@ -401,7 +411,7 @@ module Aws
         #     string_attr :hk, hash_key: true
         #     string_attr :rk, range_key: true
         #   end
-        #   
+        #
         #   results = Table.transact_find(
         #     transact_items: [
         #       {key: { hk: "hk1", rk: "rk1"}},

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

@@ -56,15 +56,24 @@ module Aws
       # @param [Hash] opts options to pass on to the client call to
       #  +#create_table+. See the documentation above in the AWS SDK for Ruby
       #  V2.
-      # @option opts [Hash] :provisioned_throughput This is a required argument,
-      #  in which you must specify the +:read_capacity_units+ and
+      # @option opts [Hash] :billing_mode Accepts values 'PAY_PER_REQUEST' or
+      #  'PROVISIONED'. If :provisioned_throughput option is specified, this
+      #  option is not required, as 'PROVISIONED' is assumed. If
+      #  :provisioned_throughput is not specified, this option is required
+      #  and must be set to 'PAY_PER_REQUEST'.
+      # @option opts [Hash] :provisioned_throughput Unless :billing_mode is
+      #  set to 'PAY_PER_REQUEST', this is a required argument, in which
+      #  you must specify the +:read_capacity_units+ and
       #  +:write_capacity_units+ of your new table.
       # @option opts [Hash] :global_secondary_index_throughput This argument is
-      #  required if you define any global secondary indexes. It should map your
+      #  required if you define any global secondary indexes, unless
+      #  :billing_mode is set to 'PAY_PER_REQUEST'. It should map your
       #  global secondary index names to their provisioned throughput, similar
       #  to how you define the provisioned throughput for the table in general.
       def create!(opts)
         gsit = opts.delete(:global_secondary_index_throughput)
+        _validate_billing(opts)
+
         create_opts = opts.merge({
           table_name: @model.table_name,
           attribute_definitions: _attribute_definitions,
@@ -75,14 +84,19 @@ module Aws
           _append_to_attribute_definitions(lsis, create_opts)
         end
         if gsis = @model.global_secondary_indexes_for_migration
-          unless gsit
+          unless gsit || opts[:billing_mode] == 'PAY_PER_REQUEST'
             raise ArgumentError.new(
-              "If you define global secondary indexes, you must also define"\
-                " :global_secondary_index_throughput on table creation."
+              'If you define global secondary indexes, you must also define'\
+                ' :global_secondary_index_throughput on table creation,'\
+                " unless :billing_mode is set to 'PAY_PER_REQUEST'."
             )
           end
-          gsis_with_throughput = _add_throughout_to_gsis(gsis, gsit)
-          create_opts[:global_secondary_indexes] = gsis_with_throughput
+          gsis_opts = if opts[:billing_mode] == 'PAY_PER_REQUEST'
+                        gsis
+                      else
+                        _add_throughput_to_gsis(gsis, gsit)
+                      end
+          create_opts[:global_secondary_indexes] = gsis_opts
           _append_to_attribute_definitions(gsis, create_opts)
         end
         @client.create_table(create_opts)
@@ -142,6 +156,33 @@ module Aws
         end
       end
 
+      def _validate_billing(opts)
+        valid_modes = %w[PAY_PER_REQUEST PROVISIONED]
+        if opts.key?(:billing_mode)
+          unless valid_modes.include?(opts[:billing_mode])
+            raise ArgumentError.new(
+              ":billing_mode option must be one of #{valid_modes.join(', ')}"\
+                " current value is: #{opts[:billing_mode]}"
+            )
+          end
+        end
+        if opts.key?(:provisioned_throughput)
+          if opts[:billing_mode] == 'PAY_PER_REQUEST'
+            raise ArgumentError.new(
+              'when :provisioned_throughput option is specified, :billing_mode'\
+                " must either be unspecified or have a value of 'PROVISIONED'"
+            )
+          end
+        else
+          if opts[:billing_mode] != 'PAY_PER_REQUEST'
+            raise ArgumentError.new(
+              'when :provisioned_throughput option is not specified,'\
+                " :billing_mode must be set to 'PAY_PER_REQUEST'"
+            )
+          end
+        end
+      end
+
       def _attribute_definitions
         _keys.map do |type, attr|
           {
@@ -173,7 +214,7 @@ module Aws
         create_opts[:attribute_definitions] = attr_def
       end
 
-      def _add_throughout_to_gsis(global_secondary_indexes, gsi_throughput)
+      def _add_throughput_to_gsis(global_secondary_indexes, gsi_throughput)
         missing_throughput = []
         ret = global_secondary_indexes.map do |params|
           name = params[:index_name]

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

@@ -1,6 +1,8 @@
 module Aws
   module Record
     module Transactions
+      extend ClientConfiguration
+
       class << self
 
         # @example Usage Example
@@ -8,13 +10,13 @@ module Aws
         #     include Aws::Record
         #     string_attr :uuid, hash_key: true
         #   end
-        #   
+        #
         #   class TableTwo
         #     include Aws::Record
         #     string_attr :hk, hash_key: true
         #     string_attr :rk, range_key: true
         #   end
-        #   
+        #
         #   results = Aws::Record::Transactions.transact_find(
         #     transact_items: [
         #       TableOne.tfind_opts(key: { uuid: "uuid1234" }),
@@ -93,14 +95,14 @@ module Aws
         #     string_attr :uuid, hash_key: true
         #     string_attr :body
         #   end
-        #   
+        #
         #   class TableTwo
         #     include Aws::Record
         #     string_attr :hk, hash_key: true
         #     string_attr :rk, range_key: true
         #     string_attr :body
         #   end
-        #   
+        #
         #   check_exp = TableOne.transact_check_expression(
         #     key: { uuid: "foo" },
         #     condition_expression: "size(#T) <= :v",
@@ -118,7 +120,7 @@ module Aws
         #   update_item_2 = TableTwo.find(hk: "hk2", rk: "rk2")
         #   update_item_2.body = "Update!"
         #   delete_item = TableOne.find(uuid: "to_be_deleted")
-        #   
+        #
         #   Aws::Record::Transactions.transact_write(
         #     transact_items: [
         #       { check: check_exp },
@@ -183,44 +185,6 @@ module Aws
           resp
         end
 
-        # Configures the Amazon DynamoDB client used by global transaction
-        # operations.
-        #
-        # Please note that this method is also called internally when you first
-        # attempt to perform an operation against the remote end, if you have
-        # not already configured a client. As such, please read and understand
-        # the documentation in the AWS SDK for Ruby V3 around
-        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/#Configuration configuration}
-        # to ensure you understand how default configuration behavior works.
-        # When in doubt, call this method to ensure your client is configured
-        # the way you want it to be configured.
-        #
-        # @param [Hash] opts the options you wish to use to create the client.
-        #  Note that if you include the option +:client+, all other options
-        #  will be ignored. See the documentation for other options in the
-        #  {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby V3}.
-        # @option opts [Aws::DynamoDB::Client] :client allows you to pass in
-        #  your own pre-configured client.
-        def configure_client(opts = {})
-          provided_client = opts.delete(:client)
-          opts[:user_agent_suffix] = _user_agent(
-            opts.delete(:user_agent_suffix)
-          )
-          client = provided_client || Aws::DynamoDB::Client.new(opts)
-          @@dynamodb_client = client
-        end
-
-        # Gets the
-        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html}
-        # instance that Transactions use. When called for the first time, if
-        # {#configure_client} has not yet been called, will configure a new
-        # client for you with default parameters.
-      #
-      # @return [Aws::DynamoDB::Client] the Amazon DynamoDB client instance.
-        def dynamodb_client
-          @@dynamodb_client ||= configure_client
-        end
-
         private
         def _transform_transact_write_items(transact_items, dirty_items, delete_items)
           transact_items.map do |item|
@@ -317,15 +281,6 @@ module Aws
           # check records are a pass-through
           { condition_check: opts.merge(check_record) }
         end
-
-        def _user_agent(custom)
-          if custom
-            custom
-          else
-            " aws-record/#{VERSION}"
-          end
-        end
-
       end
     end
   end

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

@@ -13,6 +13,6 @@
 
 module Aws
   module Record
-    VERSION = '2.4.0'
+    VERSION = '2.7.0'
   end
 end

data/lib/aws-record/record.rb

@@ -50,7 +50,7 @@ module Aws
     #     # Attribute definitions go here...
     #   end
     def self.included(sub_class)
-      @track_mutations = true
+      sub_class.send(:extend, ClientConfiguration)
       sub_class.send(:extend, RecordClassMethods)
       sub_class.send(:include, Attributes)
       sub_class.send(:include, ItemOperations)
@@ -76,12 +76,12 @@ module Aws
       #   class MyTable
       #     include Aws::Record
       #   end
-      #   
+      #
       #   class MyTableTest
       #     include Aws::Record
       #     set_table_name "test_MyTable"
       #   end
-      #   
+      #
       #   MyTable.table_name      # => "MyTable"
       #   MyOtherTable.table_name # => "test_MyTable"
       def table_name
@@ -100,12 +100,12 @@ module Aws
       #     include Aws::Record
       #     set_table_name "prod_MyTable"
       #   end
-      #   
+      #
       #   class MyTableTest
       #     include Aws::Record
       #     set_table_name "test_MyTable"
       #   end
-      #   
+      #
       #   MyTable.table_name      # => "prod_MyTable"
       #   MyOtherTable.table_name # => "test_MyTable"
       def set_table_name(name)
@@ -148,42 +148,6 @@ module Aws
         end
       end
 
-      # Configures the Amazon DynamoDB client used by this class and all
-      # instances of this class.
-      #
-      # Please note that this method is also called internally when you first
-      # attempt to perform an operation against the remote end, if you have not
-      # already configured a client. As such, please read and understand the
-      # documentation in the AWS SDK for Ruby V2 around
-      # {http://docs.aws.amazon.com/sdkforruby/api/index.html#Configuration configuration}
-      # to ensure you understand how default configuration behavior works. When
-      # in doubt, call this method to ensure your client is configured the way
-      # you want it to be configured.
-      #
-      # @param [Hash] opts the options you wish to use to create the client.
-      #  Note that if you include the option +:client+, all other options
-      #  will be ignored. See the documentation for other options in the
-      #  {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#initialize-instance_method AWS SDK for Ruby V2}.
-      # @option opts [Aws::DynamoDB::Client] :client allows you to pass in your
-      #  own pre-configured client.
-      def configure_client(opts = {})
-        provided_client = opts.delete(:client)
-        opts[:user_agent_suffix] = _user_agent(opts.delete(:user_agent_suffix))
-        client = provided_client || Aws::DynamoDB::Client.new(opts)
-        @dynamodb_client = client
-      end
-
-      # Gets the
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html Aws::DynamoDB::Client}
-      # instance that this model uses. When called for the first time, if
-      # {#configure_client} has not yet been called, will configure a new client
-      # for you with default parameters.
-      #
-      # @return [Aws::DynamoDB::Client] the Amazon DynamoDB client instance.
-      def dynamodb_client
-        @dynamodb_client ||= configure_client
-      end
-
       # Turns off mutation tracking for all attributes in the model.
       def disable_mutation_tracking
         @track_mutations = false
@@ -201,7 +165,11 @@ module Aws
       # @return [Boolean] true if mutation tracking is enabled at the model
       # level, false otherwise.
       def mutation_tracking_enabled?
-        @track_mutations == false ? false : true
+        if defined?(@track_mutations)
+          @track_mutations
+        else
+          @track_mutations = true
+        end
       end
 
       def model_valid?
@@ -209,15 +177,6 @@ module Aws
           raise Errors::InvalidModel.new("Table models must include a hash key")
         end
       end
-
-      private
-      def _user_agent(custom)
-        if custom
-          custom
-        else
-          " aws-record/#{VERSION}"
-        end
-      end
     end
   end
 end

data/lib/aws-record.rb

@@ -12,6 +12,7 @@
 # and limitations under the License.
 
 require 'aws-sdk-dynamodb'
+require_relative 'aws-record/record/client_configuration'
 require_relative 'aws-record/record'
 require_relative 'aws-record/record/attribute'
 require_relative 'aws-record/record/attributes'
@@ -29,6 +30,8 @@ require_relative 'aws-record/record/table_migration'
 require_relative 'aws-record/record/version'
 require_relative 'aws-record/record/transactions'
 require_relative 'aws-record/record/buildable_search'
+require_relative 'aws-record/record/batch_write'
+require_relative 'aws-record/record/batch'
 require_relative 'aws-record/record/marshalers/string_marshaler'
 require_relative 'aws-record/record/marshalers/boolean_marshaler'
 require_relative 'aws-record/record/marshalers/integer_marshaler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -26,7 +26,8 @@ dependencies:
         version: '1.18'
 description: Provides an object mapping abstraction for Amazon DynamoDB.
 email:
-- alexwood@amazon.com
+- mamuller@amazon.com
+- alexwoo@amazon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,7 +36,10 @@ files:
 - lib/aws-record/record.rb
 - lib/aws-record/record/attribute.rb
 - lib/aws-record/record/attributes.rb
+- lib/aws-record/record/batch.rb
+- lib/aws-record/record/batch_write.rb
 - lib/aws-record/record/buildable_search.rb
+- lib/aws-record/record/client_configuration.rb
 - lib/aws-record/record/dirty_tracking.rb
 - lib/aws-record/record/errors.rb
 - lib/aws-record/record/item_collection.rb
@@ -65,7 +69,7 @@ homepage: http://github.com/aws/aws-sdk-ruby-record
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: AWS Record library for Amazon DynamoDB
 test_files: []