mongo 2.5.1 → 2.5.2

data/lib/mongo/operation/indexes.rb

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

data/lib/mongo/operation/indexes/command.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 Indexes
+
+      # A MongoDB indexes operation sent as a command message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Command
+        include Specifiable
+        include Executable
+        include Limited
+        include ReadPreferenceSupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::Indexes::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/indexes/legacy.rb

@@ -0,0 +1,57 @@
+# 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 Indexes
+
+      # A MongoDB indexes operation sent as a legacy wire protocol message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Legacy
+        include Specifiable
+        include Executable
+        include ReadPreferenceSupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::Indexes::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Operation::Result.new(dispatch_message(server))
+          process_result(result, server)
+          result.validate!
+        end
+
+        private
+
+        def selector(server)
+          { ns: namespace }
+        end
+
+        def message(server)
+          Protocol::Query.new(db_name, Index::COLLECTION, command(server), options(server))
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/indexes/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 Indexes
+
+      # A MongoDB indexes operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg
+        include Specifiable
+        include Executable
+        include Limited
+        include SessionsSupported
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::Indexes::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/indexes/result.rb

@@ -0,0 +1,97 @@
+# 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 Indexes
+
+      # Defines custom behaviour of results when using the
+      # listIndexes 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
+        #   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)) : 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/insert.rb

@@ -0,0 +1,40 @@
+# 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/insert/command'
+require 'mongo/operation/insert/op_msg'
+require 'mongo/operation/insert/legacy'
+require 'mongo/operation/insert/result'
+require 'mongo/operation/insert/bulk_result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB insert operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class Insert
+      include Specifiable
+      include Write
+
+      private
+
+      IDENTIFIER = 'documents'.freeze
+
+      def validate!;end
+    end
+  end
+end

data/lib/mongo/operation/insert/bulk_result.rb

@@ -0,0 +1,70 @@
+# 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 Insert
+
+      # Defines custom behaviour of results for an insert when sent as part of a bulk write.
+      #
+      # @since 2.0.0
+      class BulkResult < Operation::Result
+        include Aggregatable
+
+        # Get the ids of the inserted documents.
+        #
+        # @since 2.0.0
+        attr_reader :inserted_ids
+
+        # Initialize a new result.
+        #
+        # @example Instantiate the result.
+        #   Result.new(replies, inserted_ids)
+        #
+        # @param [ Protocol::Message ] replies The wire protocol replies.
+        # @param [ Array<Object> ] ids The ids of the inserted documents.
+        #
+        # @since 2.0.0
+        def initialize(replies, ids)
+          @replies = [*replies] if replies
+          @inserted_ids = ids
+        end
+
+        # Gets the number of documents inserted.
+        #
+        # @example Get the number of documents inserted.
+        #   result.n_inserted
+        #
+        # @return [ Integer ] The number of documents inserted.
+        #
+        # @since 2.0.0
+        def n_inserted
+          written_count
+        end
+
+        # Gets the id of the document inserted.
+        #
+        # @example Get id of the document inserted.
+        #   result.inserted_id
+        #
+        # @return [ Object ] The id of the document inserted.
+        #
+        # @since 2.0.0
+        def inserted_id
+          inserted_ids.first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 Insert
+
+      # A MongoDB insert operation sent as a command message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Command
+        include Specifiable
+        include Executable
+        include Idable
+        include Limited
+        include WriteConcernSupported
+        include BypassDocumentValidation
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::Insert::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Result.new(dispatch_message(server), @ids)
+          process_result(result, server)
+        end
+
+        private
+
+        def selector(server)
+          { insert: coll_name,
+            documents: send(IDENTIFIER),
+            ordered: ordered? }
+        end
+
+        def options
+          super.merge(validating_keys: true)
+        end
+
+        def message(server)
+          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        end
+      end
+    end
+  end
+end