mongo 1.1.5 → 1.3.0

data/lib/mongo/db.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -56,33 +56,33 @@ module Mongo
 
     # Instances of DB are normally obtained by calling Mongo#db.
     #
-    # @param [String] db_name the database name.
+    # @param [String] name the database name.
     # @param [Mongo::Connection] connection a connection object pointing to MongoDB. Note
     #   that databases are usually instantiated via the Connection class. See the examples below.
     #
-    # @option options [Boolean] :strict (False) If true, collections must exist to be accessed and must
+    # @option opts [Boolean] :strict (False) If true, collections must exist to be accessed and must
     #   not exist to be created. See DB#collection and DB#create_collection.
     #
-    # @option options [Object, #create_pk(doc)] :pk (Mongo::ObjectId) A primary key factory object,
+    # @option opts [Object, #create_pk(doc)] :pk (Mongo::ObjectId) A primary key factory object,
     #   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).
     #
-    # @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
-    #   propogated to Collection objects instantiated off of this DB. If no
+    # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
+    #   propagated to Collection objects instantiated off of this DB. If no
     #   value is provided, the default value set on this instance's Connection object will be used. This
     #   default can be overridden upon instantiation of any collection by explicity setting a :safe value
     #   on initialization
-    # @option options [Integer] :cache_time (300) Set the time that all ensure_index calls should cache the command.
+    # @option opts [Integer] :cache_time (300) Set the time that all ensure_index calls should cache the command.
     #
     # @core databases constructor_details
-    def initialize(db_name, connection, options={})
-      @name       = Mongo::Support.validate_db_name(db_name)
+    def initialize(name, connection, opts={})
+      @name       = Mongo::Support.validate_db_name(name)
       @connection = connection
-      @strict     = options[:strict]
-      @pk_factory = options[:pk]
-      @safe       = options.has_key?(:safe) ? options[:safe] : @connection.safe
-      @cache_time = options[:cache_time] || 300 #5 minutes.
+      @strict     = opts[:strict]
+      @pk_factory = opts[:pk]
+      @safe       = opts.fetch(:safe, @connection.safe)
+      @cache_time = opts[:cache_time] || 300 #5 minutes.
     end
 
     # Authenticate with the given username and password. Note that mongod
@@ -92,7 +92,8 @@ module Mongo
     # @param [String] password
     # @param [Boolean] save_auth
     #   Save this authentication to the connection object using Connection#add_auth. This
-    #   will ensure that the authentication will be applied on database reconnect.
+    #   will ensure that the authentication will be applied on database reconnect. Note
+    #   that this value must be true when using connection pooling.
     #
     # @return [Boolean]
     #
@@ -100,8 +101,19 @@ module Mongo
     #
     # @core authenticate authenticate-instance_method
     def authenticate(username, password, save_auth=true)
-      doc = command({:getnonce => 1}, :check_response => false)
-      raise "error retrieving nonce: #{doc}" unless ok?(doc)
+      if @connection.pool_size > 1
+        if !save_auth
+          raise MongoArgumentError, "If using connection pooling, :save_auth must be set to true."
+        end
+        @connection.authenticate_pools
+      end
+
+      issue_authentication(username, password, save_auth)
+    end
+
+    def issue_authentication(username, password, save_auth=true, opts={})
+      doc = command({:getnonce => 1}, :check_response => false, :socket => opts[:socket])
+      raise MongoDBError, "Error retrieving nonce: #{doc}" unless ok?(doc)
       nonce = doc['nonce']
 
       auth = BSON::OrderedHash.new
@@ -109,7 +121,7 @@ module Mongo
       auth['user'] = username
       auth['nonce'] = nonce
       auth['key'] = Mongo::Support.auth_key(username, password, nonce)
-      if ok?(self.command(auth, :check_response => false))
+      if ok?(self.command(auth, :check_response => false, :socket => opts[:socket]))
         if save_auth
           @connection.add_auth(@name, username, password)
         end
@@ -121,7 +133,7 @@ module Mongo
 
     # Adds a stored Javascript function to the database which can executed  
     # server-side in map_reduce, db.eval and $where clauses.
-    # 
+    #
     # @param [String] function_name
     # @param [String] code
     #
@@ -179,14 +191,22 @@ module Mongo
     end
 
     # Deauthorizes use for this database for this connection. Also removes
