mongo 2.22.0 → 2.24.0

data/lib/mongo/crypt/kms/gcp/credentials_retriever.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -19,7 +18,7 @@ module Mongo
   module Crypt
     module KMS
       module GCP
-        # This class retrieves GPC credentials using Google Compute Engine
+        # This class retrieves GCP credentials using Google Compute Engine
         # metadata host. This should be used when the driver is used on the
         # Google Compute Engine instance.
         #
@@ -45,22 +44,22 @@ module Mongo
             resp = fetch_response(uri, req, timeout_holder)
             if resp.code != '200'
               raise KMS::CredentialsNotFound,
-                "GCE metadata host responded with code #{resp.code}"
+                    "GCE metadata host responded with code #{resp.code}"
             end
             parsed_resp = JSON.parse(resp.body)
             parsed_resp.fetch('access_token')
           rescue JSON::ParserError, KeyError => e
             raise KMS::CredentialsNotFound,
-              "GCE metadata response is invalid: '#{resp.body}'; #{e.class}: #{e.message}"
-            rescue ::Timeout::Error, IOError, SystemCallError, SocketError => e
-              raise KMS::CredentialsNotFound,
-                    "Could not receive GCP metadata response; #{e.class}: #{e.message}"
+                  "GCE metadata response is invalid: '#{resp.body}'; #{e.class}: #{e.message}"
+          rescue ::Timeout::Error, IOError, SystemCallError, SocketError => e
+            raise KMS::CredentialsNotFound,
+                  "Could not receive GCP metadata response; #{e.class}: #{e.message}"
           end
 
           def self.fetch_response(uri, req, timeout_holder)
             timeout_holder&.check_timeout!
             if timeout_holder&.timeout?
-              ::Timeout.timeout(timeout_holder.remaining_timeout_sec, Error:TimeoutError) do
+              ::Timeout.timeout(timeout_holder.remaining_timeout_sec, Error: TimeoutError) do
                 do_fetch(uri, req)
               end
             else
@@ -80,4 +79,3 @@ module Mongo
     end
   end
 end
-

data/lib/mongo/crypt/kms/gcp/master_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -43,9 +42,9 @@ module Mongo
           # @return [ String | nil ] GCP KMS endpoint.
           attr_reader :endpoint
 
-          FORMAT_HINT = "GCP key document  must be in the format: " +
-            "{ project_id: 'PROJECT_ID', location: 'LOCATION', " +
-            "key_ring: 'KEY-RING', key_name: 'KEY-NAME' }"
+          FORMAT_HINT = 'GCP key document  must be in the format: ' +
+                        "{ project_id: 'PROJECT_ID', location: 'LOCATION', " +
+                        "key_ring: 'KEY-RING', key_name: 'KEY-NAME' }"
 
           # Creates a master key document object form a parameters hash.
           #
@@ -77,19 +76,16 @@ module Mongo
           # @return [ BSON::Document ] GCP KMS credentials in libmongocrypt format.
           def to_document
             return BSON::Document.new({}) if @empty
+
             BSON::Document.new({
-              provider: 'gcp',
-              projectId: project_id,
-              location: location,
-              keyRing: key_ring,
-              keyName: key_name
-            }).tap do |bson|
-              unless key_version.nil?
-                bson.update({ keyVersion: key_version })
-              end
-              unless endpoint.nil?
-                bson.update({ endpoint: endpoint })
-              end
+                                 provider: 'gcp',
+                                 projectId: project_id,
+                                 location: location,
+                                 keyRing: key_ring,
+                                 keyName: key_name
+                               }).tap do |bson|
+              bson.update({ keyVersion: key_version }) unless key_version.nil?
+              bson.update({ endpoint: endpoint }) unless endpoint.nil?
             end
           end
         end

data/lib/mongo/crypt/kms/gcp.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -18,4 +17,3 @@
 require 'mongo/crypt/kms/gcp/credentials'
 require 'mongo/crypt/kms/gcp/credentials_retriever'
 require 'mongo/crypt/kms/gcp/master_document'
-

data/lib/mongo/crypt/kms/kmip/credentials.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -33,7 +32,7 @@ module Mongo
           # @api private
           def_delegator :@opts, :empty?
 
-          FORMAT_HINT = "KMIP KMS provider options must be in the format: " +
+          FORMAT_HINT = 'KMIP KMS provider options must be in the format: ' +
                         "{ endpoint: 'ENDPOINT' }"
 
           # Creates a KMIP KMS credentials object form a parameters hash.
@@ -46,9 +45,9 @@ module Mongo
           #   formatted.
           def initialize(opts)
             @opts = opts
