mongo 2.0.6 → 2.1.0

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

@@ -29,37 +29,14 @@ module Mongo
       #
       # @since 2.0.0
       class RemoveUser
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
 
-        # Execute the remove user operation.
-        #
-        # @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::RemoveUser.new(spec).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
+        def write_command_op
+          Command::RemoveUser.new(spec)
         end
 
         def message

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

@@ -51,52 +51,29 @@ module Mongo
       #
       # @since 2.0.0
       class Update
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
 
-        # Execute the update operation.
-        #
-        # @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)
+        def write_command_op
           s = spec.merge(:updates => [ update ])
           s.delete(:update)
-          Result.new(Command::Update.new(s).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            LegacyResult.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
-        end
-
-        def initialize_copy(original)
-          @spec = original.spec.dup
-          @spec[:updates] = original.spec[:updates].dup
+          Command::Update.new(s)
         end
 
         def message
           flags = []
-          flags << :multi_update if update[:multi]
-          flags << :upsert if update[:upsert]
-          Protocol::Update.new(db_name, coll_name, update[:q], update[:u],
-                               flags.empty? ? {} : { flags: flags })
+          flags << :multi_update if update[Operation::MULTI]
+          flags << :upsert if update[Operation::UPSERT]
+          Protocol::Update.new(
+            db_name,
+            coll_name,
+            update[Operation::Q],
+            update[Operation::U],
+            flags.empty? ? {} : { flags: flags }
+          )
         end
       end
     end

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

@@ -30,40 +30,14 @@ module Mongo
       #
       # @since 2.0.0
       class UpdateUser
-        include Executable
+        include GLE
+        include WriteCommandEnabled
         include Specifiable
 
-        # Execute the operation.
-        #
-        # @note Updating 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::UpdateUser.new(spec).execute(context)).validate!
-        end
-
-        def execute_message(context)
-          context.with_connection do |connection|
-            Result.new(connection.dispatch([ message, gle ].compact)).validate!
-          end
+        def write_command_op
+          Command::UpdateUser.new(spec)
         end
 
         def message

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

@@ -0,0 +1,53 @@
+# 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
+
+      # This module contains common functionality for operations that send either
+      # a write command or a specific wire protocol message, depending on server version.
+      # For server versions >= 2.6, a write command is sent.
+      #
+      # @since 2.1.0
+      module WriteCommandEnabled
+
+        # Execute the operation.
+        #
+        # @example Execute the operation.
+        #   operation.execute(context)
+        #
+        # @param [ Mongo::Server::Context ] context The context for this operation.
+        #
+        # @return [ Result ] The operation result.
+        #
+        # @since 2.1.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_class = defined?(self.class::Result) ? self.class::Result : Result
+          result_class.new(write_command_op.execute(context)).validate!
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/write.rb

@@ -12,7 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/write/write_command_enabled'
 require 'mongo/operation/write/idable'
+require 'mongo/operation/write/gle'
 require 'mongo/operation/write/bulk'
 require 'mongo/operation/write/delete'
 require 'mongo/operation/write/insert'

data/lib/mongo/operation.rb

@@ -16,10 +16,38 @@ require 'mongo/operation/result'
 require 'mongo/operation/executable'
 require 'mongo/operation/specifiable'
 require 'mongo/operation/limited'
-require 'mongo/operation/read_preferrable'
+require 'mongo/operation/read_preference'
 require 'mongo/operation/read'
 require 'mongo/operation/write'
-require 'mongo/operation/aggregate'
-require 'mongo/operation/command'
+require 'mongo/operation/commands'
 require 'mongo/operation/kill_cursors'
-require 'mongo/operation/map_reduce'
+
+module Mongo
+  module Operation
+
+    # The q field constant.
+    #
+    # @since 2.1.0
+    Q = 'q'.freeze
+
+    # The u field constant.
+    #
+    # @since 2.1.0
+    U = 'u'.freeze
+
+    # The limit field constant.
+    #
+    # @since 2.1.0
+    LIMIT = 'limit'.freeze
+
+    # The multi field constant.
+    #
+    # @since 2.1.0
+    MULTI = 'multi'.freeze
+
+    # The upsert field constant.
+    #
+    # @since 2.1.0
+    UPSERT = 'upsert'.freeze
+  end
+end

data/lib/mongo/options/mapper.rb

@@ -34,8 +34,10 @@ module Mongo
       #
       # @since 2.0.0
       def transform(options, mappings)
-        options.reduce({}) do |transformed, (key, value)|
-          transformed[mappings[key] || key] = value
+        map = transform_keys_to_strings(mappings)
+        opts = transform_keys_to_strings(options)
+        opts.reduce({}) do |transformed, (key, value)|
+          transformed[map[key]] = value if map[key]
           transformed
         end
       end

data/lib/mongo/options/redacted.rb

@@ -0,0 +1,156 @@
+# Copyright (C) 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 Options
+
+    # Class for wrapping options that could be sensitive.
+    # When printed, the sensitive values will be redacted.
+    #
+    # @since 2.1.0
+    class Redacted < BSON::Document
+
+      # The options whose values will be redacted.
+      #
+      # @since 2.1.0
+      SENSITIVE_OPTIONS = [ :password,
+                            :pwd ].freeze
+
+      # The replacement string used in place of the value for sensitive keys.
+      #
+      # @since 2.1.0
+      STRING_REPLACEMENT = '<REDACTED>'.freeze
+
+      # Get a string representation of the options.
+      #
+      # @return [ String ] The string representation of the options.
+      #
+      # @since 2.1.0
+      def inspect
+        redacted_string(:inspect)
+      end
+
+      # Get a string representation of the options.
+      #
+      # @return [ String ] The string representation of the options.
+      #
+      # @since 2.1.0
+      def to_s
+        redacted_string(:to_s)
+      end
+
+      # Whether these options contain a given key.
+      #
+      # @example Determine if the options contain a given key.
+      #   options.has_key?(:name)
+      #
+      # @param [ String, Symbol ] key The key to check for existence.
+      #
+      # @return [ true, false ] If the options contain the given key.
+      #
+      # @since 2.1.0
+      def has_key?(key)
+        super(convert_key(key))
+      end
+      alias_method :key?, :has_key?
+
+      # Returns a new options object consisting of pairs for which the block returns false.
+      #
+      # @example Get a new options object with pairs for which the block returns false.
+      #   new_options = options.reject { |k, v| k == 'database' }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] A new options object.
+      #
+      # @since 2.1.0
+      def reject(&block)
+        new_options = dup
+        new_options.reject!(&block) || new_options
+      end
+
+      # Only keeps pairs for which the block returns false.
+      #
+      # @example Remove pairs from this object for which the block returns true.
+      #   options.reject! { |k, v| k == 'database' }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted, nil ] This object or nil if no changes were made.
+      #
+      # @since 2.1.0
+      def reject!
+        if block_given?
+          n_keys = keys.size
+          keys.each do |key|
+            delete(key) if yield(key, self[key])
+          end
+          n_keys == keys.size ? nil : self
+        else
+          to_enum
+        end
+      end
+
+      # Returns a new options object consisting of pairs for which the block returns true.
+      #
+      # @example Get a new options object with pairs for which the block returns true.
+      #   ssl_options = options.select { |k, v| k =~ /ssl/ }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted ] A new options object.
+      #
+      # @since 2.1.0
+      def select(&block)
+        new_options = dup
+        new_options.select!(&block) || new_options
+      end
+
+      # Only keeps pairs for which the block returns true.
+      #
+      # @example Remove pairs from this object for which the block does not return true.
+      #   options.select! { |k, v| k =~ /ssl/ }
+      #
+      # @yieldparam [ String, Object ] The key as a string and its value.
+      #
+      # @return [ Options::Redacted, nil ] This object or nil if no changes were made.
+      #
+      # @since 2.1.0
+      def select!
+        if block_given?
+          n_keys = keys.size
+          keys.each do |key|
+            delete(key) unless yield(key, self[key])
+          end
+          n_keys == keys.size ? nil : self
+        else
+          to_enum
+        end
+      end
+
+      private
+
+      def redacted_string(method)
+        '{' + reduce([]) do |list, (k, v)|
+          list << "#{k.send(method)}=>#{redact(k, v, method)}"
+        end.join(', ') + '}'
+      end
+
+      def redact(k, v, method)
+        return STRING_REPLACEMENT if SENSITIVE_OPTIONS.include?(k.to_sym)
+        v.send(method)
+      end
+    end
+  end
+end

data/lib/mongo/options.rb

@@ -13,3 +13,4 @@
 # limitations under the License.
 
 require 'mongo/options/mapper'
+require 'mongo/options/redacted'

data/lib/mongo/protocol/delete.rb

@@ -41,31 +41,34 @@ module Mongo
       #
       #   Supported flags: +:single_remove+
       def initialize(database, collection, selector, options = {})
+        @database = database
         @namespace = "#{database}.#{collection}"
-        @selector  = selector
-        @flags     = options[:flags] || []
+        @selector = selector
+        @flags = options[:flags] || []
+        @upconverter = Upconverter.new(collection, selector, options)
       end
 
-      # The log message for a delete operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   delete.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", "DELETE"]
-        fields << ["namespace=%s", namespace]
-        fields << ["selector=%s", selector.inspect]
-        fields << ["flags=%s", flags.inspect]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: 'delete',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify a Delete message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -89,6 +92,63 @@ module Mongo
       # @!attribute
       # @return [Hash] The selector for this Delete message.
       field :selector, Document
+
+      # Converts legacy delete messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ BSON::Document, Hash ] filter The query filter or command.
+        attr_reader :filter
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', { name: 'test' })
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ BSON::Document, Hash ] filter The filter or command.
+        #
+        # @since 2.1.0
+        def initialize(collection, filter, options)
+          @collection = collection
+          @filter = filter
+          @options = options
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          BSON::Document.new(
+            delete: collection,
+            deletes: [ BSON::Document.new(q: filter, limit: limit) ],
+            ordered: true
+          )
+        end
+
+        private
+
+        def limit
+          if options.key?(:flags)
+            options[:flags].include?(:single_remove) ? 1 : 0
+          else
+            0
+          end
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/get_more.rb

