mongo 1.8.6 → 2.15.1

data/lib/mongo/error/insufficient_iteration_count.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
+
+    # 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/internal_driver_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2021 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 detects an internal implementation problem.
+    class InternalDriverError < Error
+    end
+  end
+end

data/lib/mongo/error/invalid_address.rb

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# 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.
+# 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 metadata document sent to the server
+    #   at the time of a connection handshake is invalid.
+    #
+    # @since 2.4.0
+    class InvalidApplicationName < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Create the exception.
+      #   InvalidApplicationName.new(app_name, 128)
+      #
+      # @param [ String ] app_name The application name option.
+      # @param [ Integer ] max_size The max byte size of the application name.
+      #
+      # @since 2.4.0
+      def initialize(app_name, max_size)
+        super("The provided application name '#{app_name}' cannot exceed #{max_size} bytes.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_bulk_operation.rb

@@ -0,0 +1,40 @@
+# 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 non-existent operation type is used.
+    #
+    # @since 2.0.0
+    class InvalidBulkOperation < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidBulkOperation.new(name)
+      #
+      # @param [ String ] type The bulk operation type.
+      # @param [ Hash ] operation The bulk operation.
+      #
+      # @since 2.0.0
+      def initialize(type, operation)
+        super("Invalid document format for bulk #{type} operation: #{operation}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_bulk_operation_type.rb

@@ -0,0 +1,39 @@
+# 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 non-existent operation type is used.
+    #
+    # @since 2.0.0
+    class InvalidBulkOperationType < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidBulkOperationType.new(type)
+      #
+      # @param [ String ] type The attempted operation type.
+      #
+      # @since 2.0.0
+      def initialize(type)
+        super("Invalid bulk operation type: #{type}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_collection_name.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 create a collection with no name.
+    #
+    # @since 2.0.0
+    class InvalidCollectionName < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = 'nil is an invalid collection name. Please provide a string or symbol.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Collection::InvalidName.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

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

@@ -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 create a database with no name.
+    #
+    # @since 2.0.0
+    class InvalidDatabaseName < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = 'nil is an invalid database name. Please provide a string or symbol.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidDatabaseName.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_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 document.
+    #
+    # @since 2.0.0
+    class InvalidDocument < Error
+
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid document provided.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidDocument.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_file.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 file md5 and server md5 do not match when acknowledging
+    # GridFS writes.
+    #
+    # @since 2.0.0
+    class InvalidFile < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::InvalidFile.new(file_md5, server_md5)
+      #
+      # @param [ String ] client_md5 The client side file md5.
+      # @param [ String ] server_md5 The server side file md5.
+      #
+      # @since 2.0.0
+      def initialize(client_md5, server_md5)
+        super("File MD5 on client side is #{client_md5} but the server reported #{server_md5}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_file_revision.rb

@@ -0,0 +1,40 @@
+# 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 requested file revision is not found.
+    #
+    # @since 2.1.0
+    class InvalidFileRevision < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::InvalidFileRevision.new('some-file.txt', 3)
+      #
+      # @param [ String ] filename The name of the file.
+      # @param [ Integer ] revision The requested revision.
+      #
+      # @since 2.1.0
+      def initialize(filename, revision)
+        super("No revision #{revision} found for file '#{filename}'.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_min_pool_size.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
+
+    # 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

@@ -0,0 +1,49 @@
+# 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 nonce returned does not
+    # start with the client nonce sent to it.
+    #
+    # @since 2.0.0
+    class InvalidNonce < Error
+
+      # @return [ String ] nonce The client nonce.
+      attr_reader :nonce
+
+      # @return [ String ] rnonce The server nonce.
+      attr_reader :rnonce
+
+      # Instantiate the new exception.
+      #
+      # @example Create the exception.
+      #   InvalidNonce.new(nonce, rnonce)
+      #
+      # @param [ String ] nonce The client nonce.
+      # @param [ String ] rnonce The server nonce.
+      #
+      # @since 2.0.0
+      def initialize(nonce, rnonce)
+        @nonce = nonce
+        @rnonce = rnonce
+        super("Expected server rnonce '#{rnonce}' to start with client nonce '#{nonce}'.")
+      end
+    end
+  end
+end

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

@@ -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
+
+    # 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

@@ -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 replacement document.
+    #
+    # @since 2.0.0
+    class InvalidReplacementDocument < Error
+
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid replacement document provided'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidReplacementDoc.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

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