aws-record 2.10.0 → 2.11.0

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

@@ -1,19 +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
-
     # +Aws::Record::TableConfig+ provides a DSL for describing and modifying
     # the remote configuration of your DynamoDB tables. A table configuration
     # object can perform intelligent comparisons and incremental migrations
@@ -101,11 +89,9 @@ module Aws
     #   end
     #
     class TableConfig
-
       attr_accessor :client
 
       class << self
-
         # Creates a new table configuration, using a DSL in the provided block.
         # The DSL has the following methods:
         # * +#model_class+ A class name reference to the +Aws::Record+ model
@@ -169,7 +155,7 @@ module Aws
       def initialize
         @client_options = {}
         @global_secondary_indexes = {}
-        @billing_mode = "PROVISIONED" # default
+        @billing_mode = 'PROVISIONED' # default
       end
 
       # @api private
@@ -202,6 +188,7 @@ module Aws
       # @api private
       def configure_client
         @client = Aws::DynamoDB::Client.new(@client_options)
+        @client.config.user_agent_frameworks << 'aws-record'
       end
 
       # @api private
@@ -242,9 +229,9 @@ module Aws
             unless _gsi_superset(resp)
               @client.update_table(_update_index_opts(resp))
               @client.wait_until(
-              :table_exists,
-              table_name: @model_class.table_name
-            )
+                :table_exists,
+                table_name: @model_class.table_name
+              )
             end
           end
         rescue DynamoDB::Errors::ResourceNotFoundException
@@ -259,7 +246,7 @@ module Aws
         # we will only alter TTL status if we have a TTL attribute defined. We
         # may someday support explicit TTL deletion, but we do not yet do this.
         if @ttl_attribute
