mongo 2.10.5 → 2.15.1

data/lib/mongo/error/invalid_cursor_operation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # Exception raised when an unsupported operation is attempted on a cursor.
+    #
+    # Examples:
+    # - Attempting to iterate a regular cursor more than once.
+    # - Attempting to call try_next on a caching cursor after it had been
+    #   iterated completely the first time.
+    class InvalidCursorOperation < Error
+    end
+  end
+end

data/lib/mongo/error/invalid_database_name.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_document.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_file.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_file_revision.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_min_pool_size.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_nonce.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +19,7 @@ module Mongo
   class Error
 
     # This exception is raised when the server nonce returned does not
-    # match the client nonce sent to it.
+    # start with the client nonce sent to it.
     #
     # @since 2.0.0
     class InvalidNonce < Error

data/lib/mongo/error/invalid_read_concern.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # Raised when an invalid read concern is provided.
+    class InvalidReadConcern < Error
+      # Instantiate the new exception.
+      def initialize(msg = nil)
+        super(msg || 'Invalid read concern option provided.' \
+              'The only valid key is :level, for which accepted values are' \
+              ':local, :majority, and :snapshot')
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_read_option.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_replacement_document.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_server_auth_host.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # Raised when the server returned an invalid Host value in AWS auth.
+    class InvalidServerAuthHost < InvalidServerAuthResponse
+    end
+  end
+end

data/lib/mongo/error/invalid_server_auth_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # Raised when authentication is aborted on the client because the server
+    # responded in an unacceptable manner.
+    class InvalidServerAuthResponse < AuthError
+    end
+  end
+end

data/lib/mongo/error/invalid_server_preference.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -30,6 +33,11 @@ module Mongo
       # @since 2.4.0
       NO_MAX_STALENESS_SUPPORT = 'max_staleness cannot be set for this read preference.'.freeze
 
+      # Error message when hedge is specified for a read preference that does not support it.
+      #
+      # @api private
+      NO_HEDGE_SUPPORT = 'The hedge option cannot be set for this read preference'.freeze
+
       # Error message for when the max staleness is not at least twice the heartbeat frequency.
       #
       # @since 2.4.0

data/lib/mongo/error/invalid_session.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +18,8 @@
 module Mongo
   class Error
 
-    # This exception is raised when a session is attempted to be used and it is invalid.
+    # This exception is raised when a session is attempted to be used and it
+    # is invalid.
     #
     # @since 2.5.0
     class InvalidSession < Error

data/lib/mongo/error/invalid_signature.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_transaction_operation.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_txt_record.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_update_document.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_uri.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/invalid_write_concern.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/{spec/support/crud/context.rb → lib/mongo/error/kms_error.rb}

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,11 +16,10 @@
 # limitations under the License.
 
 module Mongo
-  module CRUD
-    class Context
-      def transform_arguments(arguments)
-        arguments
-      end
+  class Error
+
+    # A KMS-related error during client-side encryption.
+    class KmsError < CryptError
     end
   end
 end

data/lib/mongo/error/lint_error.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/max_bson_size.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,16 +27,27 @@ module Mongo
       # The message is constant.
       #
       # @since 2.0.0
-      MESSAGE = "Document exceeds allowed max BSON size.".freeze
+      MESSAGE = "The document exceeds maximum allowed BSON size".freeze
 
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
       #   Mongo::Error::MaxBSONSize.new(max)
       #
+      # @param [ String | Numeric ] max_size_or_msg The message to use or
+      #   the maximum size to insert into the predefined message. The
+      #   Numeric argument type is deprecated.
+      #
       # @since 2.0.0
-      def initialize(max_size = nil)
-        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+      def initialize(max_size_or_msg = nil)
+        if max_size_or_msg.is_a?(Numeric)
+          msg = "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
+        elsif max_size_or_msg
+          msg = max_size_or_msg
+        else
+          msg = MESSAGE
+        end
+        super(msg)
       end
     end
   end

data/lib/mongo/error/max_message_size.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/mismatched_domain.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/missing_file_chunk.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/missing_password.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/missing_resume_token.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/missing_scram_server_signature.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # This exception is raised when the server returned +{done: true}+ in a
+    # SCRAM conversation but did not provide a ServerSignature.
+    class MissingScramServerSignature < Error
+      def initialize(msg = nil)
+        msg ||= "Server signaled completion of SCRAM conversation without providing ServerSignature"
+        super(msg)
+      end
+    end
+  end
+end

data/lib/mongo/error/mongocryptd_spawn_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2020 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License 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 Mongo
+  class Error
+
+    # An error related to spawning mongocryptd for client-side encryption.
+    class MongocryptdSpawnError < CryptError
+    end
+  end
+end

data/lib/mongo/error/multi_index_drop.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/need_primary_server.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/no_server_available.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,9 +35,14 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(server_selector, cluster=nil, msg=nil)
-        msg ||= "No #{server_selector.name} server is available in cluster: #{cluster.summary} " +
-                "with timeout=#{server_selector.server_selection_timeout}, " +
-                "LT=#{server_selector.local_threshold}"
+        unless msg
+          msg = "No #{server_selector.name} server is available"
+          if cluster
+            msg += " in cluster: #{cluster.summary}"
+          end
+          msg += " with timeout=#{server_selector.server_selection_timeout}, " +
+            "LT=#{server_selector.local_threshold}"
+        end
 
         super(msg)
       end

data/lib/mongo/error/no_srv_records.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/notable.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,10 +18,11 @@
 module Mongo
   class Error < StandardError
 
-    # A module encapsulating note tracking functionality, since currently
-    # the driver does not have a single exception hierarchy root.
+    # A module encapsulating functionality to manage data attached to
+    # exceptions in the driver, since the driver does not currently have a
+    # single exception hierarchy root.
     #
-    # @since 2.10.1
+    # @since 2.11.0
     # @api private
     module Notable
 
@@ -27,7 +31,7 @@ module Mongo
       #
       # @return [ Array<String> ] Additional information strings.
       #
-      # @since 2.10.1
+      # @since 2.11.0
       # @api public
       def notes
         if @notes
@@ -42,29 +46,28 @@ module Mongo
         unless @notes
           @notes = []
         end
+        if Lint.enabled?
+          if @notes.include?(note)
+            # The driver makes an effort to not add duplicated notes, by
+            # keeping track of *when* a particular exception should have the
+            # particular notes attached to it throughout the call stack.
+            raise Error::LintError, "Adding a note which already exists in exception #{self}: #{note}"
+          end
+        end
         @notes << note
       end
 
-      # @api public
-      def message
-        super + notes_tail
-      end
+      # Returns connection pool generation for the connection on which the
+      # error occurred.
+      #
+      # @return [ Integer | nil ] Connection pool generation.
+      attr_accessor :generation
 
       # @api public
       def to_s
         super + notes_tail
       end
 
-      # @api public
-      def inspect
-        msg = super
-        if msg.end_with?('>')
-          msg[0...msg.length-1] + notes_tail + '>'
-        else
-          msg + notes_tail
-        end
-      end
-
       private
 
       # @api private