mongo 1.8.6 → 2.15.1

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

@@ -0,0 +1,68 @@
+# 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.
+# 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 server preference is provided.
+    #
+    # @since 2.0.0
+    class InvalidServerPreference < Error
+
+      # Error message when tags are specified for a read preference that cannot support them.
+      #
+      # @since 2.4.0
+      NO_TAG_SUPPORT = 'This read preference cannot be combined with tags.'.freeze
+
+      # Error message when a max staleness is specified for a read preference that cannot support it.
+      #
+      # @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
+
+      # Error message when max staleness cannot be used because one or more servers has version < 3.4.
+      #
+      # @since 2.4.0
+      NO_MAX_STALENESS_WITH_LEGACY_SERVER = 'max_staleness can only be set for a cluster in which ' +
+                                              'each server is at least version 3.4.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidServerPreference.new
+      #
+      # @param [ String ] message The error message.
+      #
+      # @since 2.0.0
+      def initialize(message)
+        super(message)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_session.rb

@@ -0,0 +1,40 @@
+# 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.
+# 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

@@ -0,0 +1,50 @@
+# 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.
+# 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 verifier does not match the
+    # expected signature on the client.
+    #
+    # @since 2.0.0
+    class InvalidSignature < Error
+
+      # @return [ String ] verifier The server verifier string.
+      attr_reader :verifier
+
+      # @return [ String ] server_signature The expected server signature.
+      attr_reader :server_signature
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   InvalidSignature.new(verifier, server_signature)
+      #
+      # @param [ String ] verifier The verifier returned from the server.
+      # @param [ String ] server_signature The expected value from the
+      #   server.
+      #
+      # @since 2.0.0
+      def initialize(verifier, server_signature)
+        @verifier = verifier
+        @server_signature = server_signature
+        super("Expected server verifier '#{verifier}' to match '#{server_signature}'.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_transaction_operation.rb

@@ -0,0 +1,85 @@
+# 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.
+# 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,30 @@
+# 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.
+# 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

@@ -0,0 +1,42 @@
+# 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.
+# 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 the object is not a valid update document.
+    #
+    # @since 2.0.0
+    class InvalidUpdateDocument < Error
+
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid update document provided'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidUpdateDocument.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_uri.rb

@@ -0,0 +1,42 @@
+# 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.
+# 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 parse a URI that does not match
+    # the specification.
+    #
+    # @since 2.0.0
+    class InvalidURI < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidURI.new(uri, details, format)
+      #
+      # @since 2.0.0
+      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
+end

data/lib/mongo/error/invalid_write_concern.rb

@@ -0,0 +1,38 @@
+# 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.
+# 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 write concern is provided.
+    #
+    # @since 2.2.0
+    class InvalidWriteConcern < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidWriteConcern.new
+      #
+      # @since 2.2.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
+  end
+end

data/lib/mongo/error/kms_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
+
+    # A KMS-related error during client-side encryption.
+    class KmsError < CryptError
+    end
+  end
+end

data/lib/mongo/error/lint_error.rb

@@ -0,0 +1,38 @@
+# 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.
+# 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 driver is used incorrectly.
+    #
+    # Normally the driver passes certain data to the server and lets the
+    # server return an error if the data is invalid. This makes it possible
+    # for the server to add functionality in the future and for older
+    # driver versions to support such functionality transparently, but
+    # also complicates debugging.
+    #
+    # Setting the environment variable MONGO_RUBY_DRIVER_LINT to 1, true
+    # or yes will make the driver perform additional checks on data it passes
+    # to the server, to flag failures sooner. This exception is raised on
+    # such failures.
+    #
+    # @since 2.6.1
+    class LintError < Error
+    end
+  end
+end

data/lib/mongo/error/max_bson_size.rb

@@ -0,0 +1,54 @@
+# 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.
+# 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 serialize a document that
+    # exceeds max BSON object size.
+    #
+    # @since 2.0.0
+    class MaxBSONSize < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      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_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
+end

data/lib/mongo/error/max_message_size.rb

@@ -0,0 +1,45 @@
+# 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.
+# 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 send a message that exceeds max
+    # message size.
+    #
+    # @since 2.0.0
+    class MaxMessageSize < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = "Message exceeds allowed max message size.".freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::MaxMessageSize.new(max)
+      #
+      # @param [ Integer ] max_size The maximum message size.
+      #
+      # @since 2.0.0
+      def initialize(max_size = nil)
+        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/mismatched_domain.rb

@@ -0,0 +1,30 @@
+# 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.
+# 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 DNS query returns SRV record(s)
+    #   whose parent domain does not match the hostname used for the query.
+    #
+    # @example Instantiate the exception.
+    #   Mongo::Error::MismatchedDomain.new(message)
+    #
+    # @since 2.5.0
+    class MismatchedDomain < Error; end
+  end
+end

data/lib/mongo/error/missing_file_chunk.rb

@@ -0,0 +1,41 @@
+# 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.
+# 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 if the next chunk when reading from a GridFSBucket does not have the
+    # expected sequence number (n).
+    #
+    # @since 2.1.0
+    class MissingFileChunk < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::MissingFileChunk.new(expected_n, chunk)
+      #
+      # @param [ Integer ] expected_n The expected index value.
+      # @param [ Grid::File::Chunk ] chunk The chunk read from GridFS.
+      #
+      # @since 2.1.0
+      def initialize(expected_n, chunk)
+        super("Unexpected chunk in sequence. Expected next chunk to have index #{expected_n} but it has index #{chunk.n}")
+      end
+    end
+  end
+end