mongo 2.5.3 → 2.6.0

data/lib/mongo/database/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -35,7 +35,7 @@ module Mongo
       # @return [ Collection ] collection The command collection.
       attr_reader :collection
 
-      # Get all the names of the non system collections in the database.
+      # Get all the names of the non-system collections in the database.
       #
       # @example Get the collection names.
       #   database.collection_names
@@ -53,7 +53,7 @@ module Mongo
         server = next_primary(false)
         @limit = -1 if server.features.list_collections_enabled?
         session = client.send(:get_session, options)
-        collections_info(server, session).collect do |info|
+        collections_info(server, session, name_only: true).collect do |info|
           if server.features.list_collections_enabled?
             info[Database::NAME]
           else
@@ -93,29 +93,29 @@ module Mongo
 
       private
 
-      def collections_info(server, session, &block)
-        cursor = Cursor.new(self, send_initial_query(server, session), server, session: session)
+      def collections_info(server, session, options = {}, &block)
+        cursor = Cursor.new(self, send_initial_query(server, session, options), server, session: session)
         cursor.each do |doc|
           yield doc
         end if block_given?
         cursor.to_enum
       end
 
-      def collections_info_spec(session)
+      def collections_info_spec(session, options = {})
         { selector: {
             listCollections: 1,
             cursor: batch_size ? { batchSize: batch_size } : {} },
           db_name: @database.name,
           session: session
-        }
+        }.tap { |spec| spec[:selector][:nameOnly] = true if options[:name_only] }
       end
 
-      def initial_query_op(session)
-        Operation::CollectionsInfo.new(collections_info_spec(session))
+      def initial_query_op(session, options = {})
+        Operation::CollectionsInfo.new(collections_info_spec(session, options))
       end
 
-      def send_initial_query(server, session)
-        initial_query_op(session).execute(server)
+      def send_initial_query(server, session, options = {})
+        initial_query_op(session, options).execute(server)
       end
     end
   end

data/lib/mongo/dbref.rb

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -69,10 +69,62 @@ module Mongo
     #
     # @since 2.2.3
     CURSOR_NOT_FOUND = 'Cursor not found.'
+
+    # Can the change stream on which this error occurred be resumed,
+    # provided the operation that triggered this error was a getMore?
+    #
+    # @example Is the error resumable for the change stream?
+    #   error.change_stream_resumable?
+    #
+    # @return [ true, false ] Whether the error is resumable.
+    #
+    # @since 2.6.0
+    def change_stream_resumable?
+      false
+    end
+
+    # Error label describing commitTransaction errors that may or may not occur again if a commit is
+    # manually retried by the user.
+    #
+    # @since 2.6.0
+    UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'.freeze
+
+    # Error label describing errors that will likely not occur if a transaction is manually retried
+    # from the start.
+    #
+    # @since 2.6.0
+    TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'.freeze
+
+    def initialize(msg = nil)
+      @labels = []
+      super(msg)
+    end
+
+    # Does the error have the given label?
+    #
+    # @example
+    #   error.label?(label)
+    #
+    # @param [ String ] label The label to check if the error has.
+    #
+    # @return [ true, false ] Whether the error has the given label.
+    #
+    # @since 2.6.0
+    def label?(label)
+      @labels.include?(label)
+    end
+
+    private
+
+    def add_label(label)
+      @labels << label unless label?(label)
+    end
   end
 end
 
 require 'mongo/error/parser'
+require 'mongo/error/write_retryable'
+require 'mongo/error/change_stream_resumable'
 require 'mongo/error/bulk_write_error'
 require 'mongo/error/closed_stream'
 require 'mongo/error/extra_file_chunk'
@@ -86,16 +138,19 @@ require 'mongo/error/invalid_document'
 require 'mongo/error/invalid_file'
 require 'mongo/error/invalid_file_revision'
 require 'mongo/error/invalid_min_pool_size'
+require 'mongo/error/invalid_read_option'
 require 'mongo/error/invalid_application_name'
 require 'mongo/error/invalid_nonce'
 require 'mongo/error/invalid_replacement_document'
 require 'mongo/error/invalid_server_preference'
 require 'mongo/error/invalid_session'
 require 'mongo/error/invalid_signature'
+require 'mongo/error/invalid_transaction_operation'
 require 'mongo/error/invalid_txt_record'
 require 'mongo/error/invalid_update_document'
 require 'mongo/error/invalid_uri'
 require 'mongo/error/invalid_write_concern'
+require 'mongo/error/insufficient_iteration_count'
 require 'mongo/error/max_bson_size'
 require 'mongo/error/max_message_size'
 require 'mongo/error/mismatched_domain'
@@ -105,6 +160,7 @@ require 'mongo/error/no_server_available'
 require 'mongo/error/no_srv_records'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
+require 'mongo/error/failed_stringprep_validation'
 require 'mongo/error/unchangeable_collection_option'
 require 'mongo/error/unexpected_chunk_length'
 require 'mongo/error/unexpected_response'

data/lib/mongo/error/bulk_write_error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ module Mongo
       # Instantiate the new exception.
       #
       # @example Instantiate the exception.
-      #   Mongo::Error::BulkWriteFailure.new(response)
+      #   Mongo::Error::BulkWriteError.new(response)
       #
       # @param [ Hash ] result A processed response from the server
       #   reporting results of the operation.

data/lib/mongo/error/change_stream_resumable.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2018 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 module signifying the error will always cause change stream to
+    # resume once.
+    #
+    # @since 2.6.0
+    module ChangeStreamResumable
+      # Can the change stream on which this error occurred be resumed,
+      # provided the operation that triggered this error was a getMore?
+      #
+      # @example Is the error resumable for the change stream?
+      #   error.change_stream_resumable?
+      #
+      # @return [ true, false ] Whether the error is resumable.
+      #
+      # @since 2.6.0
+      def change_stream_resumable?
+        true
+      end
+    end
+  end
+end

data/lib/mongo/error/closed_stream.rb

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

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

@@ -0,0 +1,38 @@
+# Copyright (C) 2014-2018 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_application_name.rb

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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_read_option.rb

@@ -0,0 +1,35 @@
+# Copyright (C) 2018 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-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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_preference.rb

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

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.