mongo 2.5.1 → 2.5.2

data/lib/mongo/operation/find/legacy.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.
+
+require 'mongo/operation/find/legacy/result'
+
+module Mongo
+  module Operation
+    class Find
+
+      # A MongoDB find 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::Find::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, coll_name, command(server), options(server))
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/{read/query → find/legacy}/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# 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.
@@ -14,8 +14,8 @@
 
 module Mongo
   module Operation
-    module Read
-      class Query
+    class Find
+      class Legacy
 
         # Defines custom behaviour of results for a query.
         #

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

@@ -0,0 +1,59 @@
+# 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 Find
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::Find::Result ] The operation result.
+      #
+      # @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::Find::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/find/result.rb

@@ -0,0 +1,60 @@
+# 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.
+
+module Mongo
+  module Operation
+    class Find
+
+      # Defines custom behaviour of results in find command.
+      #
+      # @since 2.2.0
+      class Result < Operation::Result
+
+        # Get the cursor id.
+        #
+        # @example Get the cursor id.
+        #   result.cursor_id
+        #
+        # @return [ Integer ] The cursor id.
+        #
+        # @since 2.2.0
+        def cursor_id
+          cursor_document ? cursor_document[CURSOR_ID] : super
+        end
+
+        # Get the documents in the result.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.2.0
+        def documents
+          cursor_document[FIRST_BATCH]
+        end
+
+        private
+
+        def cursor_document
+          @cursor_document ||= reply.documents[0][CURSOR]
+        end
+
+        def first_document
+          @first_document ||= reply.documents[0]
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# 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.
@@ -12,31 +12,29 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/get_more/command'
+require 'mongo/operation/get_more/op_msg'
+require 'mongo/operation/get_more/legacy'
+require 'mongo/operation/get_more/result'
+
 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
 
-          private
+    # A MongoDB getmore operation.
+    #
+    # @api private
+    #
+    # @since 2.5.0
+    class GetMore
+      include Specifiable
 
-          def first_document
-            @first_document ||= reply.documents[0]
-          end
+      def execute(server)
+        if server.features.op_msg_enabled?
+          OpMsg.new(spec).execute(server)
+        elsif server.features.find_command_enabled?
+          Command.new(spec).execute(server)
+        else
+          Legacy.new(spec).execute(server)
         end
       end
     end

data/lib/mongo/operation/get_more/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 GetMore
+
+      # A MongoDB getmore 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::GetMore::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/{commands/find.rb → get_more/legacy.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# 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.
@@ -14,16 +14,23 @@
 
 module Mongo
   module Operation
-    module Commands
+    class GetMore
 
-      # Encapsulates behaviour for executing a find command.
+      # A MongoDB getmore operation sent as a legacy wire protocol message.
       #
-      # @since 2.2.0
-      class Find < Command
-        include CausallyConsistent
+      # @api private
+      #
+      # @since 2.5.2
+      class Legacy
+        include Specifiable
+        include Executable
+
+        private
+
+        def message(server)
+          Protocol::GetMore.new(db_name, coll_name, to_return, cursor_id)
+        end
       end
     end
   end
 end
-
-require 'mongo/operation/commands/find/result'

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

@@ -0,0 +1,58 @@
+# 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 GetMore
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::GetMore::Result ] The operation result.
+      #
+      # @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::GetMore::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/get_more/result.rb

@@ -0,0 +1,60 @@
+# 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.
+
+module Mongo
+  module Operation
+    class GetMore
+
+      # Defines custom behaviour of results for the get more command.
+      #
+      # @since 2.2.0
+      class Result < Operation::Result
+
+        # Get the cursor id.
+        #
+        # @example Get the cursor id.
+        #   result.cursor_id
+        #
+        # @return [ Integer ] The cursor id.
+        #
+        # @since 2.2.0
+        def cursor_id
+          cursor_document ? cursor_document[CURSOR_ID] : super
+        end
+
+        # Get the documents in the result.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.2.0
+        def documents
+          cursor_document[NEXT_BATCH]
+        end
+
+        private
+
+        def cursor_document
+          @cursor_document ||= reply.documents[0][CURSOR]
+        end
+
+        def first_document
+          @first_document ||= reply.documents[0]
+        end
+      end
+    end
+  end
+end