mongo 2.12.4 → 2.14.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c810c7a786a9400b9a55c53b59a8078ec63e57703e8cf564e5001188cd33144b
-  data.tar.gz: 2230cea6d335950d790fb19f414113f7115241ce105d228f7e42a06606795b5e
+  metadata.gz: 493d0cb29d48d80c7fe4c87691500c078b6667bd214dcc021e0074938229be83
+  data.tar.gz: 44507b68e42abadad6987f50c3b3ae1b8ae70f046812607755ffbe292013ccc4
 SHA512:
-  metadata.gz: 1c0fd06e7e5e937ddb6a2c27f98574e79cf39e71f10a41b874186478708db34bcc6c9fa0a2cf5d191bf57ef35c613fbc40a47b8fca3ee660bd7e92dbb4f4b956
-  data.tar.gz: 28f1e23f087f9944ba3f236d78621e48b7fe91b7c75b57e9eac44d67dbe0f345c19d6be2ec96700e36de4952126fe42997702bd018eda9a70e2c25701991853a
+  metadata.gz: ea39c71265e24349b018a8e5f5699b556d1ed43107135da46790ad8496c4bcd8a3917ca6fd0c7b405c5e6cff968d6e18cedf35ac33fe660f19f2869f663cdf64
+  data.tar.gz: 30ca549b30bec1889f622f7002658c918b6686e417bd9a636777bbc7f321d06094278b5a7ff4b04a9395f61bf90e28f99f26ff9ec404b0e3687dbc1b4a77ec1f

data/CONTRIBUTING.md

@@ -5,46 +5,18 @@ Thank you for your interest in contributing to the MongoDB Ruby driver.
 We are building this software together and appreciate and encourage
 contributions from the community.
 
