mongo 2.5.1 → 2.5.2

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

@@ -0,0 +1,60 @@
+# 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 Update
+
+      # A MongoDB update operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg
+        include Specifiable
+        include Executable
+        include SessionsSupported
+        include BypassDocumentValidation
+
+        # Execute the operation.
+        #
+        # @example
+        #   operation.execute(server)
+        #
+        # @param [ Mongo::Server ] server The server to send the operation to.
+        #
+        # @return [ Mongo::Operation::Update::Result ] The operation result.
+        #
+        # @since 2.5.2
+        def execute(server)
+          result = Result.new(dispatch_message(server))
+          process_result(result, server)
+        end
+
+        private
+
+        def selector(server)
+          { update: coll_name,
+            Protocol::Msg::DATABASE_IDENTIFIER => db_name,
+            ordered: ordered? }
+        end
+
+        def message(server)
+          section = { type: 1, payload: { identifier: IDENTIFIER, sequence: send(IDENTIFIER) } }
+          Protocol::Msg.new(flags, {}, command(server), section)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# 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 Update
+
+      # Defines custom behaviour of results for an update.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # The number of modified docs field in the result.
+        #
+        # @since 2.0.0
+        MODIFIED = 'nModified'.freeze
+
+        # The upserted docs field in the result.
+        #
+        # @since 2.0.0
+        UPSERTED = 'upserted'.freeze
+
+        # Get the number of documents matched.
+        #
+        # @example Get the matched count.
+        #   result.matched_count
+        #
+        # @return [ Integer ] The matched count.
+        #
+        # @since 2.0.0
+        def matched_count
+          return 0 unless acknowledged?
+          if upsert?
+            0
+          else
+            n
+          end
+        end
+
+        # Get the number of documents modified.
+        #
+        # @example Get the modified count.
+        #   result.modified_count
+        #
+        # @return [ Integer ] The modified count.
+        #
+        # @since 2.0.0
+        def modified_count
+          return 0 unless acknowledged?
+          first[MODIFIED]
+        end
+
+        # The identifier of the inserted document if an upsert
+        #   took place.
+        #
+        # @example Get the upserted document's identifier.
+        #   result.upserted_id
+        #
+        # @return [ Object ] The upserted id.
+        #
+        # @since 2.0.0
+        def upserted_id
+          return nil unless upsert?
+          upsert?.first['_id']
+        end
+
+        # Returns the number of documents upserted.
+        #
+        # @example Get the number of upserted documents.
+        #   result.upserted_count
+        #
+        # @return [ Integer ] The number upserted.
+        #
+        # @since 2.4.2
+        def upserted_count
+          upsert? ? n : 0
+        end
+
+        def bulk_result
+          BulkResult.new(@replies)
+        end
+
+        private
+
+        def upsert?
+          first[UPSERTED]
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/update_user.rb

@@ -0,0 +1,48 @@
+# 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/update_user/command'
+require 'mongo/operation/update_user/op_msg'
+
+module Mongo
+  module Operation
+
+    # A MongoDB updateuser operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class UpdateUser
+      include Specifiable
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::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

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

@@ -0,0 +1,41 @@
+# 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 UpdateUser
+
+      # A MongoDB updateuser operation sent as a command message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class Command
+        include Specifiable
+        include Executable
+        include Limited
+
+        private
+
+        def selector(server)
+          { :updateUser => user.name, :digestPassword => false }.merge(user.spec)
+        end
+
+        def message(server)
+          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# 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 UpdateUser
+
+      # A MongoDB updateuser operation sent as an op message.
+      #
+      # @api private
+      #
+      # @since 2.5.2
+      class OpMsg
+        include Specifiable
+        include Executable
+        include SessionsSupported
+
+        private
+
+        def selector(server)
+          { :updateUser => user.name, :digestPassword => false }.merge(user.spec)
+        end
+
+        def message(server)
+          Protocol::Msg.new(flags, options, command(server))
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/users_info.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/users_info/command'
+require 'mongo/operation/users_info/op_msg'
+require 'mongo/operation/users_info/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB usersinfo operation.
+    #
+    # @api private
+    #
+    # @since 2.0.0
+    class UsersInfo
+      include Specifiable
+
+      # Execute the operation.
+      #
+      # @example
+      #   operation.execute(server)
+      #
+      # @param [ Mongo::Server ] server The server to send the operation to.
+      #
+      # @return [ Mongo::Operation::UsersInfo::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

data/lib/mongo/operation/users_info/command.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 UsersInfo
+
+      # A MongoDB usersinfo 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::UsersInfo::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 selector(server)
+          { :usersInfo => user_name }
+        end
+
+        def message(server)
+          Protocol::Query.new(db_name, Database::COMMAND, command(server), options(server))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 UsersInfo
+
+      # A MongoDB usersinfo 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::UsersInfo::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 selector(server)
+          { :usersInfo => user_name }
+        end
+
+        def message(server)
+          Protocol::Msg.new(flags, options, command(server))
+        end
+      end
+    end
+  end
+end