mongo 2.11.2 → 2.13.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52eaac2e54a90b6aad27aa1ef965c67cb36d4ea61907092e867b40eac1f9539
-  data.tar.gz: c118c191fac15467052a316eadd13035ed43968af1e46bd50ea45e6ad4884900
+  metadata.gz: 6f5e58cfb13fc60fb774becdceb53b4c79cd1461a2cbd3f2dcfd44216f083da8
+  data.tar.gz: df770f62315fa3ef4db7a32d796c093759a38c1e6c4e6eaa183789b1700f5ed9
 SHA512:
-  metadata.gz: f652bbcf6b01f172199d467953d8f0ab3b9bc83b2e790d87a2c2f3b3251e5c0139234cbe1c2a1fbb6791ab5bf18be001b9be271ef0a0a9bfa75f9d20be9441f5
-  data.tar.gz: 82a0273865415d0ce911b96a0f80fa59610539d23e8182acd706cade06226df0d9a5ca931a3ae1b05a6191e4d4e934cb713c232a67c4dcedb48d03cf696ed79b
+  metadata.gz: a51aa55384766e936b0bbc4ad2f99c9fb22ad03d10e04a4f65a5492c16764c92495ae17c5e1ba521c96e3fe25c5b2d787ab985939947eeffd0957a54ceef4078
+  data.tar.gz: 6d8ca3220081914ec39479c4c9ebb4a6f070be7f4840fa98f0b6cf28f9c3a9c8082264e9b3b7b0d588cda54f97c9f687e36fd467576a396527d80b493c8a52e7

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.6 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,89 +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-user list](http://groups.google.com/group/mongodb-user) on Google Groups.
+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.
@@ -107,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

@@ -76,7 +76,7 @@ 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,6 +27,8 @@ require 'timeout'
 require 'uri'
 require 'zlib'
 
+autoload :CGI, 'cgi'
+
 require 'bson'
 
 require 'mongo/id'
@@ -35,6 +37,7 @@ require 'mongo/semaphore'
 require 'mongo/options'
 require 'mongo/loggable'
 require 'mongo/cluster_time'
+require 'mongo/topology_version'
 require 'mongo/monitoring'
 require 'mongo/logger'
 require 'mongo/retryable'
@@ -49,6 +52,7 @@ require 'mongo/cluster'
 require 'mongo/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/dbref'
 require 'mongo/grid'
@@ -58,7 +62,9 @@ require 'mongo/server_selector'
 require 'mongo/session'
 require 'mongo/socket'
 require 'mongo/srv'
+require 'mongo/timeout'
 require 'mongo/uri'
 require 'mongo/version'
 require 'mongo/write_concern'
 require 'mongo/lint'
+require 'mongo/client_encryption'

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.
@@ -66,6 +66,8 @@ module Mongo
     # @param [ String ] seed The provided address.
     # @param [ Hash ] options The address options.
     #
+    # @option options [ Float ] :connect_timeout Connect timeout.
+    #
     # @since 2.0.0
     def initialize(seed, options = {})
       if seed.nil?
@@ -73,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.
@@ -85,6 +87,9 @@ module Mongo
     # @return [ Integer ] port The port.
     attr_reader :port
 
+    # @api private
+    attr_reader :options
+
     # Check equality of the address to another.
     #
     # @example Check address equality.
@@ -138,28 +143,108 @@ module Mongo
       "#<Mongo::Address:0x#{object_id} address=#{to_s}>"
     end
 
-    # Get a socket for the provided address, given the options.
-    #
-    # The address the socket connects to is determined by the algorithm described in the
-    # #intialize_resolver! documentation. Each time this method is called, #initialize_resolver!
-    # will be called, meaning that a new hostname lookup will occur. This is done so that any
-    # changes to which addresses the hostname resolves to will be picked up even if a socket has
-    # been connected to it before.
+    # Get a socket for the address stored in this object, given the options.
+    #
+    # If the address stored in this object looks like a Unix path, this method
+    # returns a Unix domain socket for this path.
+    #
+    # Otherwise, this method attempts to resolve the address stored in
+    # this object to IPv4 and IPv6 addresses using +Socket#getaddrinfo+, then
+    # connects to the resulting addresses and returns the socket of the first
+    # successful connection. The order in which address families (IPv4/IPV6)
+    # are tried is the same order in which the addresses are returned by
+    # +getaddrinfo+, and is determined by the host system.
+    #
+    # Name resolution is performed on each +socket+ call. This is done so that
+    # any changes to which addresses the host names used as seeds or in
+    # server configuration resolve to are immediately noticed by the driver,
+    # even if a socket has been connected to the affected host name/address
+    # before. However, note that DNS TTL values may still affect when a change
+    # to a host address is noticed by the driver.
+    #
+    # This method propagates any exceptions raised during DNS resolution and
+    # subsequent connection attempts. In case of a host name resolving to
+    # multiple IP addresses, the error raised by the last attempt is propagated
+    # to the caller. This method does not map exceptions to Mongo::Error
+    # subclasses, and may raise any subclass of Exception.
     #
     # @example Get a socket.
     #   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.
-    #
-    # @return [ Mongo::Socket::SSL, Mongo::Socket::TCP, Mongo::Socket::Unix ] The socket.
+    # @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.
+    #
+    # @raise [ Mongo::Error ] If network connection failed.
     #
     # @since 2.0.0
-    def socket(socket_timeout, ssl_options = {}, options = {})
-      create_resolver(ssl_options).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, opts)
+        end
+
+        # 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.
+        family = (host == LOCALHOST) ? ::Socket::AF_INET : ::Socket::AF_UNSPEC
+        error = nil
+        # Sometimes Socket#getaddrinfo returns the same info more than once
+        # (multiple identical items in the returned array). It does not make
+        # sense to try to connect to the same address more than once, thus
+        # eliminate duplicates here.
+        infos = ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM)
+        results = infos.map do |info|
+          [info[4], info[3]]
+        end.uniq
+        results.each do |family, address_str|
+          begin
+            specific_address = FAMILY_MAP[family].new(address_str, port, host)
+            socket = specific_address.socket(socket_timeout, opts)
+            return socket
+          rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
+            error = e
+          end
+        end
+        raise error
+      end
     end
 
     # Get the address as a string.
