mongo 2.4.1 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9112b76649bf922ef773b7a9018ad8b46de12760
-  data.tar.gz: d152ad097652a5c4ec4351f9c86a58de77c44977
+SHA256:
+  metadata.gz: 7bfb22d052a842e256744a88c7e3cbd3b958643cc3e0f4425bf97be8f913f167
+  data.tar.gz: b63f3605ad8223e99a5f6a62aabff94a8c8600095b84265b6b4deb38e7223013
 SHA512:
-  metadata.gz: dbdc8eeb2763a4ce969c20323188997bdc37e7f8b1f0b54fe8ef4288141ec3a43bd61f1e3f8d89b46bae2c8ae875068bc583e3b17eff1631319da2342c283c86
-  data.tar.gz: 6ca6c80afad5e7882d5c31f5a6c2446a01fb5ed46c1de13f5d8df6dd78d47636ce9253522150dcbf7844f768a07f56670a15bcb264e5c4a9c03475437f302c22
+  metadata.gz: 85566c0080b9bcfa67438a365114dd062425df557040e05c0db0448aedd37a0f52dae5b8612b08af196a9e35c1e5b41553a89607d780d187d4e2e28602471c76
+  data.tar.gz: 5172ab2d71a8d7e048fcb2d87e7219024a2028c3909f2cce48081d1b3014071df13b02426019508bda6542e4870992ca869cd3393caf3aaf6483ad4c74f1abf3

data/CONTRIBUTING.md

@@ -1,64 +1,22 @@
-## Contributing to the MongoDB Ruby Driver
+# Contributing to the MongoDB Ruby Driver
 
 Thank you for your interest in contributing to the MongoDB Ruby driver.
 
