mongo 2.1.0.beta → 2.2.0

data/lib/mongo/operation.rb

@@ -16,11 +16,39 @@ require 'mongo/operation/result'
 require 'mongo/operation/executable'
 require 'mongo/operation/specifiable'
 require 'mongo/operation/limited'
-require 'mongo/operation/read_preferrable'
+require 'mongo/operation/object_id_generator'
+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'
-require 'mongo/operation/parallel_scan'
+
+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,32 @@ 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
+
+      # Transforms the provided options to a new set of options given the
+      # provided mapping. Expects BSON::Documents in and out so no explicit
+      # string conversion needs to happen.
+      #
+      # @example Transform the options.
+      #   Mapper.transform_documents({ name: 1 }, { :name => :nombre })
+      #
+      # @param [ BSON::Document ] options The options to transform
+      # @param [ BSON::Document ] mappings The key mappings.
+      # @param [ BSON::Document ] document The output document.
+      #
+      # @return [ BSON::Document ] The transformed options.
+      #
+      # @since 2.0.0
+      def transform_documents(options, mappings, document = BSON::Document.new)
+        options.reduce(document) do |transformed, (key, value)|
+          name = mappings[key]
+          transformed[name] = value if name && !value.nil?
           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/bit_vector.rb

@@ -24,7 +24,7 @@ module Mongo
 
         # Initializes a BitVector with a layout
         #
-        # @param layout [Array<Symbol>] the array of fields in the bit vector
+        # @param layout [ Array<Symbol> ] the array of fields in the bit vector
         def initialize(layout)
           @masks = {}
           layout.each_with_index do |field, index|
@@ -34,21 +34,23 @@ module Mongo
 
         # Serializes vector by encoding each symbol according to its mask
         #
-        # @param buffer [IO] Buffer to receive the serialized vector
-        # @param value [Array<Symbol>] Array of flags to encode
-        # @return [IO] Buffer that received the serialized vector
+        # @param buffer [ String ] Buffer to receive the serialized vector
+        # @param value [ Array<Symbol> ] Array of flags to encode
+        #
+        # @return [ String ] Buffer that received the serialized vector
         def serialize(buffer, value)
           bits = 0
           value.each { |flag| bits |= @masks[flag] }
-          buffer << [bits].pack(INT32_PACK)
+          buffer.put_int32(bits)
         end
 
         # Deserializes vector by decoding the symbol according to its mask
         #
-        # @param io [IO] Stream containing the vector to be deserialized
-        # @return [Array<Symbol>] Flags contained in the vector
-        def deserialize(io)
-          vector = io.read(4).unpack(INT32_PACK).first
+        # @param [ String ] buffer Buffer containing the vector to be deserialized.
+        #
+        # @return [ Array<Symbol> ] Flags contained in the vector
+        def deserialize(buffer)
+          vector = buffer.get_int32
           flags = []
           @masks.each do |flag, mask|
             flags << flag if mask & vector != 0

data/lib/mongo/protocol/delete.rb

@@ -43,8 +43,9 @@ module Mongo
       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
 
       # Return the event payload for monitoring.
@@ -56,11 +57,18 @@ module Mongo
       #
       # @since 2.1.0
       def payload