-    # any saved authorization in the connection class associated with this
+    # any saved authentication in the connection class associated with this
     # database.
     #
     # @raise [MongoDBError] if logging out fails.
     #
     # @return [Boolean]
-    def logout
-      doc = command(:logout => 1)
+    def logout(opts={})
+      if @connection.pool_size > 1
+        @connection.logout_pools(@name)
+      end
+
+      issue_logout(opts)
+    end
+
+    def issue_logout(opts={})
+      doc = command({:logout => 1}, :socket => opts[:socket])
       if ok?(doc)
         @connection.remove_auth(@name)
         true
@@ -208,8 +228,8 @@ module Mongo
     #
     # @return [Array<Mongo::Collection>]
     def collections
-      collection_names.map do |collection_name|
-        Collection.new(self, collection_name)
+      collection_names.map do |name|
+        Collection.new(name, self)
       end
     end
 
@@ -223,7 +243,7 @@ module Mongo
     def collections_info(coll_name=nil)
       selector = {}
       selector[:name] = full_collection_name(coll_name) if coll_name
-      Cursor.new(Collection.new(self, SYSTEM_NAMESPACE_COLLECTION), :selector => selector)
+      Cursor.new(Collection.new(SYSTEM_NAMESPACE_COLLECTION, self), :selector => selector)
     end
 
     # Create a collection.
@@ -233,52 +253,52 @@ module Mongo
     #
     # @param [String] name the name of the new collection.
     #
-    # @option options [Boolean] :capped (False) created a capped collection.
+    # @option opts [Boolean] :capped (False) created a capped collection.
     #
-    # @option options [Integer] :size (Nil) If +capped+ is +true+, specifies the maximum number of
+    # @option opts [Integer] :size (Nil) If +capped+ is +true+, specifies the maximum number of
     #   bytes for the capped collection. If +false+, specifies the number of bytes allocated
     #   for the initial extent of the collection.
     #
-    # @option options [Integer] :max (Nil) If +capped+ is +true+, indicates the maximum number of records 
+    # @option opts [Integer] :max (Nil) If +capped+ is +true+, indicates the maximum number of records
     #   in a capped collection.
     #
     # @raise [MongoDBError] raised under two conditions: either we're in +strict+ mode and the collection
     #   already exists or collection creation fails on the server.
     #
     # @return [Mongo::Collection]
-    def create_collection(name, options={})
+    def create_collection(name, opts={})
       # Does the collection already exist?
       if collection_names.include?(name)
         if strict?
           raise MongoDBError, "Collection #{name} already exists. Currently in strict mode."
         else
-          return Collection.new(self, name)
+          return Collection.new(name, self, opts)
         end
       end
 
       # Create a new collection.
       oh = BSON::OrderedHash.new
       oh[:create] = name
-      doc = command(oh.merge(options || {}))
-      return Collection.new(self, name, :pk => @pk_factory) if ok?(doc)
+      doc = command(oh.merge(opts || {}))
+      return Collection.new(name, self, :pk => @pk_factory) if ok?(doc)
       raise MongoDBError, "Error creating collection: #{doc.inspect}"
     end
 
     # Get a collection by name.
     #
     # @param [String] name the collection name.
-    # @param [Hash] options any valid options that can me passed to Collection#new.
+    # @param [Hash] opts any valid options that can be passed to Collection#new.
     #
     # @raise [MongoDBError] if collection does not already exist and we're in +strict+ mode.
     #
     # @return [Mongo::Collection]
-    def collection(name, options={})
+    def collection(name, opts={})
       if strict? && !collection_names.include?(name)
         raise Mongo::MongoDBError, "Collection #{name} doesn't exist. Currently in strict mode."
       else
-        options[:safe] = options.has_key?(:safe) ? options[:safe] : @safe
-        options.merge!(:pk => @pk_factory) unless options[:pk]
-        Collection.new(self, name, options)
+        opts[:safe] = opts.fetch(:safe, @safe)
+        opts.merge!(:pk => @pk_factory) unless opts[:pk]
+        Collection.new(name, self, opts)
       end
     end
     alias_method :[], :collection
@@ -403,7 +423,7 @@ module Mongo
     def drop_index(collection_name, index_name)
       oh = BSON::OrderedHash.new
       oh[:deleteIndexes] = collection_name
-      oh[:index] = index_name
+      oh[:index] = index_name.to_s
       doc = command(oh, :check_response => false)
       ok?(doc) || raise(MongoDBError, "Error with drop_index command: #{doc.inspect}")
     end
