moped 1.3.2 → 1.4.0

data/lib/moped/collection.rb

@@ -13,6 +13,18 @@ module Moped
     # @attribute [r] name The collection name.
     attr_reader :database, :name
 
+    # Return whether or not this collection is a capped collection.
+    #
+    # @example Is the collection capped?
+    #   collection.capped?
+    #
+    # @return [ true, false ] If the collection is capped.
+    #
+    # @since 1.4.0
+    def capped?
+      database.command(collstats: name)["capped"]
+    end
+
     # Drop the collection.
     #
     # @example Drop the collection.
@@ -107,12 +119,10 @@ module Moped
     # @return [ Hash ] containing the result of aggregation
     #
     # @since 1.3.0
-    def aggregate(pipeline)
-      pipeline = [ pipeline ] unless pipeline.is_a?(Array)
+    def aggregate(*pipeline)
+      pipeline.flatten!
       command = { aggregate: name.to_s, pipeline: pipeline }
-      database.session.with(consistency: :strong) do |sess|
-        sess.command(command)["result"]
-      end
+      database.session.command(command)["result"]
     end
   end
 end

data/lib/moped/database.rb

@@ -54,7 +54,7 @@ module Moped
     #
     # @since 1.0.0
     def collection_names
-      namespaces = Collection.new(self, "system.namespaces").find(name: { "$not" => /#{name}\.system|\$/ })
+      namespaces = Collection.new(self, "system.namespaces").find(name: { "$not" => /#{name}\.system\.|\$/ })
       namespaces.map do |doc|
         _name = doc["name"]
         _name[name.length + 1, _name.length]

data/lib/moped/errors.rb

@@ -93,18 +93,32 @@ module Moped
       end
     end
 
+    # Classes of errors that should not disconnect connections.
+    class DoNotDisconnect < MongoError; end
+
+    # Classes of errors that could be caused by a replica set reconfiguration.
+    class PotentialReconfiguration < MongoError
+
+      # Replica set reconfigurations can be either in the form of an operation
+      # error with code 13435, or with an error message stating the server is
+      # not a master. (This encapsulates codes 10054, 10056, 10058)
+      def reconfiguring_replica_set?
+        details["code"] == 13435 || details["err"] == "not master"
+      end
+    end
+
     # Exception raised when authentication fails.
-    class AuthenticationFailure < MongoError; end
+    class AuthenticationFailure < DoNotDisconnect; end
 
     # Exception class for exceptions generated as a direct result of an
     # operation, such as a failed insert or an invalid command.
-    class OperationFailure < MongoError; end
+    class OperationFailure < PotentialReconfiguration; end
 
     # Exception raised on invalid queries.
-    class QueryFailure < MongoError; end
+    class QueryFailure < PotentialReconfiguration; end
 
     # Exception raised if the cursor could not be found.
-    class CursorNotFound < MongoError
+    class CursorNotFound < DoNotDisconnect
       def initialize(operation, cursor_id)
         super(operation, {"errmsg" => "cursor #{cursor_id} not found"})
       end
@@ -114,7 +128,7 @@ module Moped
     #
     # Internal exception raised by Node#ensure_primary and captured by
     # Cluster#with_primary.
-    class ReplicaSetReconfigured < StandardError; end
+    class ReplicaSetReconfigured < DoNotDisconnect; end
 
     # Tag applied to unhandled exceptions on a node.
     module SocketError; end

data/lib/moped/node.rb

@@ -127,32 +127,17 @@ module Moped
       begin
         connect unless connected?
         yield
-      rescue Errors::ReplicaSetReconfigured
-        # Someone else wrapped this in an #ensure_primary block, so let the
-        # reconfiguration exception bubble up.
-        raise
-      rescue Errors::QueryFailure => e
-        # We might have a replica set change with:
-        # "failed with error 13435: "not master and slaveOk=false"
-        if e.details['code'] == 13435
+      rescue Errors::PotentialReconfiguration => e
+        if e.reconfiguring_replica_set?
           raise Errors::ReplicaSetReconfigured
         end
         raise
-      rescue Errors::OperationFailure => e
-        # We might have a replica set change with:
-        # MongoDB uses 3 different error codes for "not master", [10054, 10056, 10058]
-        # thus it is easier to capture the "err"
-        if e.details["err"] == "not master"
-          raise Errors::ReplicaSetReconfigured
-        end
-        raise
-      rescue Errors::AuthenticationFailure, Errors::CursorNotFound
+      rescue Errors::DoNotDisconnect
         # These exceptions are "expected" in the normal course of events, and
         # don't necessitate disconnecting.
         raise
       rescue Errors::ConnectionFailure
         disconnect
-
         if retry_on_failure
           # Maybe there was a hiccup -- try reconnecting one more time
           retry_on_failure = false
@@ -387,7 +372,7 @@ module Moped
     #   node.refresh
     #
     # @raise [ ConnectionFailure ] If the node cannot be reached.
-
+    #
     # @raise [ ReplicaSetReconfigured ] If the node is no longer a primary node and
     #   refresh was called within an +#ensure_primary+ block.
     #
@@ -398,18 +383,11 @@ module Moped
       if resolve_address
         begin
           info = command("admin", ismaster: 1)
-
           @refreshed_at = Time.now
-          primary = true if info["ismaster"]
+          primary = true   if info["ismaster"]
           secondary = true if info["secondary"]
+          generate_peers(info)
 
-          peers = []
-          peers.push(info["primary"]) if info["primary"]
-          peers.concat(info["hosts"]) if info["hosts"]
-          peers.concat(info["passives"]) if info["passives"]
-          peers.concat(info["arbiters"]) if info["arbiters"]
-
-          @peers = peers.map { |peer| Node.new(peer, options) }
           @primary, @secondary = primary, secondary
           @arbiter = info["arbiterOnly"]
           @passive = info["passive"]
@@ -475,28 +453,42 @@ module Moped
       process(Protocol::Update.new(database, collection, selector, change, options))
     end
 
+    # Get the node as a nice formatted string.
+    #
+    # @example Inspect the node.
+    #   node.inspect
+    #
+    # @return [ String ] The string inspection.
+    #
+    # @since 1.0.0
     def inspect
       "<#{self.class.name} resolved_address=#{@resolved_address.inspect}>"
     end
 
-
     private
 
     def auth
       @auth ||= {}
     end
 
+    def generate_peers(info)
+      peers = []
+      peers.push(info["primary"]) if info["primary"]
+      peers.concat(info["hosts"]) if info["hosts"]
+      peers.concat(info["passives"]) if info["passives"]
+      peers.concat(info["arbiters"]) if info["arbiters"]
+      @peers = peers.map { |peer| Node.new(peer, options) }.uniq
+    end
+
     def login(database, username, password)
       getnonce = Protocol::Command.new(database, getnonce: 1)
       connection.write [getnonce]
       result = connection.read.documents.first
       raise Errors::OperationFailure.new(getnonce, result) unless result["ok"] == 1
-
       authenticate = Protocol::Commands::Authenticate.new(database, username, password, result["nonce"])
       connection.write [authenticate]
       result = connection.read.documents.first
       raise Errors::AuthenticationFailure.new(authenticate, result) unless result["ok"] == 1
-
       auth[database] = [username, password]
     end
 

data/lib/moped/protocol/query.rb

@@ -134,6 +134,21 @@ module Moped
         f.join(" ") % v
       end
 
+      # Get the basic selector.
+      #
+      # @example Get the basic selector.
+      #   query.basic_selector
+      #
+      # @note Sometimes, like in cases of deletion we need this since MongoDB
+      # does not understand $query in operations like DELETE.
+      #
+      # @return [ Hash ] The basic selector.
+      #
+      # @since 2.0.0
+      def basic_selector
+        selector["$query"] || selector
+      end
+
       # Receive replies to the message.
       #
       # @example Receive replies.

data/lib/moped/query.rb

@@ -32,11 +32,10 @@ module Moped
     # @return [ Integer ] The number of documents that match the selector.
     #
     # @since 1.0.0
-    def count
-      result = collection.database.command(
-        count: collection.name,
-        query: selector
-      )
+    def count(limit = false)
+      command = { count: collection.name, query: selector }
+      command.merge!(skip: operation.skip, limit: operation.limit) if limit
+      result = collection.database.command(command)
       result["n"].to_i
     end
 
@@ -93,12 +92,14 @@ module Moped
       explanation = operation.selector.dup
       hint = explanation["$hint"]
       sort = explanation["$orderby"]
+      max_scan = explanation["$maxScan"]
       explanation = {
         "$query" => selector,
         "$explain" => true,
       }
       explanation["$orderby"] = sort if sort
       explanation["$hint"] = hint if hint
+      explanation["$maxScan"] = max_scan if max_scan
       Query.new(collection, explanation).limit(-(operation.limit.abs)).each { |doc| return doc }
     end
 
@@ -135,11 +136,27 @@ module Moped
     #
     # @since 1.0.0
     def hint(hint)
-      operation.selector = { "$query" => selector } unless operation.selector["$query"]
+      upgrade_to_advanced_selector
       operation.selector["$hint"] = hint
       self
     end
 
+    # Apply a max scan limit to the query.
+    #
+    # @example Limit the query to only scan up to 100 documents
+    #   db[:people].find.max_scan(100)
+    #
+    # @param [ Integer ] max The maximum number of documents to scan
+    #
+    # @return [ Query ] self
+    #
+    # @since 1.4.0
+    def max_scan(max)
+      upgrade_to_advanced_selector
+      operation.selector["$maxScan"] = max
+      self
+    end
+
     # Initialize the query.
     #
     # @example Initialize the query.
@@ -256,7 +273,7 @@ module Moped
         session.context.remove(
           operation.database,
           operation.collection,
-          operation.selector,
+          operation.basic_selector,
           flags: [ :remove_first ]
         )
       end
@@ -275,7 +292,7 @@ module Moped
         session.context.remove(
           operation.database,
           operation.collection,
-          operation.selector
+          operation.basic_selector
         )
       end
     end
@@ -321,7 +338,8 @@ module Moped
     #
     # @since 1.0.0
     def sort(sort)
-      operation.selector = { "$query" => selector, "$orderby" => sort }
+      upgrade_to_advanced_selector
+      operation.selector["$orderby"] = sort
       self
     end
 
@@ -404,5 +422,9 @@ module Moped
     def session
       collection.database.session
     end
+
+    def upgrade_to_advanced_selector
+      operation.selector = { "$query" => selector } unless operation.selector["$query"]
+    end
   end
 end

data/lib/moped/session.rb

@@ -130,6 +130,18 @@ module Moped
       current_database.drop
     end
 
+    # Provide a string inspection for the session.
+    #
+    # @example Inspect the session.
+    #   session.inspect
+    #
+    # @return [ String ] The string inspection.
+    #
+    # @since 1.4.0
+    def inspect
+      "<#{self.class.name} seeds=#{cluster.seeds} database=#{current_database_name}>"
+    end
+
     # Log in with +username+ and +password+ on the current database.
     #
     # @param (see Moped::Database#login)
@@ -229,7 +241,7 @@ module Moped
       session = with(options)
       session.instance_variable_set(:@cluster, cluster.dup)
       if block_given?
-        yield session
+        yield(session)
       else
         session
       end
@@ -271,7 +283,7 @@ module Moped
     # @since 1.0.0
     def use(database)
       options[:database] = database
-      set_current_database database
+      set_current_database(database)
     end
 
     # Create a new session with +options+ reusing existing connections.
@@ -309,7 +321,7 @@ module Moped
       session = dup
       session.options.update(options)
       if block_given?
-        yield session
+        yield(session)
       else
         session
       end
@@ -338,8 +350,7 @@ module Moped
     private
 
     def current_database
-      return @current_database if defined? @current_database
-
+      return @current_database if defined?(@current_database)
       if database = options[:database]
         set_current_database(database)
       else
@@ -347,12 +358,15 @@ module Moped
       end
     end
 
+    def current_database_name
+      defined?(@current_database) ? current_database.name : :none
+    end
+
     def initialize_copy(_)
       @context = Context.new(self)
       @options = @options.dup
-
-      if defined? @current_database
-        remove_instance_variable :@current_database
+      if defined?(@current_database)
+        remove_instance_variable(:@current_database)
       end
     end
 

data/lib/moped/sockets/connectable.rb

@@ -13,7 +13,7 @@ module Moped
       #
       # @since 1.0.0
       def alive?
-        if Kernel::select([ self ], nil, nil, 0)
+        if Kernel::select([ self ], nil, [ self ], 0)
           !eof? rescue false
         else
           true
@@ -42,6 +42,7 @@ module Moped
       #
       # @since 1.2.0
       def read(length)
+        check_if_alive!
         handle_socket_errors { super }
       end
 
@@ -56,30 +57,77 @@ module Moped
       #
       # @since 1.0.0
       def write(*args)
-        raise Errors::ConnectionFailure, "Socket connection was closed by remote host" unless alive?
+        check_if_alive!
         handle_socket_errors { super }
       end
 
       private
 
+      # Before performing a read or write operating, ping the server to check
+      # if it is alive.
+      #
+      # @api private
+      #
+      # @example Check if the connection is alive.
+      #   connectable.check_if_alive!
+      #
+      # @raise [ ConnectionFailure ] If the connectable is not alive.
+      #
+      # @since 1.4.0
+      def check_if_alive!
+        unless alive?
+          raise Errors::ConnectionFailure, "Socket connection was closed by remote host"
+        end
+      end
+
+      # Generate the message for the connection failure based of the system
+      # call error, with some added information.
+      #
+      # @api private
+      #
+      # @example Generate the error message.
+      #   connectable.generate_message(error)
+      #
+      # @param [ SystemCallError ] error The error.
+      #
+      # @return [ String ] The error message.
+      #
+      # @since 1.4.0
+      def generate_message(error)
+        "#{host}:#{port}: #{error.class.name} (#{error.errno}): #{error.message}"
+      end
+
       # Handle the potential socket errors that can occur.
       #
       # @api private
       #
       # @example Handle the socket errors while executing the block.
       #   handle_socket_errors do
-      #     #...
+      #     socket.read(128)
       #   end
       #
+      # @raise [ Moped::Errors::ConnectionFailure ] If a system call error or
+      #   IOError occured which can be retried.
+      # @raise [ Moped::Errors::Unrecoverable ] If a system call error occured
+      #   which cannot be retried and should be re-raised.
+      #
       # @return [ Object ] The result of the yield.
       #
       # @since 1.0.0
       def handle_socket_errors
         yield
-      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EPIPE
-        raise Errors::ConnectionFailure, "Could not connect to Mongo on #{host}:#{port}"
-      rescue Errno::ECONNRESET
-        raise Errors::ConnectionFailure, "Connection reset to Mongo on #{host}:#{port}"
+      rescue Errno::ECONNREFUSED => e
+        raise Errors::ConnectionFailure, generate_message(e)
+      rescue Errno::EHOSTUNREACH => e
+        raise Errors::ConnectionFailure, generate_message(e)
+      rescue Errno::EPIPE => e
+        raise Errors::ConnectionFailure, generate_message(e)
+      rescue Errno::ECONNRESET => e
+        raise Errors::ConnectionFailure, generate_message(e)
+      rescue Errno::ETIMEDOUT => e
+        raise Errors::ConnectionFailure, generate_message(e)
+      rescue IOError
+        raise Errors::ConnectionFailure, "Connection timed out to Mongo on #{host}:#{port}"
       rescue OpenSSL::SSL::SSLError => e
         raise Errors::ConnectionFailure, "SSL Error '#{e.to_s}' for connection to Mongo on #{host}:#{port}"
       end
@@ -103,7 +151,10 @@ module Moped
             Timeout::timeout(timeout) do
               sock = new(host, port)
               sock.set_encoding('binary')
+              timeout_val = [ timeout, 0 ].pack("l_2")
               sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+              sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, timeout_val)
+              sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, timeout_val)
               sock
             end
           rescue Timeout::Error