-JIRA Tickets
-------------
-
-The Ruby driver team uses MongoDB JIRA to schedule and track work.
-To report a problem with the driver, please [create a new
-issue](https://jira.mongodb.org/secure/CreateIssue!default.jspa) in the Ruby
-JIRA project. A ticket is appreciated, though not necessary, when submitting
-a pull request.
-
-Please consult [JIRA issues](https://jira.mongodb.org/browse/RUBY)
-for existing known issues in the driver.
-
-Environment
------------
-
-We recommend using [rbenv](https://github.com/sstephenson/rbenv) to set up
-the Ruby development and testing environments, though other tools like
-[RVM](https://rvm.io/) will also work. The driver currently supports
-MRI 2.3-2.7 and JRuby 9.2.
-
-A MongoDB cluster is required to run the tests. Setup procedures and
-recommendations for various clusters, as well as how to configure the
-driver's test suite, are covered in the [spec
-readme](https://github.com/mongodb/mongo-ruby-driver/blob/master/spec/README.md).
-
-The driver is tested on [Evergreen](https://github.com/evergreen-ci/evergreen),
-MongoDB's in house continuous integration platform. After a pull request
-is created, one of the Ruby driver team engineers will schedule continous
-integration builds on Evergreen.
-
 Pull Requests
 -------------
 
-Pull requests should be made against the master (development) branch and
+Pull requests should be made against the `master` branch and
 include relevant tests, if applicable. The Ruby driver team will backport
 the changes to the stable branches, if needed.
 
-Talk To Us
-----------
+JIRA Tickets
+------------
+
+The Ruby driver team uses [MongoDB JIRA](https://jira.mongodb.org/browse/RUBY)
+to schedule and track work.
 
-We would love to hear from you. If you want to work on something or have
-questions please reach out to us by creating a [question](https://jira.mongodb.org/secure/CreateIssue.jspa?pid=10005&issuetype=6)
-in JIRA.
+A JIRA ticket is not required when submitting a pull request, but is
+appreciated especially for non-trivial changes.

data/LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright (C) 2009-2019 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.

data/README.md

@@ -1,6 +1,11 @@
-MongoDB Ruby Driver [![Code Climate][codeclimate-img]][codeclimate-url] [![Gem Version][rubygems-img]][rubygems-url]
------
-The officially supported Ruby driver for [MongoDB](http://www.mongodb.org).
+MongoDB Ruby Driver
+[![Gem Version][rubygems-img]][rubygems-url]
+[![Inline docs][inch-img]][inch-url]
+================================================================
+
+The officially supported Ruby driver for [MongoDB](https://www.mongodb.org/).
+
+The Ruby driver supports Ruby 2.3-2.7 and JRuby 9.2.
 
 
 Documentation
@@ -9,90 +14,85 @@ Documentation
 High level documentation and usage examples are located
 [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
 
-API docs can be found [here](http://api.mongodb.org/ruby/).
+API documentation can be found [here](https://api.mongodb.org/ruby/).
 
 
-Support & Feedback
-------------------
+Support
+-------
+
+Commercial support for the driver is available through the
+[MongoDB Support Portal](https://support.mongodb.com/).
 
-For issues, questions or feedback related to the Ruby driver, please look into
-our [support channels](http://www.mongodb.org/about/support). Please
-do not email any of the Ruby developers directly with issues or
-questions - you're more likely to get an answer quickly on the
-[MongoDB Community Forum](https://community.mongodb.com).
+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
+in the documentation for other support resources.
 
 
 Bugs & Feature Requests
 -----------------------
 
-Do you have a bug to report or a feature request to make?
+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 necessary).
-2. Navigate to the [RUBY](https://jira.mongodb.org/browse/RUBY) project.
-3. Click 'Create Issue' and fill out all the applicable form fields.
+1. Visit [our issue tracker](https://jira.mongodb.org/) and login
+(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.
 
-When reporting an issue, please keep in mind that all information in JIRA for all driver projects (ex. RUBY, CSHARP, JAVA) and the Core Server (ex. SERVER) project is **PUBLICLY** visible.
+When creating an issue, please keep in mind that all information in JIRA
+for the RUBY project, as well as the core server (the SERVER project),
+is publicly visible.
 
-**PLEASE DO**
+**PLEASE DO:**
 
-* Provide as much information as possible about the issue.
-* Provide detailed steps for reproducing the issue.
-* Provide any applicable code snippets, stack traces and log data.
-* Specify version information for the driver and MongoDB.
+- Provide as much information as possible about the issue.
+- Provide detailed steps for reproducing the issue.
+- Provide any applicable code snippets, stack traces and log data.
+  Do not include any sensitive data or server logs.
+- Specify version numbers of the driver and MongoDB server.
 
-**PLEASE DO NOT**
+**PLEASE DO NOT:**
 
-* Provide any sensitive data or server logs.
-* Report potential security issues publicly (see 'Security Issues').
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
 
 
 Security Issues
 ---------------
 
-If you’ve identified a potential security related issue in a driver or any other
-MongoDB project, please report it by following the [instructions here](http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
-
-
-Running Tests
--------------
-
-The driver uses RSpec as its primary testing tool. Most tests require a
-running MongoDB server. To test the driver against a single-node (standalone)
-deployment, first launch a server:
-
-    mkdir /tmp/mrb
-    mongod --dbpath /tmp/mrb --bind_ip 127.0.0.1 --setParameter enableTestCommands=1
+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).
 
-... then run the tests:
 
-    bundle exec rake
+Product Feature Requests
+------------------------
 
-It is possible to run tests in a specific file, as well as use other
-test invocations supported by RSpec:
+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).
 
-    bundle exec rspec path/to/spec.rb:42
 
-Note that certain user accounts have to be created for individual tests to
-succeed, and they are not created when the individual tests are run. The
-user accounts are created if you run `rake` as mentioned above, and you can
-also create them by running:
-
-    bundle exec rake spec:prepare
+Running Tests
+-------------
 
-For further information about supported cluster configurations and how to
-configure the test suite, please see the README in the spec directory.
+Please refer to [spec/README.md](spec/README.md) for instructions on how
+to run the driver's test suite.
 
 
 Release History
 ---------------
 
-Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
+Full release notes and release history are available [on the GitHub releases
+page](https://github.com/mongodb/mongo-ruby-driver/releases).
 
 
 License
 -------
 
- Copyright (C) 2009-2019 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.
@@ -108,5 +108,5 @@ License
 
 [rubygems-img]: https://badge.fury.io/rb/mongo.svg
 [rubygems-url]: http://badge.fury.io/rb/mongo
-[codeclimate-img]: https://codeclimate.com/github/mongodb/mongo-ruby-driver.svg?branch=master
-[codeclimate-url]: https://codeclimate.com/github/mongodb/mongo-ruby-driver?branch=master
+[inch-img]: http://inch-ci.org/github/mongodb/mongo-ruby-driver.svg?branch=master
+[inch-url]: http://inch-ci.org/github/mongodb/mongo-ruby-driver

data/Rakefile

@@ -45,16 +45,16 @@ namespace :spec do
     client = ClientRegistry.instance.global_client('authorized')
     client.database.command(ping: 1)
     deadline = Time.now + 300
-    while Time.now < deadline
-      if client.cluster.send(:sessions_supported?)
+    loop do
+      begin
+        client.cluster.validate_session_support!
         break
+      rescue Mongo::Error::SessionsNotSupported
+        if Time.now >= deadline
+          raise "Sessions did not become supported in 300 seconds"
+        end
+        client.cluster.scan!
       end
-      sleep 1
-      client.close
-      client.reconnect
-    end
-    unless client.cluster.send(:sessions_supported?)
-      raise "Sessions did not become supported in the allowed time"
     end
   end
 
@@ -71,12 +71,18 @@ namespace :spec do
     SpecConfig.instance.print_summary
   end
 
-  task :ci => ['spec:prepare', :spec]
+  task :ci => ['spec:prepare'] do
+    $: << File.join(File.dirname(__FILE__), 'spec')
+
+    require 'support/spec_organizer'
+
+    SpecOrganizer.new.run
+  end
 end
 
 namespace :release do
   task :check_private_key do
-    unless File.exists?('gem-private_key.pem')
+    unless File.exist?('gem-private_key.pem')
       raise "No private key present, cannot release"
     end
   end

data/lib/mongo.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -27,14 +27,18 @@ require 'timeout'
 require 'uri'
 require 'zlib'
 
+autoload :CGI, 'cgi'
+
 require 'bson'
 
 require 'mongo/id'
 require 'mongo/bson'
 require 'mongo/semaphore'
+require 'mongo/distinguishing_semaphore'
 require 'mongo/options'
 require 'mongo/loggable'
 require 'mongo/cluster_time'
+require 'mongo/topology_version'
 require 'mongo/monitoring'
 require 'mongo/logger'
 require 'mongo/retryable'
@@ -47,13 +51,17 @@ require 'mongo/protocol'
 require 'mongo/background_thread'
 require 'mongo/cluster'
 require 'mongo/cursor'
+require 'mongo/caching_cursor'
 require 'mongo/collection'
 require 'mongo/database'
 require 'mongo/crypt'
 require 'mongo/client' # Purposely out-of-order so that database is loaded first
+require 'mongo/client_encryption'
 require 'mongo/dbref'
 require 'mongo/grid'
 require 'mongo/index'
+require 'mongo/lint'
+require 'mongo/query_cache'
 require 'mongo/server'
 require 'mongo/server_selector'
 require 'mongo/session'
@@ -63,5 +71,11 @@ require 'mongo/timeout'
 require 'mongo/uri'
 require 'mongo/version'
 require 'mongo/write_concern'
-require 'mongo/lint'
-require 'mongo/client_encryption'
+require 'mongo/utils'
+
+module Mongo
+  # Clears the driver's OCSP response cache.
+  module_function def clear_ocsp_cache
+    Socket::OcspCache.clear
+  end
+end

data/lib/mongo/active_support.rb

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

data/lib/mongo/address.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -75,7 +75,7 @@ module Mongo
       end
       @seed = seed
       @host, @port = parse_host_port
-      @options = options
+      @options = Hash[options.map { |k, v| [k.to_sym, v] }]
     end
 
     # @return [ String ] seed The seed address.
@@ -172,10 +172,36 @@ module Mongo
     #   address.socket(5, :ssl => true)
     #
     # @param [ Float ] socket_timeout The socket timeout.
-    # @param [ Hash ] ssl_options SSL options.
-    # @param [ Hash ] options The options.
-    #
-    # @option options [ Float ] :connect_timeout Connect timeout.
+    # @param [ Hash ] opts The options.
+    #
+    # @option opts [ Float ] :connect_timeout Connect timeout.
+    # @option opts [ true | false ] :ssl Whether to use SSL.
+    # @option opts [ String ] :ssl_ca_cert
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_ca_cert_string
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_cert
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ OpenSSL::X509::Certificate ] :ssl_cert_object
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_cert_string
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_key
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ OpenSSL::PKey ] :ssl_key_object
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_key_pass_phrase
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ String ] :ssl_key_string
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ true, false ] :ssl_verify
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ true, false ] :ssl_verify_certificate
+    #   Same as the corresponding Client/Socket::SSL option.
+    # @option opts [ true, false ] :ssl_verify_hostname
+    #   Same as the corresponding Client/Socket::SSL option.
     #
     # @return [ Mongo::Socket::SSL | Mongo::Socket::TCP | Mongo::Socket::Unix ]
     #   The socket.
@@ -183,17 +209,18 @@ module Mongo
     # @raise [ Mongo::Error ] If network connection failed.
     #
     # @since 2.0.0
-    def socket(socket_timeout, ssl_options = {}, options = {})
+    # @api private
+    def socket(socket_timeout, opts = {})
+      opts = {
+        connect_timeout: Server::CONNECT_TIMEOUT,
+      }.update(options).update(Hash[opts.map { |k, v| [k.to_sym, v] }])
+
       map_exceptions do
         if seed.downcase =~ Unix::MATCH
           specific_address = Unix.new(seed.downcase)
-          return specific_address.socket(socket_timeout, ssl_options, options)
+          return specific_address.socket(socket_timeout, opts)
         end
 
-        options = {
-          connect_timeout: Server::CONNECT_TIMEOUT,
-        }.update(options)
-
         # When the driver connects to "localhost", it only attempts IPv4
         # connections. When the driver connects to other hosts, it will
         # attempt both IPv4 and IPv6 connections.
@@ -210,7 +237,7 @@ module Mongo
         results.each do |family, address_str|
           begin
             specific_address = FAMILY_MAP[family].new(address_str, port, host)
-            socket = specific_address.socket(socket_timeout, ssl_options, options)
+            socket = specific_address.socket(socket_timeout, opts)
             return socket
           rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
             error = e

data/lib/mongo/address/ipv4.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -78,17 +78,44 @@ module Mongo
       #   ipv4.socket(5, :ssl => true)
       #
       # @param [ Float ] socket_timeout The socket timeout.
-      # @param [ Hash ] ssl_options SSL options.
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout.
+      # @option options [ true | false ] :ssl Whether to use TLS.
+      # @option options [ String ] :ssl_ca_cert
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_ca_cert_string
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_cert
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ OpenSSL::X509::Certificate ] :ssl_cert_object
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_cert_string
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_key
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ OpenSSL::PKey ] :ssl_key_object
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_key_pass_phrase
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ String ] :ssl_key_string
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ true, false ] :ssl_verify
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ true, false ] :ssl_verify_certificate
+      #   Same as the corresponding Client/Socket::SSL option.
+      # @option options [ true, false ] :ssl_verify_hostname
+      #   Same as the corresponding Client/Socket::SSL option.
       #
       # @return [ Mongo::Socket::SSL, Mongo::Socket::TCP ] The socket.
       #
       # @since 2.0.0
-      def socket(socket_timeout, ssl_options = {}, options = {})
-        unless ssl_options.empty?
-          Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET, ssl_options.merge(options))
+      # @api private
+      def socket(socket_timeout, options = {})
+        if options[:ssl]
+          Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET, options)
         else
           Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET, options)
         end