mongo 1.10.0.rc1 → 1.10.0

data/lib/mongo/gridfs/grid_file_system.rb

@@ -60,7 +60,7 @@ module Mongo
     # @option opts [String] :content_type ('binary/octet-stream') If no content type is specified,
     #   the content type will may be inferred from the filename extension if the mime-types gem can be
     #   loaded. Otherwise, the content type 'binary/octet-stream' will be used.
-    # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
+    # @option opts [Integer] (261120) :chunk_size size of file chunks in bytes.
     # @option opts [Boolean] :delete_old (false) ensure that old versions of the file are deleted. This option
     #  only work in 'w' mode. Certain precautions must be taken when deleting GridFS files. See the notes under
     #  GridFileSystem#delete.

data/lib/mongo/gridfs/grid_io.rb

@@ -21,7 +21,7 @@ module Mongo
   class GridIO
     include Mongo::WriteConcern
 
-    DEFAULT_CHUNK_SIZE   = 256 * 1024
+    DEFAULT_CHUNK_SIZE   = 255 * 1024
     DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
     PROTECTED_ATTRS      = [:files_id, :file_length, :client_md5, :server_md5]
 
@@ -39,7 +39,7 @@ module Mongo
     # @option opts [Hash] :query a query selector used when opening the file in 'r' mode.
     # @option opts [Hash] :query_opts any query options to be used when opening the file in 'r' mode.
     # @option opts [String] :fs_name the file system prefix.
-    # @option opts [Integer] (262144) :chunk_size size of file chunks in bytes.
+    # @option opts [Integer] (261120) :chunk_size size of file chunks in bytes.
     # @option opts [Hash] :metadata ({}) any additional data to store with the file.
     # @option opts [ObjectId] :_id (ObjectId) a unique id for
     #   the file to be use in lieu of an automatically generated one.
@@ -106,11 +106,9 @@ module Mongo
 
     # Write the given string (binary) data to the file.
     #
-    # @param [String] string
-    #   the data to write
+    # @param [String] io the data to write.
     #
-    # @return [Integer]
-    #   the number of bytes written.
+    # @return [Integer] the number of bytes written.
     def write(io)
       raise GridError, "file not opened for write" unless @mode[0] == ?w
       if io.is_a? String

data/lib/mongo/mongo_client.rb

@@ -43,7 +43,7 @@ module Mongo
     DEFAULT_DB_NAME      = 'test'
     GENERIC_OPTS         = [:auths, :logger, :connect, :db_name]
     TIMEOUT_OPTS         = [:timeout, :op_timeout, :connect_timeout]
-    SSL_OPTS             = [:ssl, :ssl_key, :ssl_cert, :ssl_verify, :ssl_ca_cert]
+    SSL_OPTS             = [:ssl, :ssl_key, :ssl_cert, :ssl_verify, :ssl_ca_cert, :ssl_key_pass_phrase]
     POOL_OPTS            = [:pool_size, :pool_timeout]
     READ_PREFERENCE_OPTS = [:read, :tag_sets, :secondary_acceptable_latency_ms]
     WRITE_CONCERN_OPTS   = [:w, :j, :fsync, :wtimeout]
@@ -90,14 +90,14 @@ module Mongo
     #  @param [Integer] port specify a port number here if only one host is being specified.
     #  @param [Hash] opts hash of optional settings and configuration values.
     #
-    # @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
+    #  @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
     #   should be acknowledged.
-    # @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout.
-    # @option opts [Boolean] :j (false) If true, block until write operations have been committed
+    #  @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout.
+    #  @option opts [Boolean] :j (false) If true, block until write operations have been committed
     #   to the journal. Cannot be used in combination with 'fsync'. Prior to MongoDB 2.6 this option was
     #   ignored if the server was running without journaling. Starting with MongoDB 2.6, write operations will
     #   fail with an exception if this option is used when the server is running without journaling.