-            unless empty?
-              @endpoint = validate_param(:endpoint, opts, FORMAT_HINT)
-            end
+            return if empty?
+
+            @endpoint = validate_param(:endpoint, opts, FORMAT_HINT)
           end
 
           # Convert credentials object to a BSON document in libmongocrypt format.
@@ -56,13 +55,13 @@ module Mongo
           # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
           def to_document
             return BSON::Document.new({}) if empty?
+
             BSON::Document.new({
-              endpoint: endpoint,
-            })
+                                 endpoint: endpoint,
+                               })
           end
         end
       end
     end
   end
 end
-

data/lib/mongo/crypt/kms/kmip/master_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -32,7 +31,7 @@ module Mongo
           # @return [ String | nil ] KMIP KMS endpoint with optional port.
           attr_reader :endpoint
 
-          FORMAT_HINT = "KMIP KMS key document must be in the format: " +
+          FORMAT_HINT = 'KMIP KMS key document must be in the format: ' +
                         "{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"
 
           # Creates a master key document object form a parameters hash.
@@ -60,8 +59,8 @@ module Mongo
           # @return [ BSON::Document ] KMIP KMS credentials in libmongocrypt format.
           def to_document
             BSON::Document.new({
-              provider: 'kmip',
-            }).tap do |bson|
+                                 provider: 'kmip',
+                               }).tap do |bson|
               bson.update({ endpoint: endpoint }) unless endpoint.nil?
               bson.update({ keyId: key_id }) unless key_id.nil?
             end
@@ -71,4 +70,3 @@ module Mongo
     end
   end
 end
-

data/lib/mongo/crypt/kms/kmip.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #

data/lib/mongo/crypt/kms/local/credentials.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -32,7 +31,7 @@ module Mongo
           # @api private
           def_delegator :@opts, :empty?
 
-          FORMAT_HINT = "Local KMS provider options must be in the format: " +
+          FORMAT_HINT = 'Local KMS provider options must be in the format: ' +
                         "{ key: 'MASTER-KEY' }"
 
           # Creates a local KMS credentials object form a parameters hash.
@@ -45,21 +44,21 @@ module Mongo
           #   formatted.
           def initialize(opts)
             @opts = opts
-            unless empty?
-              @key = validate_param(:key, opts, FORMAT_HINT)
-            end
+            return if empty?
+
+            @key = validate_param(:key, opts, FORMAT_HINT)
           end
 
           # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
           def to_document
             return BSON::Document.new({}) if empty?
+
             BSON::Document.new({
-              key: BSON::Binary.new(@key, :generic),
-            })
+                                 key: BSON::Binary.new(@key, :generic),
+                               })
           end
         end
       end
     end
   end
 end
-

data/lib/mongo/crypt/kms/local/master_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -23,21 +22,18 @@ module Mongo
         #
         # @api private
         class MasterKeyDocument
-
           # Creates a master key document object form a parameters hash.
           # This empty method is to keep a uniform interface for all KMS providers.
-          def initialize(_opts)
-          end
+          def initialize(_opts); end
 
           # Convert master key document object to a BSON document in libmongocrypt format.
           #
           # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
           def to_document
-            BSON::Document.new({ provider: "local" })
+            BSON::Document.new({ provider: 'local' })
           end
         end
       end
     end
   end
 end
-

data/lib/mongo/crypt/kms/local.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #

data/lib/mongo/crypt/kms/master_key_document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -18,15 +17,13 @@
 module Mongo
   module Crypt
     module KMS
-
       # KMS master key document object contains KMS master key parameters
       # that are used for creation of data keys.
       #
       # @api private
       class MasterKeyDocument
-
         # Known KMS provider names.
-        KMS_PROVIDERS = %w(aws azure gcp kmip local).freeze
+        KMS_PROVIDERS = %w[aws azure gcp kmip local].freeze
 
         # Creates a master key document object form a parameters hash.
         #
@@ -38,19 +35,18 @@ module Mongo
         #
         # @raise [ ArgumentError ] If required options are missing or incorrectly.
         def initialize(kms_provider, options)
-          if options.nil?
-            raise ArgumentError.new('Key document options must not be nil')
-          end
+          raise ArgumentError.new('Key document options must not be nil') if options.nil?
+
           master_key = options.fetch(:master_key, {})
           @key_document = case kms_provider.to_s
