mongo 2.0.6 → 2.1.0

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

@@ -0,0 +1,72 @@
+
+# Copyright (C) 2009-2014 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 ParallelScan
+
+      # Defines custom behaviour of results in a parallel scan.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # Get the name of the cursor field.
+        #
+        # @since 2.0.0
+        CURSOR = 'cursor'.freeze
+
+        # The name of the cursors field in the result.
+        #
+        # @since 2.0.0
+        CURSORS = 'cursors'.freeze
+
+        # Get the name of the id field.
+        #
+        # @since 2.0.0
+        ID = 'id'.freeze
+
+        # Get all the cursor ids from the result.
+        #
+        # @example Get the cursor ids.
+        #   result.cursor_ids
+        #
+        # @return [ Array<Integer> ] The cursor ids.
+        #
+        # @since 2.0.0
+        def cursor_ids
+          documents.map{ |doc| doc[CURSOR][ID] }
+        end
+
+        # Get the documents from parallel scan.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.0.0
+        def documents
+          reply.documents[0][CURSORS]
+        end
+
+        private
+
+        def first
+          @first ||= reply.documents[0] || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# Copyright (C) 2009-2014 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/parallel_scan/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB parallel scan operation.
+    #
+    # @example Create the parallel scan operation.
+    #   ParallelScan.new({
+    #     :db_name  => 'test_db',
+    #     :coll_name = > 'test_collection',
+    #     :cursor_count => 5
+    #   })
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
+    #
+    #   option spec :db_name [ String ] The name of the database on which
+    #     the operation should be executed.
+    #   option spec :coll_name [ String ] The collection to scan.
+    #   option spec :cursor_count [ Integer ] The number of cursors to use.
+    #   option spec :options [ Hash ] Options for the command.
+    #
+    # @since 2.0.0
+    class ParallelScan
+      include Specifiable
+      include Limited
+      include ReadPreference
+      include Executable
+
+      private
+
+      def selector
+        { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
+      end
+
+      def query_coll
+        Database::COMMAND
+      end
+    end
+  end
+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/{bulk_write/ordered_bulk_write.rb → operation/commands/users_info/result.rb}

@@ -13,36 +13,24 @@
 # limitations under the License.
 
 module Mongo
-
-  module BulkWrite
-
-    class OrderedBulkWrite
-
-      include BulkWritable
-
-      private
-
-      def ordered?
-        true
-      end
-
-      def merged_ops
-        merge_consecutive_ops(@operations)
-      end
-
-      def process(result, indexes)
-        combine_results(result, indexes)
-        raise Error::BulkWriteError.new(@results) if stop?
-      end
-
-      def stop?
-        @results.keys.include?(:write_errors)
-      end
-
-      def finalize
-        raise Error::BulkWriteError.new(@results) if @results[:write_concern_errors]
-        @results
+  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
+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.rb

@@ -0,0 +1,24 @@
+# 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/command'
+require 'mongo/operation/commands/parallel_scan'
+require 'mongo/operation/commands/aggregate'
+require 'mongo/operation/commands/map_reduce'
+require 'mongo/operation/commands/collections_info'
+require 'mongo/operation/commands/indexes'
+require 'mongo/operation/commands/list_collections'
+require 'mongo/operation/commands/list_indexes'
+require 'mongo/operation/commands/user_query'
+require 'mongo/operation/commands/users_info'

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 ])
-        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

data/lib/mongo/operation/kill_cursors.rb

@@ -27,13 +27,13 @@ module Mongo
     #
     # @since 2.0.0
     class KillCursors
-      include Executable
       include Specifiable
+      include Executable
 
       private
 
-      def message
-        Protocol::KillCursors.new(cursor_ids)
+      def message(context)
+        Protocol::KillCursors.new(coll_name, db_name, cursor_ids)
       end
     end
   end

data/lib/mongo/operation/read/get_more.rb

@@ -38,32 +38,12 @@ module Mongo
       #
       # @since 2.0.0
       class GetMore
-        include Executable
         include Specifiable
-
-        # Execute the get more 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 Executable
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message ]))
-          end
-        end
-
-        def message
+        def message(context)
           Protocol::GetMore.new(db_name, coll_name, to_return, cursor_id)
         end
       end

data/lib/mongo/{bulk_write/unordered_bulk_write.rb → operation/read/query/result.rb}

@@ -13,34 +13,28 @@
 # limitations under the License.
 
 module Mongo