-    # @option opts [Boolean] :fsync (false) If true, and the server is running without journaling, blocks until
+    #  @option opts [Boolean] :fsync (false) If true, and the server is running without journaling, blocks until
     #   the server has synced all data files to disk. If the server is running with journaling, this acts the same as
     #   the 'j' option, blocking until write operations have been committed to the journal.
     #   Cannot be used in combination with 'j'.
@@ -111,7 +111,7 @@ module Mongo
     #  @option opts [String] :ssl_cert (nil) The certificate file used to identify the local connection against MongoDB.
     #  @option opts [String] :ssl_key (nil) The private keyfile used to identify the local connection against MongoDB.
     #    Note that even if the key is stored in the same file as the certificate, both need to be explicitly specified.
-    #    Additionally, note that the driver does not currently support providing a passphrase for the private key.
+    #  @option opts [String] :ssl_key_pass_phrase (nil) A passphrase for the private key.
     #  @option opts [Boolean] :ssl_verify (nil) Specifies whether or not peer certification validation should occur.
     #  @option opts [String] :ssl_ca_cert (nil) The ca_certs file contains a set of concatenated "certification authority"
     #    certificates, which are used to validate certificates passed from the other end of the connection.
@@ -216,7 +216,7 @@ module Mongo
     # @param uri [String]
     #   A string of the format mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/database]
     #
-    # @param opts Any of the options available for MongoClient.new
+    # @param [Hash] extra_opts Any of the options available for MongoClient.new
     #
     # @return [Mongo::MongoClient, Mongo::MongoReplicaSetClient]
     def self.from_uri(uri = ENV['MONGODB_URI'], extra_opts={})
@@ -594,10 +594,11 @@ module Mongo
       @socket_opts = {}
       if @ssl
         # construct ssl socket opts
-        @socket_opts[:key]     = opts.delete(:ssl_key)
-        @socket_opts[:cert]    = opts.delete(:ssl_cert)
-        @socket_opts[:verify]  = opts.delete(:ssl_verify)
-        @socket_opts[:ca_cert] = opts.delete(:ssl_ca_cert)
+        @socket_opts[:key]             = opts.delete(:ssl_key)
+        @socket_opts[:cert]            = opts.delete(:ssl_cert)
+        @socket_opts[:verify]          = opts.delete(:ssl_verify)
+        @socket_opts[:ca_cert]         = opts.delete(:ssl_ca_cert)
+        @socket_opts[:key_pass_phrase] = opts.delete(:ssl_key_pass_phrase)
 
         # verify peer requires ca_cert, raise if only one is present
         if @socket_opts[:verify] && !@socket_opts[:ca_cert]
@@ -606,6 +607,13 @@ module Mongo
             ':ssl_ca_cert in order to perform server validation.'
         end
 
+        # if we have a keyfile passphrase but no key file, raise
+        if @socket_opts[:key_pass_phrase] && !@socket_opts[:key]
+          raise MongoArgumentError,
+            'If :ssl_key_pass_phrase has been specified, then you must include ' +
+            ':ssl_key, the passphrase-protected keyfile.'
+        end
+
         @socket_class = Mongo::SSLSocket
       elsif @unix
         @socket_class = Mongo::UNIXSocket

data/lib/mongo/mongo_replica_set_client.rb

@@ -92,7 +92,7 @@ module Mongo
     #   @option opts [String] :ssl_cert (nil) The certificate file used to identify the local connection against MongoDB.
     #   @option opts [String] :ssl_key (nil) The private keyfile used to identify the local connection against MongoDB.
     #     Note that even if the key is stored in the same file as the certificate, both need to be explicitly specified.
-    #     Additionally, note that the driver does not currently support providing a passphrase for the private key.
+    #   @option opts [String] :ssl_key_pass_phrase (nil) A passphrase for the private key.
     #   @option opts [Boolean] :ssl_verify (nil) Specifies whether or not peer certification validation should occur.
     #   @option opts [String] :ssl_ca_cert (nil) The ca_certs file contains a set of concatenated "certification authority"
     #     certificates, which are used to validate certificates passed from the other end of the connection.

data/lib/mongo/mongo_sharded_client.rb

