mongo 1.3.0 → 1.12.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 756bee5f8dcecc237006f5ebfe8d4087ae06f855
+  data.tar.gz: c504ef1e1492dee4ff6e5bdab83fac92cdf54069
+SHA512:
+  metadata.gz: d87e98fa9b33d9d446128a61efc85e0b7e0c67ebfd58bc2e42758156a4794d2c5aa09ff4dd3a87900b1593213145d813aa663df58d6d1fb11325441214fc29fe
+  data.tar.gz: 07ec6387420ed99a2308266fa50342de858f0fbac16ee308853f2fe36e633901e61c160b67ad292e1cc25b47135ae19267ec08d14fea3cb8a7e3f3b4fa6d4916

data/{LICENSE.txt → LICENSE}

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2008-2010 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,332 +1,183 @@
-# Introduction
+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).
 
-This is the 10gen-supported Ruby driver for [MongoDB](http://www.mongodb.org).
+Installation
+-----
 
-This documentation includes other articles of interest, include:
+**Gem Installation**<br>
+The Ruby driver is released and distributed through RubyGems and it can be installed with the following command:
 
-1. [A tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html).
-2. [Replica Sets in Ruby](http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html).
-3. [Write Concern in Ruby](http://api.mongodb.org/ruby/current/file.WRITE_CONCERN.html).
-4. [GridFS in Ruby](http://api.mongodb.org/ruby/current/file.GridFS.html).
-5. [Frequently Asked Questions](http://api.mongodb.org/ruby/current/file.FAQ.html).
-6. [History](http://api.mongodb.org/ruby/current/file.HISTORY.html).
-6. [Release plan](http://api.mongodb.org/ruby/current/file.RELEASES.html).
-7. [Credits](http://api.mongodb.org/ruby/current/file.CREDITS.html).
+```bash
+gem install mongo
+```
 
-Here's a quick code sample. Again, see the [MongoDB Ruby Tutorial](http://api.mongodb.org/ruby/current/file.TUTORIAL.html)
-for much more:
+For a significant performance boost, you'll want to install the C-extension:
 
-    require 'rubygems'
-    require 'mongo'
-    include Mongo
+```bash
+gem install bson_ext
+```
 
-    db   = Connection.new.db('sample-db')
-    coll = db.collection('test')
+**Github Installation**<br>
+For development and test environments (not recommended for production) you can also install the Ruby driver directly from source:
 
-    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
+# clone the repository
+git clone https://github.com/mongodb/mongo-ruby-driver.git
+cd mongo-ruby-driver
 
-# Installation
+# checkout a specific version by tag (optional)
+git checkout 1.x.x
 
-### Ruby Versions
+# install all development dependencies
+gem install bundler
+bundle install
 
-The driver works and is consistently tested on Ruby 1.8.6, 1.8.7, and 1.9.2, and JRuby 1.5.1.
+# install the ruby driver
+rake install
+```
 
-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.
+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:
 
-### Gems
+```bash
+gem install mongo_kerberos
+```
 
-The driver's gems are hosted at [Rubygems.org](http://rubygems.org). Make sure you're
-using the latest version of rubygems:
+```ruby
+require 'mongo_kerberos'
+```
 
-    $ gem update --system
+Usage
+-----
+Here is a quick example of basic usage for the Ruby driver:
 
-Then you can install the mongo gem as follows:
+```ruby
+require 'mongo'
+include Mongo
 
-    $ gem install mongo
+# connecting to the database
+client = MongoClient.new # defaults to localhost:27017
+db     = client['example-db']
+coll   = db['example-collection']
 
-The driver also requires the bson gem:
+# inserting documents
+10.times { |i| coll.insert({ :count => i+1 }) }
 
-    $ gem install bson
+# finding documents
+puts "There are #{coll.count} total documents. Here they are:"
+coll.find.each { |doc| puts doc.inspect }
 
-And for a significant performance boost, you'll want to install the C extensions:
+# updating documents
+coll.update({ :count => 5 }, { :count => 'foobar' })
 
-    $ gem install bson_ext
+# removing documents
+coll.remove({ :count => 8 })
+coll.remove
+```
 
-Note that bson_ext isn't used with JRuby. Instead, some native Java extensions are bundled with the bson gem.
-If you ever need to modify these extenions, you can recompile with the following rake task:
+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>
 
-    $ rake build:java
+API Reference Documentation
+-----
+For API reference documentation, please visit [here](http://api.mongodb.org/ruby).
 
-### From the GitHub source
+Compatibility
+-----
+The MongoDB Ruby driver requires Ruby 1.8.7 or greater and is regularly tested against the platforms and environments listed below.
 
-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
+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
 
-    $ rake gem:install
+Support & Feedback
+-----
 
-To install the C extensions from source, type this instead:
+**Support Channels**
 
-    $ rake gem:install_extensions
+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.
 
-That's all there is to it!
+Bugs & Feature Requests
+-----
 
-# Examples
+Do you have a bug to report or a feature request to make?
 
-For extensive examples, see the [MongoDB Ruby Tutorial](http://www.mongodb.org/display/DOCS/Ruby+Tutorial).
+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.
 
-Bundled with the driver are many examples, located in the "docs/examples" subdirectory. Samples include using
-the driver and using the GridFS class GridStore. MongoDB must be running for
-these examples to work, of course.
+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.
 
-Here's how to start MongoDB and run the "simple.rb" example:
+**HOW TO ASK FOR HELP**
 
-      $ cd path/to/mongo
-      $ ./mongod run
-      ... then in another window ...
-      $ cd path/to/mongo-ruby-driver
-      $ ruby docs/examples/simple.rb
+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:
 
-See also the test code, especially test/test_db_api.rb.
+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
 
-# GridFS
+**PLEASE DO NOT**
 
-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 essentailly the same, but provides a more filesystem-like API
-and assumes that filenames are unique.
+* Provide any sensitive data or server logs.
+* Report potential security issues publicly (see 'Security Issues').
 
-An instance of both classes represents an individual file store. See the API reference
-for details, and see examples/gridfs.rb for code that uses many of the Grid
-features (metadata, content type, seek, tell, etc).
+**EXAMPLE BUG REPORT**
 
-Examples:
-      # Write a file on disk to the Grid
-      file = File.open('image.jpg')
-      grid = Grid.new(db)
-      id   = grid.put(file)
+Example taken from [RUBY-775](https://jira.mongodb.org/browse/RUBY-775)
 
-      # Retrieve the file
-      file = grid.get(id)
-      file.read
+```
+There appears to be a recursive locking condition in the replica set connection pooling.
 
-      # Get all the file's metata
-      file.filename
-      file.content_type
-      file.metadata
+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
 
-# Notes
+Component: Connection Pooling / Replica set
 
-## Thread Safety
+Here is a stack trace:
+https://gist.githubusercontent.com/cheald/5ed01172c5b2c9943c87/raw/63075158dac4c78c1775cac8bf84ba3b6537bc1e/gistfile1.txt
 
-The driver is thread-safe.
+The original lock occurs [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L60)
 
-## Connection Pooling
+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)
+```
 
-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.
+Security Issues
+-----
 
-To set up a pooled connection to a single MongoDB instance:
+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).
 
-    @conn = Connection.new("localhost", 27017, :pool_size => 5, :timeout => 5)
+Release History
+-----
 
-Though the pooling architecture will undoubtedly evolve, it currently owes much credit
-to the connection pooling implementations in ActiveRecord and PyMongo.
+Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
 
-## Forking
+License
+-----
 
-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.
-
-## String Encoding
-
-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 Connection#db method.
-
-    db = Mongo::Connection.new.db('dbname', :pk => MyPKFactory.new)
-
-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:
-
-    class TestPKFactory
-      def create_pk(row)
-        row['_id'] ||= Mongo::ObjectID.new
-        row
-      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):
-
-  class PKFactory
-    def create_pk(row)
-      return row if row[:_id]
-      row.delete(:_id)      # in case it exists but the value is nil
-      row['_id'] ||= Mongo::ObjectID.new
-      row
-    end
-  end
-
-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
-
-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:
-
-    db = Connection.new.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
-
-Notes:
-
-* Cursors are enumerable (and have a #to_a method).
-
-* The query doesn't get run until you actually attempt to retrieve data from a
-  cursor.
-
-* 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.
-
-## Socket timeouts
-
-The Ruby driver support timeouts on socket read operations. To enable them, set the
-`:op_timeout` option when you create a `Mongo::Connection` object.
-
-If implementing higher-level timeouts, using tools like `Rack::Timeout`, it's very important
-to call `Mongo::Connection#close` to prevent the subsequent operation from receiving the previous
-request.
-
-# Testing
-
-If you have the source code, you can run the tests.
-
-    $ rake test:c
-
-If you want to test the basic Ruby encoder, without the C extension, or if you're running JRuby:
-
-    $ rake test:ruby
-
-These will run both unit and functional tests. To run these tests alone:
-
-    $ rake test:unit
-    $ rake test:functional
-
-To run any individual rake tasks with the C extension enabled, just pass C_EXT=true to the task:
-
-    $ rake test:unit C_EXT=true
-
-If you want to test replica set, you can run the following tests
-individually:
-
-    $ rake test:replica_set_count
-    $ rake test:replica_set_insert
-    $ rake test:replica_set_query
-
-### Shoulda and Mocha
-
-Running the test suite requires shoulda and mocha.  You can install them as follows:
-
-    $ gem install shoulda
-    $ gem install mocha
-
-The tests assume that the Mongo database is running on the default port. You
-can override the default host (localhost) and port (Connection::DEFAULT_PORT) by
-using the environment variables MONGO_RUBY_DRIVER_HOST and
-MONGO_RUBY_DRIVER_PORT.
-
-# Documentation
-
-This documentation is available online at [http://api.mongodb.org/ruby](http://api.mongodb.org/ruby). You can
-generate the documentation if you have the source by typing
-
-    $ rake ydoc
-
-Then open the file +ydoc/index.html+.
-
-# Release Notes
-
-See HISTORY.
-
-# Credits
-
-See CREDITS.
-
-# License
-
- Copyright 2008-2010 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.
    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.
+
+[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