mongo 2.13.1 → 2.14.0.rc1

data/lib/mongo/database.rb

@@ -263,6 +263,7 @@ module Mongo
     # @param [ Hash ] options The options for the operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
@@ -270,6 +271,11 @@ module Mongo
     def drop(options = {})
       operation = { :dropDatabase => 1 }
       client.send(:with_session, options) do |session|
+        write_concern = if options[:write_concern]
+          WriteConcern.get(options[:write_concern])
+        else
+          self.write_concern
+        end
         Operation::DropDatabase.new({
           selector: operation,
           db_name: name,

data/lib/mongo/error.rb

@@ -188,6 +188,7 @@ 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_read_concern'
 require 'mongo/error/invalid_replacement_document'
 require 'mongo/error/invalid_server_auth_response'
 # Subclass of InvalidServerAuthResponse
@@ -215,6 +216,7 @@ require 'mongo/error/session_ended'
 require 'mongo/error/sessions_not_supported'
 require 'mongo/error/pool_closed_error'
 require 'mongo/error/raise_original_error'
+require 'mongo/error/server_certificate_revoked'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
 require 'mongo/error/failed_string_prep_validation'

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/server_certificate_revoked.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
+
+    # Server certificate has been revoked (determined via OCSP).
+    class ServerCertificateRevoked < Error
+    end
+  end
+end

data/lib/mongo/error/unsupported_option.rb

@@ -17,39 +17,39 @@ module Mongo
 
     # Raised if an unsupported option is specified for an operation.
     class UnsupportedOption < Error
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # a write operation against a server that does not support the hint
       # option and does not provide option validation.
+      #
+      # @api private
       HINT_MESSAGE = "The MongoDB server handling this request does not support " \
         "the hint option on this command. The hint option is supported on update " \
         "commands on MongoDB server versions 4.2 and later and on findAndModify " \
         "and delete commands on MongoDB server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the hint option to
       # an unacknowledged write operation.
+      #
+      # @api private
       UNACKNOWLEDGED_HINT_MESSAGE = "The hint option cannot be specified on " \
         "an unacknowledged write operation. Remove the hint option or perform " \
         "this operation with a write concern of at least { w: 1 }"
 
-      # @api private
-      #
       # The error message provided when the user passes the allow_disk_use
       # option to a find operation against a server that does not support the
       # allow_disk_use operation and does not provide option validation.
+      #
+      # @api private
       ALLOW_DISK_USE_MESSAGE = "The MongoDB server handling this request does " \
         "not support the allow_disk_use option on this command. The " \
         "allow_disk_use option is supported on find commands on MongoDB " \
         "server versions 4.4 and later"
 
-      # @api private
-      #
       # The error message provided when the user passes the commit_quorum option
       # to a createIndexes operation against a server that does not support
       # that option.
+      #
+      # @api private
       COMMIT_QUORUM_MESSAGE = "The MongoDB server handling this request does " \
         "not support the commit_quorum option on this command. The commit_quorum " \
         "option is supported on createIndexes commands on MongoDB server versions " \
@@ -57,14 +57,14 @@ module Mongo
 
       # Raise an error about an unsupported hint option.
       #
-      # @param [ Hash ] options
-      #
       # @option options [ Boolean ] unacknowledged_write Whether this error
       #   pertains to a hint option passed to an unacknowledged write. Defaults
       #   to false.
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.hint_error(**options)
         unacknowledged_write = options[:unacknowledged_write] || false
 
@@ -79,10 +79,10 @@ module Mongo
 
       # Raise an error about an unsupported allow_disk_use option.
       #
-      # @param [ Hash ] options
-      #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.allow_disk_use_error
         new(ALLOW_DISK_USE_MESSAGE)
       end
@@ -91,6 +91,8 @@ module Mongo
       #
       # @return [ Mongo::Error::UnsupportedOption ] An error with a default
       #   error message.
+      #
+      # @api private
       def self.commit_quorum_error
         new(COMMIT_QUORUM_MESSAGE)
       end

data/lib/mongo/lint.rb

@@ -4,12 +4,13 @@ module Mongo
   module Lint
 
     # Raises LintError if +obj+ is not of type +cls+.
-    module_function def assert_type(obj, cls)
+    def assert_type(obj, cls)
       return unless enabled?
       unless obj.is_a?(cls)
         raise Error::LintError, "Expected #{obj} to be a #{cls}"
       end
     end
+    module_function :assert_type
 
     def validate_underscore_read_preference(read_pref)
       return unless enabled?

data/lib/mongo/logger.rb

@@ -21,7 +21,7 @@ module Mongo
 
     class << self
 
-      # Get the wrapped logger. If none was set will return a default debug
+      # Get the wrapped logger. If none was set will return a default info
       # level logger.
       #
       # @example Get the wrapped logger.
@@ -75,8 +75,8 @@ module Mongo
       private
 
       def default_logger
-        logger = ::Logger.new($stdout)
-        logger.level = ::Logger::DEBUG
+        logger = ::Logger.new(STDOUT)
+        logger.level = ::Logger::INFO
         logger
       end
     end

data/lib/mongo/operation.rb

@@ -50,6 +50,8 @@ require 'mongo/operation/create_index'
 require 'mongo/operation/drop_index'
 
 module Mongo
+
+  # @api private
   module Operation
 
     # The q field constant.

data/lib/mongo/operation/aggregate/result.rb

@@ -14,25 +14,24 @@
 
 module Mongo
   module Operation
-
-    # Aggregate result wrapper.
-    #
-    # @since 2.0.0
     class Aggregate
 
       # Defines custom behavior of results in an aggregation context.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN = 'stages'.freeze
 
         # The legacy field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN_LEGACY = 'serverPipeline'.freeze
 
         # Get the cursor id for the result.
@@ -48,6 +47,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : 0
         end
@@ -62,8 +62,8 @@ module Mongo
         end
 
         # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected, 
-        # it is the 'firstBatch' field in the 'cursor' field of the first 
+        # first document's 'result' field, or if a cursor option was selected,
+        # it is the 'firstBatch' field in the 'cursor' field of the first
         # document returned. Otherwise, it is an explain document.
         #
         # @example Get the documents.
@@ -72,10 +72,11 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
-          docs = reply.documents[0][RESULT] 
+          docs = reply.documents[0][RESULT]
           docs ||= cursor_document[FIRST_BATCH] if cursor_document
-          docs ||= explain_document 
+          docs ||= explain_document
           docs
         end
 

data/lib/mongo/operation/collections_info/result.rb

@@ -20,6 +20,7 @@ module Mongo
       # collection.
       #
       # @since 2.1.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the namespace for the cursor.
@@ -30,6 +31,7 @@ module Mongo
         # @return [ String ] The namespace.
         #
         # @since 2.1.0
+        # @api private
         def namespace
           Database::NAMESPACES
         end

data/lib/mongo/operation/delete/bulk_result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete when part of a bulk write.
       #
       # @since 2.0.0
+      # @api semiprivate
       class BulkResult < Operation::Result
         include Aggregatable
 
@@ -30,6 +31,7 @@ module Mongo
         # @return [ Integer ] The number of documents deleted.
         #
         # @since 2.0.0
+        # @api public
         def n_removed
           return 0 unless acknowledged?
           @replies.reduce(0) do |n, reply|

data/lib/mongo/operation/delete/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for a delete.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the number of documents deleted.
@@ -29,10 +30,12 @@ module Mongo
         # @return [ Integer ] The deleted count.
         #
         # @since 2.0.0
+        # @api public
         def deleted_count
           n
         end
 
+        # @api public
         def bulk_result
           BulkResult.new(@replies, connection_description)
         end

data/lib/mongo/operation/explain/command.rb

@@ -30,6 +30,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end

data/lib/mongo/operation/explain/legacy.rb

@@ -29,6 +29,10 @@ module Mongo
 
         private
 
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
+
         def message(connection)
           Protocol::Query.new(db_name, coll_name, command(connection), options(connection))
         end

data/lib/mongo/operation/explain/op_msg.rb

@@ -25,6 +25,12 @@ module Mongo
         include CausalConsistencySupported
         include ExecutableTransactionLabel
         include PolymorphicResult
+
+        private
+
+        def selector(connection)
+          super.merge(spec[:explain])
+        end
       end
     end
   end

data/lib/mongo/operation/explain/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results in find command with explain.
       #
       # @since 2.5.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ 0 ] Always 0 because explain doesn't return a cursor.
         #
         # @since 2.5.0
+        # @api private
         def cursor_id
           0
         end
@@ -41,6 +43,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.5.0
+        # @api public
         def documents
           reply.documents
         end

data/lib/mongo/operation/find/legacy/result.rb

@@ -20,6 +20,7 @@ module Mongo
         # Defines custom behavior of results for a query.
         #
         # @since 2.1.0
+        # @api semiprivate
         class Result < Operation::Result
           include Operation::Result::UseLegacyErrorParser
 
@@ -31,6 +32,7 @@ module Mongo
           # @return [ true, false ] If the query was successful.
           #
           # @since 2.0.0
+          # @api public
           def successful?
             !query_failure?
           end

data/lib/mongo/operation/find/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results in find command.
       #
       # @since 2.2.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.2.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -41,6 +43,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.2.0
+        # @api public
         def documents
           cursor_document[FIRST_BATCH]
         end

data/lib/mongo/operation/get_more/result.rb

@@ -19,6 +19,7 @@ module Mongo
       # Defines custom behavior of results for the get more command.
       #
       # @since 2.2.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # Get the cursor id.
@@ -29,6 +30,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.2.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : super
         end
@@ -50,6 +52,7 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.2.0
+        # @api public
         def documents
           cursor_document[NEXT_BATCH]
         end