mongo 1.12.5 → 2.0.0

data/lib/mongo/logger.rb

@@ -0,0 +1,132 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 'logger'
+
+module Mongo
+
+  # Provides ability to log messages.
+  #
+  # @since 2.0.0
+  class Logger
+
+    class << self
+
+      # Log a debug level message.
+      #
+      # @example Log a debug level message.
+      #   Logger.debug('mongo', 'message', '10ms')
+      #
+      # @param [ String ] prefix The category prefix.
+      # @param [ String ] message The log message.
+      # @param [ String ] runtime The time of the operation.
+      #
+      # @since 2.0.0
+      def debug(prefix, message, runtime)
+        logger.debug("#{prefix} | #{message} | runtime: #{runtime}")
+      end
+
+      # Log a error level message.
+      #
+      # @example Log a error level message.
+      #   Logger.error('mongo', 'message', '10ms')
+      #
+      # @param [ String ] prefix The category prefix.
+      # @param [ String ] message The log message.
+      # @param [ String ] runtime The time of the operation.
+      #
+      # @since 2.0.0
+      def error(prefix, message, runtime)
+        logger.error("#{prefix} | #{message} | runtime: #{runtime}")
+      end
+
+      # Log a fatal level message.
+      #
+      # @example Log a fatal level message.
+      #   Logger.fatal('mongo', 'message', '10ms')
+      #
+      # @param [ String ] prefix The category prefix.
+      # @param [ String ] message The log message.
+      # @param [ String ] runtime The time of the operation.
+      #
+      # @since 2.0.0
+      def fatal(prefix, message, runtime)
+        logger.fatal("#{prefix} | #{message} | runtime: #{runtime}")
+      end
+
+      # Log a info level message.
+      #
+      # @example Log a info level message.
+      #   Logger.info('mongo', 'message', '10ms')
+      #
+      # @param [ String ] prefix The category prefix.
+      # @param [ String ] message The log message.
+      # @param [ String ] runtime The time of the operation.
+      #
+      # @since 2.0.0
+      def info(prefix, message, runtime)
+        logger.info("#{prefix} | #{message} | runtime: #{runtime}")
+      end
+
+      # Log a warn level message.
+      #
+      # @example Log a warn level message.
+      #   Logger.warn('mongo', 'message', '10ms')
+      #
+      # @param [ String ] prefix The category prefix.
+      # @param [ String ] message The log message.
+      # @param [ String ] runtime The time of the operation.
+      #
+      # @since 2.0.0
+      def warn(prefix, message, runtime)
+        logger.warn("#{prefix} | #{message} | runtime: #{runtime}")
+      end
+
+      # Get the wrapped logger. If none was set will return a default debug
+      # level logger.
+      #
+      # @example Get the wrapped logger.
+      #   Mongo::Logger.logger
+      #
+      # @return [ ::Logger ] The wrapped logger.
+      #
+      # @since 2.0.0
+      def logger
+        @logger ||= default_logger
+      end
+
+      # Set the logger.
+      #
+      # @example Set the wrapped logger.
+      #   Mongo::Logger.logger = logger
+      #
+      # @param [ ::Logger ] other The logger to set.
+      #
+      # @return [ ::Logger ] The wrapped logger.
+      #
+      # @since 2.0.0
+      def logger=(other)
+        @logger = other
+      end
+
+      private
+
+      def default_logger
+        logger = ::Logger.new($stdout)
+        logger.level = ::Logger::DEBUG
+        logger
+      end
+    end
+  end
+end

data/lib/mongo/operation/aggregate/result.rb

@@ -0,0 +1,88 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+    class Aggregate
+
+      # Defines custom behaviour of results in an aggregation context.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # The field name for the cursor document in an aggregation.
+        #
+        # @since 2.0.0
+        CURSOR = 'cursor'.freeze
+
+        # The cursor id field in the cursor document.
+        #
+        # @since 2.0.0
+        CURSOR_ID = 'id'.freeze
+
+        # The field name for the first batch of a cursor.
+        #
+        # @since 2.0.0
+        FIRST_BATCH = 'firstBatch'.freeze
+
+        # The field name for a result without a cursor.
+        #
+        # @since 2.0.0
+        RESULT = 'result'.freeze
+
+        # Get the cursor id for the result.
+        #
+        # @example Get the cursor id.
+        #   result.cursor_id
+        #
+        # @note Even though the wire protocol has a cursor_id field for all
+        #   messages of type reply, it is always zero when using the
+        #   aggregation framework and must be retrieved from the cursor
+        #   document itself. Wahnsinn!
+        #
+        # @return [ Integer ] The cursor id.
+        #
+        # @since 2.0.0
+        def cursor_id
+          cursor_document ? cursor_document[CURSOR_ID] : super
+        end
+
+        # Get the documents for the aggregation result. This is either the
+        # first document's 'result' field, or if a cursor option was selected
+        # it is the 'firstBatch' field in the 'cursor' field of the first
+        # document returned.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.0.0
+        def documents
+          reply.documents[0][RESULT] || cursor_document[FIRST_BATCH]
+        end
+
+        private
+
+        def cursor_document
+          @cursor_document ||= reply.documents[0][CURSOR]
+        end
+
+        def first_document
+          @first_document ||= reply.documents[0]
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/aggregate.rb

