mongo 2.1.0.rc0 → 2.1.0

data/lib/mongo/index.rb

@@ -21,6 +21,11 @@ module Mongo
   # @since 2.0.0
   module Index
 
+    # Wildcard constant for all.
+    #
+    # @since 2.1.0
+    ALL = '*'.freeze
+
     # Specify ascending order for an index.
     #
     # @since 2.0.0

data/lib/mongo/index/view.rb

@@ -76,7 +76,7 @@ module Mongo
       #
       # @since 2.0.0
       def drop_one(name)
-        raise Error::MultiIndexDrop.new if name == '*'
+        raise Error::MultiIndexDrop.new if name == Index::ALL
         drop_by_name(name)
       end
 
@@ -89,7 +89,7 @@ module Mongo
       #
       # @since 2.0.0
       def drop_all
-        drop_by_name('*')
+        drop_by_name(Index::ALL)
       end
 
       # Creates an index on the collection.

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -53,7 +53,9 @@ module Mongo
       #
       # @since 2.1.0
       def started(event)
-        log_debug("#{prefix(event)} | STARTED | #{format_command(event.command)}")
+        if logger.debug?
+          log_debug("#{prefix(event)} | STARTED | #{format_command(event.command)}")
+        end
       end
 
       # Handle the command succeeded event.
@@ -65,7 +67,9 @@ module Mongo
       #
       # @since 2.1.0
       def succeeded(event)
-        log_debug("#{prefix(event)} | SUCCEEDED | #{event.duration}s")
+        if logger.debug?
+          log_debug("#{prefix(event)} | SUCCEEDED | #{event.duration}s")
+        end
       end
 
       # Handle the command failed event.
@@ -77,7 +81,9 @@ module Mongo
       #
       # @since 2.1.0
       def failed(event)
