mongo 1.8.6 → 1.12.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bdb78ad2291ea3ecb387526ccdbd162ffd51687
-  data.tar.gz: 6b3ec42fadc3f0beea953a08fe07a2d2ff206cba
+  metadata.gz: 756bee5f8dcecc237006f5ebfe8d4087ae06f855
+  data.tar.gz: c504ef1e1492dee4ff6e5bdab83fac92cdf54069
 SHA512:
-  metadata.gz: 83bb86f711779590a47d0d8d83fea4d844cd8ebdcde6617109c9172dd9d6961688d3faf03c1c7d0c0601575ed1a253522aecc2b26f2e81fb7980079ca3dff9fd
-  data.tar.gz: 880a70826f29e9e60fff3d26ede30390da593e78ad095f635743ffec711ce22af34da2d89318fd48f7825e2583bbec02da80c78899d4388386a76c769ee1e80e
+  metadata.gz: d87e98fa9b33d9d446128a61efc85e0b7e0c67ebfd58bc2e42758156a4794d2c5aa09ff4dd3a87900b1593213145d813aa663df58d6d1fb11325441214fc29fe
+  data.tar.gz: 07ec6387420ed99a2308266fa50342de858f0fbac16ee308853f2fe36e633901e61c160b67ad292e1cc25b47135ae19267ec08d14fea3cb8a7e3f3b4fa6d4916

data/LICENSE

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

data/README.md