@@ -0,0 +1,100 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 'mongo/operation/aggregate/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB aggregate operation.
+    #
+    # @note An aggregate operation can behave like a read and return a 
+    #   result set, or can behave like a write operation and
+    #   output results to a user-specified collection.
+    #
+    # @example Create the aggregate operation.
+    #   Aggregate.new({
+    #     :selector => {
+    #       :aggregate => 'test_coll', :pipeline => [{ '$out' => 'test-out' }]
+    #     },
+    #     :db_name => 'test_db'
+    #   })
+    #
+    # @param [ Hash ] spec The specifications for the operation.
+    #
+    # @option spec :selector [ Hash ] The aggregate selector.
+    # @option spec :db_name [ String ] The name of the database on which
+    #   the operation should be executed.
+    # @option spec :options [ Hash ] Options for the aggregate command.
+    #
+    # @since 2.0.0
+    class Aggregate
+      include Executable
+      include Specifiable
+      include Limited
+
+      # The need primary error message.
+      #
+      # @since 2.0.0
+      ERROR_MESSAGE = "The pipeline contains the '$out' operator so the primary must be used.".freeze
+
+      # Execute the operation.
+      # The context gets a connection on which the operation
+      # is sent in the block.
+      # If the aggregation will be written to an output collection and the
+      # server is not primary, the operation will be rerouted to the primary
+      # with a warning.
+      #
+      # @param [ Server::Context ] context The context for this operation.
+      #
+      # @return [ Result ] The operation response, if there is one.
+      #
+      # @since 2.0.0
+      def execute(context)
+        unless context.standalone? || context.mongos? || context.primary? || secondary_ok?
+          raise Error::NeedPrimaryServer.new(ERROR_MESSAGE)
+        end
+        execute_message(context)
+      end
+
+      private
+
+      def execute_message(context)
+        context.with_connection do |connection|
+          Result.new(connection.dispatch([ message(context) ])).validate!
+        end
+      end
+
+      # Whether this operation can be executed on a replica set secondary server.
+      # The aggregate operation may not be executed on a secondary if the user has specified
+      # an output collection to which the results will be written.
+      #
+      # @return [ true, false ] Whether the operation can be executed on a secondary.
+      #
+      # @since 2.0.0
+      def secondary_ok?
+        selector[:pipeline].none? { |op| op.key?('$out') || op.key?(:$out) }
+      end
+
+      def filter(context)
+        return selector if context.features.write_command_enabled?
+        selector.reject{ |option, value| option.to_s == 'cursor' }
+      end
+
+      def message(context)
+        Protocol::Query.new(db_name, Database::COMMAND, filter(context), options)
+      end
+    end
+  end
+end

data/lib/mongo/operation/command.rb

@@ -0,0 +1,62 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+
+    # A MongoDB command operation.
+    #
+    # @example Create the command operation.
+    #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
+    #
+    # @note A command is actually a query on the virtual '$cmd' collection.
+    #
+    # @param [ Hash ] spec The specifications for the command.
+    #
+    # @option spec :selector [ Hash ] The command selector.
+    # @option spec :db_name [ String ] The name of the database on which
+    #   the command should be executed.
+    # @option spec :options [ Hash ] Options for the command.
+    #
+    # @since 2.0.0
+    class Command
+      include Executable
+      include Specifiable
+      include Limited
+      include ReadPreferrable
+
+      # Execute the command operation.
+      #
+      # @example Execute the operation.
+      #   operation.execute(context)
+      #
+      # @param [ Server::Context ] context The context for this operation.
+      #
+      # @return [ Result ] The operation result.
+      #
+      # @since 2.0.0
+      def execute(context)
+        context.with_connection do |connection|
+          Result.new(connection.dispatch([ message(context) ])).validate!
+        end
+      end
+
+      private
+
+      def query_coll
+        Database::COMMAND
+      end
+    end
+  end
+end

data/lib/mongo/operation/executable.rb