@@ -418,7 +438,7 @@ module Mongo
     def index_information(collection_name)
       sel  = {:ns => full_collection_name(collection_name)}
       info = {}
-      Cursor.new(Collection.new(self, SYSTEM_INDEX_COLLECTION), :selector => sel).each do |index|
+      Cursor.new(Collection.new(SYSTEM_INDEX_COLLECTION, self), :selector => sel).each do |index|
         info[index['name']] = index
       end
       info
@@ -455,14 +475,14 @@ module Mongo
     #
     # @option opts [Boolean] :check_response (true) If +true+, raises an exception if the
     # command fails.
-    # @option opts [Socket] :sock a socket to use for sending the command. This is mainly for internal use.
+    # @option opts [Socket] :socket a socket to use for sending the command. This is mainly for internal use.
     #
     # @return [Hash]
     #
     # @core commands command_instance-method
     def command(selector, opts={})
       check_response = opts.fetch(:check_response, true)
-      sock           = opts[:sock]
+      socket         = opts[:socket]
       raise MongoArgumentError, "command must be given a selector" unless selector.is_a?(Hash) && !selector.empty?
       if selector.keys.length > 1 && RUBY_VERSION < '1.9' && selector.class != BSON::OrderedHash
         raise MongoArgumentError, "DB#command requires an OrderedHash when hash contains multiple keys"
@@ -470,7 +490,7 @@ module Mongo
 
       begin
         result = Cursor.new(system_command_collection,
-          :limit => -1, :selector => selector, :socket => sock).next_document
+          :limit => -1, :selector => selector, :socket => socket).next_document
       rescue OperationFailure => ex
         raise OperationFailure, "Database command '#{selector.keys.first}' failed: #{ex.message}"
       end
@@ -558,7 +578,7 @@ module Mongo
     #
     # @return [Array] a list of documents containing profiling information.
     def profiling_info
-      Cursor.new(Collection.new(self, DB::SYSTEM_PROFILE_COLLECTION), :selector => {}).to_a
+      Cursor.new(Collection.new(SYSTEM_PROFILE_COLLECTION, self), :selector => {}).to_a
     end
 
     # Validate a named collection.
@@ -581,7 +601,7 @@ module Mongo
     private
 
     def system_command_collection
-      Collection.new(self, SYSTEM_COMMAND_COLLECTION)
+      Collection.new(SYSTEM_COMMAND_COLLECTION, self)
     end
   end
 end

data/lib/mongo/exceptions.rb

@@ -2,7 +2,7 @@
 
 #
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -57,6 +57,9 @@ module Mongo
   # Raised when a database operation fails.
   class OperationFailure < MongoDBError; end
 
+  # Raised when a socket read operation times out.
+  class OperationTimeout < ::Timeout::Error; end
+
   # Raised when a client attempts to perform an invalid operation.
   class InvalidOperation < MongoDBError; end
 

data/lib/mongo/gridfs/grid.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_ext.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_file_system.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/gridfs/grid_io.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,10 +17,6 @@
 # ++
 
 require 'digest/md5'
-begin
-require 'mime/types'
-rescue LoadError
-end
 
 module Mongo
 
@@ -172,6 +168,91 @@ module Mongo
     def tell
       @file_position
     end
