mongo 2.14.0 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bfb22d052a842e256744a88c7e3cbd3b958643cc3e0f4425bf97be8f913f167
-  data.tar.gz: b63f3605ad8223e99a5f6a62aabff94a8c8600095b84265b6b4deb38e7223013
+  metadata.gz: 664d381d4746fb4ff6282069f909a91a58f497220bae57656c265f52c5d99040
+  data.tar.gz: 85fa7fbf071c3e8fc4c1beb2215b3297a3af560130204dbd0f916adb272987f7
 SHA512:
-  metadata.gz: 85566c0080b9bcfa67438a365114dd062425df557040e05c0db0448aedd37a0f52dae5b8612b08af196a9e35c1e5b41553a89607d780d187d4e2e28602471c76
-  data.tar.gz: 5172ab2d71a8d7e048fcb2d87e7219024a2028c3909f2cce48081d1b3014071df13b02426019508bda6542e4870992ca869cd3393caf3aaf6483ad4c74f1abf3
+  metadata.gz: 2dcf66e773da4e2bdaf0a22d15a06eadbc5ab2bccffc29f012e2ae863e8148b597550ee680dc2556b40408f4c759b78b159b678cf494cf619c0975044d72d662
+  data.tar.gz: c120607792132931a54511db0a4ef62653393138e9da3fcf0ca0f0a85fde3aefe6b04782fd09125b0fe3085e50c66b1cd2f6e0c4743ae40e7094dc8e7892587a

data/README.md