-We are building this software together and strongly encourage contributions
-from the community that are within the guidelines set forth below.
-
-Bug Fixes and New Features
---------------------------
-
-Before starting to write code, look for existing [tickets]
-(https://jira.mongodb.org/browse/RUBY) or [create one]
-(https://jira.mongodb.org/secure/CreateIssue!default.jspa) 
-for your bug, issue, or feature request. This helps the community
-avoid working on something that might not be of interest or which
-has already been addressed.
-
-Environment
------------
-
-We highly suggest using [RVM](https://rvm.io/) or [rbenv]
-(https://github.com/sstephenson/rbenv) to set up Ruby development and
-testing environments. In this way, moving between and testing code for
-alternate Ruby versions (besides the one possibly included with your 
-system) is simple. This practice is essential for ensuring the quality
-of the driver.
+We are building this software together and appreciate and encourage
+contributions from the community.
 
 Pull Requests
 -------------
 
-Pull requests should be made against the master (development)
-branch and include relevant tests, if applicable. The driver follows
-the Git-Flow branching model where the traditional master branch is
-known as release and the master (default) branch is considered under
-development.
-
-Tests should pass under all Ruby interpreters which the MongoDB Ruby 
-driver currently supports (1.8.7, 1.9.3, JRuby 1.6.x and 1.7.x) and will be 
-automatically tested.
-
-The results of pull request testing will be appended to the request.
-If any tests do not pass, or relavant tests are not included the pull
-request will not be considered.
-
-Clusters and Replica Sets
--------------------------
-
-If your bug fix or enhancement deals with Cluster or Replica Set
-code, please run all relevant tests for those code subsets before
-issuing the request.
-
-* `rake test:sharded_cluster` for sharded clusters
-* `rake test:replica_set` for replica sets
+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.
 
-Cluster and Replica Set testing is currently **not** automatically
-performed so it is important they are run in a thorough fashion under
-all supported interpreters before a pull request is made.
+JIRA Tickets
+------------
 
-Talk To Us
-----------
+The Ruby driver team uses [MongoDB JIRA](https://jira.mongodb.org/browse/RUBY)
+to schedule and track work.
 
-We love to hear from you. If you want to work on something or have
-questions / complaints please reach out to us by creating a [question]
-(https://jira.mongodb.org/secure/CreateIssue.jspa?pid=10005&issuetype=6).
+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-2016 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,69 +1,98 @@
-MongoDB Ruby Driver [![Build Status][travis-img]][travis-url] [![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
------
+-------------
 
-Documentation is located [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
+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
------
 
-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.
+Support
+-------
 
-Bugs & Feature Requests
------
+Commercial support for the driver is available through the
+[MongoDB Support Portal](https://support.mongodb.com/).
 
-Do you have a bug to report or a feature request to make?
+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).
 
-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.
+Please see [Technical Support](https://docs.mongodb.com/manual/support/) page
+in the documentation for other support resources.
 
-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.
 
-**PLEASE DO**
+Bugs & Feature Requests
+-----------------------
 
-* 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.
+To report a bug in the driver or request a feature specific to the Ruby driver:
 
-**PLEASE DO NOT**
+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.
 
-* Provide any sensitive data or server logs.
-* Report potential security issues publicly (see 'Security Issues').
+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.
 
-Running Tests
------
+**PLEASE DO:**
 
-The driver uses RSpec as it's primary testing tool. To run all tests simple run `rspec`.
+- 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.
 
-To run a test at a specific location (where `42` is the line number), use:
+**PLEASE DO NOT:**
+
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
 
-    rspec path/to/spec.rb:42
 
 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
+------------------------
+
+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
+-------------
+
+Please refer to [spec/README.md](spec/README.md) for instructions on how
+to run the driver's test suite.
 
-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).
 
 Release History
------
+---------------
+
+Full release notes and release history are available [on the GitHub releases
+page](https://github.com/mongodb/mongo-ruby-driver/releases).
 
-Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
 
 License
------
+-------
 
- Copyright (C) 2009-2016 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.
@@ -77,9 +106,7 @@ License
    See the License for the specific language governing permissions and
    limitations under the License.
 
-[rubygems-img]: https://badge.fury.io/rb/mongo.png
+[rubygems-img]: https://badge.fury.io/rb/mongo.svg
 [rubygems-url]: http://badge.fury.io/rb/mongo
-[travis-img]: https://secure.travis-ci.org/mongodb/mongo-ruby-driver.png?branch=master
-[travis-url]: http://travis-ci.org/mongodb/mongo-ruby-driver?branch=master
-[codeclimate-img]: https://codeclimate.com/github/mongodb/mongo-ruby-driver.png?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

@@ -13,23 +13,118 @@ end
 default_groups = [:default, :testing]
 Bundler.require(*default_groups)
 
+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,, :unit],
+  [%r,^kerberos,, :unit],
+  [%r,^integration/sdam_error_handling,, :sdam_integration],
+  [%r,^integration/cursor_reaping,, :cursor_reaping],
+  [%r,^integration/query_cache,, :query_cache],
+  [%r,^integration/transactions_examples,, :tx_examples],
+  [%r,^(atlas|integration),, :integration],
+  [%r,^spec_tests/sdam_integration,, :spec_sdam_integration],
+  [%r,^spec_tests,, :spec],
+]
+
+RUN_PRIORITY = %i(
+  tx_examples
+  unit
+  integration sdam_integration cursor_reaping query_cache
+  spec spec_sdam_integration
+)
+
+tasks = Rake.application.instance_variable_get('@tasks')
+tasks['release:do'] = tasks.delete('release')
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  #t.rspec_opts = "--profile 5" if ENV['CI']
+end
 
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task :default => ['spec:prepare', :spec]
 
 namespace :spec do
-  task :ci => [:spec]
+  desc 'Creates necessary user accounts in the cluster'
+  task :prepare do
+    $: << File.join(File.dirname(__FILE__), 'spec')
+
+    require 'support/utils'
+    require 'support/spec_setup'
+    SpecSetup.new.run
+  end
+
+  desc 'Waits for sessions to be available in the deployment'
+  task :wait_for_sessions do
+    $: << File.join(File.dirname(__FILE__), 'spec')
+
+    require 'support/utils'
+    require 'support/spec_config'
+    require 'support/client_registry'
+
+    client = ClientRegistry.instance.global_client('authorized')
+    client.database.command(ping: 1)
+    deadline = Time.now + 300
+    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
+    end
+  end
+
+  desc 'Prints configuration used by the test suite'
+  task :config do
+    $: << File.join(File.dirname(__FILE__), 'spec')
+
+    # Since this task is usually used for troubleshooting of test suite
+    # configuration, leave driver log level at the default of debug to
+    # have connection diagnostics printed during handshakes and such.
+    require 'support/utils'
+    require 'support/spec_config'
+    require 'support/client_registry'
+    SpecConfig.instance.print_summary
+  end
+
+  def spec_organizer
+    Mrss::SpecOrganizer.new(
+      root: ROOT,
+      classifiers: CLASSIFIERS,
+      priority_order: RUN_PRIORITY,
+    )
+  end
+
+  task :ci => ['spec:prepare'] do
+    spec_organizer.run
+  end
+
+  desc 'Show test buckets'
+  task :buckets do
+    spec_organizer.ordered_buckets.each do |category, paths|
+      puts "#{category || 'remaining'}: #{paths&.join(' ') || '<none>'}"
+    end
+  end
 end
 
-task :release => :spec do
-  system "git tag -a #{Mongo::VERSION} -m 'Tagging release: #{Mongo::VERSION}'"
-  system "git push --tags"
-  system "gem build mongo.gemspec"
-  system "gem push mongo-#{Mongo::VERSION}.gem"
-  system "rm mongo-#{Mongo::VERSION}.gem"
+namespace :release do
+  task :check_private_key do
+    unless File.exist?('gem-private_key.pem')
+      raise "No private key present, cannot release"
+    end
+  end
 end
 
+task :release => ['release:check_private_key', 'release:do']
+
 desc "Generate all documentation"
 task :docs => 'docs:yard'
 

data/lib/mongo/active_support.rb

@@ -0,0 +1,17 @@
+# 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.
+# 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.
+
+# Require this file if using the Ruby drver with ActiveSupport.
+
+require "bson/active_support"

data/lib/mongo/address/ipv4.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 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.
@@ -77,17 +77,47 @@ module Mongo
       # @example Get an IPv4 socket.
       #   ipv4.socket(5, :ssl => true)
       #
-      # @param [ Float ] timeout The socket timeout.
-      # @param [ Hash ] ssl_options SSL options.
+      # @param [ Float ] socket_timeout The socket timeout.
+      # @param [ Hash ] options The options.
       #
-      # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      # @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(timeout, ssl_options = {})
-        unless ssl_options.empty?
-          Socket::SSL.new(host, port, host_name, timeout, Socket::PF_INET, ssl_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, timeout, Socket::PF_INET)
+          Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET, options)
         end
       end
     end

data/lib/mongo/address/ipv6.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 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.
@@ -38,7 +38,7 @@ module Mongo
       # Parse an IPv6 address into its host and port.
       #
       # @example Parse the address.
-      #   IPv4.parse("[::1]:28011")
+      #   IPv6.parse("[::1]:28011")
       #
       # @param [ String ] address The address to parse.
       #
@@ -46,9 +46,28 @@ module Mongo
       #
       # @since 2.0.0
       def self.parse(address)
-        parts = address.match(/\[(.+)\]:?(.+)?/)
-        host = parts[1]
-        port = (parts[2] || 27017).to_i
+        # IPAddr's parser handles IP address only, not port.
+        # Therefore we need to handle the port ourselves
+        if address =~ /[\[\]]/
+          parts = address.match(/\A\[(.+)\](?::(\d+))?\z/)
+          if parts.nil?
+            raise ArgumentError, "Invalid IPv6 address: #{address}"
+          end
+          host = parts[1]
+          port = (parts[2] || 27017).to_i
+        else
+          host = address
+          port = 27017
+        end
+        # Validate host.
+        # This will raise IPAddr::InvalidAddressError
+        # on newer rubies which is a subclass of ArgumentError
+        # if host is invalid
+        begin
+          IPAddr.new(host)
+        rescue ArgumentError
+          raise ArgumentError, "Invalid IPv6 address: #{address}"
+        end
         [ host, port ]
       end
 
@@ -72,17 +91,47 @@ module Mongo
       # @example Get an IPv6 socket.
       #   ipv4.socket(5, :ssl => true)
       #
-      # @param [ Float ] timeout The socket timeout.
-      # @param [ Hash ] ssl_options SSL options.
+      # @param [ Float ] socket_timeout The socket timeout.
+      # @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 [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      # @return [ Mongo::Socket::SSL, Mongo::Socket::TCP ] The socket.
       #
       # @since 2.0.0
-      def socket(timeout, ssl_options = {})
-        unless ssl_options.empty?
-          Socket::SSL.new(host, port, host_name, timeout, Socket::PF_INET6, ssl_options)
+      # @api private
+      def socket(socket_timeout, options = {})
+        if options[:ssl]
+          Socket::SSL.new(host, port, host_name, socket_timeout, Socket::PF_INET6, options)
         else
-          Socket::TCP.new(host, port, timeout, Socket::PF_INET6)
+          Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET6, options)
         end
       end
     end

data/lib/mongo/address/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2016 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.
@@ -62,14 +62,17 @@ module Mongo
       # @example Get a Unix socket.
       #   address.socket(5)
       #
-      # @param [ Float ] timeout The socket timeout.
-      # @param [ Hash ] ssl_options SSL options - ignored.
+      # @param [ Float ] socket_timeout The socket timeout.
+      # @param [ Hash ] options The options.
       #
-      # @return [ Pool::Socket::Unix ] The socket.
+      # @option options [ Float ] :connect_timeout Connect timeout.
+      #
+      # @return [ Mongo::Socket::Unix ] The socket.
       #
       # @since 2.0.0
-      def socket(timeout, ssl_options = {})
-        Socket::Unix.new(host, timeout)
+      # @api private
+      def socket(socket_timeout, options = {})
+        Socket::Unix.new(host, socket_timeout, options)
       end
     end
   end