mongo 2.1.0.beta → 2.2.0

data/lib/mongo/operation/{read → commands}/indexes.rb

@@ -14,7 +14,7 @@
 
 module Mongo
   module Operation
-    module Read
+    module Commands
 
       # A MongoDB get indexes operation.
       #
@@ -31,9 +31,8 @@ module Mongo
       #
       # @since 2.0.0
       class Indexes
-        include Executable
         include Specifiable
-        include ReadPreferrable
+        include ReadPreference
 
         # Execute the operation.
         # The context gets a connection on which the operation
@@ -48,14 +47,18 @@ module Mongo
           if context.features.list_indexes_enabled?
             ListIndexes.new(spec).execute(context)
           else
-            context.with_connection do |connection|
-              Result.new(connection.dispatch([ message(context) ]))
-            end
+            execute_message(context)
           end
         end
 
         private
 
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ]))
+          end
+        end
+
         def selector
           { ns: namespace }
         end

data/lib/mongo/operation/{list_collections → commands/list_collections}/result.rb

@@ -14,7 +14,7 @@
 
 module Mongo
   module Operation
-    module Read
+    module Commands
       class ListCollections
 
         # Defines custom behaviour of results when using the
@@ -23,26 +23,6 @@ module Mongo
         # @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.

data/lib/mongo/operation/{read → commands}/list_collections.rb

@@ -12,11 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/list_collections/result'
-
 module Mongo
   module Operation
-    module Read
+    module Commands
 
       # A MongoDB listCollections command operation.
       #
@@ -33,38 +31,10 @@ module Mongo
       #   option spec :options [ Hash ] Options for the command.
       #
       # @since 2.0.0
