mongo 1.12.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 756bee5f8dcecc237006f5ebfe8d4087ae06f855
-  data.tar.gz: c504ef1e1492dee4ff6e5bdab83fac92cdf54069
+  metadata.gz: f1b1c17b52cc160be41aa083e33789a71d99b6b8
+  data.tar.gz: ba505d3b59d858a210a570670a98c6baded60489
 SHA512:
-  metadata.gz: d87e98fa9b33d9d446128a61efc85e0b7e0c67ebfd58bc2e42758156a4794d2c5aa09ff4dd3a87900b1593213145d813aa663df58d6d1fb11325441214fc29fe
-  data.tar.gz: 07ec6387420ed99a2308266fa50342de858f0fbac16ee308853f2fe36e633901e61c160b67ad292e1cc25b47135ae19267ec08d14fea3cb8a7e3f3b4fa6d4916
+  metadata.gz: 9e770b0aee96c3226681ae96fb0de826fbb4c10ddb8851bd4d9ce763b0cd6d8c1067ec50f42748d84ac31e1ca009e641d2f7f66e780166a8cd4adc33e9db6183
+  data.tar.gz: 5a34d970f35bcd33d06dbfc61ae533cd05a5f585bb242d9e591805d3545902d2cfd74071587bbd47f997318ad9012012c3ad4d951ca0f79ce9c5488324d890cf

data/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+## 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.
+
+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
+
+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.
+
+Talk To Us
+----------
+
+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).

data/LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright (C) 2008-2013 MongoDB, Inc.
+   Copyright (C) 2009-2015 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

