mongo 2.5.1 → 2.5.2

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

@@ -0,0 +1,53 @@
+# Copyright (C) 2018 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
+
+      # A MongoDB listcollections operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg
+        include Specifiable
+        include Executable
+        include SessionsSupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::ListCollections::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Result.new(dispatch_message(server))
+          process_result(result, server)
+          result.validate!
+        end
+
+        private
+
+        def message(server)
+          Protocol::Msg.new(flags, options, command(server))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# Copyright (C) 2014-2018 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
+
+        # 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)) : 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

@@ -0,0 +1,49 @@
+# Copyright (C) 2015-2018 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/command'
+require 'mongo/operation/map_reduce/op_msg'
+require 'mongo/operation/map_reduce/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB mapreduce operation.
+    #
+    # @api private
+    #
+    # @since 2.5.0
+    class MapReduce
+      include Specifiable
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::MapReduce::Result ] The operation result.
+      #
+      # @since 2.5.0
+      def execute(server)
+        if server.features.op_msg_enabled?
+          OpMsg.new(spec).execute(server)
+        else
+          Command.new(spec).execute(server)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# Copyright (C) 2018 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
+
+      # A MongoDB mapreduce operation sent as a command message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Command
+        include Specifiable
+        include Executable
+        include Limited
+        include ReadPreferenceSupported
+        include WriteConcernSupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::MapReduce::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Result.new(dispatch_message(server))
+          process_result(result, server)
+          result.validate!
+        end
+
+        private
+
+        def message(server)
+          Protocol::Query.new(db_name, Database::COMMAND, command(server), options(server))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# Copyright (C) 2018 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
+
+      # A MongoDB mapreduce operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg
+        include Specifiable
+        include Executable
+        include SessionsSupported
+        include CausalConsistencySupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::MapReduce::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Result.new(dispatch_message(server))
+          process_result(result, server)
+          result.validate!
+        end
+
+        private
+
+        def message(server)
+          Protocol::Msg.new(flags, options, command(server))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# Copyright (C) 2014-2018 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 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 executing 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)) : self
+        end
+
+        # Get the cursor id.
+        #
+        # @example Get the cursor id.
+        #   result.cursor_id
+        #
+        # @return [ Integer ] Always 0 because map reduce doesn't return a cursor.
+        #
+        # @since 2.5.0
+        def cursor_id
+          0
+        end
+
+        private
+
+        def first_document
+          @first_document ||= reply.documents[0]
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/parallel_scan.rb

@@ -0,0 +1,49 @@
+# Copyright (C) 2015-2018 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/parallel_scan/command'
+require 'mongo/operation/parallel_scan/op_msg'
+require 'mongo/operation/parallel_scan/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB parallelscan operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class ParallelScan
+      include Specifiable
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::ParallelScan::Result ] The operation result.
+      #
+      # @since 2.0.0
+      def execute(server)
+        if server.features.op_msg_enabled?
+          OpMsg.new(spec).execute(server)
+        else
+          Command.new(spec).execute(server)
+        end
+      end
+    end
+  end
+end