aws-record 2.10.0 → 2.11.0

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Aws
   module Record
     module Transactions
       extend ClientConfiguration
 
       class << self
-
         # @example Usage Example
         #   class TableOne
         #     include Aws::Record
@@ -26,15 +27,26 @@ module Aws
         #   ) # => results.responses contains nil or marshalled items
         #   results.responses.map { |r| r.class } # [TableOne, TableTwo, TableTwo]
         #
-        # Provides a way to run a transactional find across multiple DynamoDB
+        # Provides support for the
+        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_get_items-instance_method
+        # Aws::DynamoDB::Client#transact_get_item} for aws-record models.
+        #
+        # This method runs a transactional find across multiple DynamoDB
         # items, including transactions which get items across multiple actual
-        # or virtual tables.
+        # or virtual tables. This call can contain up to 100 item keys.
+        #
+        # DynamoDB will reject the request if any of the following is true:
+        # * A conflicting operation is in the process of updating an item to be read.
+        # * There is insufficient provisioned capacity for the transaction to be completed.
+        # * There is a user error, such as an invalid data format.
+        # * The aggregate size of the items in the transaction cannot exceed 4 MB.
         #
         # @param [Hash] opts Options to pass through to
-        #   {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_get_items-instance_method Aws::DynamoDB::Client#transact_get_items},
-        #   with the exception of the :transact_items array, which uses the
-        #   +#tfind_opts+ operation on your model class to provide extra
-        #   metadata used to marshal your items after retrieval.
+        #   {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_get_items-instance_method
+        #   Aws::DynamoDB::Client#transact_get_items}, with the exception of the
+        #   +:transact_items+ array, which uses the {ItemOperations.ItemOperationsClassMethods.tfind_opts #tfind_opts}
+        #   operation on your model class to provide extra metadata
+        #   used to marshal your items after retrieval.
         # @option opts [Array] :transact_items A set of +#tfind_opts+ results,
         #   such as those created by the usage example.
         # @option opts [Aws::DynamoDB::Client] :client Optionally, you can pass
@@ -58,7 +70,6 @@ module Aws
           client_resp = client.transact_get_items(
             request_opts
           )
-          responses = client_resp.responses
           index = -1
           ret = OpenStruct.new
           ret.consumed_capacity = client_resp.consumed_capacity
@@ -137,7 +148,11 @@ module Aws
         #     ]
         #   )
         #
-        # Provides a way to pass in aws-record items into transactional writes,
+        # Provides support for the
+        # {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_write_items-instance_method
+        # Aws::DynamoDB::Client#transact_write_items} for aws-record models.
+        #
+        # This method passes in aws-record items into transactional writes,
         # as well as adding the ability to run 'save' commands in a transaction
         # while allowing aws-record to determine if a :put or :update operation
         # is most appropriate. +#transact_write+ supports 5 different transact
@@ -145,7 +160,7 @@ module Aws
         # - save: Behaves much like the +#save+ operation on the item itself.
         #   If the keys are dirty, and thus it appears to be a new item, will
         #   create a :put operation with a conditional check on the item's
-        #   existance. Note that you cannot bring your own conditional
+        #   existence. Note that you cannot bring your own conditional
         #   expression in this case. If you wish to force put or add your
         #   own conditional checks, use the :put operation.
         # - put: Does a force put for the given item key and model.
@@ -153,13 +168,28 @@ module Aws
         # - delete: Deletes the given item.
         # - check: Takes the result of +#transact_check_expression+,
         #   performing the specified check as a part of the transaction.
+        #   See {ItemOperations.ItemOperationsClassMethods.transact_check_expression #transact_check_expression}
+        #   for more information.
+        #
+        # This call contain up to 100 action requests.
+        #
+        # DynamoDB will reject the request if any of the following is true:
+        # * A condition in one of the condition expressions is not met.
+        # * An ongoing operation is in the process of updating the same item.
+        # * There is insufficient provisioned capacity for the transaction to
+        #   be completed.
+        # * An item size becomes too large (bigger than 400 KB), a local secondary
+        #   index (LSI) becomes too large, or a similar validation error occurs
+        #   because of changes made by the transaction.
+        # * The aggregate size of the items in the transaction exceeds 4 MB.
+        # * There is a user error, such as an invalid data format.
         #
         # @param [Hash] opts Options to pass through to
-        #   {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_write_items-instance_method Aws::DynamoDB::Client#transact_write_items}
-        #   with the exception of :transact_items array, which is transformed
-        #   to use your item to populate the :key, :table_name, :item, and/or
-        #   :update_expression parameters as appropriate. See the usage example
-        #   for a comprehensive set of combinations.
+        #   {https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#transact_write_items-instance_method
+        #   Aws::DynamoDB::Client#transact_write_items} with the exception of
+        #   :transact_items array, which is transformed to use your item to populate
+        #   the :key, :table_name, :item, and/or :update_expression parameters
+        #   as appropriate. See the usage example for a comprehensive set of combinations.
         # @option opts [Array] :transact_items An array of hashes, accepting
         #   +:save+, +:put+, +:delete+, +:update+, and +:check+ as specified.
         # @option opts [Aws::DynamoDB::Client] :client Optionally, you can