-          if !_ttl_compatibility_check
+          unless _ttl_compatibility_check
             client.update_time_to_live(
               table_name: @model_class.table_name,
               time_to_live_specification: {
@@ -281,12 +268,10 @@ module Aws
       #
       # @return [Boolean] true if remote is compatible, false otherwise.
       def compatible?
-        begin
-          resp = @client.describe_table(table_name: @model_class.table_name)
-          _compatible_check(resp) && _ttl_compatibility_check
-        rescue DynamoDB::Errors::ResourceNotFoundException
-          false
-        end
+        resp = @client.describe_table(table_name: @model_class.table_name)
+        _compatible_check(resp) && _ttl_compatibility_check
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        false
       end
 
       # Checks against the remote table's configuration. If the remote table
@@ -296,26 +281,25 @@ module Aws
       #
       # @return [Boolean] true if remote is an exact match, false otherwise.
       def exact_match?
-        begin
-          resp = @client.describe_table(table_name: @model_class.table_name)
-          _throughput_equal(resp) &&
-            _keys_equal(resp) &&
-            _ad_equal(resp) &&
-            _gsi_equal(resp) &&
-            _ttl_match_check
-        rescue DynamoDB::Errors::ResourceNotFoundException
-          false
-        end
+        resp = @client.describe_table(table_name: @model_class.table_name)
+        _throughput_equal(resp) &&
+          _keys_equal(resp) &&
+          _ad_equal(resp) &&
+          _gsi_equal(resp) &&
+          _ttl_match_check
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        false
       end
 
       private
+
       def _ttl_compatibility_check
         if @ttl_attribute
           ttl_status = @client.describe_time_to_live(
             table_name: @model_class.table_name
           )
           desc = ttl_status.time_to_live_description
-          ["ENABLED", "ENABLING"].include?(desc.time_to_live_status) &&
+          %w[ENABLED ENABLING].include?(desc.time_to_live_status) &&
             desc.attribute_name == @ttl_attribute
         else
           true
@@ -328,11 +312,11 @@ module Aws
         )
         desc = ttl_status.time_to_live_description
         if @ttl_attribute
-          ["ENABLED", "ENABLING"].include?(desc.time_to_live_status) &&
+          %w[ENABLED ENABLING].include?(desc.time_to_live_status) &&
             desc.attribute_name == @ttl_attribute
         else
-          !["ENABLED", "ENABLING"].include?(desc.time_to_live_status) ||
-            desc.attribute_name == nil
+          !%w[ENABLED ENABLING].include?(desc.time_to_live_status) ||
+            desc.attribute_name.nil?
         end
       end
 
@@ -347,30 +331,25 @@ module Aws
         opts = {
           table_name: @model_class.table_name
         }
-        if @billing_mode == "PROVISIONED"
+        if @billing_mode == 'PROVISIONED'
           opts[:provisioned_throughput] = {
             read_capacity_units: @read_capacity_units,
             write_capacity_units: @write_capacity_units
           }
-        elsif @billing_mode == "PAY_PER_REQUEST"
+        elsif @billing_mode == 'PAY_PER_REQUEST'
           opts[:billing_mode] = @billing_mode
         else
           raise ArgumentError, "Unsupported billing mode #{@billing_mode}"
         end
-          
         opts[:key_schema] = _key_schema
         opts[:attribute_definitions] = _attribute_definitions
         gsi = _global_secondary_indexes
-        unless gsi.empty?
-          opts[:global_secondary_indexes] = gsi 
-        end
+        opts[:global_secondary_indexes] = gsi unless gsi.empty?
         opts
       end
 
       def _add_global_secondary_index_throughput(opts, resp_gsis)
-        gsis = resp_gsis.map do |g|
-          g.index_name
-        end
+        gsis = resp_gsis.map(&:index_name)
         gsi_updates = []
         gsis.each do |index_name|
           lgsi = @global_secondary_indexes[index_name.to_sym]
@@ -386,7 +365,7 @@ module Aws
       end
 
       def _update_throughput_opts(resp)
-        if @billing_mode == "PROVISIONED"
+        if @billing_mode == 'PROVISIONED'
           opts = {
             table_name: @model_class.table_name,
             provisioned_throughput: {
@@ -397,7 +376,7 @@ module Aws
           # special case: we have global secondary indexes existing, and they
           # need provisioned capacity to be set within this call
           if !resp.table.billing_mode_summary.nil? &&
-              resp.table.billing_mode_summary.billing_mode == "PAY_PER_REQUEST"
+             resp.table.billing_mode_summary.billing_mode == 'PAY_PER_REQUEST'
             opts[:billing_mode] = @billing_mode
             if resp.table.global_secondary_indexes
               resp_gsis = resp.table.global_secondary_indexes
@@ -405,10 +384,10 @@ module Aws
             end
           end # else don't include billing mode
           opts
-        elsif @billing_mode == "PAY_PER_REQUEST"
+        elsif @billing_mode == 'PAY_PER_REQUEST'
           {
             table_name: @model_class.table_name,
-            billing_mode: "PAY_PER_REQUEST"
+            billing_mode: 'PAY_PER_REQUEST'
           }
         else
           raise ArgumentError, "Unsupported billing mode #{@billing_mode}"
@@ -442,7 +421,7 @@ module Aws
           gsi[:key_schema].each do |k|
             attributes_referenced.add(k[:attribute_name])
           end
-          if @billing_mode == "PROVISIONED"
+          if @billing_mode == 'PROVISIONED'
             lgsi = @global_secondary_indexes[index_name.to_sym]
             gsi[:provisioned_throughput] = lgsi.provisioned_throughput
           end
@@ -451,7 +430,7 @@ module Aws
           }
         end
         # we don't currently update anything other than throughput
-        if @billing_mode == "PROVISIONED"
+        if @billing_mode == 'PROVISIONED'
           update_candidates.each do |index_name|
             lgsi = @global_secondary_indexes[index_name.to_sym]
             gsi_updates << {
@@ -475,19 +454,19 @@ module Aws
         _keys.map do |type, attr|
           {
             attribute_name: attr.database_name,
-            key_type: type == :hash ? "HASH" : "RANGE"
+            key_type: type == :hash ? 'HASH' : 'RANGE'
           }
         end
       end
 
       def _attribute_definitions
-        attribute_definitions = _keys.map do |type, attr|
+        attribute_definitions = _keys.map do |_type, attr|
           {
             attribute_name: attr.database_name,
             attribute_type: attr.dynamodb_type
           }
         end
-        @model_class.global_secondary_indexes.each do |_, attributes|
+        @model_class.global_secondary_indexes.each_value do |attributes|
           gsi_keys = [attributes[:hash_key]]
           gsi_keys << attributes[:range_key] if attributes[:range_key]
           gsi_keys.each do |name|
@@ -507,40 +486,40 @@ module Aws
       end
 
       def _keys
-        @model_class.keys.inject({}) do |acc, (type, name)|
+        @model_class.keys.each_with_object({}) do |(type, name), acc|
           acc[type] = @model_class.attributes.attribute_for(name)
           acc
         end
       end
 
       def _throughput_equal(resp)
-        if @billing_mode == "PAY_PER_REQUEST"
+        if @billing_mode == 'PAY_PER_REQUEST'
           !resp.table.billing_mode_summary.nil? &&
-            resp.table.billing_mode_summary.billing_mode == "PAY_PER_REQUEST"
+            resp.table.billing_mode_summary.billing_mode == 'PAY_PER_REQUEST'
         else
           expected = resp.table.provisioned_throughput.to_h
           actual = {
             read_capacity_units: @read_capacity_units,
             write_capacity_units: @write_capacity_units
           }
-          actual.all? do |k,v|
+          actual.all? do |k, v|
             expected[k] == v
           end
         end
       end
 
       def _keys_equal(resp)
-        remote_key_schema = resp.table.key_schema.map { |i| i.to_h }
+        remote_key_schema = resp.table.key_schema.map(&:to_h)
         _array_unsorted_eql(remote_key_schema, _key_schema)
       end
 
       def _ad_equal(resp)
-        remote_ad = resp.table.attribute_definitions.map { |i| i.to_h }
+        remote_ad = resp.table.attribute_definitions.map(&:to_h)
         _array_unsorted_eql(remote_ad, _attribute_definitions)
       end
 
       def _ad_superset(resp)
-        remote_ad = resp.table.attribute_definitions.map { |i| i.to_h }
+        remote_ad = resp.table.attribute_definitions.map(&:to_h)
         _attribute_definitions.all? do |attribute_definition|
           remote_ad.include?(attribute_definition)
         end
@@ -551,7 +530,7 @@ module Aws
         local_gsis = _global_secondary_indexes
         remote_idx, local_idx = _gsi_index_names(remote_gsis, local_gsis)
         if local_idx.subset?(remote_idx)
-           _gsi_set_compare(remote_gsis, local_gsis)
+          _gsi_set_compare(remote_gsis, local_gsis)
         else
           # If we have any local indexes not on the remote table,
           # guaranteed false.
@@ -576,17 +555,17 @@ module Aws
             r.index_name == lgsi[:index_name].to_s
           end
 
-          remote_key_schema = rgsi.key_schema.map { |i| i.to_h }
+          remote_key_schema = rgsi.key_schema.map(&:to_h)
           ks_match = _array_unsorted_eql(remote_key_schema, lgsi[:key_schema])
 
           # Throughput Check: Dependent on Billing Mode
           rpt = rgsi.provisioned_throughput.to_h
           lpt = lgsi[:provisioned_throughput]
-          if @billing_mode == "PROVISIONED"
-            pt_match = lpt.all? do |k,v|
+          if @billing_mode == 'PROVISIONED'
+            pt_match = lpt.all? do |k, v|
               rpt[k] == v
             end
-          elsif @billing_mode == "PAY_PER_REQUEST"
+          elsif @billing_mode == 'PAY_PER_REQUEST'
             pt_match = lpt.nil? ? true : false
           else
             raise ArgumentError, "Unsupported billing mode #{@billing_mode}"
@@ -625,7 +604,7 @@ module Aws
         if model_gsis
           model_gsis.each do |mgsi|
             config = gsi_config[mgsi[:index_name]]
-            if @billing_mode == "PROVISIONED"
+            if @billing_mode == 'PROVISIONED'
               gsis << mgsi.merge(
                 provisioned_throughput: config.provisioned_throughput
               )
@@ -644,12 +623,12 @@ module Aws
       def _validate_required_configuration
         missing_config = []
         missing_config << 'model_class' unless @model_class
-        if @billing_mode == "PROVISIONED"
+        if @billing_mode == 'PROVISIONED'
           missing_config << 'read_capacity_units' unless @read_capacity_units
           missing_config << 'write_capacity_units' unless @write_capacity_units
         else
           if @read_capacity_units || @write_capacity_units
-            raise ArgumentError.new("Cannot have billing mode #{@billing_mode} with provisioned capacity.")
+            raise ArgumentError, "Cannot have billing mode #{@billing_mode} with provisioned capacity."
           end
         end
         unless missing_config.empty?
@@ -674,7 +653,6 @@ module Aws
           @provisioned_throughput[:write_capacity_units] = units
         end
       end
-
     end
   end
 end

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

@@ -1,20 +1,8 @@
-# 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
   module Record
     class TableMigration
-
       # @!attribute [rw] client
       #   @return [Aws::DynamoDB::Client] the
       #     {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html Aws::DynamoDB::Client}
@@ -32,12 +20,14 @@ module Aws
         _assert_model_valid(model)
         @model = model
         @client = opts[:client] || model.dynamodb_client || Aws::DynamoDB::Client.new
+        @client.config.user_agent_frameworks << 'aws-record'
       end
 
       # This method calls
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#create_table-instance_method Aws::DynamoDB::Client#create_table},
-      # populating the attribute definitions and key schema based on your model
-      # class, as well as passing through other parameters as provided by you.
+      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#create_table-instance_method
+      # Aws::DynamoDB::Client#create_table}, populating the attribute definitions and
+      # key schema based on your model class, as well as passing through other
+      # parameters as provided by you.
       #
       # @example Creating a table with a global secondary index named +:gsi+
       #   migration.create!(
@@ -74,22 +64,20 @@ module Aws
         gsit = opts.delete(:global_secondary_index_throughput)
         _validate_billing(opts)
 
-        create_opts = opts.merge({
+        create_opts = opts.merge(
           table_name: @model.table_name,
           attribute_definitions: _attribute_definitions,
           key_schema: _key_schema
-        })
-        if lsis = @model.local_secondary_indexes_for_migration
+        )
+        if (lsis = @model.local_secondary_indexes_for_migration)
           create_opts[:local_secondary_indexes] = lsis
           _append_to_attribute_definitions(lsis, create_opts)
         end
-        if gsis = @model.global_secondary_indexes_for_migration
+        if (gsis = @model.global_secondary_indexes_for_migration)
           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,'\
-                " unless :billing_mode is set to 'PAY_PER_REQUEST'."
-            )
+            raise ArgumentError, '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_opts = if opts[:billing_mode] == 'PAY_PER_REQUEST'
                         gsis
@@ -103,8 +91,8 @@ module Aws
       end
 
       # This method calls
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_table-instance_method Aws::DynamoDB::Client#update_table}
-      # using the parameters that you provide.
+      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#update_table-instance_method
+      # Aws::DynamoDB::Client#update_table} using the parameters that you provide.
       #
       # @param [Hash] opts options to pass on to the client call to
       #  +#update_table+. See the documentation above in the AWS SDK for Ruby
@@ -112,28 +100,24 @@ module Aws
       # @raise [Aws::Record::Errors::TableDoesNotExist] if the table does not
       #  currently exist in Amazon DynamoDB.
       def update!(opts)
-        begin
-          update_opts = opts.merge({
-            table_name: @model.table_name
-          })
-          @client.update_table(update_opts)
-        rescue DynamoDB::Errors::ResourceNotFoundException => e
-          raise Errors::TableDoesNotExist.new(e)
-        end
+        update_opts = opts.merge(
+          table_name: @model.table_name
+        )
+        @client.update_table(update_opts)
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        raise Errors::TableDoesNotExist
       end
 
       # This method calls
-      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_table-instance_method Aws::DynamoDB::Client#delete_table}
-      # using the table name of your model.
+      # {http://docs.aws.amazon.com/sdkforruby/api/Aws/DynamoDB/Client.html#delete_table-instance_method
+      # Aws::DynamoDB::Client#delete_table} using the table name of your model.
       #
       # @raise [Aws::Record::Errors::TableDoesNotExist] if the table did not
       #  exist in Amazon DynamoDB at the time of calling.
       def delete!
-        begin
-          @client.delete_table(table_name: @model.table_name)
-        rescue DynamoDB::Errors::ResourceNotFoundException => e
-          raise Errors::TableDoesNotExist.new(e)
-        end
+        @client.delete_table(table_name: @model.table_name)
+      rescue DynamoDB::Errors::ResourceNotFoundException
+        raise Errors::TableDoesNotExist
       end
 
       # This method waits on the table specified in the model to exist and be
@@ -145,6 +129,7 @@ module Aws
       end
 
       private
+
       def _assert_model_valid(model)
         _assert_required_include(model)
         model.model_valid?
@@ -152,7 +137,7 @@ module Aws
 
       def _assert_required_include(model)
         unless model.include?(::Aws::Record)
-          raise Errors::InvalidModel.new("Table models must include Aws::Record")
+          raise Errors::InvalidModel, 'Table models must include Aws::Record'
         end
       end
 
@@ -160,31 +145,25 @@ module Aws
         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]}"
