mongo 1.12.5 → 2.0.0

data/lib/mongo/operation/write/command/create_user.rb

@@ -0,0 +1,43 @@
+
+# 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 Write
+      module Command
+
+        # Create user commands on non-legacy servers.
+        #
+        # @since 2.0.0
+        class CreateUser
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this create user command operation.
+          #
+          # @return [ Hash ] The selector describing this create user operation.
+          #
+          # @since 2.0.0
+          def selector
+            { :createUser => user.name, :digestPassword => false }.merge(user.spec)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/command/delete.rb

@@ -0,0 +1,56 @@
+# 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 Write
+      module Command
+
+        # A MongoDB delete write command operation.
+        #
+        # @example Initialize a delete write command.
+        #   Write::Command::Delete.new({
+        #     :deletes => [{ :q => { :foo => 1 }, :limit => 1 }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern,
+        #     :ordered => true
+        #   })
+        #
+        # @since 2.0.0
+        class Delete
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this delete command operation.
+          #
+          # @return [ Hash ] The selector describing this delete operation.
+          #
+          # @since 2.0.0
+          def selector
+            { delete: coll_name,
+              deletes: deletes,
+              writeConcern: write_concern.options,
+              ordered: ordered?
+            }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/operation/write/command/drop_index.rb

@@ -0,0 +1,51 @@
+# 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 Write
+      module Command
+
+        # A MongoDB drop index write command operation.
+        #
+        # @example Create the drop index operation.
+        #   Write::Command::DropIndex.new({
+        #     :index      => { :foo => 1 },
+        #     :db_name    => 'test',
+        #     :coll_name  => 'test_coll',
+        #     :index_name => 'foo_1'
+        #   })
+        #
+        # @since 2.0.0
+        class DropIndex
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this drop index command operation.
+          #
+          # @return [ Hash ] The selector describing this insert operation.
+          #
+          # @since 2.0.0
+          def selector
+            { :dropIndexes => coll_name, :index => index_name }
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,55 @@
+# 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 Write
+      module Command
+
+        # A MongoDB insert write command operation.
+        #
+        # @example Create an insert write command operation.
+        #   Write::Command::Insert.new({
+        #     :documents => [{ :foo => 1 }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern,
+        #     :ordered => true
+        #   })
+        # @since 2.0.0
+        class Insert
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this insert command operation.
+          #
+          # @return [ Hash ] The selector describing this insert operation.
+          #
+          # @since 2.0.0
+          def selector
+            { insert: coll_name,
+              documents: documents,
+              writeConcern: write_concern.options,
+              ordered: ordered?
+            }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/operation/write/command/remove_user.rb

@@ -0,0 +1,42 @@
+# 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 Write
+      module Command
+
+        # Remove user commands on non-legacy servers.
+        #
+        # @since 2.0.0
+        class RemoveUser
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this drop user command operation.
+          #
+          # @return [ Hash ] The selector describing this drop user operation.
+          #
+          # @since 2.0.0
+          def selector
+            { :dropUser => user_name }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/command/update.rb

@@ -0,0 +1,60 @@
+# 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 Write
+      module Command
+
+        # A MongoDB update write command operation.
+        #
+        # @example Create an update write command operation.
+        #   Write::Command::Update.new({
+        #     :updates => [{
+        #       :q => { :foo => 1 },
+        #       :u => { :$set =>
+        #       :bar => 1 }},
+        #       :multi  => true,
+        #       :upsert => false
+        #     }],
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :write_concern => write_concern,
+        #     :ordered => true
+        #   })
+        #
+        # @since 2.0.0
+        class Update
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this update command operation.
+          #
+          # @return [ Hash ] The selector describing this update operation.
+          def selector
+            { update: coll_name,
+              updates: updates,
+              writeConcern: write_concern.options,
+              ordered: ordered?
+            }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/operation/write/command/writable.rb