@@ -2,103 +2,20 @@ MongoDB Ruby Driver [![Build Status][travis-img]][travis-url] [![Code Climate][c
 -----
 The officially supported Ruby driver for [MongoDB](http://www.mongodb.org).
 
-Installation
+Documentation
 -----
 
-**Gem Installation**<br>
-The Ruby driver is released and distributed through RubyGems and it can be installed with the following command:
+Documentation is located [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
 
-```bash
-gem install mongo
-```
-
-For a significant performance boost, you'll want to install the C-extension:
-
-```bash
-gem install bson_ext
-```
-
-**Github Installation**<br>
-For development and test environments (not recommended for production) you can also install the Ruby driver directly from source:
-
-```bash
-# clone the repository
-git clone https://github.com/mongodb/mongo-ruby-driver.git
-cd mongo-ruby-driver
-
-# checkout a specific version by tag (optional)
-git checkout 1.x.x
-
-# install all development dependencies
-gem install bundler
-bundle install
-
-# install the ruby driver
-rake install
-```
-
-To be able to use the driver with Kerberos authentication enabled, install the
-`mongo_kerberos` gem and add it instead of mongo to your application:
-
-```bash
-gem install mongo_kerberos
-```
-
-```ruby
-require 'mongo_kerberos'
-```
-
-Usage
------
-Here is a quick example of basic usage for the Ruby driver:
-
-```ruby
-require 'mongo'
-include Mongo
-
-# connecting to the database
-client = MongoClient.new # defaults to localhost:27017
-db     = client['example-db']
-coll   = db['example-collection']
-
-# inserting documents
-10.times { |i| coll.insert({ :count => i+1 }) }
-
-# finding documents
-puts "There are #{coll.count} total documents. Here they are:"
-coll.find.each { |doc| puts doc.inspect }
-
-# updating documents
-coll.update({ :count => 5 }, { :count => 'foobar' })
-
-# removing documents
-coll.remove({ :count => 8 })
-coll.remove
-```
-
-Wiki - Tutorials & Examples
------
-For many more usage examples and a full tutorial, please visit our [wiki](https://github.com/mongodb/mongo-ruby-driver/wiki).<br>
-
-API Reference Documentation
------
-For API reference documentation, please visit [here](http://api.mongodb.org/ruby).
-
-Compatibility
------
-The MongoDB Ruby driver requires Ruby 1.8.7 or greater and is regularly tested against the platforms and environments listed below.
-
-Ruby Platforms | Operating Systems | Architectures
--------------- | ----------------- | -------------
-MRI 1.8.7, 1.9.3, 2.0.0<br>JRuby 1.7.x | Windows<br>Linux<br>OS X | x86<br>x64<br>ARM
+API docs can be found [here](http://api.mongodb.org/ruby/).
 
 Support & Feedback
 -----
 
-**Support Channels**
-
-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'll get a quicker answer on the [mongodb-user list](http://groups.google.com/group/mongodb-user) Google Group.
+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
 -----
@@ -111,45 +28,23 @@ Do you have a bug to report or a feature request to make?
 
 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.
 
-**HOW TO ASK FOR HELP**
-
-Providing enough information so we can reproduce the issue immediately will reduce roundtrip communications and get you a useful response as quickly as possible.
-That said, please provide the following information when logging an issue:
+**PLEASE DO**
 
-1. Environment
-2. Ruby version, including patch-level
-3. MongoDB version
-4. A test case or code snippets
-5. Stack traces and log data, keeping in mind that this info is public
+* 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.
 
 **PLEASE DO NOT**
 
 * Provide any sensitive data or server logs.
 * Report potential security issues publicly (see 'Security Issues').
 
-**EXAMPLE BUG REPORT**
-
-Example taken from [RUBY-775](https://jira.mongodb.org/browse/RUBY-775)
-
-```
-There appears to be a recursive locking condition in the replica set connection pooling.
-
-Environment: AWS Linux 3.10.37-47.135.amzn1.x86_64 / jruby-1.7.12 / JDK java-1.7.0-openjdk-1.7.0.55-2.4.7.1.40.amzn1.x86_64
-
-Component: Connection Pooling / Replica set
-
-Here is a stack trace:
-https://gist.githubusercontent.com/cheald/5ed01172c5b2c9943c87/raw/63075158dac4c78c1775cac8bf84ba3b6537bc1e/gistfile1.txt
-
-The original lock occurs [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L60)
-
-and then the process of reconnecting ends up attempting to resynchronize the same lock [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L150)
-```
-
 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).
+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
 -----
@@ -159,7 +54,7 @@ Full release notes and release history are available [here](https://github.com/m
 License
 -----
 
- Copyright (C) 2009-2013 MongoDB, Inc.
+ Copyright (C) 2009-2015 MongoDB, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -175,9 +70,9 @@ License
 
 [rubygems-img]: https://badge.fury.io/rb/mongo.png
 [rubygems-url]: http://badge.fury.io/rb/mongo
-[travis-img]: https://secure.travis-ci.org/mongodb/mongo-ruby-driver.png?branch=1.x-stable
-[travis-url]: http://travis-ci.org/mongodb/mongo-ruby-driver?branch=1.x-stable
-[codeclimate-img]: https://codeclimate.com/github/mongodb/mongo-ruby-driver.png?branch=1.x-stable
-[codeclimate-url]: https://codeclimate.com/github/mongodb/mongo-ruby-driver?branch=1.x-stable
-[coveralls-img]: https://coveralls.io/repos/mongodb/mongo-ruby-driver/badge.png?branch=1.x-stable
-[coveralls-url]: https://coveralls.io/r/mongodb/mongo-ruby-driver?branch=1.x-stable
+[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
+[coveralls-img]: https://coveralls.io/repos/mongodb/mongo-ruby-driver/badge.png?branch=master
+[coveralls-url]: https://coveralls.io/r/mongodb/mongo-ruby-driver?branch=master

data/Rakefile

@@ -1,31 +1,49 @@
-# Copyright (C) 2009-2013 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.
+#!/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`.'
+  raise '[FAIL] Bundler not found! Install it with ' +
+        '`gem install bundler; bundle install`.'
 end
 
-rake_tasks = Dir.glob(File.join('tasks', '**', '*.rake')).sort
-if ENV.keys.any? { |k| k.end_with?('_CI') }
-  Bundler.require(:default, :testing)
-  rake_tasks.reject! { |r| r =~ /deploy/ }
-else
-  Bundler.require(:default, :testing, :deploy, :development)
+default_groups = [:default, :testing]
+Bundler.require(*default_groups)
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace :spec do
+  if RUBY_VERSION > '1.9' && RUBY_VERSION < '2.2'
+    require 'coveralls/rake/task'
+    Coveralls::RakeTask.new
+    task :ci => [:spec, 'coveralls:push']
+  else
+    task :ci => [:spec]
+  end
 end
 
-rake_tasks.each { |rake| load File.expand_path(rake) }
+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"
+end
+
+desc "Generate all documentation"
+task :docs => 'docs:yard'
+
+namespace :docs do
+  desc "Generate yard documention"
+  task :yard do
+    out = File.join('docs', Mongo::VERSION)
+    FileUtils.rm_rf(out)
+    system "yardoc -o #{out} --title mongo-#{Mongo::VERSION}"
+  end
+end

data/bin/mongo_console

@@ -1,43 +1,11 @@
 #!/usr/bin/env ruby
 
-# Copyright (C) 2009-2013 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.
-
-org_argv = ARGV.dup
-ARGV.clear
-
-$LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
+$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'pry'
 require 'mongo'
-include Mongo
 
-host = org_argv[0] || ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
-port = org_argv[1] || ENV['MONGO_RUBY_DRIVER_PORT'] || MongoClient::DEFAULT_PORT
-dbnm = org_argv[2] || ENV['MONGO_RUBY_DRIVER_DB']   || 'ruby-mongo-console'
-
-puts "Connecting to #{host}:#{port} (CLIENT) on with database #{dbnm} (DB)"
-CLIENT = MongoClient.new(host, port)
-DB = CLIENT.db(dbnm)
-
-# try pry if available, fall back to irb
-begin
-  require 'pry'
-  CONSOLE_CLASS = Pry
-rescue LoadError
-  require 'irb'
-  CONSOLE_CLASS = IRB
-end
+# include the mongo namespace
+include Mongo
 
-puts "Starting #{CONSOLE_CLASS.name} session..."
-CONSOLE_CLASS.start(__FILE__)
+Pry.config.prompt_name = 'mongo'
+Pry.start

data/lib/mongo/address/ipv4.rb

@@ -0,0 +1,85 @@
+# Copyright (C) 2014-2015 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.
+
+module Mongo
+  class Address
+
+    # Sets up resolution with IPv4 support if the address is an ip
+    # address.
+    #
+    # @since 2.0.0
+    class IPv4
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ Integer ] port The port.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match an IPv4 ip address.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('/\./').freeze
+
+      # Initialize the IPv4 resolver.
+      #
+      # @example Initialize the resolver.
+      #   IPv4.new("127.0.0.1:28011")
+      #
+      # @param [ String ] address The address to resolve.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        parts = address.split(':')
+        @host = parts[0]
+        @port = (parts[1] || 27017).to_i
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get an IPv4 socket.
+      #   ipv4.socket(5, :ssl => true)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options.
+      #
+      # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        unless ssl_options.empty?
+          Socket::SSL.new(host, port, timeout, Socket::PF_INET, ssl_options)
+        else
+          Socket::TCP.new(host, port, timeout, Socket::PF_INET)
+        end
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      def to_s
+        "#{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/mongo/address/ipv6.rb

@@ -0,0 +1,85 @@
+# Copyright (C) 2014-2015 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.
+
+module Mongo
+  class Address
+
+    # Sets up resolution with IPv6 support if the address is an ip
+    # address.
+    #
+    # @since 2.0.0
+    class IPv6
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ Integer ] port The port.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match an IPv6 ip address.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('::').freeze
+
+      # Initialize the IPv6 resolver.
+      #
+      # @example Initialize the resolver.
+      #   IPv6.new("[::1]:28011")
+      #
+      # @param [ String ] address The address to resolve.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        parts = address.match(/\[(.+)\]:?(.+)?/)
+        @host = parts[1]
+        @port = (parts[2] || 27017).to_i
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get an IPv6 socket.
+      #   ipv4.socket(5, :ssl => true)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options.
+      #
+      # @return [ Pool::Socket::SSL, Pool::Socket::TCP ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        unless ssl_options.empty?
+          Socket::SSL.new(host, port, timeout, Socket::PF_INET6, ssl_options)
+        else
+          Socket::TCP.new(host, port, timeout, Socket::PF_INET6)
+        end
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      def to_s
+        "#{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/mongo/address/unix.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2014-2015 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.
+
+module Mongo
+  class Address
+
+    # Sets up socket addresses.
+    #
+    # @since 2.0.0
+    class Unix
+
+      # @return [ String ] host The original host name.
+      attr_reader :host
+
+      # @return [ nil ] port Will always be nil.
+      attr_reader :port
+
+      # @return [ String ] seed The seed address.
+      attr_reader :seed
+
+      # The regular expression to use to match a socket path.
+      #
+      # @since 2.0.0
+      MATCH = Regexp.new('\.sock').freeze
+
+      # Initialize the socket resolver.
+      #
+      # @example Initialize the resolver.
+      #   Sock.new("/path/to/socket.sock")
+      #
+      # @param [ String ] address The socket path.
+      #
+      # @since 2.0.0
+      def initialize(address)
+        @host = address
+        @seed = address
+      end
+
+      # Get a socket for the provided address type, given the options.
+      #
+      # @example Get a Unix socket.
+      #   ipv4.socket(5)
+      #
+      # @param [ Float ] timeout The socket timeout.
+      # @param [ Hash ] ssl_options SSL options - ignored.
+      #
+      # @return [ Pool::Socket::Unix ] The socket.
+      #
+      # @since 2.0.0
+      def socket(timeout, ssl_options = {})
+        Socket::Unix.new(host, timeout, Socket::AF_UNIX)
+      end
+
+      # Get the address as a string.
+      #
+      # @example Get the address as a string.
+      #   ipv4.to_s
+      #
+      # @return [ String ] The nice string.
+      #
+      # @since 2.0.0
+      alias :to_s :host
+    end
+  end
+end