@@ -180,35 +210,35 @@ module Aws
           opts[:transact_items] = transact_items
           resp = client.transact_write_items(opts)
           # mark all items clean/destroyed as needed if we didn't raise an exception
-          dirty_items.each { |i| i.clean! }
-          delete_items.each { |i| i.instance_variable_get("@data").destroyed = true }
+          dirty_items.each(&:clean!)
+          delete_items.each { |i| i.instance_variable_get('@data').destroyed = true }
           resp
         end
 
         private
+
         def _transform_transact_write_items(transact_items, dirty_items, delete_items)
           transact_items.map do |item|
             # this code will assume users only provided one operation, and
             # will fail down the line if that assumption is wrong
-            if save_record = item.delete(:save)
+            if (save_record = item.delete(:save))
               dirty_items << save_record
               _transform_save_record(save_record, item)
-            elsif put_record = item.delete(:put)
+            elsif (put_record = item.delete(:put))
               dirty_items << put_record
               _transform_put_record(put_record, item)
-            elsif delete_record = item.delete(:delete)
+            elsif (delete_record = item.delete(:delete))
               delete_items << delete_record
               _transform_delete_record(delete_record, item)
-            elsif update_record = item.delete(:update)
+            elsif (update_record = item.delete(:update))
               dirty_items << update_record
               _transform_update_record(update_record, item)
-            elsif check_record = item.delete(:check)
+            elsif (check_record = item.delete(:check))
               _transform_check_record(check_record, item)
             else
-              raise ArgumentError.new(
-                "Invalid transact write item, must include an operation of "\
-                  "type :save, :update, :delete, :update, or :check - #{item}"
-              )
+              raise ArgumentError, 'Invalid transact write item, must include an operation of '\
+                                   "type :save, :update, :delete, :update, or :check - #{item}"
+
             end
           end
         end
@@ -219,16 +249,15 @@ module Aws
           if save_record.send(:expect_new_item?)
             safety_expression = save_record.send(:prevent_overwrite_expression)
             if opts.include?(:condition_expression)
-              raise Errors::TransactionalSaveConditionCollision.new(
-                "Transactional write includes a :save operation that would "\
-                  "result in a 'safe put' for the given item, yet a "\
-                  "condition expression was also provided. This is not "\
-                  "currently supported. You should rewrite this case to use "\
-                  "a :put transaction, adding the existence check to your "\
-                  "own condition expression if desired.\n"\
-                  "\tItem: #{JSON.pretty_unparse(save_record.to_h)}\n"\
-                  "\tExtra Options: #{JSON.pretty_unparse(opts)}"
-              )
+              raise Errors::TransactionalSaveConditionCollision,
+                    'Transactional write includes a :save operation that would '\
+                    "result in a 'safe put' for the given item, yet a "\
+                    'condition expression was also provided. This is not '\
+                    'currently supported. You should rewrite this case to use '\
+                    'a :put transaction, adding the existence check to your '\
+                    "own condition expression if desired.\n"\
+                    "\tItem: #{JSON.pretty_unparse(save_record.to_h)}\n"\
+                    "\tExtra Options: #{JSON.pretty_unparse(opts)}"
             else
               opts = opts.merge(safety_expression)
               _transform_put_record(save_record, opts)
@@ -264,12 +293,12 @@ module Aws
           opts[:key] = update_record.send(:key_values)
           opts[:update_expression] = uex
           # need to combine expression attribute names and values
-          if names = opts[:expression_attribute_names]
+          if (names = opts[:expression_attribute_names])
             opts[:expression_attribute_names] = exp_attr_names.merge(names)
           else
             opts[:expression_attribute_names] = exp_attr_names
           end
-          if values = opts[:expression_attribute_values]
+          if (values = opts[:expression_attribute_values])
             opts[:expression_attribute_values] = exp_attr_values.merge(values)
           else
             opts[:expression_attribute_values] = exp_attr_values

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

@@ -1,18 +1,7 @@
-# Copyright 2015-2017 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.
+# frozen_string_literal: true
 
 module Aws
   module Record
-    VERSION = '2.7.0'
+    VERSION = File.read(File.expand_path('../../../../VERSION', __FILE__)).strip
   end
 end

data/lib/aws-record/record.rb

@@ -1,18 +1,6 @@
-# Copyright 2015-2016 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.
+# frozen_string_literal: true
 
 module Aws
