mongo 1.8.6 → 1.9.0

data/lib/mongo/gridfs/grid_ext.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
   module GridExt
     module InstanceMethods

data/lib/mongo/gridfs/grid_file_system.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
 
   # A file store built on the GridFS specification featuring
@@ -22,7 +36,6 @@ module Mongo
       @default_query_opts = {:sort => [['filename', 1], ['uploadDate', -1]], :limit => 1}
 
       # This will create indexes only if we're connected to a primary node.
-      connection = @db.connection
       begin
         @files.ensure_index([['filename', 1], ['uploadDate', -1]])
         @chunks.ensure_index([['files_id', Mongo::ASCENDING], ['n', Mongo::ASCENDING]], :unique => true)
@@ -56,8 +69,8 @@ module Mongo
     #   Notes on write concern:
     #     When :w > 0, the chunks sent to the server
     #     will be validated using an md5 hash. If validation fails, an exception will be raised.
-    # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to 
-    #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when 
+    # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to
+    #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when
     #   deleting GridFS files. See the notes under GridFileSystem#delete.
     #
     # @example

data/lib/mongo/gridfs/grid_io.rb

@@ -1,12 +1,26 @@
+# Copyright (C) 2013 10gen 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 'digest/md5'
 
 module Mongo
 
   # GridIO objects represent files in the GridFS specification. This class
   # manages the reading and writing of file chunks and metadata.
-  class GridIO 
+  class GridIO
     include Mongo::WriteConcern
-    
+
     DEFAULT_CHUNK_SIZE   = 256 * 1024
     DEFAULT_CONTENT_TYPE = 'binary/octet-stream'
     PROTECTED_ATTRS      = [:files_id, :file_length, :client_md5, :server_md5]
@@ -238,7 +252,7 @@ module Mongo
     # @return [Mongo::GridIO] self
     def each
       return read_all unless block_given?
-      while chunk = read(chunk_size) 
+      while chunk = read(chunk_size)
         yield chunk
         break if chunk.empty?
       end

data/lib/mongo/legacy.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
   module LegacyWriteConcern
     @legacy_write_concern = true

data/lib/mongo/mongo_client.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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 'set'
 require 'socket'
 require 'thread'
@@ -16,8 +30,9 @@ module Mongo
     DEFAULT_HOST         = 'localhost'
     DEFAULT_PORT         = 27017
     DEFAULT_DB_NAME      = 'test'
-    GENERIC_OPTS         = [:ssl, :auths, :logger, :connect]
+    GENERIC_OPTS         = [:auths, :logger, :connect]
     TIMEOUT_OPTS         = [:timeout, :op_timeout, :connect_timeout]
+    SSL_OPTS             = [:ssl, :ssl_key, :ssl_cert, :ssl_verify, :ssl_ca_cert]
     POOL_OPTS            = [:pool_size, :pool_timeout]
     READ_PREFERENCE_OPTS = [:read, :tag_sets, :secondary_acceptable_latency_ms]
     WRITE_CONCERN_OPTS   = [:w, :j, :fsync, :wtimeout]
@@ -36,6 +51,7 @@ module Mongo
                 :pool_timeout,
                 :primary_pool,
                 :socket_class,
+                :socket_opts,
                 :op_timeout,
                 :tag_sets,
                 :acceptable_latency,
@@ -55,33 +71,43 @@ module Mongo
     # MongoClient#arbiters. This is useful if your application needs to connect manually to nodes other
     # than the primary.
     #
