mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/{connection/socket/socket_util.rb → operation/write/command.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,26 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'socket'
-require 'timeout'
-
-module SocketUtil
-
-  attr_accessor :pool, :pid, :auths
-
-  def checkout
-    @pool.checkout if @pool
-  end
-
-  def checkin
-    @pool.checkin(self) if @pool
-  end
-
-  def close
-    @socket.close unless closed?
-  end
-
-  def closed?
-    @socket.closed?
-  end
-end
+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/ensure_index'
+require 'mongo/operation/write/command/create_user'
+require 'mongo/operation/write/command/remove_user'

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
+            { :deleteIndexes => coll_name, :index => index_name }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/operation/write/command/ensure_index.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 ensure index write command operation.
+        #
+        # @example Create an ensure index command operation.
+        #   Write::Command::EnsureIndex.new({
+        #     :index => { :foo => 1 },
+        #     :db_name => 'test',
+        #     :coll_name => 'test_coll',
+        #     :index_name => 'foo_1'
+        #     :options => { :unique => true }
+        #   })
+        #
+        # @since 2.0.0
+        class CreateIndex
+          include Specifiable
+          include Executable
+          include Writable
+
+          private
+
+          # The query selector for this ensure index command operation.
+          #
+          # @return [ Hash ] The selector describing this insert operation.
+          #
+          # @since 2.0.0
+          def selector
+            {
+              :createIndexes => coll_name,
+              :indexes => [ options.merge(key: index, name: 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