@@ -0,0 +1,61 @@
+# 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 Write
+      module Command
+
+        # Provides common behavior for all write commands.
+        #
+        # @since 2.0.0
+        module Writable
+          include Limited
+
+          private
+
+          # Whether this operation may be executed on a secondary server.
+          #
+          # @return [ false ] A write command may not be executed on a secondary.
+          def secondary_ok?
+            false
+          end
+
+          # Whether the batch writes should be applied in the same order the
+          # items appear, ie. sequentially. 
+          # If ordered is false, the server applies the batch items in no particular
+          # order, and possibly in parallel. Execution halts after the first error.
+          # The default value is true, which means the batch items are applied
+          # sequentially.
+          #
+          # @return [ true, false ] Whether batch items are applied sequentially. 
+          #
+          # @since 2.0.0
+          def ordered?
+            @spec.fetch(:ordered, true)
+          end
+
+          # The wire protocol message for this write operation.
+          #
+          # @return [ Mongo::Protocol::Query ] Wire protocol message.
+          #
+          # @since 2.0.0
+          def message
+            Protocol::Query.new(db_name, Database::COMMAND, selector, options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# 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/write/command/writable'
+require 'mongo/operation/write/command/delete'
+require 'mongo/operation/write/command/insert'
+require 'mongo/operation/write/command/update'
+require 'mongo/operation/write/command/drop_index'
+require 'mongo/operation/write/command/create_index'
+require 'mongo/operation/write/command/create_user'
+require 'mongo/operation/write/command/remove_user'

data/lib/mongo/operation/write/create_index.rb

@@ -0,0 +1,89 @@
+
+# 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 Write
+
+      # A MongoDB create index operation.
+      #
+      # @note If a server with version >= 2.5.5 is being used, a write command
+      #   operation will be created and sent instead.
+      #
+      # @example Create the create index operation.
+      #   Write::CreateIndex.new({
+      #     :index => { :name => 1, :age => -1 },
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :index_name => 'name_1_age_-1'
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the insert.
+      #
+      # @option spec :index [ Hash ] The index spec to create.
+      # @option spec :db_name [ String ] The name of the database.
+      # @option spec :coll_name [ String ] The name of the collection.
+      # @option spec :index_name [ String ] The name of the index.
+      # @option spec :options [ Hash ] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class CreateIndex
+        include Executable
+        include Specifiable
+
+        # Execute the ensure index operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The result of the operation.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::CreateIndex.new(spec).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def index_documents
+          indexes.dup.each do |index|
+            index[:ns] = namespace
+          end
+        end
+
+        def message
+          Protocol::Insert.new(db_name, Index::COLLECTION, index_documents)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/create_user.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.
+
+module Mongo
+  module Operation
+    module Write
+
+      # A MongoDB create user operation.
+      #
+      # @example Initialize the operation.
+      #   Write::CreateUser.new(:db_name => 'test', :user => user)
+      #
+      # @param [ Hash ] spec The specifications for the create.
+      #
+      # @option spec :user [ Auth::User ] The user to create.
+      # @option spec :db_name [ String ] The name of the database.
+      #
+      # @since 2.0.0
+      class CreateUser
+        include Executable
+        include Specifiable
+
+        # Execute the operation.
+        #
+        # @note Creating users behaves different on 2.7+, 2.6.x, and
+        #   2.4- so we need to break this out into separate operations.
+        #
+        # @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)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          Result.new(Command::CreateUser.new(spec).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def message
+          user_spec = { user: user.name }.merge(user.spec)
+          Protocol::Insert.new(db_name, Auth::User::COLLECTION, [ user_spec ])
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/delete/result.rb

@@ -0,0 +1,40 @@
+# 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 Write
+      class Delete
+
+        # Defines custom behaviour of results for a delete.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          # Get the number of documents deleted.
+          #
+          # @example Get the deleted count.
+          #   result.deleted_count
+          #
+          # @return [ Integer ] The deleted count.
+          #
+          # @since 2.0.0
+          def deleted_count
+            n
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write/delete.rb

@@ -0,0 +1,93 @@
+# 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/write/delete/result'
+
+module Mongo
+  module Operation
+    module Write
+
+      # A MongoDB delete operation.
+      #
+      # @note If a server with version >= 2.5.5 is selected, a write command
+      #   operation will be created and sent instead.
+      #
+      # @example Create the delete operation.
+      #   Write::Delete.new({
+      #     :delete => { :q => { :foo => 1 }, :limit => 1 },
+      #     :db_name => 'test',
+      #     :coll_name => 'test_coll',
+      #     :write_concern => write_concern
+      #   })
+      #
+      # @param [ Hash ] spec The specifications for the delete.
+      #
+      # @option spec :delete [ Hash ] The delete document.
+      # @option spec :db_name [ String ] The name of the database on which
+      #   the delete should be executed.
+      # @option spec :coll_name [ String ] The name of the collection on which
+      #   the delete should be executed.
+      # @option spec :write_concern [ Mongo::WriteConcern ] The write concern
+      #   for this operation.
+      # @option spec :ordered [ true, false ] Whether the operations should be
+      #   executed in order.
+      # @option spec :options [Hash] Options for the command, if it ends up being a
+      #   write command.
+      #
+      # @since 2.0.0
+      class Delete
+        include Executable
+        include Specifiable
+
+        # Execute the delete operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The result.
+        #
+        # @since 2.0.0
+        def execute(context)
+          if context.features.write_command_enabled?
+            execute_write_command(context)
+          else
+            execute_message(context)
+          end
+        end
+
+        private
+
+        def execute_write_command(context)
+          s = spec.merge(:deletes => [ delete ])
+          s.delete(:delete)
+          Result.new(Command::Delete.new(s).execute(context)).validate!
+        end
+
+        def execute_message(context)
+          context.with_connection do |connection|
+            Result.new(connection.dispatch([ message, gle ].compact)).validate!
+          end
+        end
+
+        def message
+          selector = delete[:q]
+          opts     = ( delete[:limit] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+          Protocol::Delete.new(db_name, coll_name, selector, opts)
+        end
+      end
+    end
+  end
+end