@@ -1,342 +1,165 @@
-[![Build Status][travis-img]][travis-url] [![Jenkins Status][jenkins-img]][jenkins-url] [![Code Climate][codeclimate-img]][codeclimate-url]
+MongoDB Ruby Driver [![Build Status][travis-img]][travis-url] [![Code Climate][codeclimate-img]][codeclimate-url] [![Coverage Status][coveralls-img]][coveralls-url] [![Gem Version][rubygems-img]][rubygems-url]
+-----
+The officially supported Ruby driver for [MongoDB](http://www.mongodb.org).
 
-[travis-img]: https://secure.travis-ci.org/mongodb/mongo-ruby-driver.png
-[travis-url]: http://travis-ci.org/mongodb/mongo-ruby-driver
-[codeclimate-img]: https://codeclimate.com/github/mongodb/mongo-ruby-driver.png
-[codeclimate-url]: https://codeclimate.com/github/mongodb/mongo-ruby-driver
-[jenkins-img]: https://jenkins.10gen.com/job/mongo-ruby-driver/badge/icon
-[jenkins-url]: https://jenkins.10gen.com/job/mongo-ruby-driver/
-[api-url]: http://api.mongodb.org/ruby/current
+Installation
+-----
 
-# Documentation
+**Gem Installation**<br>
+The Ruby driver is released and distributed through RubyGems and it can be installed with the following command:
 
-This API documentation is available online at [http://api.mongodb.org/ruby](http://api.mongodb.org/ruby)
-for all releases of the MongoDB Ruby driver.  Please reference the exact version of the documentation
-that matches the release of the Ruby driver that you are using.  Note that the
-[Ruby Language Center for MongoDB](http://www.mongodb.org/display/DOCS/Ruby+Language+Center)
-has a link to API Documentation for the current release.
-
-If you have the source, you can generate the matching documentation  by typing
-
-    $ rake docs
-
-Once generated, the API documentation can be found in the docs/ folder.
-
-# Introduction
-
-This is the 10gen-supported Ruby driver for [MongoDB](http://www.mongodb.org).
-
-For the api reference please see the [API][api-url]
-
-The [wiki](https://github.com/mongodb/mongo-ruby-driver/wiki) has other articles of interest, including:
-
-1. [A tutorial](https://github.com/mongodb/mongo-ruby-driver/wiki/Tutorial).
-2. [Replica Sets in Ruby](https://github.com/mongodb/mongo-ruby-driver/wiki/Replica-Sets).
-3. [Write Concern in Ruby](https://github.com/mongodb/mongo-ruby-driver/wiki/Write-Concern).
-4. [Tailable Cursors in Ruby](https://github.com/mongodb/mongo-ruby-driver/wiki/Tailable-Cursors).
-5. [Read Preference in Ruby](https://github.com/mongodb/mongo-ruby-driver/wiki/Read-Preference).
-6. [GridFS in Ruby](https://github.com/mongodb/mongo-ruby-driver/wiki/GridFS).
-7. [Frequently Asked Questions](https://github.com/mongodb/mongo-ruby-driver/wiki/FAQ).
-8. [History](https://github.com/mongodb/mongo-ruby-driver/wiki/History).
-9. [Release plan](https://github.com/mongodb/mongo-ruby-driver/wiki/Releases).
-10. [Credits](https://github.com/mongodb/mongo-ruby-driver/wiki/Credits).
-
-Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](https://github.com/mongodb/mongo-ruby-driver/wiki/Tutorial) for much more:
-
-```ruby
-require 'rubygems'
-require 'mongo'
-
-include Mongo
-
-@client = MongoClient.new('localhost', 27017)
-@db     = @client['sample-db']
-@coll   = @db['test']
-
-@coll.remove
-
-3.times do |i|
-  @coll.insert({'a' => i+1})
-end
-
-puts "There are #{@coll.count} records. Here they are:"
-@coll.find.each { |doc| puts doc.inspect }
+```bash
+gem install mongo
 ```
 
-# Installation
-
-### Ruby Versions
-
-The driver works and is consistently tested on Ruby 1.8.7 and 1.9.3 as well as JRuby 1.6.x and 1.7.x.
+For a significant performance boost, you'll want to install the C-extension:
 
-Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. There are some IO bugs in earlier versions.
-
-### Gems
-
-    $ gem update --system
-    $ gem install mongo
-
-For a significant performance boost, you'll want to install the C extension:
-
-    $ gem install bson_ext
-
-Note that bson_ext isn't used with JRuby. Instead, we use some native Java extensions are bundled with the bson gem. If you ever need to modify these extensions, you can recompile with the following rake task:
-
-    $ rake compile:jbson
-
-### From the GitHub source
-
-The source code is available at http://github.com/mongodb/mongo-ruby-driver.
-You can either clone the git repository or download a tarball or zip file.
-Once you have the source, you can use it from wherever you downloaded it or
-you can install it as a gem from the source by typing:
-
-    $ rake install
-
-# Examples
-
-For extensive examples, see the [MongoDB Ruby Tutorial](https://github.com/mongodb/mongo-ruby-driver/wiki/Tutorial).
-
-# GridFS
-
-The Ruby driver include two abstractions for storing large files: Grid and GridFileSystem.
-
-The Grid class is a Ruby implementation of MongoDB's GridFS file storage
-specification. GridFileSystem is essentially the same, but provides a more filesystem-like API and assumes that filenames are unique.
-
-An instance of both classes represents an individual file store. See the API reference for details.
-
-Examples:
-
-```ruby
-# Write a file on disk to the Grid
-file = File.open('image.jpg')
-grid = Mongo::Grid.new(db)
-id   = grid.put(file)
-
-# Retrieve the file
-file = grid.get(id)
-file.read
-
-# Get all the file's metata
-file.filename
-file.content_type
-file.metadata
+```bash
+gem install bson_ext
 ```
 
-# Notes
-
-## Thread Safety
+**Github Installation**<br>
+For development and test environments (not recommended for production) you can also install the Ruby driver directly from source:
 
-The driver is thread-safe.
+```bash
+# clone the repository
+git clone https://github.com/mongodb/mongo-ruby-driver.git
+cd mongo-ruby-driver
 
-## Connection Pooling
+# checkout a specific version by tag (optional)
+git checkout 1.x.x
 
-The driver implements connection pooling. By default, only one
-socket connection will be opened to MongoDB. However, if you're running a
-multi-threaded application, you can specify a maximum pool size and a maximum
-timeout for waiting for old connections to be released to the pool.
+# install all development dependencies
+gem install bundler
+bundle install
 
-To set up a pooled connection to a single MongoDB instance:
-
-```ruby
-  @client = MongoClient.new("localhost", 27017, :pool_size => 5, :timeout => 5)
+# install the ruby driver
+rake install
 ```
 
-Though the pooling architecture will undoubtedly evolve, it currently owes much credit
-to the connection pooling implementations in ActiveRecord and PyMongo.
-
-## Forking
-
-Certain Ruby application servers work by forking, and it has long been necessary to
-re-establish the child process's connection to the database after fork. But with the release
-of v1.3.0, the Ruby driver detects forking and reconnects automatically.
-
-## Environment variable `MONGODB_URI`
-
-`Mongo::MongoClient.from_uri`, `Mongo::MongoClient.new` and `Mongo::MongoReplicaSetClient.new` will use <code>ENV["MONGODB_URI"]</code> if no other args are provided.
-
-The URI must fit this specification:
-
-    mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
-
-If the type of connection (direct or replica set) should be determined entirely from <code>ENV["MONGODB_URI"]</code>, you may want to use `Mongo::MongoClient.from_uri` because it will return either `Mongo::MongoClient` or a `Mongo::MongoReplicaSetClient` depending on how many hosts are specified. Trying to use `Mongo::MongoClient.new` with multiple hosts in <code>ENV["MONGODB_URI"]</code> will raise an exception.
-
-## String Encoding
+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:
 
-The BSON ("Binary JSON") format used to communicate with Mongo requires that
-strings be UTF-8 (http://en.wikipedia.org/wiki/UTF-8).
-
-Ruby 1.9 has built-in character encoding support. All strings sent to Mongo
-and received from Mongo are converted to UTF-8 when necessary, and strings
-read from Mongo will have their character encodings set to UTF-8.
-
-When used with Ruby 1.8, the bytes in each string are written to and read from
-Mongo as is. If the string is ASCII, all is well, because ASCII is a subset of
-UTF-8. If the string is not ASCII, it may not be a well-formed UTF-8
-string.
-
-## Primary Keys
-
-The `_id` field is a primary key. It is treated specially by the database, and
-its use makes many operations more efficient. The value of an _id may be of
-any type. The database itself inserts an _id value if none is specified when
-a record is inserted.
-
-### Primary Key Factories
-
-A primary key factory is a class you supply to a DB object that knows how to
-generate _id values. If you want to control _id values or even their types,
-using a PK factory lets you do so.
-
-You can tell the Ruby Mongo driver how to create primary keys by passing in
-the :pk option to the MongoClient#db method.
-
-```ruby
-include Mongo
-db = MongoClient.new('localhost', 27017).db('dbname', :pk => MyPKFactory.new)
+```bash
+gem install mongo_kerberos
 ```
 
-A primary key factory object must respond to :create_pk, which should
-take a hash and return a hash which merges the original hash with any
-primary key fields the factory wishes to inject.
-
-NOTE: if the object already has a primary key, the factory should not
-inject a new key; this means that the object may already exist in the
-database.  The idea here is that whenever a record is inserted, the
-:pk object's +create_pk+ method will be called and the new hash
-returned will be inserted.
-
-Here is a sample primary key factory, taken from the tests:
-```ruby
-class TestPKFactory
-  def create_pk(doc)
-    doc['_id'] ||= BSON::ObjectId.new
-    doc
-  end
-end
-```
-Here's a slightly more sophisticated one that handles both symbol and string
-keys. This is the PKFactory that comes with the MongoRecord code (an
-ActiveRecord-like framework for non-Rails apps) and the AR Mongo adapter code
-(for Rails):
 ```ruby
-class PKFactory
-  def create_pk(doc)
-    return doc if doc[:_id]
-    doc.delete(:_id)      # in case it exists but the value is nil
-    doc['_id'] ||= BSON::ObjectId.new
-    doc
-  end
-end
+require 'mongo_kerberos'
 ```
 
-A database's PK factory object may be set either when a DB object is created
-or immediately after you obtain it, but only once. The only reason it is
-changeable at all is so that libraries such as MongoRecord that use this
-driver can set the PK factory after obtaining the database but before using it
-for the first time.
-
-## The DB Class
-
-### Strict mode
-
-_**NOTE:** Support for strict mode has been deprecated and will be removed in version 2.0 of the driver._
-
-Each database has an optional strict mode. If strict mode is on, then asking
-for a collection that does not exist will raise an error, as will asking to
-create a collection that already exists. Note that both these operations are
-completely harmless; strict mode is a programmer convenience only.
-
-To turn on strict mode, either pass in :strict => true when obtaining a DB
-object or call the `:strict=` method:
+Usage
+-----
+Here is a quick example of basic usage for the Ruby driver:
 
 ```ruby
-db = MongoClient.new('localhost', 27017).db('dbname', :strict => true)
-# I'm feeling lax
-db.strict = false
-# No, I'm not!
-db.strict = true
-```
-
-The method DB#strict? returns the current value of that flag.
-
-## Cursors
+require 'mongo'
+include Mongo
 
-Notes:
+# connecting to the database
+client = MongoClient.new # defaults to localhost:27017
+db     = client['example-db']
+coll   = db['example-collection']
 
-* Cursors are enumerable (and have a #to_a method).
+# inserting documents
+10.times { |i| coll.insert({ :count => i+1 }) }
 
-* The query doesn't get run until you actually attempt to retrieve data from a
-  cursor.
+# finding documents
+puts "There are #{coll.count} total documents. Here they are:"
+coll.find.each { |doc| puts doc.inspect }
 
-* Cursors will timeout on the server after 10 minutes. If you need to keep a cursor
-  open for more than 10 minutes, specify `:timeout => false` when you create the cursor.
+# updating documents
+coll.update({ :count => 5 }, { :count => 'foobar' })
 
-## Socket timeouts
+# removing documents
+coll.remove({ :count => 8 })
+coll.remove
+```
 
-The Ruby driver support timeouts on socket read operations. To enable them, set the
-`:op_timeout` option when you create a `Mongo::MongoClient` object.
+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>
 
-If implementing higher-level timeouts, using tools like `Rack::Timeout`, it's very important
-to call `Mongo::MongoClient#close` to prevent the subsequent operation from receiving the previous
-request.
+API Reference Documentation
+-----
+For API reference documentation, please visit [here](http://api.mongodb.org/ruby).
 
-# Testing
+Compatibility
+-----
+The MongoDB Ruby driver requires Ruby 1.8.7 or greater and is regularly tested against the platforms and environments listed below.
 
-Before running the tests, make sure you install all test dependencies by running:
+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
 
-    $ gem install bundler; bundle install
+Support & Feedback
+-----
 
-To run all default test suites (without the BSON extensions) just type:
+**Support Channels**
 
-    $ rake test
+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.
 
-If you want to run the default test suite using the BSON extensions:
+Bugs & Feature Requests
+-----
 
-    $ rake test:ext
+Do you have a bug to report or a feature request to make?
 
-These will run both unit and functional tests. To run these tests alone:
+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.
 
-    $ rake test:unit
-    $ rake test:functional
+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.
 
-To run any individual rake tasks with the BSON extension disabled, just pass BSON_EXT_DISABLED=true to the task:
+**HOW TO ASK FOR HELP**
 
-    $ rake test:unit BSON_EXT_DISABLED=true
+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:
 
-If you want to test replica set, you can run the following task:
+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
 
-    $ rake test:replica_set
+**PLEASE DO NOT**
 
-To run a single test at the top level, add -Itest since we no longer modify LOAD_PATH:
+* Provide any sensitive data or server logs.
+* Report potential security issues publicly (see 'Security Issues').
 
-    $ ruby -Itest -Ilib test/bson/bson_test.rb
+**EXAMPLE BUG REPORT**
 
-To run a single test from the test directory, add -I. since we no longer modify LOAD_PATH:
+Example taken from [RUBY-775](https://jira.mongodb.org/browse/RUBY-775)
 
-    $ ruby -I. -I../lib bson/bson_test.rb
+```
+There appears to be a recursive locking condition in the replica set connection pooling.
 
-To run a single test from its subdirectory, add -I.. since we no longer modify LOAD_PATH:
+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
 
-    $ ruby -I.. -I../../lib bson_test.rb
+Component: Connection Pooling / Replica set
 
-To fix the following error on Mac OS X - "/.../lib/bson_ext/cbson.bundle: [BUG] Segmentation fault":
+Here is a stack trace:
+https://gist.githubusercontent.com/cheald/5ed01172c5b2c9943c87/raw/63075158dac4c78c1775cac8bf84ba3b6537bc1e/gistfile1.txt
 
-    $ rake compile
+The original lock occurs [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L60)
 
-# Release Notes
+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)
+```
 
-See [history](https://github.com/mongodb/mongo-ruby-driver/wiki/History).
+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).
 
-# Credits
+Release History
+-----
 
-See [credits](https://github.com/mongodb/mongo-ruby-driver/wiki/Credits).
+Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
 
-# License
+License
+-----
 
- Copyright (C) 2008-2013 10gen Inc.
+ 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.
@@ -349,3 +172,12 @@ See [credits](https://github.com/mongodb/mongo-ruby-driver/wiki/Credits).
    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.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

data/Rakefile

@@ -1,17 +1,31 @@
-# -*- mode: 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.
 
 require 'rubygems'
 
 begin
   require 'bundler'
 rescue LoadError
-  raise '[FAIL] Bundler not found! Install it with `gem install bundler; bundle install`.'
+  raise '[FAIL] Bundler not found! Install it with `gem install bundler && bundle`.'
 end
 
-if ENV.has_key?('TEST') || ENV.has_key?('TRAVIS_TEST')
+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)
 end
 
-Dir.glob(File.join('tasks', '**', '*.rake')).sort.each { |rake| load File.expand_path(rake) }
+rake_tasks.each { |rake| load File.expand_path(rake) }

data/VERSION

@@ -1 +1 @@
-1.8.6
+1.12.5

data/bin/mongo_console

@@ -1,12 +1,25 @@
 #!/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
 
-require 'irb'
-
 $LOAD_PATH[0,0] = File.join(File.dirname(__FILE__), '..', 'lib')
-require 'mongo'
 
+require 'mongo'
 include Mongo
 
 host = org_argv[0] || ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
@@ -17,5 +30,14 @@ puts "Connecting to #{host}:#{port} (CLIENT) on with database #{dbnm} (DB)"
 CLIENT = MongoClient.new(host, port)
 DB = CLIENT.db(dbnm)
 
-puts "Starting IRB session..."
-IRB.start(__FILE__)
+# try pry if available, fall back to irb
+begin
+  require 'pry'
+  CONSOLE_CLASS = Pry
+rescue LoadError
+  require 'irb'
+  CONSOLE_CLASS = IRB
+end
+
+puts "Starting #{CONSOLE_CLASS.name} session..."
+CONSOLE_CLASS.start(__FILE__)