@@ -0,0 +1,105 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+
+    # This module contains common functionality for defining an operation
+    # and executing it, given a certain context.
+    #
+    # @since 2.0.0
+    module Executable
+
+      # Execute the operation.
+      # The context gets a connection on which the operation
+      # is sent in the block.
+      #
+      # @param [ Mongo::Server::Context ] context The context for this operation.
+      #
+      # @return [ Result ] The operation response, if there is one.
+      #
+      # @since 2.0.0
+      def execute(context)
+        context.with_connection do |connection|
+          connection.dispatch([ message ])
+        end
+      end
+
+      # Merge this operation with another operation, returning a new one.
+      # Requires that the collection and database of the two ops are the same.
+      #
+      # @param[ Object ] The other operation.
+      #
+      # @return [ Object ] A new operation merging this one and another.
+      #
+      # @since 2.0.0
+      def merge(other)
+        # @todo: use specific exception
+        raise Exception, "Cannot merge" unless self.class == other.class &&
+            coll_name == other.coll_name &&
+            db_name == other.db_name
+        dup.merge!(other)
+      end
+
+      # Get the full namespace that this operates on.
+      #
+      # @example Get the namespace.
+      #   executable.namespace
+      #
+      # @return [ String ] The namespace.
+      #
+      # @since 2.0.0
+      def namespace
+        "#{db_name}.#{coll_name}"
+      end
+
+      # If an operation including this module doesn't define #merge!, neither
+      # #merge nor #merge! will be allowed.
+      #
+      # @param[ Object ] The other operation.
+      #
+      # @raise [ Exception ] Merging is not supported for this operation.
+      #
+      # @since 2.0.0
+      def merge!(other)
+        raise Exception, "Merging not allowed for this operation type"
+      end
+
+      private
+
+      # If it's ok that this operation be sent to a secondary server.
+      #
+      # @return [ true, false ] Whether it's ok for this op to go to a secondary.
+      #
+      # @since 2.0.0
+      def secondary_ok?
+        true
+      end
+
+      # Gets the legacy get last error command as a wire protocol query.
+      #
+      # @since 2.0.0
+      def gle
+        if gle_message = write_concern.get_last_error
+          Protocol::Query.new(
+            db_name,
+            Database::COMMAND,
+            gle_message,
+            options.merge(limit: -1)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/kill_cursors.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+
+    # A MongoDB kill cursors operation.
+    #
+    # @example Create the kill cursors operation.
+    #   Mongo::Operation::KillCursor.new({ :cursor_ids => [1, 2] })
+    #
+    # @param [ Hash ] spec The specifications for the operation.
+    #
+    # @option spec :cursor_ids [ Array ] The ids of cursors to kill.
+    #
+    # @since 2.0.0
+    class KillCursors
+      include Executable
+      include Specifiable
+
+      private
+
+      def message
+        Protocol::KillCursors.new(cursor_ids)
+      end
+    end
+  end
+end

data/lib/mongo/operation/limited.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+
+    # Adds behaviour for commands so ensure the limit option is always -1.
+    #
+    # @since 2.0.0
+    module Limited
+
+      # Limited operations are commands that always require a limit of -1. In
+      # these cases we always overwrite the limit value.
+      #
+      # @example Get the options.
+      #   limited.options
+      #
+      # @return [ Hash ] The options with a -1 limit.
+      #
+      # @since 2.0.0
+      def options
+        super.merge(:limit => -1)
+      end
+    end
+  end
+end

data/lib/mongo/operation/list_collections/result.rb

@@ -0,0 +1,114 @@
+# Copyright (C) 2014-2015 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
+#
+# 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 Operation
+    module Read
+      class ListCollections
+
+        # Defines custom behaviour of results when using the
+        # listCollections command.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          # The field name for the cursor document in a listCollections result.
+          #
+          # @since 2.0.0
+          CURSOR = 'cursor'.freeze
+
+          # The cursor id field in the cursor document.
+          #
+          # @since 2.0.0
+          CURSOR_ID = 'id'.freeze
+
+          # The namespace field in the cursor document.
+          #
+          # @since 2.0.0
+          NAMESPACE = 'ns'.freeze
+
+          # The field name for the first batch of a cursor.
+          #
+          # @since 2.0.0
+          FIRST_BATCH = 'firstBatch'.freeze
+
+          # Get the cursor id for the result.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @note Even though the wire protocol has a cursor_id field for all
+          #   messages of type reply, it is always zero when using the
+          #   listCollections command and must be retrieved from the cursor
+          #   document itself.
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.0.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the namespace for the cursor.
+          #
+          # @example Get the namespace.
+          #   result.namespace
+          #
+          # @return [ String ] The namespace.
+          #
+          # @since 2.0.0
+          def namespace
+            cursor_document ? cursor_document[NAMESPACE] : super
+          end
+
+          # Get the documents for the listCollections result. It is the 'firstBatch'
+          #   field in the 'cursor' field of the first document returned.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.0.0
+          def documents
+            cursor_document[FIRST_BATCH]
+          end
+
+          # Validate the result. In the case where an unauthorized client tries
+          # to run the command we need to generate the proper error.
+          #
+          # @example Validate the result.
+          #   result.validate!
+          #
+          # @return [ Result ] Self if successful.
+          #
+          # @since 2.0.0
+          def validate!
+            !successful? ? raise(Error::OperationFailure.new(parser.message)) : self
+          end
+
+          private
+
+          def cursor_document
+            @cursor_document ||= first_document[CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end