@@ -148,10 +148,10 @@ module Mongo
     # @param uri [ String ]  string of the format:
     #   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/database]
     #
-    # @param opts [ Hash ] Any of the options available for MongoShardedClient.new
+    # @param options [ Hash ] Any of the options available for MongoShardedClient.new
     #
     # @return [ Mongo::MongoShardedClient ] The sharded client.
-    def self.from_uri(uri, options = {})
+    def self.from_uri(uri, options={})
       uri ||= ENV['MONGODB_URI']
       URIParser.new(uri).connection(options, false, true)
     end

data/lib/mongo/networking.rb

@@ -67,8 +67,8 @@ module Mongo
     # @param [Integer] operation a MongoDB opcode.
     # @param [BSON::ByteBuffer] message a message to send to the database.
     # @param [String] db_name the name of the database. used on call to get_last_error.
-    # @param [Hash] last_error_params parameters to be sent to getLastError. See DB#error for
-    #   available options.
+    # @param [String] log_message this is currently a no-op and will be removed.
+    # @param [Hash] write_concern write concern.
     #
     # @see DB#get_last_error for valid last error params.
     #
@@ -95,18 +95,20 @@ module Mongo
         raise ex
       end
 
-      if num_received == 1 && (error = docs[0]['err'] || docs[0]['errmsg'])
-        if error.include?("not master")
+      if num_received == 1
+        error = docs[0]['err'] || docs[0]['errmsg']
+        if error && error.include?("not master")
           close
           raise ConnectionFailure.new(docs[0]['code'].to_s + ': ' + error, docs[0]['code'], docs[0])
-        else
+        elsif (note = docs[0]['jnote'] || docs[0]['wnote']) # assignment
+          code = docs[0]['code'] || Mongo::ErrorCode::BAD_VALUE # as of server version 2.5.5
+          raise WriteConcernError.new(code.to_s + ': ' + note, code, docs[0])
+        elsif error
           code = docs[0]['code'] || Mongo::ErrorCode::UNKNOWN_ERROR
           error = "wtimeout" if error == "timeout"
+          raise WriteConcernError.new(code.to_s + ': ' + error, code, docs[0]) if error == "wtimeout"
           raise OperationFailure.new(code.to_s + ': ' + error, code, docs[0])
         end
-      elsif num_received == 1 && (note = docs[0]['jnote'] || docs[0]['wnote']) # assignment
-        code = docs[0]['code'] || Mongo::ErrorCode::BAD_VALUE # as of server version 2.5.5
-        raise OperationFailure.new(code.to_s + ': ' + note, code, docs[0])
       end
 
       docs[0]
@@ -120,8 +122,10 @@ module Mongo
     # @param [Socket] socket a socket to use in lieu of checking out a new one.
     # @param [Boolean] command (false) indicate whether this is a command. If this is a command,
     #   the message will be sent to the primary node.
-    # @param [Boolean] command (false) indicate whether the cursor should be exhausted. Set
+    # @param [Symbol] read the read preference.
+    # @param [Boolean] exhaust (false) indicate whether the cursor should be exhausted. Set
     #   this to true only when the OP_QUERY_EXHAUST flag is set.
+    # @param [Boolean] compile_regex whether BSON regex objects should be compiled into Ruby regexes.
     #
     # @return [Array]
     #   An array whose indexes include [0] documents returned, [1] number of document received,

data/test/functional/client_test.rb

@@ -144,6 +144,20 @@ class ClientTest < Test::Unit::TestCase
     assert_equal db.name, MongoClient::DEFAULT_DB_NAME
   end
 
+  def test_from_uri_write_concern
+    con = MongoClient.from_uri("mongodb://#{host_port}")
+    db = con.db
+    coll = db.collection('from-uri-test')
+    assert_equal BSON::ObjectId, coll.insert({'a' => 1}).class
+    [con, db, coll].each do |component|
+      component.write_concern.each do |key,value|
+        assert_not_nil(value, "component #{component.class.inspect} should not have write concern #{key.inspect} field with nil value")
+      end
+    end
+    assert_equal({:w => 1}, con.write_concern, "write concern should not have extra pairs that were not specified by the user")
+    assert_equal({:w => 1}, db.write_concern, "write concern should not have extra pairs that were not specified by the user")
+    assert_equal({:w => 1}, coll.write_concern, "write concern should not have extra pairs that were not specified by the user")
+  end
 
   def test_server_version
     assert_match(/\d\.\d+(\.\d+)?/, @client.server_version.to_s)