-    # @param [String] host
-    # @param [Integer] port specify a port number here if only one host is being specified.
-    #
-    # @option opts [String, Integer, Symbol] :w (1) Set default number of nodes to which a write
-    #   should be acknowledged
-    # @option opts [Boolean] :j (false) Set journal acknowledgement
-    # @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout
-    # @option opts [Boolean] :fsync (false) Set fsync acknowledgement.
-    #
-    #     Notes about write concern options:
-    #       Write concern options are propagated to objects instantiated from this MongoClient.
-    #       These defaults can be overridden upon instantiation of any object by explicitly setting an options hash
-    #       on initialization.
-    # @option opts [Boolean] :slave_ok (false) Must be set to +true+ when connecting
-    #   to a single, slave node.
-    # @option opts [Logger, #debug] :logger (nil) A Logger instance for debugging driver ops. Note that
-    #   logging negatively impacts performance; therefore, it should not be used for high-performance apps.
-    # @option opts [Integer] :pool_size (1) The maximum number of socket self.connections allowed per
-    #   connection pool. Note: this setting is relevant only for multi-threaded applications.
-    # @option opts [Float] :timeout (5.0) When all of the self.connections a pool are checked out,
-    #   this is the number of seconds to wait for a new connection to be released before throwing an exception.
-    #   Note: this setting is relevant only for multi-threaded applications (which in Ruby are rare).
-    # @option opts [Float] :op_timeout (nil) The number of seconds to wait for a read operation to time out.
-    #   Disabled by default.
-    # @option opts [Float] :connect_timeout (nil) The number of seconds to wait before timing out a
-    #   connection attempt.
-    # @option opts [Boolean] :ssl (false) If true, create the connection to the server using SSL.
+    # @overload initialize(host, port, opts={})
+    #  @param [String] host hostname for the target MongoDB server.
+    #  @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
+    #    should be acknowledged
+    #  @option opts [Boolean] :j (false) Set journal acknowledgement
+    #  @option opts [Integer] :wtimeout (nil) Set replica set acknowledgement timeout
+    #  @option opts [Boolean] :fsync (false) Set fsync acknowledgement.
+    #
+    #  Notes about Write-Concern Options:
+    #   Write concern options are propagated to objects instantiated from this MongoClient.
+    #   These defaults can be overridden upon instantiation of any object by explicitly setting an options hash
+    #   on initialization.
+    #
+    #  @option opts [Boolean] :ssl (false) If true, create the connection to the server using SSL.
+    #  @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.
+    #    If included with the :ssl_cert then only :ssl_cert is needed.
+    #  @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.
+    #    Required for :ssl_verify.
+    #  @option opts [Boolean] :slave_ok (false) Must be set to +true+ when connecting
+    #    to a single, slave node.
+    #  @option opts [Logger, #debug] :logger (nil) A Logger instance for debugging driver ops. Note that
+    #    logging negatively impacts performance; therefore, it should not be used for high-performance apps.
+    #  @option opts [Integer] :pool_size (1) The maximum number of socket self.connections allowed per
+    #    connection pool. Note: this setting is relevant only for multi-threaded applications.
+    #  @option opts [Float] :timeout (5.0) When all of the self.connections a pool are checked out,
+    #    this is the number of seconds to wait for a new connection to be released before throwing an exception.
+    #    Note: this setting is relevant only for multi-threaded applications.
+    #  @option opts [Float] :op_timeout (nil) The number of seconds to wait for a read operation to time out.
+    #    Disabled by default.
+    #  @option opts [Float] :connect_timeout (nil) The number of seconds to wait before timing out a
+    #    connection attempt.
     #
     # @example localhost, 27017 (or <code>ENV["MONGODB_URI"]</code> if available)
     #   MongoClient.new
@@ -122,6 +148,9 @@ module Mongo
       @tag_sets = []
       @acceptable_latency = 15
 
+      @max_message_size = nil
+      @max_bson_size = nil
+
       check_opts(opts)
       setup(opts.dup)
     end
@@ -242,7 +271,7 @@ module Mongo
       return false if @auths.empty?
       @auths.each do |auth|
         self[auth[:db_name]].issue_authentication(auth[:username], auth[:password], false,
-          :socket => opts[:socket])
+          :source => auth[:source], :socket => opts[:socket])
       end
       true
     end
@@ -260,7 +289,7 @@ module Mongo
     # @param [String] password
     #
     # @return [Hash] a hash representing the authentication just added.
-    def add_auth(db_name, username, password)
+    def add_auth(db_name, username, password, source)
       if @auths.any? {|a| a[:db_name] == db_name}
         raise MongoArgumentError, "Cannot apply multiple authentications to database '#{db_name}'"
       end
@@ -268,7 +297,8 @@ module Mongo
       auth = {
         :db_name  => db_name,
         :username => username,
-        :password => password
+        :password => password,
+        :source => source
       }
       @auths << auth
       auth
@@ -306,8 +336,9 @@ module Mongo
     # @return [Hash]
     def database_info
       doc = self['admin'].command({:listDatabases => 1})
-      doc['databases'].each_with_object({}) do |db, info|
+      doc['databases'].inject({}) do |info, db|
         info[db['name']] = db['sizeOnDisk'].to_i
+        info
       end
     end
 
@@ -440,9 +471,7 @@ module Mongo
     # @raise [ConnectionFailure] if unable to connect to any host or port.
     def connect
       close
-
       config = check_is_master(host_port)
-
       if config
         if config['ismaster'] == 1 || config['ismaster'] == true
           @read_primary = true
@@ -462,6 +491,7 @@ module Mongo
       if !connected?
         raise ConnectionFailure, "Failed to connect to a master node at #{host_port.join(":")}"
       end
+      true
     end
     alias :reconnect :connect
 
@@ -555,7 +585,7 @@ module Mongo
       begin
         host, port = *node
         config = nil