-        log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
+        if logger.debug?
+          log_debug("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
+        end
       end
 
       private

data/lib/mongo/monitoring/event.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/monitoring/event/secure'
 require 'mongo/monitoring/event/command_started'
 require 'mongo/monitoring/event/command_succeeded'
 require 'mongo/monitoring/event/command_failed'

data/lib/mongo/monitoring/event/command_started.rb

@@ -20,6 +20,7 @@ module Mongo
       #
       # @since 2.1.0
       class CommandStarted
+        include Secure
 
         # @return [ Server::Address ] address The server address.
         attr_reader :address
@@ -57,7 +58,7 @@ module Mongo
           @address = address
           @request_id = request_id
           @operation_id = operation_id
-          @command = command
+          @command = redacted(command_name, command)
         end
 
         # Create the event from a wire protocol message payload.

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -20,6 +20,7 @@ module Mongo
       #
       # @since 2.1.0
       class CommandSucceeded
+        include Secure
 
         # @return [ Server::Address ] address The server address.
         attr_reader :address
@@ -61,7 +62,7 @@ module Mongo
           @address = address
           @request_id = request_id
           @operation_id = operation_id
-          @reply = reply
+          @reply = redacted(command_name, reply)
           @duration = duration
         end
 
@@ -97,11 +98,13 @@ module Mongo
           if reply_payload
             reply = reply_payload[:reply]
             if cursor = reply[:cursor]
-              reply = reply.merge(cursor: cursor.merge(ns: namespace(command_payload)))
+              if !cursor.key?(Collection::NS)
+                cursor.merge!(Collection::NS => namespace(command_payload))
+              end
             end
             reply
           else
-            BSON::Document.new(ok: 1)
+            BSON::Document.new(Operation::Result::OK => 1)
           end
         end
 

data/lib/mongo/monitoring/event/secure.rb

@@ -0,0 +1,58 @@
+# 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
+  class Monitoring
+    module Event
+
+      # Provides behaviour to redact sensitive information from commands and
+      # replies.
+      #
+      # @since 2.1.0
+      module Secure
+
+        # The list of commands that has the data redacted for security.
+        #
+        # @since 2.1.0
+        REDACTED_COMMANDS = [
+          'authenticate',
+          'saslStart',
+          'saslContinue',
+          'getnonce',
+          'createUser',
+          'updateUser',
+          'copydbgetnonce',
+          'copydbsaslstart',
+          'copydb'
+        ].freeze
+
+        # Redact secure information from the document if it's command is in the
+        # list.
+        #
+        # @example Get the redacted document.
+        #   secure.redacted(command_name, document)
+        #
+        # @param [ String, Symbol ] command_name The command name.
+        # @param [ BSON::Document ] document The document.
+        #
+        # @return [ BSON::Document ] The redacted document.
+        #
+        # @since 2.1.0
+        def redacted(command_name, document)
+          REDACTED_COMMANDS.include?(command_name.to_s) ? BSON::Document.new : document
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation.rb

@@ -20,4 +20,34 @@ require 'mongo/operation/read_preference'
 require 'mongo/operation/read'
 require 'mongo/operation/write'
 require 'mongo/operation/commands'
-require 'mongo/operation/kill_cursors'
+require 'mongo/operation/kill_cursors'
+
+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/operation/commands/collections_info.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/commands/collections_info/result'
+
 module Mongo
   module Operation
 

data/lib/mongo/operation/commands/collections_info/result.rb

@@ -0,0 +1,39 @@
+# 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
+    class CollectionsInfo
+
+      # Defines custom behaviour of results when query the system.namespaces
+      # collection.
+      #
+      # @since 2.1.0
+      class Result < Operation::Result
+
+        # Get the namespace for the cursor.
+        #
+        # @example Get the namespace.
+        #   result.namespace
+        #
+        # @return [ String ] The namespace.
+        #
+        # @since 2.1.0
+        def namespace
+          Database::NAMESPACES
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/list_indexes/result.rb

@@ -110,6 +110,7 @@ module Mongo
         def first_document
           @first_document ||= reply.documents[0]
         end
-      end end
+      end
+    end
   end
 end

data/lib/mongo/operation/commands/map_reduce/result.rb

@@ -16,7 +16,7 @@ module Mongo
   module Operation
     class MapReduce
 
-      # Defines custom behaviour of results in an aggregation context.
+      # Defines custom behaviour of results for a map reduce operation.
       #
       # @since 2.0.0
       class Result < Operation::Result

data/lib/mongo/operation/read/query.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/read/query/result'
+
 module Mongo
   module Operation
     module Read

data/lib/mongo/operation/read/query/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 Read
+      class Query
+
+        # Defines custom behaviour of results for a query.
+        #
+        # @since 2.1.0
+        class Result < Operation::Result
+
+          # Determine if the query was a success.
+          #
+          # @example Was the query successful?
+          #   result.successful?
+          #
+          # @return [ true, false ] If the query was successful.
+          #
+          # @since 2.0.0
+          def successful?
+            !query_failure?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/result.rb

@@ -190,12 +190,24 @@ module Mongo
       def successful?
         return true if !acknowledged?
         if first_document.has_key?(OK)
-          first_document[OK] == 1 && parser.message.empty?
+          ok? && parser.message.empty?
         else
           !query_failure? && parser.message.empty?
         end
       end
 
+      # Check the first document's ok field.
+      #
+      # @example Check the ok field.
+      #   result.ok?
+      #
+      # @return [ true, false ] If the command returned ok.
+      #
+      # @since 2.1.0
+      def ok?
+        first_document[OK] == 1
+      end
+
       # Validate the result by checking for any errors.
       #
       # @note This only checks for errors with writes since authentication is

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

@@ -60,8 +60,8 @@ module Mongo
 
           def messages
             deletes.collect do |del|
-              opts = ( del[:limit] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
-              Protocol::Delete.new(db_name, coll_name, del[:q], opts)
+              opts = ( del[Operation::LIMIT] || 0 ) <= 0 ? {} : { :flags => [ :single_remove ] }
+              Protocol::Delete.new(db_name, coll_name, del[Operation::Q], opts)
             end
           end
         end

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

@@ -69,9 +69,9 @@ module Mongo
           def messages
             updates.collect do |u|
               opts = { :flags => [] }
-              opts[:flags] << :multi_update if !!u[:multi]
-              opts[:flags] << :upsert if !!u[:upsert]
-              Protocol::Update.new(db_name, coll_name, u[:q], u[:u], opts)
+              opts[:flags] << :multi_update if !!u[Operation::MULTI]
+              opts[:flags] << :upsert if !!u[Operation::UPSERT]
+              Protocol::Update.new(db_name, coll_name, u[Operation::Q], u[Operation::U], opts)
             end
           end
         end

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

@@ -61,8 +61,8 @@ module Mongo
         end
 
         def message
-          selector = delete[:q]
-          opts     = (delete[:limit] || 0) <= 0 ? {} : { :flags => [ :single_remove ] }
+          selector = delete[Operation::Q]
+          opts     = (delete[Operation::LIMIT] || 0) <= 0 ? {} : { :flags => [ :single_remove ] }
           Protocol::Delete.new(db_name, coll_name, selector, opts)
         end
       end

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

@@ -65,10 +65,15 @@ module Mongo
 
         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/options.rb

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

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