mongo 2.1.0.beta → 2.1.0.rc0

data/lib/mongo/operation/commands/list_indexes/result.rb

@@ -0,0 +1,115 @@
+# 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 ListIndexes
+
+      # Defines custom behaviour of results when using the
+      # listIndexes command.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # The field name for the cursor document in a listIndexes 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
+        #   listIndexes 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 listIndexes result. This 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 the database or collection
+        # does not exist on the server we will get an error, and it's better
+        # to raise a meaningful exception here than the ambiguous one when
+        # the error occurs.
+        #
+        # @example Validate the result.
+        #   result.validate!
+        #
+        # @raise [ NoNamespace ] If the ns doesn't exist.
+        #
+        # @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

data/lib/mongo/operation/{map_reduce.rb → commands/map_reduce.rb}

@@ -12,11 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/map_reduce/result'
+require 'mongo/operation/commands/map_reduce/result'
 
 module Mongo
   module Operation
-
     # A MongoDB map reduce operation.
     #
     # @note A map/reduce operation can behave like a read and
@@ -43,50 +42,13 @@ module Mongo
     #
     # @since 2.0.0
     class MapReduce
-      include Executable
       include Specifiable
       include Limited
-      include ReadPreferrable
-
-      # The error message for needing a primary.
-      #
-      # @since 2.0.
-      ERROR_MESSAGE = "If 'out' is specified as a collection, the primary server must be used.".freeze
-
-      # Execute the map/reduce operation.
-      #
-      # @example Execute the operation.
-      #   operation.execute(context)
-      #
-      # @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 valid_context?(context)
-          raise Error::NeedPrimaryServer.new(ERROR_MESSAGE)
-        end
-        execute_message(context)
-      end
+      include ReadPreference
+      include Executable
 
       private
 
-      def valid_context?(context)
-        context.standalone? || context.mongos? || context.primary? || secondary_ok?
-      end
-
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
-      def secondary_ok?
-        selector[:out].respond_to?(:keys) &&
-          selector[:out].keys.first.to_s.downcase == 'inline'
-      end
-
       def query_coll
         Database::COMMAND
       end

data/lib/mongo/operation/{parallel_scan.rb → commands/parallel_scan.rb}

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/parallel_scan/result'
+require 'mongo/operation/commands/parallel_scan/result'
 
 module Mongo
   module Operation
@@ -37,33 +37,13 @@ module Mongo
     #
     # @since 2.0.0
     class ParallelScan
-      include Executable
       include Specifiable
       include Limited
-      include ReadPreferrable
-
-      # Execute the parallel scan operation.
-      #
-      # @example Execute the operation.
-      #   operation.execute(context)
-      #
-      # @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)
-        execute_message(context)
-      end
+      include ReadPreference
+      include Executable
 
       private
 
-      def execute_message(context)
-        context.with_connection do |connection|
-          Result.new(connection.dispatch([ message(context) ])).validate!
-        end
-      end
-
       def selector
         { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
       end

data/lib/mongo/operation/commands/user_query.rb

@@ -0,0 +1,69 @@
+# 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 operation to get info of a particular user in a database.
+    #
+    # @example Create the user query operation.
+    #   Read::UserQuery.new(:name => 'emily', :db_name => 'test-db')
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the user query operation.
+    #
+    #   option spec :user_name [ String ] The name of the user.
+    #   option spec :db_name [ String ] The name of the database where the user exists.
+    #   option spec :options [ Hash ] Options for the operation.
+    #
+    # @since 2.1.0
+    class UserQuery
+      include Executable
+      include Specifiable
+
+      # 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.1.0
+      def execute(context)
+        if context.features.users_info_enabled?
+          UsersInfo.new(spec).execute(context)
+        else
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ])).validate!
+          end
+        end
+      end
+
+      private
+
+      def selector
+        { :user => user_name }
+      end
+
+      def query_coll
+        Auth::User::COLLECTION
+      end
+
+      def message(context)
+        Protocol::Query.new(db_name, query_coll, selector, options)
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/users_info.rb

@@ -0,0 +1,53 @@
+# 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/commands/users_info/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB operation to get info of a particular user in a database.
+    #
+    # @example Create the users info operation.
+    #   Read::UsersInfo.new(:name => 'emily', :db_name => 'test-db')
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the users info operation.
+    #
+    #   option spec :user_name [ String ] The name of the user.
+    #   option spec :db_name [ String ] The name of the database where the user exists.
+    #   option spec :options [ Hash ] Options for the operation.
+    #
+    # @since 2.1.0
+    class UsersInfo
+      include Executable
+      include Specifiable
+      include Limited
+
+      private
+
+      def selector
+        { :usersInfo => user_name }
+      end
+
+      def query_coll
+        Database::COMMAND
+      end
+
+      def message(context)
+        Protocol::Query.new(db_name, query_coll, selector, options)
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/users_info/result.rb

@@ -0,0 +1,36 @@
+# 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 UsersInfo
+
+      # Defines custom behaviour of results when using the
+      # usersInfo command.
+      #
+      # @since 2.1.0
+      class Result < Operation::Result
+
+        # The field name for the users document in a usersInfo result.
+        #
+        # @since 2.1.0
+        USERS = 'users'.freeze
+
+        def documents
+          reply.documents.first[USERS]
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/executable.rb

@@ -15,8 +15,8 @@
 module Mongo
   module Operation
 
-    # This module contains common functionality for defining an operation
-    # and executing it, given a certain context.
+    # This module provides the #execute method that many operations use.
+    # It makes sure to instantiate the appropriate Result class for the operation's response.
     #
     # @since 2.0.0
     module Executable
@@ -32,72 +32,8 @@ module Mongo
       # @since 2.0.0
       def execute(context)
         context.with_connection do |connection|
-          connection.dispatch([ message ], operation_id)
-        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)
-          )
+          result_class = defined?(self.class::Result) ? self.class::Result : Result
+          result_class.new(connection.dispatch([ message(context) ], operation_id)).validate!
         end
       end
     end