@@ -5,20 +5,19 @@ MongoDB Ruby Driver
 
 The officially supported Ruby driver for [MongoDB](https://www.mongodb.org/).
 
-The Ruby driver supports Ruby 2.3-2.7 and JRuby 9.2.
+The Ruby driver supports Ruby 2.5-3.0 and JRuby 9.2.
 
-
-Documentation
--------------
+## Documentation
 
 High level documentation and usage examples are located
 [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
 
-API documentation can be found [here](https://api.mongodb.org/ruby/).
-
+API documentation for the most recent release can be found
+[here](https://mongodb.com/docs/ruby-driver/current/api/).
+To build API documentation for the master branch, check out the
+repository locally and run `rake docs`.
 
-Support
--------
+## Support
 
 Commercial support for the driver is available through the
 [MongoDB Support Portal](https://support.mongodb.com/).
@@ -26,17 +25,15 @@ Commercial support for the driver is available through the
 For questions, discussions or general technical support, please visit the
 [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/ruby-driver).
 
-Please see [Technical Support](https://docs.mongodb.com/manual/support/) page
+Please see [Technical Support](https://mongodb.com/docs/manual/support/) page
 in the documentation for other support resources.
 
-
-Bugs & Feature Requests
------------------------
+## Bugs & Feature Requests
 
 To report a bug in the driver or request a feature specific to the Ruby driver:
 
 1. Visit [our issue tracker](https://jira.mongodb.org/) and login
-(or create an account if you do not have one already).
+   (or create an account if you do not have one already).
 2. Navigate to the [RUBY project](https://jira.mongodb.org/browse/RUBY).
 3. Click 'Create Issue' and fill out all of the applicable form fields.
 
@@ -57,54 +54,44 @@ is publicly visible.
 - Provide any sensitive data or server logs.
 - Report potential security issues publicly (see 'Security Issues' below).
 
-
-Security Issues
----------------
+## Security Issues
 
 If you have identified a potential security-related issue in the Ruby driver
 (or any other MongoDB product), please report it by following the
 [instructions here](http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
 
-
-Product Feature Requests
-------------------------
+## Product Feature Requests
 
 To request a feature which is not specific to the Ruby driver, or which
 affects more than the driver alone (for example, a feature which requires
 MongoDB server support), please submit your idea through the
 [MongoDB Feedback Forum](https://feedback.mongodb.com/forums/924286-drivers).
 
-
-Running Tests
--------------
+## Running Tests
 
 Please refer to [spec/README.md](spec/README.md) for instructions on how
 to run the driver's test suite.
 
-
-Release History
----------------
+## Release History
 
 Full release notes and release history are available [on the GitHub releases
 page](https://github.com/mongodb/mongo-ruby-driver/releases).
 
+## License
 
-License
--------
-
- Copyright (C) 2009-2020 MongoDB, Inc.
+Copyright (C) 2009-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
+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
+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.
+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.
 
 [rubygems-img]: https://badge.fury.io/rb/mongo.svg
 [rubygems-url]: http://badge.fury.io/rb/mongo

data/Rakefile

@@ -1,26 +1,19 @@
-#!/usr/bin/env ruby
+# -*- mode: ruby -*-
 
-require 'rubygems'
-
-begin
-  require 'bundler'
-  require 'bundler/gem_tasks'
-rescue LoadError
-  raise '[FAIL] Bundler not found! Install it with ' +
-        '`gem install bundler; bundle install`.'
-end
-
-default_groups = [:default, :testing]
-Bundler.require(*default_groups)
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+# TODO move the mongo require into the individual tasks that actually need it
+require 'mongo'
 
 ROOT = File.expand_path(File.join(File.dirname(__FILE__)))
 
 $: << File.join(ROOT, 'spec/shared/lib')
 
-require 'rspec/core/rake_task'
 require 'mrss/spec_organizer'
 
 CLASSIFIERS = [
+  [%r,^mongo/server,, :unit_server],
   [%r,^mongo,, :unit],
   [%r,^kerberos,, :unit],
   [%r,^integration/sdam_error_handling,, :sdam_integration],
@@ -34,7 +27,7 @@ CLASSIFIERS = [
 
 RUN_PRIORITY = %i(
   tx_examples
-  unit
+  unit unit_server
   integration sdam_integration cursor_reaping query_cache
   spec spec_sdam_integration
 )

data/lib/mongo/active_support.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/address/ipv4.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/address/ipv6.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/address/unix.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/address/validator.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/address.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/auth/aws/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -49,10 +52,7 @@ module Mongo
             payload: BSON::Binary.new(client_final_payload),
             conversationId: conversation_id,
           )
-          selector[Protocol::Msg::DATABASE_IDENTIFIER] = user.auth_source
-          cluster_time = connection.mongos? && connection.cluster_time
-          selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
-          Protocol::Msg.new([], {}, selector)
+          build_message(connection, user.auth_source, selector)
         end
 
         private

data/lib/mongo/auth/aws/credentials_retriever.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/aws/request.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -150,7 +153,6 @@ module Mongo
             'x-mongodb-gs2-cb-flag' => 'n',
             'x-mongodb-server-nonce' => Base64.encode64(server_nonce).gsub("\n", ''),
           }
-          # Hash#compact is available as of Ruby 2.4
           if session_token
             headers['x-amz-security-token'] = session_token
           end

data/lib/mongo/auth/aws.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -68,7 +71,7 @@ module Mongo
       # @param [ Server::Connection ] connection The connection.
       # @param [ Auth::*::Conversation ] conversation The conversation.
       # @param [ BSON::Document | nil ] speculative_auth_result The
-      #   value of speculativeAuthenticate field of ismaster response of
+      #   value of speculativeAuthenticate field of hello response of
       #   the handshake on the specified connection.
       def converse_multi_step(connection, conversation,
         speculative_auth_result: nil
@@ -100,10 +103,21 @@ module Mongo
       end
 
       def dispatch_msg(connection, conversation, msg)
-        reply = connection.dispatch([msg])
+        context = Operation::Context.new(options: {
+          server_api: connection.options[:server_api],
+        })
+        if server_api = context.server_api
+          msg = msg.maybe_add_server_api(server_api)
+        end
+        reply = connection.dispatch([msg], context)
         reply_document = reply.documents.first
         validate_reply!(connection, conversation, reply_document)
-        result = Operation::Result.new(reply, connection.description)
+        connection_global_id = if connection.respond_to?(:global_id)
+          connection.global_id
+        else
+          nil
+        end
+        result = Operation::Result.new(reply, connection.description, connection_global_id)
         connection.update_cluster_time(result)
         reply_document
       end
@@ -112,15 +126,17 @@ module Mongo
       # raises Unauthorized if not.
       def validate_reply!(connection, conversation, doc)
         if doc[:ok] != 1
-          extra = [doc[:code], doc[:codeName]].compact.join(': ')
-          msg = doc[:errmsg]
-          unless extra.empty?
-            msg += " (#{extra})"
-          end
+          message = Error::Parser.build_message(
+            code: doc[:code],
+            code_name: doc[:codeName],
+            message: doc[:errmsg],
+          )
+
           raise Unauthorized.new(user,
             used_mechanism: self.class.const_get(:MECHANISM),
-            message: msg,
+            message: message,
             server: connection.server,
+            code: doc[:code]
           )
         end
       end

data/lib/mongo/auth/conversation_base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -47,6 +50,38 @@ module Mongo
       def speculative_auth_document
         nil
       end
+
+      # @return [ Protocol::Message ] The message to send.
+      def build_message(connection, auth_source, selector)
+        if connection && connection.features.op_msg_enabled?
+          selector = selector.dup
+          selector[Protocol::Msg::DATABASE_IDENTIFIER] = auth_source
+          cluster_time = connection.mongos? && connection.cluster_time
+          if cluster_time
+            selector[Operation::CLUSTER_TIME] = cluster_time
+          end
+          Protocol::Msg.new([], {}, selector)
+        else
+          Protocol::Query.new(
+            auth_source,
+            Database::COMMAND,
+            selector,
+            limit: -1,
+          )
+        end
+      end
+
+      def validate_external_auth_source
+        if user.auth_source != '$external'
+          user_name_msg = if user.name
+            " #{user.name}"
+          else
+            ''
+          end
+          mechanism = user.mechanism
+          raise Auth::InvalidConfiguration, "User#{user_name_msg} specifies auth source '#{user.auth_source}', but the only valid auth source for #{mechanism} is '$external'"
+        end
+      end
     end
   end
 end

data/lib/mongo/auth/cr/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -43,22 +46,12 @@ module Mongo
         # @param [ Server::Connection ] connection The connection being
         #   authenticated.
         #
-        # @return [ Protocol::Query ] The first CR conversation message.
+        # @return [ Protocol::Message ] The first CR conversation message.
         #
         # @since 2.0.0
         def start(connection)
-          if connection && connection.features.op_msg_enabled?
-            selector = Auth::GET_NONCE.merge(Protocol::Msg::DATABASE_IDENTIFIER => user.auth_source)
-            cluster_time = connection.mongos? && connection.cluster_time
-            selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
-            Protocol::Msg.new([], {}, selector)
-          else
-            Protocol::Query.new(
-              user.auth_source,
-              Database::COMMAND,
-              Auth::GET_NONCE,
-              limit: -1)
-          end
+          selector = Auth::GET_NONCE
+          build_message(connection, user.auth_source, selector)
         end
 
         # Continue the CR conversation. This sends the client final message
@@ -70,26 +63,13 @@ module Mongo
         # @param [ Mongo::Server::Connection ] connection The connection being
         #   authenticated.
         #
-        # @return [ Protocol::Query ] The next message to send.
+        # @return [ Protocol::Message ] The next message to send.
         #
         # @since 2.0.0
         def continue(reply_document, connection)
           @nonce = reply_document[Auth::NONCE]
-
-          if connection && connection.features.op_msg_enabled?
-            selector = LOGIN.merge(user: user.name, nonce: nonce, key: user.auth_key(nonce))
-            selector[Protocol::Msg::DATABASE_IDENTIFIER] = user.auth_source
-            cluster_time = connection.mongos? && connection.cluster_time
-            selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
-            Protocol::Msg.new([], {}, selector)
-          else
-            Protocol::Query.new(
-              user.auth_source,
-              Database::COMMAND,
-              LOGIN.merge(user: user.name, nonce: nonce, key: user.auth_key(nonce)),
-              limit: -1
-            )
-          end
+          selector = LOGIN.merge(user: user.name, nonce: nonce, key: user.auth_key(nonce))
+          build_message(connection, user.auth_source, selector)
         end
       end
     end

data/lib/mongo/auth/cr.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/credential_cache.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/gssapi/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -70,20 +73,14 @@ module Mongo
         # @param [ BSON::Document ] reply_document The reply document of the
         #   previous message.
         #
-        # @return [ Protocol::Query ] The next query to execute.
+        # @return [ Protocol::Message ] The next query to execute.
         def continue(reply_document, connection)
           @id = reply_document['conversationId']
           payload = reply_document['payload']
 
           continue_token = authenticator.evaluate_challenge(payload)
           selector = CONTINUE_MESSAGE.merge(payload: continue_token, conversationId: id)
-
-          Protocol::Query.new(
-            Auth::EXTERNAL,
-            Database::COMMAND,
-            selector,
-            limit: 1,
-          )
+          build_message(connection, '$external', selector)
         end
 
         def process_continue_response(reply_document)
@@ -92,15 +89,10 @@ module Mongo
           @continue_token = authenticator.evaluate_challenge(payload)
         end
 
+        # @return [ Protocol::Message ] The next query to execute.
         def finalize(connection)
           selector = CONTINUE_MESSAGE.merge(payload: @continue_token, conversationId: id)
-
-          Protocol::Query.new(
-            Auth::EXTERNAL,
-            Database::COMMAND,
-            selector,
-            limit: 1,
-          )
+          build_message(connection, '$external', selector)
         end
       end
     end

data/lib/mongo/auth/gssapi.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/ldap/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,20 +41,9 @@ module Mongo
         #
         # @since 2.0.0
         def start(connection)
-          if connection && connection.features.op_msg_enabled?
-            selector = LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM)
-            selector[Protocol::Msg::DATABASE_IDENTIFIER] = Auth::EXTERNAL
-            cluster_time = connection.mongos? && connection.cluster_time
-            selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
-            Protocol::Msg.new([], {}, selector)
-          else
-            Protocol::Query.new(
-              Auth::EXTERNAL,
-              Database::COMMAND,
-              LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM),
-              limit: -1
-            )
-          end
+          validate_external_auth_source
+          selector = LOGIN.merge(payload: payload, mechanism: LDAP::MECHANISM)
+          build_message(connection, '$external', selector)
         end
 
         private

data/lib/mongo/auth/ldap.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/roles.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/sasl_conversation_base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,19 +38,7 @@ module Mongo
       # @return [ Protocol::Message ] The first SASL conversation message.
       def start(connection)
         selector = client_first_document
-        if connection && connection.features.op_msg_enabled?
-          selector[Protocol::Msg::DATABASE_IDENTIFIER] = user.auth_source
-          cluster_time = connection.mongos? && connection.cluster_time
-          selector[Operation::CLUSTER_TIME] = cluster_time if cluster_time
-          Protocol::Msg.new([], {}, selector)
-        else
-          Protocol::Query.new(
-            user.auth_source,
-            Database::COMMAND,
-            selector,
-            limit: -1,
-          )
-        end
+        build_message(connection, user.auth_source, selector)
       end
 
       private

data/lib/mongo/auth/scram/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/scram.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,7 +35,7 @@ module Mongo
       #   nonce used in speculative auth on the specified connection that
       #   produced the specified speculative auth result.
       # @option opts [ BSON::Document | nil ] speculative_auth_result The
-      #   value of speculativeAuthenticate field of ismaster response of
+      #   value of speculativeAuthenticate field of hello response of
       #   the handshake on the specified connection.
       def initialize(user, connection, **opts)
         super
@@ -45,7 +48,7 @@ module Mongo
       attr_reader :speculative_auth_client_nonce
 
       # @return [ BSON::Document | nil ] The value of speculativeAuthenticate
-      #   field of ismaster response of the handshake on the current connection.
+      #   field of hello response of the handshake on the current connection.
       attr_reader :speculative_auth_result
 
       def conversation

data/lib/mongo/auth/scram256/conversation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/auth/scram256.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");