-            when 'aws' then KMS::AWS::MasterKeyDocument.new(master_key)
-            when 'azure' then KMS::Azure::MasterKeyDocument.new(master_key)
-            when 'gcp' then KMS::GCP::MasterKeyDocument.new(master_key)
-            when 'kmip' then KMS::KMIP::MasterKeyDocument.new(master_key)
-            when 'local' then KMS::Local::MasterKeyDocument.new(master_key)
-            else
-              raise ArgumentError.new("KMS provider must be one of #{KMS_PROVIDERS}")
-          end
+                          when 'aws' then KMS::AWS::MasterKeyDocument.new(master_key)
+                          when 'azure' then KMS::Azure::MasterKeyDocument.new(master_key)
+                          when 'gcp' then KMS::GCP::MasterKeyDocument.new(master_key)
+                          when 'kmip' then KMS::KMIP::MasterKeyDocument.new(master_key)
+                          when 'local' then KMS::Local::MasterKeyDocument.new(master_key)
+                          else
+                            raise ArgumentError.new("KMS provider must be one of #{KMS_PROVIDERS}")
+                          end
         end
 
         # Convert master key document object to a BSON document in libmongocrypt format.

data/lib/mongo/crypt/kms.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -43,10 +42,11 @@ module Mongo
         def validate_param(key, opts, format_hint, required: true)
           value = opts.fetch(key)
           return nil if value.nil? && !required
+
           if value.nil?
             raise ArgumentError.new(
               "The #{key} option must be a String with at least one character; " \
-              "currently have nil"
+              'currently have nil'
             )
           end
           unless value.is_a?(String)
@@ -58,7 +58,7 @@ module Mongo
           if value.empty?
             raise ArgumentError.new(
               "The #{key} option must be a String with at least one character; " \
-              "it is currently an empty string"
+              'it is currently an empty string'
             )
           end
           value
@@ -68,8 +68,6 @@ module Mongo
               "The specified KMS provider options are invalid: #{opts}. " +
               format_hint
             )
-          else
-            nil
           end
         end
 
@@ -92,17 +90,17 @@ module Mongo
                 "Incorrect TLS options for #{provider}: TLS is required"
               )
             end
-            %i(
+            %i[
               ssl_verify_certificate
               ssl_verify_hostname
-            ).each do |opt|
-              if provider_opts[opt] == false
-                raise ArgumentError.new(
-                  "Incorrect TLS options for #{provider}: " +
-                  'Insecure TLS options prohibited, ' +
-                  "#{opt} cannot be set to false for KMS"
-                )
-              end
+            ].each do |opt|
+              next unless provider_opts[opt] == false
+
+              raise ArgumentError.new(
+                "Incorrect TLS options for #{provider}: " +
+                'Insecure TLS options prohibited, ' +
+                "#{opt} cannot be set to false for KMS"
+              )
             end
           end
           opts
@@ -113,8 +111,8 @@ module Mongo
   end
 end
 
-require "mongo/crypt/kms/credentials"
-require "mongo/crypt/kms/master_key_document"
+require 'mongo/crypt/kms/credentials'
+require 'mongo/crypt/kms/master_key_document'
 require 'mongo/crypt/kms/aws'
 require 'mongo/crypt/kms/azure'
 require 'mongo/crypt/kms/gcp'

data/lib/mongo/crypt/kms_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,7 +16,6 @@
 
 module Mongo
   module Crypt
-
     # Wraps a libmongocrypt mongocrypt_kms_ctx_t object. Contains information
     # about making an HTTP request to fetch information about a KMS
     # data key.

data/lib/mongo/crypt/rewrap_many_data_key_context.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -17,13 +16,11 @@
 
 module Mongo
   module Crypt
-
     # A Context object initialized specifically for the purpose of rewrapping
-    # data keys (decrypting and re-rencryting using a new KEK).
+    # data keys (decrypting and re-encrypting using a new KEK).
     #
     # @api private
     class RewrapManyDataKeyContext < Context
-
       # Create a new RewrapManyDataKeyContext object
       #
       # @param [ Mongo::Crypt::Handle ] mongocrypt a Handle that
@@ -36,9 +33,7 @@ module Mongo
       #   key document that contains master encryption key parameters.
       def initialize(mongocrypt, io, filter, master_key_document)
         super(mongocrypt, io)
-        if master_key_document
-          Binding.ctx_setopt_key_encryption_key(self, master_key_document.to_document)
-        end
+        Binding.ctx_setopt_key_encryption_key(self, master_key_document.to_document) if master_key_document
         Binding.ctx_rewrap_many_datakey_init(self, filter)
       end
     end

data/lib/mongo/crypt/rewrap_many_data_key_result.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2022 MongoDB Inc.
 #