data/test/functional/collection_test.rb

@@ -102,12 +102,10 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 1 }])
 
-      command = {
-        'delete' => @@test.name,
-        :deletes => [{ :q => { :a => 1 }, :limit => 1 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['delete', @@test.name,
+                                  :deletes, [{ :q => { :a => 1 }, :limit => 1 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['n']
@@ -119,12 +117,10 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 1 }])
 
-      command = {
-        'delete' => @@test.name,
-        :deletes => [{ :q => { :a => 1 }, :limit => 0 }],
-        :writeConcern => { :w => 1 },
-        :ordered => true
-      }
+      command = BSON::OrderedHash['delete', @@test.name,
+                                  :deletes, [{ :q => { :a => 1 }, :limit => 0 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, true]
 
       result = @@db.command(command)
       assert_equal 2, result['n']
@@ -136,12 +132,10 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 1 }])
 
-      command = {
-        'delete' => @@test.name,
-        :deletes => [{ :q => { :a => 1 }, :limit => 0 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['delete', @@test.name,
+                                  :deletes, [{ :q => { :a => 1 }, :limit => 0 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 2, result['n']
@@ -153,11 +147,9 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 1 }])
 
-      command = {
-        'delete' => @@test.name,
-        :deletes => [{ :q => { :a => 1 }, :limit => 0 }],
-        :ordered => false
-      }
+      command = BSON::OrderedHash['delete', @@test.name,
+                                  :deletes, [{ :q => { :a => 1 }, :limit => 0 }],
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 2, result['n']
@@ -169,12 +161,10 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 1 }])
 
-      command = {
-        'delete' => @@test.name,
-        :deletes => [{ :q => { '$set' => { :a => 1 }}, :limit => 0 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['delete', @@test.name,
+                                  :deletes, [{ :q => { '$set' => { :a => 1 }}, :limit => 0 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       assert_raise Mongo::OperationFailure do
         @@db.command(command)
@@ -184,12 +174,10 @@ class CollectionTest < Test::Unit::TestCase
     def test_single_insert_write_command
       @@test.drop
 
-      command = {
-        'insert' => @@test.name,
-        :documents => [{ :a => 1 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['insert', @@test.name,
+                                  :documents, [{ :a => 1 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -199,12 +187,10 @@ class CollectionTest < Test::Unit::TestCase
     def test_multi_ordered_insert_write_command
       @@test.drop
 
-      command = {
-        'insert' => @@test.name,
-        :documents => [{ :a => 1 }, { :a => 2 }],
-        :writeConcern => { :w => 1 },
-        :ordered => true
-      }
+      command = BSON::OrderedHash['insert', @@test.name,
+                                  :documents, [{ :a => 1 }, { :a => 2 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, true]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -214,12 +200,10 @@ class CollectionTest < Test::Unit::TestCase
     def test_multi_unordered_insert_write_command
       @@test.drop
 
-      command = {
-        'insert' => @@test.name,
-        :documents => [{ :a => 1 }, { :a => 2 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['insert', @@test.name,
+                                  :documents, [{ :a => 1 }, { :a => 2 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -229,11 +213,9 @@ class CollectionTest < Test::Unit::TestCase
     def test_insert_write_command_with_no_concern
       @@test.drop
 
-      command = {
-        'insert' => @@test.name,
-        :documents => [{ :a => 1 }, { :a => 2 }],
-        :ordered => false
-      }
+      command = BSON::OrderedHash['insert', @@test.name,
+                                  :documents, [{ :a => 1 }, { :a => 2 }],
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -242,14 +224,12 @@ class CollectionTest < Test::Unit::TestCase
 
     def test_insert_write_command_with_error
       @@test.drop
-      @@test.ensure_index({ :a => 1 }, { :unique => true })
+      @@test.ensure_index([[:a, 1]], { :unique => true })
 
-      command = {
-        'insert' => @@test.name,
-        :documents => [{ :a => 1 }, { :a => 1 }],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['insert', @@test.name,
+                                  :documents, [{ :a => 1 }, { :a => 1 }],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       assert_raise Mongo::OperationFailure do
         @@db.command(command)
@@ -260,11 +240,9 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 2 }])
 
-      command = {
-        'update' => @@test.name,
-        :updates => [{ :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}}],
-        :writeConcern => { :w => 1 }
-      }
+      command = BSON::OrderedHash['update', @@test.name,
+                                  :updates, [{ :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}}],
+                                  :writeConcern, { :w => 1 }]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -276,15 +254,13 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 3 }])
 
-      command = {
-        'update' => @@test.name,
-        :updates => [
-          { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
-          { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
-        ],
-        :writeConcern => { :w => 1 },
-        :ordered => true
-      }
+      command = BSON::OrderedHash['update', @@test.name,
+                                  :updates, [
+                                              { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
+                                              { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
+                                            ],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, true]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -297,15 +273,13 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 3 }])
 
-      command = {
-        'update' => @@test.name,
-        :updates => [
-          { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
-          { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
-        ],
-        :writeConcern => { :w => 1 },
-        :ordered => false
-      }
+      command = BSON::OrderedHash['update', @@test.name,
+                                  :updates, [
+                                             { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
+                                             { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
+                                            ],
+                                  :writeConcern, { :w => 1 },
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -318,14 +292,12 @@ class CollectionTest < Test::Unit::TestCase
       @@test.drop
       @@test.insert([{ :a => 1 }, { :a => 3 }])
 
-      command = {
-        'update' => @@test.name,
-        :updates => [
-          { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
-          { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
-        ],
-        :ordered => false
-      }
+      command = BSON::OrderedHash['update', @@test.name,
+                                  :updates, [
+                                             { :q => { :a => 1 }, :u => { '$set' => { :a => 2 }}},
+                                             { :q => { :a => 3 }, :u => { '$set' => { :a => 4 }}}
+                                            ],
+                                  :ordered, false]
 
       result = @@db.command(command)
       assert_equal 1, result['ok']
@@ -336,16 +308,14 @@ class CollectionTest < Test::Unit::TestCase
 
     def test_update_write_command_with_error
       @@test.drop
-      @@test.ensure_index({ :a => 1 }, { :unique => true })
+      @@test.ensure_index([[:a, 1]], { :unique => true })
       @@test.insert([{ :a => 1 }, { :a => 2 }])
 
-      command = {
-        'update' => @@test.name,
-        :updates => [
-          { :q => { :a => 2 }, :u => { '$set' => { :a => 1 }}}
-        ],
-        :ordered => false
-      }
+      command = BSON::OrderedHash['update', @@test.name,
+                                  :updates, [
+                                             { :q => { :a => 2 }, :u => { '$set' => { :a => 1 }}}
+                                            ],
+                                  :ordered, false]
 
       assert_raise Mongo::OperationFailure do
         @@db.command(command)
@@ -877,7 +847,7 @@ class CollectionTest < Test::Unit::TestCase
   if @@version < "2.5.3"
     def test_jnote_raises_exception
       with_no_journaling(@@client) do
-        ex = assert_raise Mongo::OperationFailure do
+        ex = assert_raise Mongo::WriteConcernError do
           @@test.insert({:foo => 1}, :j => true)
         end
         result = ex.result
@@ -886,7 +856,7 @@ class CollectionTest < Test::Unit::TestCase
     end
 
     def test_wnote_raises_exception
-      ex = assert_raise Mongo::OperationFailure do
+      ex = assert_raise Mongo::WriteConcernError do
         @@test.insert({:foo => 1}, :w => 2)
       end
       result = ex.result