@@ -37,27 +37,28 @@ module Mongo
       # @param number_to_return [Integer] The number of documents to return.
       # @param cursor_id [Integer] The cursor id returned in a reply.
       def initialize(database, collection, number_to_return, cursor_id)
+        @database = database
         @namespace = "#{database}.#{collection}"
         @number_to_return = number_to_return
         @cursor_id = cursor_id
+        @upconverter = Upconverter.new(collection, cursor_id, number_to_return)
       end
 
-      # The log message for a get more operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   get_more.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", "GETMORE"]
-        fields << ["namespace=%s", namespace]
-        fields << ["number_to_return=%s", number_to_return]
-        fields << ["cursor_id=%s", cursor_id]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: 'getMore',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       # Get more messages require replies from the database.
@@ -74,6 +75,8 @@ module Mongo
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify a GetMore message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -94,6 +97,55 @@ module Mongo
       # @!attribute
       # @return [Fixnum] The cursor id to get more documents from.
       field :cursor_id, Int64
+
+      # Converts legacy getmore messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Integer ] cursor_id The cursor id.
+        attr_reader :cursor_id
+
+        # @return [ Integer ] number_to_return The number of docs to return.
+        attr_reader :number_to_return
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', 1, 1)
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Integer ] cursor_id The cursor id.
+        # @param [ Integer ] number_to_return The number of documents to
+        #   return.
+        #
+        # @since 2.1.0
+        def initialize(collection, cursor_id, number_to_return)
+          @collection = collection
+          @cursor_id = cursor_id
+          @number_to_return = number_to_return
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          BSON::Document.new(
+            getMore: cursor_id,
+            batchSize: number_to_return,
+            collection: collection
+          )
+        end
+      end
     end
   end
 end