-        socket = @socket_class.new(host, port, @op_timeout, @connect_timeout)
+        socket = @socket_class.new(host, port, @op_timeout, @connect_timeout, @socket_opts)
         if @connect_timeout
           Timeout::timeout(@connect_timeout, OperationTimeout) do
             config = self['admin'].command({:ismaster => 1}, :socket => socket)
@@ -579,7 +609,8 @@ module Mongo
       POOL_OPTS +
       READ_PREFERENCE_OPTS +
       WRITE_CONCERN_OPTS +
-      TIMEOUT_OPTS
+      TIMEOUT_OPTS +
+      SSL_OPTS
     end
 
     def check_opts(opts)
@@ -593,11 +624,32 @@ module Mongo
     # Parse option hash
     def setup(opts)
       @slave_ok = opts.delete(:slave_ok)
+      @ssl      = opts.delete(:ssl)
+      @unix     = @host ? @host.end_with?('.sock') : false
+
+      # if ssl options are present, but ssl is nil/false raise for misconfig
+      ssl_opts = opts.keys.select { |k| k.to_s.start_with?('ssl') }
+      if ssl_opts.size > 0 && !@ssl
+        raise MongoArgumentError, "SSL has not been enabled (:ssl=false) " +
+          "but the following  SSL related options were " +
+          "specified: #{ssl_opts.join(', ')}"
+      end
 
-      @ssl = opts.delete(:ssl)
-      @unix = @host ? @host.end_with?('.sock') : false
-
+      @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)
+
+        # verify peer requires ca_cert, raise if only one is present
+        if @socket_opts[:verify] && !@socket_opts[:ca_cert]
+          raise MongoArgumentError,
+            "If :ssl_verify_mode has been specified, then you must include " +
+            ":ssl_ca_cert in order to perform server validation."
+        end
+
         @socket_class = Mongo::SSLSocket
       elsif @unix
         @socket_class = Mongo::UNIXSocket
@@ -612,7 +664,8 @@ module Mongo
       @pool_size = opts.delete(:pool_size) || 1
       if opts[:timeout]
         warn "The :timeout option has been deprecated " +
-          "and will be removed in the 2.0 release. Use :pool_timeout instead."
+             "and will be removed in the 2.0 release. " +
+             "Use :pool_timeout instead."
       end
       @pool_timeout = opts.delete(:pool_timeout) || opts.delete(:timeout) || 5.0
 

data/lib/mongo/mongo_replica_set_client.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
 
   # Instantiates and manages connections to a MongoDB replica set.
@@ -69,6 +83,13 @@ module Mongo
     #   @option opts [Float] :connect_timeout (30) The number of seconds to wait before timing out a
     #     connection attempt.
     #   @option opts [Boolean] :ssl (false) If true, create the connection to the server using SSL.
+    #   @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.
+    #     If included with the :ssl_cert then only :ssl_cert is needed.
+    #   @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.
+    #     Required for :ssl_verify.
     #   @option opts [Boolean] :refresh_mode (false) Set this to :sync to periodically update the
     #     state of the connection every :refresh_interval seconds. Replica set connection failures
     #     will always trigger a complete refresh. This option is useful when you want to add new nodes

data/lib/mongo/mongo_sharded_client.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
 
   # Instantiates and manages connections to a MongoDB sharded cluster for high availability.
@@ -52,7 +66,7 @@ module Mongo
     end
 
     def valid_opts
-      GENERIC_OPTS + SHARDED_CLUSTER_OPTS + READ_PREFERENCE_OPTS + WRITE_CONCERN_OPTS
+      super + SHARDED_CLUSTER_OPTS
     end
 
     def inspect

data/lib/mongo/networking.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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
   module Networking
 

data/lib/mongo/util/conversions.rb

@@ -1,3 +1,17 @@
+# Copyright (C) 2013 10gen 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 #:nodoc:
 
   # Utility module to include when needing to convert certain types of
@@ -31,7 +45,7 @@ module Mongo #:nodoc:
     end
 
     # Converts the supplied +Array+ to a +Hash+ to pass to mongo as
-    # sorting parameters. The returned +Hash+ will vary depending 
+    # sorting parameters. The returned +Hash+ will vary depending
     # on whether the passed +Array+ is one or two dimensional.
     #
     # Example:
@@ -73,7 +87,7 @@ module Mongo #:nodoc:
       { str => 1 }
     end
 
-    # Converts the +String+, +Symbol+, or +Integer+ to the 
+    # Converts the +String+, +Symbol+, or +Integer+ to the
     # corresponding sort value in MongoDB.
     #
     # Valid conversions (case-insensitive):