-      class ListCollections
-        include Executable
-        include Specifiable
-        include Limited
-        include ReadPreferrable
-
-        # Execute the listCollections command operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation result.
-        #
-        # @since 2.0.0
-        def execute(context)
-          execute_message(context)
-        end
+      class ListCollections < Command
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
-        def query_coll
-          Database::COMMAND
-        end
-
         def selector
           (spec[SELECTOR] || {}).merge(
             listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
@@ -74,3 +44,5 @@ module Mongo
     end
   end
 end
+
+require 'mongo/operation/commands/list_collections/result'

data/lib/mongo/operation/{list_indexes → commands/list_indexes}/result.rb

@@ -14,7 +14,7 @@
 
 module Mongo
   module Operation
-    module Read
+    module Commands
       class ListIndexes
 
         # Defines custom behaviour of results when using the
@@ -23,26 +23,6 @@ module Mongo
         # @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.

data/lib/mongo/operation/{read → commands}/list_indexes.rb

@@ -12,11 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/list_indexes/result'
-
 module Mongo
   module Operation
-    module Read
+    module Commands
 
       # A MongoDB listIndexes command operation.
       #
@@ -35,38 +33,10 @@ module Mongo
       #   option spec :options [ Hash ] Options for the command.
       #
       # @since 2.0.0
-      class ListIndexes
-        include Executable
-        include Specifiable
-        include Limited
-        include ReadPreferrable
-
-        # Execute the listIndexes command operation.
-        #
-        # @example Execute the operation.
-        #   operation.execute(context)
-        #
-        # @param [ Mongo::Server::Context ] context The context for this operation.
-        #
-        # @return [ Result ] The operation result.
-        #
-        # @since 2.0.0
-        def execute(context)
-          execute_message(context)
-        end
+      class ListIndexes < Command
 
         private
 
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message(context) ])).validate!
-          end
-        end
-
-        def query_coll
-          Database::COMMAND
-        end
-
         def selector
           (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
         end
@@ -75,4 +45,4 @@ module Mongo
   end
 end
 
-
+require 'mongo/operation/commands/list_indexes/result'

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

@@ -0,0 +1,119 @@
+# 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 Commands
+      class MapReduce
+
+        # Defines custom behaviour of results for a map reduce operation.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          # The counts field for the map/reduce.
+          #
+          # @since 2.0.0
+          COUNTS = 'counts'.freeze
+
+          # The field name for a result without a cursor.
+          #
+          # @since 2.0.0
+          RESULTS = 'results'.freeze
+
+          # The time the operation took constant.
+          #
+          # @since 2.0.0
+          TIME = 'timeMillis'.freeze
+
+          # Gets the map/reduce counts from the reply.
+          #
+          # @example Get the counts.
+          #   result.counts
+          #
+          # @return [ Hash ] A hash of the result counts.
+          #
+          # @since 2.0.0
+          def counts
+            reply.documents[0][COUNTS]
+          end
+
+          # Get the documents from the map/reduce.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.0.0
+          def documents
+            reply.documents[0][RESULTS] || reply.documents[0][RESULT]
+          end
+
+          # If the result was a command then determine if it was considered a
+          # success.
+          #
+          # @note If the write was unacknowledged, then this will always return
+          #   true.
+          #
+          # @example Was the command successful?
+          #   result.successful?
+          #
+          # @return [ true, false ] If the command was successful.
+          #
+          # @since 2.0.0
+          def successful?
+            !documents.nil?
+          end
+
+          # Get the execution time of the map/reduce.
+          #
+          # @example Get the execution time.
+          #   result.time
+          #
+          # @return [ Integer ] The executiong time in milliseconds.
+          #
+          # @since 2.0.0
+          def time
+            reply.documents[0][TIME]
+          end
+
+          # Validate the result by checking for any errors.
+          #
+          # @note This only checks for errors with writes since authentication is
+          #   handled at the connection level and any authentication errors would
+          #   be raised there, before a Result is ever created.
+          #
+          # @example Validate the result.
+          #   result.validate!
+          #
+          # @raise [ Error::OperationFailure ] If an error is in the result.
+          #
+          # @return [ Result ] The result if verification passed.
+          #
+          # @since 2.0.0
+          def validate!
+            documents.nil? ? raise(Error::OperationFailure.new(parser.message)) : self
+          end
+
+          private
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# 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 Commands
+
+      # A MongoDB map reduce operation.
+      #
+      # @note A map/reduce 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 map/reduce operation.
+      #   MapReduce.new({
+      #     :selector => {
+      #       :mapreduce => 'test_coll',
+      #       :map => '',
+      #       :reduce => ''
+      #     },
+      #     :db_name  => 'test_db'
+      #   })
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the operation.
+      #
+      #   option spec :selector [ Hash ] The map reduce 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 map reduce command.
+      #
+      # @since 2.0.0
+      class MapReduce < Command; end
+    end
+  end
+end
+
+require 'mongo/operation/commands/map_reduce/result'

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

@@ -0,0 +1,64 @@
+
+# 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
+    module Commands
+      class ParallelScan
+
+        # Defines custom behaviour of results in a parallel scan.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          # The name of the cursors field in the result.
+          #
+          # @since 2.0.0
+          CURSORS = 'cursors'.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][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
+end

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

@@ -0,0 +1,52 @@
+# 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
+    module Commands
+
+      # 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 < Command
+
+        private
+
+        def selector
+          command = { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
+          command[:readConcern] = read_concern if read_concern
+          command
+        end
+      end
+    end
+  end
+end
+
+require 'mongo/operation/commands/parallel_scan/result'

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

@@ -0,0 +1,71 @@
+# 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 Commands
+
+      # 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
+end

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

@@ -0,0 +1,38 @@
+# 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 Commands
+      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,48 @@
+# 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 Commands
+
+      # 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 < Command
+
+        private
+
+        def selector
+          { :usersInfo => user_name }
+        end
+
+        def message(context)
+          Protocol::Query.new(db_name, query_coll, selector, options)
+        end
+      end
+    end
+  end
+end
+
+require 'mongo/operation/commands/users_info/result'