@@ -17,12 +16,11 @@
 
 module Mongo
   module Crypt
-    # Represent result of the rewrap many data ke operation.
+    # Represent result of the rewrap many data key operation.
     #
     # @api semiprivate
     class RewrapManyDataKeyResult
-
-      # @returns [ BulkWrite::Result ] the result of the bulk write operation
+      # @return [ BulkWrite::Result ] the result of the bulk write operation
       #   used to update the key vault collection with rewrapped data keys.
       attr_reader :bulk_write_result
 

data/lib/mongo/crypt/status.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 ## Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -19,7 +18,6 @@ require 'ffi'
 
 module Mongo
   module Crypt
-
     # A wrapper around mongocrypt_status_t, representing the status of
     # a mongocrypt_t handle.
     #
@@ -39,9 +37,9 @@ module Mongo
         # FFI::AutoPointer uses a custom release strategy to automatically free
         # the pointer once this object goes out of scope
         @status = pointer || FFI::AutoPointer.new(
-                              Binding.mongocrypt_status_new,
-                              Binding.method(:mongocrypt_status_destroy)
-                            )
+          Binding.mongocrypt_status_new,
+          Binding.method(:mongocrypt_status_destroy)
+        )
       end
 
       # Initialize a Status object from an existing pointer to a
@@ -52,7 +50,7 @@ module Mongo
       #
       # @return [ Mongo::Crypt::Status ] A new Status object
       def self.from_pointer(pointer)
-        self.new(pointer: pointer)
+        new(pointer: pointer)
       end
 
       # Set a label, code, and message on the Status
@@ -63,10 +61,10 @@ module Mongo
       #
       # @return [ Mongo::Crypt::Status ] returns self
       def update(label, code, message)
-        unless [:ok, :error_client, :error_kms].include?(label)
+        unless %i[ok error_client error_kms].include?(label)
           raise ArgumentError.new(
             "#{label} is an invalid value for a Mongo::Crypt::Status label. " +
-            "Label must have one of the following values: :ok, :error_client, :error_kms"
+            'Label must have one of the following values: :ok, :error_client, :error_kms'
           )
         end
 
@@ -109,7 +107,7 @@ module Mongo
       # Returns the reference to the underlying mongocrypt_status_t
       # object
       #
-      # @return [ FFI::Pointer ] Pointer to the underlying mongocrypt_status_t oject
+      # @return [ FFI::Pointer ] Pointer to the underlying mongocrypt_status_t object
       def ref
         @status
       end
@@ -127,11 +125,11 @@ module Mongo
       def raise_crypt_error(kms: false)
         return if ok?
 
-        if kms || label == :error_kms
-          error = Error::KmsError.new(message, code: code)
-        else
-          error = Error::CryptError.new(message, code: code)
-        end
+        error = if kms || label == :error_kms
+                  Error::KmsError.new(message, code: code)
+                else
+                  Error::CryptError.new(message, code: code)
+                end
 
         raise error
       end

data/lib/mongo/crypt.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/csot_timeout_holder.rb

@@ -101,9 +101,10 @@ module Mongo
     end
 
     def check_no_override_inside_transaction!(opts, session)
-      return unless opts[:operation_timeout_ms] && session&.with_transaction_deadline
+      return unless opts[:operation_timeout_ms] && session&.inside_with_transaction?
 
-      raise ArgumentError, 'Cannot override timeout_ms inside with_transaction block'
+      raise Mongo::Error::InvalidTransactionOperation,
+            'timeoutMS cannot be overridden inside a withTransaction callback'
     end
 
     def calculate_deadline_from_timeout_ms(operation_timeout_ms)

data/lib/mongo/cursor/kill_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #
@@ -17,14 +16,12 @@
 
 module Mongo
   class Cursor
-
     # This class contains the operation specification for KillCursors.
     #
     # Its purpose is to ensure we don't misspell attribute names accidentally.
     #
     # @api private
     class KillSpec
-
       def initialize(
         cursor_id:,
         coll_name:,
@@ -44,12 +41,12 @@ module Mongo
       end
 
       attr_reader :cursor_id,
-      :coll_name,
-      :db_name,
-      :connection_global_id,
-      :server_address,
-      :session,
-      :connection
+                  :coll_name,
+                  :db_name,
+                  :connection_global_id,
+                  :server_address,
+                  :session,
+                  :connection
 
       def ==(other)
         cursor_id == other.cursor_id &&
@@ -61,7 +58,7 @@ module Mongo
       end
 
       def eql?(other)
-        self.==(other)
+        self == other
       end
 
       def hash