-
   # +Aws::Record+ is the module you include in your model classes in order to
   # decorate them with the Amazon DynamoDB integration methods provided by this
   # library. Methods you can use are shown below, in sub-modules organized by
@@ -84,9 +72,7 @@ module Aws
       sub_class.send(:include, DirtyTracking)
       sub_class.send(:include, Query)
       sub_class.send(:include, SecondaryIndexes)
-      if Aws::Record.extends_record?(sub_class)
-        inherit_track_mutations(sub_class)
-      end
+      inherit_track_mutations(sub_class) if Aws::Record.extends_record?(sub_class)
     end
 
     # @api private
@@ -94,18 +80,21 @@ module Aws
       klass.superclass.include?(Aws::Record)
     end
 
+    # @api private
+    def self.inherit_track_mutations(klass)
+      superclass_track_mutations = klass.superclass.instance_variable_get('@track_mutations')
+      klass.instance_variable_set('@track_mutations', superclass_track_mutations)
+    end
+
+    private_class_method :inherit_track_mutations
+
     private
+
     def dynamodb_client
       self.class.dynamodb_client
     end
 
-    def self.inherit_track_mutations(klass)
-      superclass_track_mutations = klass.superclass.instance_variable_get("@track_mutations")
-      klass.instance_variable_set("@track_mutations", superclass_track_mutations)
-    end
-
     module RecordClassMethods
-
       # Returns the Amazon DynamoDB table name for this model class.
       #
       # By default, this will simply be the name of the class. However, you can
@@ -127,14 +116,16 @@ module Aws
       #   MyTable.table_name      # => "MyTable"
       #   MyOtherTable.table_name # => "test_MyTable"
       def table_name
+        # rubocop:disable Style/RedundantSelf
         @table_name ||= begin
           if Aws::Record.extends_record?(self) &&
-              default_table_name(self.superclass) != self.superclass.table_name
+             default_table_name(self.superclass) != self.superclass.table_name
             self.superclass.instance_variable_get('@table_name')
           else
             default_table_name(self)
           end
         end
+        # rubocop:enable Style/RedundantSelf
       end
 
       # Allows you to set a custom Amazon DynamoDB table name for this model
@@ -186,7 +177,7 @@ module Aws
       #   end
       #
       #   Dog.table_name      # => "DogTable"
-      def set_table_name(name)
+      def set_table_name(name) # rubocop:disable Naming/AccessorMethodName
         @table_name = name
       end
 
@@ -198,32 +189,24 @@ module Aws
       # @raise [Aws::Record::Errors::TableDoesNotExist] if the table name does
       #   not exist in DynamoDB.
       def provisioned_throughput
-        begin
-          resp = dynamodb_client.describe_table(table_name: table_name)
-          throughput = resp.table.provisioned_throughput
-          return {
-            read_capacity_units: throughput.read_capacity_units,
-            write_capacity_units: throughput.write_capacity_units
-          }
-        rescue DynamoDB::Errors::ResourceNotFoundException
-          raise Record::Errors::TableDoesNotExist
-        end
+        resp = dynamodb_client.describe_table(table_name: table_name)
+        throughput = resp.table.provisioned_throughput
+        {
+          read_capacity_units: throughput.read_capacity_units,
+          write_capacity_units: throughput.write_capacity_units
+        }
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        raise Record::Errors::TableDoesNotExist
       end
 
       # Checks if the model's table name exists in Amazon DynamoDB.
       #
       # @return [Boolean] true if the table does exist, false if it does not.
       def table_exists?
-        begin
-          resp = dynamodb_client.describe_table(table_name: table_name)
-          if resp.table.table_status == "ACTIVE"
-            true
-          else
-            false
-          end
-        rescue DynamoDB::Errors::ResourceNotFoundException
-          false
-        end
+        resp = dynamodb_client.describe_table(table_name: table_name)
+        resp.table.table_status == 'ACTIVE'
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        false
       end
 
       # Turns off mutation tracking for all attributes in the model.
@@ -257,17 +240,15 @@ module Aws
       end
 
       def model_valid?
-        if @keys.hash_key.nil?
-          raise Errors::InvalidModel.new("Table models must include a hash key")
-        end
+        raise Errors::InvalidModel, 'Table models must include a hash key' if @keys.hash_key.nil?
       end
 
       private
+
       def default_table_name(klass)
         return unless klass.name
-        klass.name.split("::").join("_")
+        klass.name.split('::').join('_')
       end
-
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-record
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
 description: Provides an object mapping abstraction for Amazon DynamoDB.
 email:
 - mamuller@amazon.com
@@ -32,6 +38,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- VERSION
 - lib/aws-record.rb
 - lib/aws-record/record.rb
 - lib/aws-record/record/attribute.rb
@@ -85,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: AWS Record library for Amazon DynamoDB