-        { command_name: 'delete', database_name: @database, command: selector, request_id: request_id }
+        {
+          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
@@ -84,6 +92,73 @@ 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
+
+        # The delete command constant.
+        #
+        # @since 2.2.0
+        DELETE = 'delete'.freeze
+
+        # The deletes command constant.
+        #
+        # @since 2.2.0
+        DELETES = 'deletes'.freeze
+
+        # @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
+          document = BSON::Document.new
+          document.store(DELETE, collection)
+          document.store(DELETES, [ BSON::Document.new(Message::Q => filter, Message::LIMIT => limit) ])
+          document.store(Message::ORDERED, true)
+          document
+        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

@@ -41,6 +41,7 @@ module Mongo
         @namespace = "#{database}.#{collection}"
         @number_to_return = number_to_return
         @cursor_id = cursor_id
+        @upconverter = Upconverter.new(collection, cursor_id, number_to_return)
       end
 
       # Return the event payload for monitoring.
@@ -53,9 +54,9 @@ module Mongo
       # @since 2.1.0
       def payload
         {
-          command_name: 'getmore',
+          command_name: 'getMore',
           database_name: @database,
-          command: { cursor_id: cursor_id, number_to_return: number_to_return },
+          command: upconverter.command,
           request_id: request_id
         }
       end
@@ -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,60 @@ 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
+
+        # The get more constant.
+        #
+        # @since 2.2.0
+        GET_MORE = 'getMore'.freeze
+
+        # @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
+          document = BSON::Document.new
+          document.store(GET_MORE, cursor_id)
+          document.store(Message::BATCH_SIZE, number_to_return)
+          document.store(Message::COLLECTION, collection)
+          document
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/insert.rb

@@ -53,6 +53,7 @@ module Mongo
         @namespace = "#{database}.#{collection}"
         @documents = documents
         @flags = options[:flags] || []
+        @upconverter = Upconverter.new(collection, documents, options)
       end
 
       # Return the event payload for monitoring.
@@ -64,11 +65,18 @@ module Mongo
       #
       # @since 2.1.0
       def payload
-        { command_name: 'insert', database_name: @database, command: documents, request_id: request_id }
+        {
+          command_name: 'insert',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify an Insert message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -89,6 +97,70 @@ module Mongo
       # @!attribute
       # @return [Array<Hash>] The documents to insert.
       field :documents, Document, true
+
+      # Converts legacy insert messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # Insert field constant.
+        #
+        # @since 2.1.0
+        INSERT = 'insert'.freeze
+
+        # Documents field constant.
+        #
+        # @since 2.1.0
+        DOCUMENTS = 'documents'.freeze
+
+        # Write concern field constant.
+        #
+        # @since 2.1.0
+        WRITE_CONCERN = 'writeConcern'.freeze
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Array<BSON::Document> ] documents The documents to insert.
+        attr_reader :documents
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', documents)
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Array<BSON::Document> ] documents The documents.
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.1.0
+        def initialize(collection, documents, options)
+          @collection = collection
+          @documents = documents
+          @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
+          document = BSON::Document.new
+          document.store(INSERT, collection)
+          document.store(DOCUMENTS, documents)
+          document.store(Message::ORDERED, options.fetch(:ordered, true))
+          document.merge!(WRITE_CONCERN => options[:write_concern].options) if options[:write_concern]
+          document
+        end
+      end
     end
   end
 end

data/lib/mongo/protocol/kill_cursors.rb

@@ -28,11 +28,14 @@ module Mongo
       # @example Kill the cursor on the server with id 1.
       #   KillCursors.new([1])
       #
-      # @param cursor_ids [Array<Fixnum>] The cursor ids to kill.
-      # @param options [Hash] The additional kill cursors options.
-      def initialize(cursor_ids, options = {})
+      # @param [ Mongo::Database ] collection The collection.
+      # @param [ Mongo::Database ] database The database.
+      # @param [ Array<Fixnum> ] cursor_ids The cursor ids to kill.
+      def initialize(collection, database, cursor_ids)
+        @database = database
         @cursor_ids = cursor_ids
         @id_count   = @cursor_ids.size
+        @upconverter = Upconverter.new(collection, cursor_ids)
       end
 
       # Return the event payload for monitoring.
@@ -44,11 +47,18 @@ module Mongo
       #
       # @since 2.1.0
       def payload
-        { command_name: 'killcursors', command: { cursor_ids: cursor_ids }, request_id: request_id }
+        {
+          command_name: 'killCursors',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify +KillCursors+ message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -65,6 +75,58 @@ module Mongo
       # @!attribute
       # @return [Array<Fixnum>] Cursors to kill.
       field :cursor_ids, Int64, true
+
+      # Converts legacy insert messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # The kill cursors constant.
+        #
+        # @since 2.2.0
+        KILL_CURSORS = 'killCursors'.freeze
+
+        # The cursors constant.
+        #
+        # @since 2.2.0
+        CURSORS = 'cursors'.freeze
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Array<Integer> ] cursor_ids The cursor ids.
+        attr_reader :cursor_ids
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new('users', [ 1, 2, 3 ])
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Array<Integer> ] cursor_ids The cursor ids.
+        #
+        # @since 2.1.0
+        def initialize(collection, cursor_ids)
+          @collection = collection
+          @cursor_ids = cursor_ids
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          document = BSON::Document.new
+          document.store(KILL_CURSORS, collection)
+          document.store(CURSORS, cursor_ids)
+          document
+        end
+      end
     end
   end
 end