+    alias :pos :tell
+
+    # Rewind the file. This is equivalent to seeking to the zeroth position.
+    #
+    # @return [Integer] the position of the file after rewinding (always zero).
+    def rewind
+      raise GridError, "file not opened for read" unless @mode[0] == ?r
+      seek(0)
+    end
+
+    # Return a boolean indicating whether the position pointer is
+    # at the end of the file.
+    #
+    # @return [Boolean]
+    def eof
+      raise GridError, "file not opened for read #{@mode}" unless @mode[0] == ?r
+      @file_position >= @file_length
+    end
+    alias :eof? :eof
+
+    # Return the next line from a GridFS file. This probably
+    # makes sense only if you're storing plain text. This method
+    # has a somewhat tricky API, which it inherits from Ruby's
+    # StringIO#gets.
+    #
+    # @param [String, Integer] separator or length. If a separator,
+    #   read up to the separator. If a length, read the +length+ number
+    #   of bytes. If nil, read the entire file.
+    # @param [Integer] length If a separator is provided, then
+    #   read until either finding the separator or
+    #   passing over the +length+ number of bytes.
+    #
+    # @return [String]
+    def gets(separator="\n", length=nil)
+      if separator.nil?
+        read_all
+      elsif separator.is_a?(Integer)
+        read_length(separator)
+      elsif separator.length > 1
+        result = ''
+        len = 0
+        match_idx = 0
+        match_num = separator.length - 1
+        to_match = separator[match_idx].chr
+        if length
+          matcher = lambda {|idx, num| idx < num && len < length }
+        else
+          matcher = lambda {|idx, num| idx < num}
+        end
+        while matcher.call(match_idx, match_num) && char = getc
+          result << char
+          len += 1
+          if char == to_match
+            while match_idx < match_num do
+              match_idx += 1
+              to_match = separator[match_idx].chr
+              char = getc
+              result << char
+              if char != to_match
+                match_idx = 0
+                to_match = separator[match_idx].chr
+                break
+              end
+            end
+          end
+        end
+        result
+      else
+        result = ''
+        len = 0
+        while char = getc
+          result << char
+          len += 1
+          break if char == separator || (length ? len >= length : false)
+        end
+        result
+      end
+    end
+
+    # Return the next byte from the GridFS file.
+    #
+    # @return [String]
+    def getc
+      read_length(1)
+    end
 
     # Creates or updates the document from the files collection that
     # stores the chunks' metadata. The file becomes available only after
@@ -260,7 +341,7 @@ module Mongo
       if length.nil?
         to_read = remaining
       else
-        to_read    = length > remaining ? remaining : length
+        to_read = length > remaining ? remaining : length
       end
       return nil unless remaining > 0
 
@@ -335,8 +416,8 @@ module Mongo
       @files_id      = opts.delete(:_id) || BSON::ObjectId.new
       @content_type  = opts.delete(:content_type) || (defined? MIME) && get_content_type || DEFAULT_CONTENT_TYPE
       @chunk_size    = opts.delete(:chunk_size) || DEFAULT_CHUNK_SIZE
-      @metadata      = opts.delete(:metadata) if opts[:metadata]
-      @aliases       = opts.delete(:aliases) if opts[:aliases]
+      @metadata      = opts.delete(:metadata)
+      @aliases       = opts.delete(:aliases)
       @file_length   = 0
       opts.each {|k, v| self[k] = v}
       check_existing_file if @safe

data/lib/mongo/gridfs/grid_io_fix.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/repl_set_connection.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,9 +29,11 @@ module Mongo
     # Connection#arbiters. This is useful if your application needs to connect manually to nodes other
     # than the primary.
     #
-    # @param [Array] args A list of host-port pairs ending with a hash containing any options. See
-    #   the examples below for exactly how to use the constructor.
+    # @param [Array] args A list of host-port pairs to be used as seed nodes followed by a
+    #   hash containing any options. See the examples below for exactly how to use the constructor.
     #
+    # @option options [String] :rs_name (nil) The name of the replica set to connect to. You
+    #   can use this option to verify that you're connecting to the right replica set.
     # @option options [Boolean, Hash] :safe (false) Set the default safe-mode options
     #   propogated to DB objects instantiated off of this Connection. This
     #   default can be overridden upon instantiation of any DB by explicity setting a :safe value
@@ -45,11 +47,15 @@ module Mongo
     #   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.
     #
-    # @example Connect to a replica set and provide two seed nodes:
+    # @example Connect to a replica set and provide two seed nodes. Note that the number of seed nodes does
+    #   not have to be equal to the number of replica set members. The purpose of seed nodes is to permit
+    #   the driver to find at least one replica set member even if a member is down.
     #   ReplSetConnection.new(['localhost', 30000], ['localhost', 30001])
     #
-    # @example Connect to a replica set providing two seed nodes and allowing reads from a
-    #   secondary node:
+    # @example Connect to a replica set providing two seed nodes and ensuring a connection to the replica set named 'prod':
+    #   ReplSetConnection.new(['localhost', 30000], ['localhost', 30001], :rs_name => 'prod')
+    #
+    # @example Connect to a replica set providing two seed nodes and allowing reads from a secondary node:
     #   ReplSetConnection.new(['localhost', 30000], ['localhost', 30001], :read_secondary => true)
     #
     # @see http://api.mongodb.org/ruby/current/file.REPLICA_SETS.html Replica sets in Ruby
