RubyGems - mongo - Versions diffs - 2.11.4 → 2.18.1 - Mend

mongo 2.11.4 → 2.18.1

Files changed (1659) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3363520c62689e2f649389acd84f68b46dba99a62d82c174c77414f66e055dd
-  data.tar.gz: 7b1a54bcc8657047ec15b61cdf39588965fc9328d0ac56aa294f7891ef7fb3e2
+  metadata.gz: 664d381d4746fb4ff6282069f909a91a58f497220bae57656c265f52c5d99040
+  data.tar.gz: 85fa7fbf071c3e8fc4c1beb2215b3297a3af560130204dbd0f916adb272987f7
 SHA512:
-  metadata.gz: 546bfab9a6042f6194f87efc8f19fa92ee9828040d1f34a98045e243cce6f056837e4144856a37803f964cf345724ccfdeb6eb2d407f265b4a02e7a14622f0a1
-  data.tar.gz: 9eb09ae2c44b3cee7cd9c082af7702b0acd4b56674a6c17b3959c05f654987b3b34f6d87c8d74d9863f312addc01a8de090899a879847d014fa0e7c9baa217d6
+  metadata.gz: 2dcf66e773da4e2bdaf0a22d15a06eadbc5ab2bccffc29f012e2ae863e8148b597550ee680dc2556b40408f4c759b78b159b678cf494cf619c0975044d72d662
+  data.tar.gz: c120607792132931a54511db0a4ef62653393138e9da3fcf0ca0f0a85fde3aefe6b04782fd09125b0fe3085e50c66b1cd2f6e0c4743ae40e7094dc8e7892587a

checksums.yaml.gz.sig CHANGED Viewed

Binary file

data/CONTRIBUTING.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -1,111 +1,99 @@
-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/).
-Documentation
--------------
+The Ruby driver supports Ruby 2.5-3.0 and JRuby 9.2.
+## 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/).
-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.
-Bugs & Feature Requests
------------------------
-Do you have a bug to report or a feature request to make?
-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.
-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**
-* 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.
+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`.
-**PLEASE DO NOT**
+## Support
-* Provide any sensitive data or server logs.
-* Report potential security issues publicly (see 'Security Issues').
+Commercial support for the driver is available through the
+[MongoDB Support Portal](https://support.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).
-Security Issues
----------------
+Please see [Technical Support](https://mongodb.com/docs/manual/support/) page
+in the documentation for other support resources.
-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).
+## Bugs & Feature Requests
+To report a bug in the driver or request a feature specific to the Ruby driver:
-Running Tests
--------------
+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.
-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:
+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.
-    mkdir /tmp/mrb
-    mongod --dbpath /tmp/mrb --bind_ip 127.0.0.1 --setParameter enableTestCommands=1
+**PLEASE DO:**
-... then run the tests:
+- 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.
-    bundle exec rake
+**PLEASE DO NOT:**
-It is possible to run tests in a specific file, as well as use other
-test invocations supported by RSpec:
+- Provide any sensitive data or server logs.
+- Report potential security issues publicly (see 'Security Issues' below).
-    bundle exec rspec path/to/spec.rb:42
+## Security Issues
-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:
+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).
-    bundle exec rake spec:prepare
+## Product Feature Requests
-For further information about supported cluster configurations and how to
-configure the test suite, please see the README in the spec directory.
+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
-Release History
----------------
+Please refer to [spec/README.md](spec/README.md) for instructions on how
+to run the driver's test suite.
-Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
+## 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-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.
-   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
-[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 CHANGED Viewed

@@ -1,19 +1,36 @@
-#!/usr/bin/env 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)
+# -*- mode: ruby -*-
+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 'mrss/spec_organizer'
+CLASSIFIERS = [
+  [%r,^mongo/server,, :unit_server],
+  [%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 unit_server
+  integration sdam_integration cursor_reaping query_cache
+  spec spec_sdam_integration
+)
 tasks = Rake.application.instance_variable_get('@tasks')
 tasks['release:do'] = tasks.delete('release')
@@ -45,16 +62,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 +88,29 @@ namespace :spec do
     SpecConfig.instance.print_summary
   end
-  task :ci => ['spec:prepare', :spec]
+  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
 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/active_support.rb CHANGED Viewed

@@ -1,4 +1,7 @@
-# Copyright (C) 2019 MongoDB Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+# 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/ipv4.rb CHANGED Viewed

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+# 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 +81,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

data/lib/mongo/address/ipv6.rb CHANGED Viewed

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+# 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.
@@ -92,17 +95,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_INET6, 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_INET6, options)
         else
           Socket::TCP.new(host, port, socket_timeout, Socket::PF_INET6, options)
         end

data/lib/mongo/address/unix.rb CHANGED Viewed

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+# 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.
@@ -63,7 +66,6 @@ module Mongo
       #   address.socket(5)
       #
       # @param [ Float ] socket_timeout The socket timeout.
-      # @param [ Hash ] ssl_options SSL options - ignored.
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout.
@@ -71,7 +73,8 @@ module Mongo
       # @return [ Mongo::Socket::Unix ] The socket.
       #
       # @since 2.0.0
-      def socket(socket_timeout, ssl_options = {}, options = {})
+      # @api private
+      def socket(socket_timeout, options = {})
         Socket::Unix.new(host, socket_timeout, options)
       end
     end

data/lib/mongo/address/validator.rb CHANGED Viewed

@@ -1,4 +1,7 @@
-# Copyright (C) 2017-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+# Copyright (C) 2017-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.