mongo 2.0.6 → 2.1.0

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

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/operation/aggregate/result'
+require 'mongo/operation/commands/aggregate/result'
 
 module Mongo
   module Operation
@@ -41,51 +41,13 @@ module Mongo
     #
     # @since 2.0.0
     class Aggregate
-      include Executable
       include Specifiable
       include Limited
-      include ReadPreferrable
-
-      # 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 valid_context?(context)
-          raise Error::NeedPrimaryServer.new(ERROR_MESSAGE)
-        end
-        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 valid_context?(context)
-        context.standalone? || context.mongos? || context.primary? || secondary_ok?
-      end
-
-      def secondary_ok?
-        selector[:pipeline].none? { |op| op.key?('$out') || op.key?(:$out) }
-      end
-
       def query_coll
         Database::COMMAND
       end

data/lib/mongo/operation/commands/collections_info/result.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
+    class CollectionsInfo
+
+      # Defines custom behaviour of results when query the system.namespaces
+      # collection.
+      #
+      # @since 2.1.0
+      class Result < Operation::Result
+
+        # Get the namespace for the cursor.
+        #
+        # @example Get the namespace.
+        #   result.namespace
+        #
+        # @return [ String ] The namespace.
+        #
+        # @since 2.1.0
+        def namespace
+          Database::NAMESPACES
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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/collections_info/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB operation to get a list of collection names in a database.
+    #
+    # @example Create the collection names operation.
+    #   Read::CollectionNames.new(:db_name => 'test-db')
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the collection names operation.
+    #
+    #   option spec :db_name [ String ] The name of the database whose collection
+    #     names is requested.
+    #   option spec :options [ Hash ] Options for the operation.
+    #
+    # @since 2.0.0
+    class CollectionsInfo
+      include Specifiable
+      include ReadPreference
+      include 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)
+        if context.features.list_collections_enabled?
+          ListCollections.new(spec).execute(context)
+        else
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message(context) ])).validate!
+          end
+        end
+      end
+
+      private
+
+      def selector
+        { :name => { '$not' => /system\.|\$/ } }
+      end
+
+      def query_coll
+        Database::NAMESPACES
+      end
+    end
+  end
+end

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

@@ -30,26 +30,10 @@ module Mongo
     #
     # @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
+      include ReadPreference
+      include Executable
 
       private
 

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

@@ -0,0 +1,70 @@
+# 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 get indexes operation.
+    #
+    # Initialize the get indexes operation.
+    #
+    # @example Instantiate the operation.
+    #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the insert.
+    #
+    #   option spec :db_name [ String ] The name of the database.
+    #   option spec :coll_name [ String ] The name of the collection.
+    #
+    # @since 2.0.0
+    class Indexes
+      include Specifiable
+      include ReadPreference
+
+      # 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 indexes operation response.
+      #
+      # @since 2.0.0
+      def execute(context)
+        if context.features.list_indexes_enabled?
+          ListIndexes.new(spec).execute(context)
+        else
+          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
+
+      def query_coll
+        Index::COLLECTION
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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 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

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

@@ -0,0 +1,54 @@
+# 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/list_collections/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB listCollections command operation.
+    #
+    # @example Create the listCollections command operation.
+    #   Mongo::Operation::Read::ListCollections.new(db_name: 'test')
+    #
+    # @note A command is actually a query on the virtual '$cmd' collection.
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the command.
+    #
+    #   option spec :db_name [ String ] The name of the database whose list of
+    #     collection names is requested.
+    #   option spec :options [ Hash ] Options for the command.
+    #
+    # @since 2.0.0
+    class ListCollections
+      include Specifiable
+      include Limited
+      include Executable
+      include ReadPreference
+
+      private
+
+      def query_coll
+        Database::COMMAND
+      end
+
+      def selector
+        (spec[SELECTOR] || {}).merge(
+          listCollections: 1, filter: { name: { '$not' => /system\.|\$/ }}
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# 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/commands/list_indexes.rb

@@ -0,0 +1,56 @@
+# 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/list_indexes/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB listIndexes command operation.
+    #
+    # @example Create the listIndexes command operation.
+    #   Mongo::Operation::Read::ListIndexes.new({ db_name: 'test', coll_name: 'example' })
+    #
+    # @note A command is actually a query on the virtual '$cmd' collection.
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the command.
+    #
+    #   option spec :coll_name [ Hash ] The name of the collection whose index
+    #     info is requested.
+    #   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 ListIndexes
+      include Specifiable
+      include Limited
+      include Executable
+      include ReadPreference
+
+      private
+
+      def query_coll
+        Database::COMMAND
+      end
+
+      def selector
+        (spec[SELECTOR] || {}).merge(listIndexes: coll_name)
+      end
+    end
+  end
+end
+
+

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

@@ -16,7 +16,7 @@ module Mongo
   module Operation
     class MapReduce
 
-      # Defines custom behaviour of results in an aggregation context.
+      # Defines custom behaviour of results for a map reduce operation.
       #
       # @since 2.0.0
       class Result < Operation::Result

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