-
-  module BulkWrite
-
-    class UnorderedBulkWrite
-
-      include BulkWritable
-
-      private
-
-      def ordered?
-        false
-      end
-
-      def merged_ops
-        merge_consecutive_ops(merge_ops_by_type)
-      end
-
-      def process(result, indexes)
-        combine_results(result, indexes)
-      end
-
-      def finalize
-        @results.tap do |results|
-          if results[:write_errors] || results[:write_concern_errors]
-            raise Error::BulkWriteError.new(results)
+  module Operation
+    module Read
+      class Query
+
+        # Defines custom behaviour of results for a query.
+        #
+        # @since 2.1.0
+        class Result < Operation::Result
+
+          # Determine if the query was a success.
+          #
+          # @example Was the query successful?
+          #   result.successful?
+          #
+          # @return [ true, false ] If the query was successful.
+          #
+          # @since 2.0.0
+          def successful?
+            !query_failure?
           end
         end
       end
     end
   end
-end
+end

data/lib/mongo/operation/read/query.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/read/query/result'
+
 module Mongo
   module Operation
     module Read
@@ -38,31 +40,12 @@ module Mongo
       #
       # @since 2.0.0
       class Query
-        include Executable
         include Specifiable
-        include ReadPreferrable
-
-        # Execute the operation.
-        # The context gets a connection on which the operation
-        # is sent in the block.
-        #
-        # @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)
-          execute_message(context)
-        end
+        include Executable
+        include ReadPreference
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
         def query_coll
           coll_name
         end

data/lib/mongo/operation/read.rb

@@ -14,7 +14,3 @@
 
 require 'mongo/operation/read/query'
 require 'mongo/operation/read/get_more'
-require 'mongo/operation/read/indexes'
-require 'mongo/operation/read/list_indexes'
-require 'mongo/operation/read/list_collections'
-require 'mongo/operation/read/collections_info'

data/lib/mongo/operation/{read_preferrable.rb → read_preference.rb}

@@ -15,10 +15,11 @@
 module Mongo
   module Operation
 
-    # Adds behaviour for queries that need to take read preference into account.
+    # Adds behaviour for updating the options and the selector for operations
+    # that need to take read preference into account.
     #
     # @since 2.0.0
-    module ReadPreferrable
+    module ReadPreference
 
       # The constant for slave ok flags.
       #

data/lib/mongo/operation/result.rb

@@ -190,12 +190,24 @@ module Mongo
       def successful?
         return true if !acknowledged?
         if first_document.has_key?(OK)
-          first_document[OK] == 1 && parser.message.empty?
+          ok? && parser.message.empty?
         else
           !query_failure? && parser.message.empty?
         end
       end
 
+      # Check the first document's ok field.
+      #
+      # @example Check the ok field.
+      #   result.ok?
+      #
+      # @return [ true, false ] If the command returned ok.
+      #
+      # @since 2.1.0
+      def ok?
+        first_document[OK] == 1
+      end
+
       # Validate the result by checking for any errors.
       #
       # @note This only checks for errors with writes since authentication is

data/lib/mongo/operation/specifiable.rb

@@ -76,6 +76,11 @@ module Mongo
       # @since 2.0.0
       INDEX_NAME = :index_name.freeze
 
+      # The operation id constant.
+      #
+      # @since 2.1.0
+      OPERATION_ID = :operation_id.freeze
+
       # The field for options.
       #
       # @since 2.0.0
@@ -287,6 +292,19 @@ module Mongo
         @spec = spec
       end
 
+      # Get the operation id for the operation. Used for linking operations in
+      # monitoring.
+      #
+      # @example Get the operation id.
+      #   specifiable.operation_id
+      #
+      # @return [ Integer ] The operation id.
+      #
+      # @since 2.1.0
+      def operation_id
+        spec[OPERATION_ID]
+      end
+
       # Get the options for the operation.
       #
       # @example Get the options.
@@ -392,6 +410,30 @@ module Mongo
       def read
         @spec[READ] || ServerSelector.get
       end
+
+      # Whether the operation is ordered.
+      #
+      # @example Get the ordered value, true is the default.
+      #   specifiable.ordered?
+      #
+      # @return [ true, false ] Whether the operation is ordered.
+      #
+      # @since 2.1.0
+      def ordered?
+        !!(@spec.fetch(:ordered, true))
+      end
+
+      # The namespace, consisting of the db name and collection name.
+      #
+      # @example Get the namespace.
+      #   specifiable.namespace
+      #
+      # @return [ String ] The namespace.
+      #
+      # @since 2.1.0
+      def namespace
+        "#{db_name}.#{coll_name}"
+      end
     end
   end
 end