-            )
+            raise ArgumentError, ":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'"
-            )
+            raise ArgumentError, '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'"
-            )
+            raise ArgumentError, '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|
+        _keys.map do |_type, attr|
           {
             attribute_name: attr.database_name,
             attribute_type: attr.dynamodb_type
@@ -197,9 +176,9 @@ module Aws
         attr_def = create_opts[:attribute_definitions]
         secondary_indexes.each do |si|
           si[:key_schema].each do |key_schema|
-            exists = attr_def.find { |a|
+            exists = attr_def.find do |a|
               a[:attribute_name] == key_schema[:attribute_name]
-            }
+            end
             unless exists
               attr = attributes.attribute_for(
                 attributes.db_to_attribute_name(key_schema[:attribute_name])
@@ -223,12 +202,10 @@ module Aws
           params.merge(provisioned_throughput: throughput)
         end
         unless missing_throughput.empty?
-          raise ArgumentError.new(
-            "Missing provisioned throughput for the following global secondary"\
-              " indexes: #{missing_throughput.join(", ")}. GSIs:"\
-              " #{global_secondary_indexes} and defined throughput:"\
-              " #{gsi_throughput}"
-          )
+          raise ArgumentError, 'Missing provisioned throughput for the following global secondary'\
+                               " indexes: #{missing_throughput.join(', ')}. GSIs:"\
+                               " #{global_secondary_indexes} and defined throughput:"\
+                               " #{gsi_throughput}"
         end
         ret
       end
@@ -237,13 +214,13 @@ module Aws
         _keys.map do |type, attr|
           {
             attribute_name: attr.database_name,
-            key_type: type == :hash ? "HASH" : "RANGE"
+            key_type: type == :hash ? 'HASH' : 'RANGE'
           }
         end
       end
 
       def _keys
-        @model.keys.inject({}) do |acc, (type, name)|
+        @model.keys.each_with_object({}) do |(type, name), acc|
           acc[type] = @model.attributes.attribute_for(name)
           acc
         end