RUBY-1021 Test and documentation for Redacted Options

Author: estolfo

lib/mongo/client.rb

@@ -292,14 +292,14 @@ def list_databases
     private
 
     def create_from_addresses(addresses, opts = {})
-      @options = Options::Redacted.new.merge(Database::DEFAULT_OPTIONS.merge(opts)).freeze
+      @options = Options::Redacted.new(Database::DEFAULT_OPTIONS.merge(opts)).freeze
       @cluster = Cluster.new(addresses, @monitoring, options)
       @database = Database.new(self, options[:database], options)
     end
 
     def create_from_uri(connection_string, opts = {})
       uri = URI.new(connection_string, opts)
-      @options = Options::Redacted.new.merge(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
+      @options = Options::Redacted.new(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
       @cluster = Cluster.new(uri.servers, @monitoring, options)
       @database = Database.new(self, options[:database], options)
     end

lib/mongo/options/redacted.rb

@@ -15,31 +15,63 @@
 module Mongo
   module Options
 
-    REDACTED_OPTIONS = [:password, :pwd]
-    REDACTED_STRING = '<REDACTED>'
-
+    # 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 ]
+
+      # The replacement string used in place of the value for sensitive keys.
+      #
+      # @since 2.1.0
+      STRING_REPLACEMENT = '<REDACTED>'
+
+      # Get a string representation of the options.
+      #
+      # @return [ String ] The string representation of the options.
+      #
+      # @since 2.1.0
       def inspect
         '{' + reduce([]) do |list, (k, v)|
           list << "#{k.inspect}=>#{redact(k, v, __method__)}"
         end.join(', ') + '}'
       end
 
+      # Get a string representation of the options.
+      #
+      # @return [ String ] The string representation of the options.
+      #
+      # @since 2.1.0
       def to_s
         '{' + reduce([]) do |list, (k, v)|
           list << "#{k.to_s}=>#{redact(k, v, __method__)}"
         end.join(', ') + '}'
       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
 
       private
 
       def redact(k, v, method)
-        return REDACTED_STRING if REDACTED_OPTIONS.include?(k.to_sym)
+        return STRING_REPLACEMENT if SENSITIVE_OPTIONS.include?(k.to_sym)
         v.send(method)
       end
     end

spec/mongo/options/redacted_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Mongo::Options::Redacted do
+
+  let(:options) do
+    described_class.new(original_opts)
+  end
+
+  describe '#to_s' do
+
+    context 'when the hash contains a sensitive key' do
+
+      let(:original_opts) do
+        { password: '123' }
+      end
+
+      it 'replaces the value with the redacted string' do
+        expect(options.to_s).not_to match(/123/)
+      end
+
+      it 'replaces the value with the redacted string' do
+        expect(options.to_s).to match(Mongo::Options::Redacted::STRING_REPLACEMENT)
+      end
+    end
+
+    context 'when the hash does not contain a sensitive key' do
+
+      it 'prints all the values' do
+
+      end
+    end
+  end
+
+  describe '#inspect' do
+
+    context 'when the hash contains a sensitive key' do
+
+      let(:original_opts) do
+        { password: '123' }
+      end
+
+      it 'replaces the value with the redacted string' do
+        expect(options.inspect).not_to match(/123/)
+      end
+
+      it 'replaces the value with the redacted string' do
+        expect(options.inspect).to match(Mongo::Options::Redacted::STRING_REPLACEMENT)
+      end
+    end
+
+    context 'when the hash does not contain a sensitive key' do
+
+      let(:original_opts) do
+        { name: '123' }
+      end
+
+      it 'does not replace the value with the redacted string' do
+        expect(options.inspect).to match(/123/)
+      end
+
+      it 'does not replace the value with the redacted string' do
+        expect(options.inspect).not_to match(Mongo::Options::Redacted::STRING_REPLACEMENT)
+      end
+    end
+  end
+
+  describe '#has_key?' do
+
+    context 'when the original key is a String' do
+
+      let(:original_opts) do
+        { 'name' => 'Emily' }
+      end
+
+      context 'when the method argument is a String' do
+
+        it 'returns true when ' do
+          expect(options.has_key?('name')).to be(true)
+        end
+      end
+
+      context 'when method argument is a Symbol' do
+
+        it 'returns true' do
+          expect(options.has_key?(:name)).to be(true)
+        end
+      end
+    end
+
+    context 'when the original key is a Symbol' do
+
+      let(:original_opts) do
+        { name: 'Emily' }
+      end
+
+      context 'when the method argument is a String' do
+
+        it 'returns true when ' do
+          expect(options.has_key?('name')).to be(true)
+        end
+      end
+
+      context 'when method argument is a Symbol' do
+
+        it 'returns true' do
+          expect(options.has_key?(:name)).to be(true)
+        end
+      end
+    end
+
+    context 'when the hash does not contain the key' do
+
+      let(:original_opts) do
+        { other: 'Emily' }
+      end
+
+      context 'when the method argument is a String' do
+
+        it 'returns true when ' do
+          expect(options.has_key?('name')).to be(false)
+        end
+      end
+
+      context 'when method argument is a Symbol' do
+
+        it 'returns true' do
+          expect(options.has_key?(:name)).to be(false)
+        end
+      end
+    end
+  end
+end