@@ -95,7 +101,7 @@ module Mongo
     #
     # @raise [ConnectionFailure] if unable to connect to any host or port.
     def connect
-      reset_connection
+      close
       @nodes_to_try = @nodes.clone
 
       while connecting?
@@ -111,19 +117,47 @@ module Mongo
 
       pick_secondary_for_read if @read_secondary
 
-      if !connected?
+      if connected?
+        BSON::BSON_CODER.update_max_bson_size(self)
+      else
         if @secondary_pools.empty?
+          close # close any existing pools and sockets
           raise ConnectionFailure, "Failed to connect any given host:port"
         else
+          close # close any existing pools and sockets
           raise ConnectionFailure, "Failed to connect to primary node."
         end
       end
     end
+    alias :reconnect :connect
 
     def connecting?
       @nodes_to_try.length > 0
     end
 
+    # The replica set primary's host name.
+    #
+    # @return [String]
+    def host
+      super
+    end
+
+    # The replica set primary's port.
+    #
+    # @return [Integer]
+    def port
+      super
+    end
+
+    # Determine whether we're reading from a primary node. If false,
+    # this connection connects to a secondary node and @read_secondaries is true.
+    #
+    # @return [Boolean]
+    def read_primary?
+      !@read_pool
+    end
+    alias :primary? :read_primary?
+
     # Close the connection to the database.
     def close
       super
@@ -131,13 +165,6 @@ module Mongo
       @secondary_pools.each do |pool|
         pool.close
       end
-    end
-
-    # If a ConnectionFailure is raised, this method will be called
-    # to close the connection and reset connection values.
-    # TODO: what's the point of this method?
-    def reset_connection
-      super
       @secondaries     = []
       @secondary_pools = []
       @arbiters        = []
@@ -145,6 +172,15 @@ module Mongo
       @nodes_to_try = []
     end
 
+    # If a ConnectionFailure is raised, this method will be called
+    # to close the connection and reset connection values.
+    # @deprecated
+    def reset_connection
+      close
+      warn "ReplSetConnection#reset_connection is now deprecated. " +
+        "Use ReplSetConnection#close instead."
+    end
+
     # Is it okay to connect to a slave?
     #
     # @return [Boolean]
@@ -152,6 +188,20 @@ module Mongo
       @read_secondary || @slave_ok
     end
 
+    def authenticate_pools
+      super
+      @secondary_pools.each do |pool|
+        pool.authenticate_existing
+      end
+    end
+
+    def logout_pools(db)
+      super
+      @secondary_pools.each do |pool|
+        pool.logout_existing(db)
+      end
+    end
+
     private
 
     def check_is_master(node)
@@ -160,13 +210,17 @@ module Mongo
         socket = TCPSocket.new(host, port)
         socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
 
-        config = self['admin'].command({:ismaster => 1}, :sock => socket)
+        config = self['admin'].command({:ismaster => 1}, :socket => socket)
 
         check_set_name(config, socket)
       rescue OperationFailure, SocketError, SystemCallError, IOError => ex
-        close unless connected?
+        # It's necessary to rescue here. The #connect method will keep trying
+        # until it has no more nodes to try and raise a ConnectionFailure if
+        # it can't connect to a primary.
       ensure
+        socket.close if socket
         @nodes_tried << node
+
         if config
           nodes = []
           nodes += config['hosts'] if config['hosts']
@@ -178,8 +232,6 @@ module Mongo
             @logger.warn("MONGODB #{config['msg']}")
           end
         end
-
-        socket.close if socket
       end
 
       config
@@ -203,7 +255,7 @@ module Mongo
     def check_set_name(config, socket)
       if @replica_set
         config = self['admin'].command({:replSetGetStatus => 1},
-                   :sock => socket, :check_response => false)
+                   :socket => socket, :check_response => false)
 
         if !Mongo::Support.ok?(config)
           raise ReplicaSetConnectionError, config['errmsg']

data/lib/mongo/test.rb

@@ -0,0 +1,20 @@
+
+class Foo
+
+  def zed
+    puts "Foo"
+  end
+
+end
+
+class Bar < Foo
+
+  def zed(n=nil)
+    if n.nil?
+      puts "Bar"
+    else
+      super()
+    end
+  end
+
+end

data/lib/mongo/util/conversions.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2010 10gen Inc.
+# Copyright (C) 2008-2011 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.