@@ -182,37 +267,8 @@ module Mongo
       end
     end
 
-    # @api private
-    def connect_timeout
-      @connect_timeout ||= @options[:connect_timeout] || Server::CONNECT_TIMEOUT
-    end
-
     private
 
-    # To determine which address the socket will connect to, the driver will
-    # attempt to connect to each IP address returned by Socket::getaddrinfo in
-    # sequence. Once a successful connection is made, a resolver with that
-    # IP address specified is returned. If no successful connection is
-    # made, the error made by the last connection attempt is raised.
-    def create_resolver(ssl_options)
-      return Unix.new(seed.downcase) if seed.downcase =~ Unix::MATCH
-
-      family = (host == LOCALHOST) ? ::Socket::AF_INET : ::Socket::AF_UNSPEC
-      error = nil
-      ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM).each do |info|
-        begin
-          specific_address = FAMILY_MAP[info[4]].new(info[3], port, host)
-          socket = specific_address.socket(
-            connect_timeout, ssl_options, connect_timeout: connect_timeout)
-          socket.close
-          return specific_address
-        rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e
-          error = e
-        end
-      end
-      raise error
-    end
-
     def parse_host_port
       address = seed.downcase
       case address
@@ -221,5 +277,17 @@ module Mongo
         else IPv4.parse(address)
       end
     end
+
+    def map_exceptions
+      begin
+        yield
+      rescue Errno::ETIMEDOUT => e
+        raise Error::SocketTimeoutError, "#{e.class}: #{e} (for #{self})"
+      rescue IOError, SystemCallError => e
+        raise Error::SocketError, "#{e.class}: #{e} (for #{self})"
+      rescue OpenSSL::SSL::SSLError => e
+        raise Error::SocketError, "#{e.class}: #{e} (for #{self}) (#{SSL_ERROR})"
+      end
+    end
   end
 end