mongo 2.4.1 → 2.14.0

data/lib/mongo/error/failed_string_prep_validation.rb

@@ -0,0 +1,38 @@
+module Mongo
+  class Error
+    # This exception is raised when stringprep validation fails, such as due to
+    #   character being present or bidirection data being invalid.
+    #
+    # @since 2.6.0
+    class FailedStringPrepValidation < Error
+      # The error message describing failed bidi validation.
+      #
+      # @since 2.6.0
+      INVALID_BIDIRECTIONAL = 'Data failed bidirectional validation'.freeze
+
+      # The error message describing the discovery of a prohibited character.
+      #
+      # @since 2.6.0
+      PROHIBITED_CHARACTER = 'Data contains a prohibited character.'.freeze
+
+      # The error message describing that stringprep normalization can't be done on Ruby versions
+      # below 2.2.0.
+      #
+      # @since 2.6.0
+      UNABLE_TO_NORMALIZE = 'Unable to perform normalization with Ruby versions below 2.2.0'.freeze
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::FailedStringPrepValidation.new(
+      #     Mongo::Error::FailedStringPrepValidation::PROHIBITED_CHARACTER)
+      #
+      # @param [ String ] msg The error message describing how the validation failed.
+      #
+      # @since 2.6.0
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/mongo/error/file_not_found.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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/handshake_error.rb

@@ -0,0 +1,24 @@
+# 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.
+# 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 a server handshake fails.
+    #
+    # @since 2.7.0
+    class HandshakeError < Error
+    end
+  end
+end

data/lib/mongo/error/insufficient_iteration_count.rb

@@ -0,0 +1,38 @@
+# 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.
+# 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 that is raised when trying to create a database with no name.
+    #
+    # @since 2.6.0
+    class InsufficientIterationCount < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidDatabaseName.new
+      #
+      # @since 2.6.0
+      def initialize(msg)
+        super(msg)
+      end
+
+      def self.message(required_count, given_count)
+        "This auth mechanism requires an iteration count of #{required_count}, but the server only requested #{given_count}"
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_address.rb

@@ -0,0 +1,24 @@
+# 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
+
+    # Raised when validation of addresses in URIs and SRV records fails.
+    #
+    # @since 2.11.0
+    class InvalidAddress < Error
+    end
+  end
+end

data/lib/mongo/error/invalid_application_name.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-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_bulk_operation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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_bulk_operation_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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_collection_name.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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_cursor_operation.rb

@@ -0,0 +1,27 @@
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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

@@ -0,0 +1,35 @@
+# 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.
+# 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 that is raised when trying to create a client with an invalid
+    #   min_pool_size option.
+    #
+    # @since 2.4.2
+    class InvalidMinPoolSize < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidMinPoolSize.new(10, 5)
+      #
+      # @since 2.4.2
+      def initialize(min, max)
+        super("Invalid min pool size: #{min}. Please ensure that it is less than the max size: #{max}. ")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_nonce.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2016 MongoDB, Inc.
+# 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 +16,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,28 @@
+# 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

@@ -0,0 +1,35 @@
+# 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.
+# 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 that is raised when trying to create a client with an invalid
+    #   read option.
+    #
+    # @since 2.6.0
+    class InvalidReadOption < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidReadOption.new({:mode => 'bogus'})
+      #
+      # @since 2.6.0
+      def initialize(read_option, msg)
+        super("Invalid read option: #{read_option}: #{msg}")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_replacement_document.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,22 @@
+# 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,23 @@
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,9 +30,15 @@ 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
+      # @deprecated
       INVALID_MAX_STALENESS = "`max_staleness` value is too small. It must be at least " +
         "`ServerSelector::SMALLEST_MAX_STALENESS_SECONDS` and (the cluster's heartbeat_frequency " +
           "setting + `Cluster::IDLE_WRITE_PERIOD_SECONDS`).".freeze

data/lib/mongo/error/invalid_session.rb

@@ -0,0 +1,37 @@
+# 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.
+# 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 a session is attempted to be used and it
+    # is invalid.
+    #
+    # @since 2.5.0
+    class InvalidSession < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   InvalidSession.new(message)
+      #
+      # @param [ String ] message The error message.
+      #
+      # @since 2.5.0
+      def initialize(message)
+        super(message)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_signature.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2016 MongoDB, Inc.
+# 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

@@ -0,0 +1,82 @@
+# 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.
+# 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 if an invalid operation is attempted as part of a transaction.
+    #
+    # @since 2.6.0
+    class InvalidTransactionOperation < Error
+
+      # The error message for when a user attempts to commit or abort a transaction when none is in
+      # progress.
+      #
+      # @since 2.6.0
+      NO_TRANSACTION_STARTED = 'no transaction started'.freeze
+
+      # The error message for when a user attempts to start a transaction when one is already in
+      # progress.
+      #
+      # @since 2.6.0.
+      TRANSACTION_ALREADY_IN_PROGRESS = 'transaction already in progress'.freeze
+
+      # The error message for when a transaction read operation uses a non-primary read preference.
+      #
+      # @since 2.6.0
+      INVALID_READ_PREFERENCE = 'read preference in a transaction must be primary'.freeze
+
+      # The error message for when a transaction is started with an unacknowledged write concern.
+      #
+      # @since 2.6.0
+      UNACKNOWLEDGED_WRITE_CONCERN = 'transactions do not support unacknowledged write concern'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidTransactionOperation.new(msg)
+      #
+      # @since 2.6.0
+      def initialize(msg)
+        super(msg)
+      end
+
+      # Create an error message for incorrectly running a transaction operation twice.
+      #
+      # @example Create the error message.
+      #   InvalidTransactionOperation.cannot_call_twice(op)
+      #
+      # @param [ Symbol ] op The operation which was run twice.
+      #
+      # @since 2.6.0
+      def self.cannot_call_twice_msg(op)
+        "cannot call #{op} twice"
+      end
+
+      # Create an error message for incorrectly running a transaction operation that cannot be run
+      # after the previous one.
+      #
+      # @example Create the error message.
+      #   InvalidTransactionOperation.cannot_call_after(last_op, current_op)
+      #
+      # @param [ Symbol ] last_op The operation which was run before.
+      # @param [ Symbol ] current_op The operation which cannot be run.
+      #
+      # @since 2.6.0
+      def self.cannot_call_after_msg(last_op, current_op)
+        "Cannot call #{current_op} after calling #{last_op}"
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_txt_record.rb

@@ -0,0 +1,27 @@
+# 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.
+# 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 URI Parser's query returns too many
+    #   TXT records or the record specifies invalid options.
+    #
+    # @example Instantiate the exception.
+    #   Mongo::Error::InvalidTXTRecord.new(message)
+    #
+    # @since 2.5.0
+    class InvalidTXTRecord < Error; end
+  end
+end

data/lib/mongo/error/invalid_update_document.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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,14 +24,15 @@ module Mongo
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
-      #   Mongo::Error::InvalidURI.new(uri)
+      #   Mongo::Error::InvalidURI.new(uri, details, format)
       #
       # @since 2.0.0
-      def initialize(uri, details)
-        super("Bad URI: #{uri}\n" +
-        "#{details}\n" +
-        "MongoDB URI must be in the following format: #{Mongo::URI::FORMAT}\n" +
-        "Please see the following URL for more information: #{Mongo::URI::HELP}\n")
+      def initialize(uri, details, format = nil)
+        message = "Bad URI: #{uri}\n" +
+                    "#{details}\n"
+        message += "MongoDB URI must be in the following format: #{format}\n" if format
+        message += "Please see the following URL for more information: #{Mongo::URI::HELP}\n"
+        super(message)
       end
     end
   end

data/lib/mongo/error/invalid_write_concern.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# 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.
@@ -26,8 +26,8 @@ module Mongo
       #   Mongo::Error::InvalidWriteConcern.new
       #
       # @since 2.2.0
-      def initialize
-        super('Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
+      def initialize(msg = nil)
+        super(msg || 'Invalid write concern options. If w is an Integer, it must be greater than or equal to 0. ' +
               'If w is 0, it cannot be combined with a true value for fsync or j (journal).')
       end
     end

data/lib/mongo/error/kms_error.rb

@@ -0,0 +1,22 @@
+# 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
+
+    # A KMS-related error during client-side encryption.
+    class KmsError < CryptError
+    end
+  end
+end