mongo 1.12.5 → 2.0.0

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

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

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

@@ -0,0 +1,122 @@
+# 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 MapReduce
+
+      # Defines custom behaviour of results in an aggregation context.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # The counts field for the map/reduce.
+        #
+        # @since 2.0.0
+        COUNTS = 'counts'.freeze
+
+        # The result field for when output is a collection.
+        #
+        # @since 2.0.0
+        RESULT = 'result'.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

data/lib/mongo/operation/map_reduce.rb

@@ -0,0 +1,96 @@
+# 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/map_reduce/result'
+
+module Mongo
+  module Operation
+
+    # 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'
+    #   })
+    #
+    # @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
+      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 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 map reduce 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[:out] == 'inline'
+      end
+
+      def query_coll
+        Database::COMMAND
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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
+
+      # 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')
+      #
+      # @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 Executable
+        include Specifiable
+        include ReadPreferrable
+
+        # 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
+end

data/lib/mongo/operation/read/get_more.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 Read
+
+      # A MongoDB get more operation.
+      #
+      # @example Create a get more operation.
+      #   Read::GetMore.new({
+      #     :to_return => 50,
+      #     :cursor_id => 1,
+      #     :db_name   => 'test_db',
+      #     :coll_name => 'test_coll'
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the operation.
+      #
+      # @option spec :to_return [ Integer ] The number of results to return.
+      # @option spec :cursor_id [ Integer ] The id of the cursor.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the operation should be executed.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the operation should be executed.
+      #
+      # @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
+
+        private
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message ]))
+          end
+        end
+
+        def message
+          Protocol::GetMore.new(db_name, coll_name, to_return, cursor_id)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/read/indexes.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.
+
+module Mongo
+  module Operation
+    module Read
+
+      # A MongoDB get indexes operation.
+      #
+      # Initialize the get indexes operation.
+      #
+      # @example Instantiate the operation.
+      #   Read::Indexes.new(:db_name => 'test', :coll_name => 'test_coll')
+      #
+      # @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 Executable
+        include Specifiable
+        include ReadPreferrable
+
+        # 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
+            context.with_connection do |connection|
+              Result.new(connection.dispatch([ message(context) ]))
+            end
+          end
+        end
+
+        private
+
+        def selector
+          { ns: namespace }
+        end
+
+        def query_coll
+          Index::COLLECTION
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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/list_collections/result'
+
+module Mongo
+  module Operation
+    module Read
+
+      # 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.
+      #
+      # @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 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
+
+        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\.|\$/ }}
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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/list_indexes/result'
+
+module Mongo
+  module Operation
+    module Read
+
+      # 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.
+      #
+      # @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 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
+
+        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
+      end
+    end
+  end
+end
+
+