mongo 2.0.2 → 2.0.3

data/lib/mongo/error.rb

@@ -71,12 +71,16 @@ require 'mongo/error/invalid_document'
 require 'mongo/error/invalid_file'
 require 'mongo/error/invalid_nonce'
 require 'mongo/error/invalid_replacement_document'
+require 'mongo/error/invalid_server_preference'
 require 'mongo/error/invalid_signature'
 require 'mongo/error/invalid_update_document'
+require 'mongo/error/invalid_uri'
+require 'mongo/error/invalid_uri_option'
 require 'mongo/error/max_bson_size'
 require 'mongo/error/max_message_size'
 require 'mongo/error/multi_index_drop'
 require 'mongo/error/need_primary_server'
+require 'mongo/error/no_server_available'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
 require 'mongo/error/unsupported_features'

data/lib/mongo/error/invalid_document.rb

@@ -23,7 +23,7 @@ module Mongo
       # The error message.
       #
       # @since 2.0.0
-      MESSAGE = 'Invalid document provided'.freeze
+      MESSAGE = 'Invalid document provided.'.freeze
 
       # Instantiate the new exception.
       #

data/lib/mongo/error/invalid_server_preference.rb

@@ -0,0 +1,36 @@
+# 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
+  class Error
+
+    # Raised when an invalid server preference is provided.
+    #
+    # @since 2.0.0
+    class InvalidServerPreference < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::ServerSelector::InvalidServerPreference.new
+      #
+      # @param [ String ] name The preference name.
+      #
+      # @since 2.0.0
+      def initialize(name)
+        super("This server preference #{name} cannot be combined with tags.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_uri.rb

@@ -0,0 +1,37 @@
+# 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
+  class Error
+
+    # Exception that is raised when trying to parse a URI that does not match
+    # the specification.
+    #
+    # @since 2.0.0
+    class InvalidURI < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidURI.new(uri)
+      #
+      # @since 2.0.0
+      def initialize(uri)
+        super("MongoDB URI must be in the following format: #{Mongo::URI::FORMAT}\n" +
+        "Please see the following URL for more information: #{Mongo::URI::HELP}\n" +
+        "Bad URI: #{uri}")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_uri_option.rb

@@ -0,0 +1,38 @@
+# 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
+  class Error
+
+    # Raised if the URI is in the correct format but an option is provided that
+    # is not recognized.
+    #
+    # @since 2.0.0
+    class InvalidURIOption < Error
+
+      # Create the error.
+      #
+      # @example Create the error with the invalid option name.
+      #   InvalidURIOption.new('nothing')
+      #
+      # @param [ String ] name The invalid option name.
+      #
+      # @since 2.0.0
+      def initialize(name)
+        super("Invalid option in URI: '#{name}'.\n" +
+          "Please see the following URL for more information: #{Mongo::URI::HELP}\n")
+      end
+    end
+  end
+end

data/lib/mongo/error/no_server_available.rb

@@ -0,0 +1,37 @@
+# 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
+  class Error
+
+    # Raised if there are no servers available matching the preference.
+    #
+    # @since 2.0.0
+    class NoServerAvailable < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::NoServerAvailable.new(server_selector)
+      #
+      # @param [ Hash ] server_selector The server preference that could not be
+      #   satisfied.
+      #
+      # @since 2.0.0
+      def initialize(server_selector)
+        super("No server is available matching preference: #{server_selector.inspect}")
+      end
+    end
+  end
+end

data/lib/mongo/operation/read_preferrable.rb

@@ -22,11 +22,27 @@ module Mongo
 
       private
 
+      def update_selector(context)
+        if context.mongos? && read_pref = read.to_mongos
+          selector.merge(:$readPreference => read_pref)
+        else
+          selector
+        end
+      end
+
+      def update_options(context)
+        if context.slave_ok?
+          options.merge(flags: [:slave_ok])
+        elsif !context.mongos? && read.slave_ok?
+          options.merge(flags: [:slave_ok])
+        else
+          options
+        end
+      end
+
       def message(context)
-        sel = (context.mongos? && read_pref = read.to_mongos) ?
-                selector.merge(:$readPreference => read_pref) : selector
-        opts = context.standalone? || read.slave_ok? ?
-                 options.merge(flags: [:slave_ok]) : options
+        sel = update_selector(context)
+        opts = update_options(context)
         Protocol::Query.new(db_name, query_coll, sel, opts)
       end
     end

data/lib/mongo/protocol/query.rb

@@ -30,6 +30,12 @@ module Mongo
     # @api semipublic
     class Query < Message
 
+      # Constant for the max number of characters to print when inspecting
+      # a query field.
+      #
+      # @since 2.0.3
+      LOG_STRING_LIMIT = 250
+
       # Creates a new Query message
       #
       # @example Find all users named Tyler.
@@ -78,7 +84,7 @@ module Mongo
         fields = []
         fields << ["%s |", query_type]
         fields << ["namespace=%s", namespace]
-        fields << ["selector=%s", selector.inspect]
+        fields << ["selector=%s", formatted_selector]
         fields << ["flags=%s", flags.inspect]
         fields << ["limit=%s", limit.inspect]
         fields << ["skip=%s", skip.inspect]
@@ -111,6 +117,13 @@ module Mongo
         namespace.include?(Database::COMMAND) ? 'COMMAND' : 'QUERY'
       end
 
+      def formatted_selector
+        ( (str = selector.inspect).length > LOG_STRING_LIMIT ) ?
+          "#{str[0..LOG_STRING_LIMIT]}..." : str
+      rescue ArgumentError
+        '<Unable to inspect selector>'
+      end
+
       # Available flags for a Query message.
       FLAGS = [
         :reserved,

data/lib/mongo/server.rb

@@ -159,5 +159,17 @@ module Mongo
         tags[k] && tags[k] == tag_set[k]
       end
     end
+
+    # Whether the slaveOk bit must be set for all queries sent to the server.
+    #
+    # @example Does the slaveOk bit need to be set for all queries sent to the server.
+    #   server.slave_ok?
+    #
+    # @return [ true, false ] If the slaveOk bit needs to be set for all queries.
+    #
+    # @since 2.0.0
+    def slave_ok?
+      options[:slave_ok]
+    end
   end
 end

data/lib/mongo/server/connectable.rb

@@ -82,7 +82,11 @@ module Mongo
 
       private
 
-      attr_reader :socket, :ssl_options
+      attr_reader :socket
+
+      def ssl_options
+        @ssl_options[:ssl] == true ? @ssl_options : {}
+      end
 
       def ensure_connected
         ensure_same_process!

data/lib/mongo/server/connection.rb

@@ -22,7 +22,7 @@ module Mongo
       include Connectable
       extend Forwardable
 
-      # @return [ Mongo::Auth::CR, Mongo::Auth::X509, Mongo::Auth:LDAP ]
+      # @return [ Mongo::Auth::CR, Mongo::Auth::X509, Mongo::Auth:LDAP, Mongo::Auth::SCRAM ]
       #   authenticator The authentication strategy.
       attr_reader :authenticator
 

data/lib/mongo/server/context.rb

@@ -33,7 +33,8 @@ module Mongo
                      :mongos?,
                      :primary?,
                      :secondary?,
-                     :standalone?
+                     :standalone?,
+                     :slave_ok?
 
       # Instantiate a server context.
       #

data/lib/mongo/server_selector.rb

@@ -58,24 +58,5 @@ module Mongo
         options
       )
     end
-
-    # Exception raised if there are no servers available matching the preference.
-    #
-    # @since 2.0.0
-    class NoServerAvailable < Error
-
-      # Instantiate the new exception.
-      #
-      # @example Instantiate the exception.
-      #   Mongo::ServerSelector::NoServerAvailable.new(server_selector)
-      #
-      # @param [ Hash ] server_selector The server preference that could not be
-      #   satisfied.
-      #
-      # @since 2.0.0
-      def initialize(server_selector)
-        super("No server is available matching preference: #{server_selector.inspect}")
-      end
-    end
   end
 end

data/lib/mongo/server_selector/selectable.rb

@@ -67,7 +67,7 @@ module Mongo
       # @since 2.0.0
       def initialize(tag_sets = [], options = {})
         if !tag_sets.all? { |set| set.empty? } && !tags_allowed?
-          raise ServerSelector::InvalidServerPreference.new(name)
+          raise Error::InvalidServerPreference.new(name)
         end
         @tag_sets = tag_sets
         @options = options
@@ -86,7 +86,7 @@ module Mongo
       def select_server(cluster)
         deadline = Time.now + server_selection_timeout
         while (deadline - Time.now) > 0
-          if cluster.standalone?
+          if cluster.single?
             servers = cluster.servers
           elsif cluster.sharded?
             servers = near_servers(cluster.servers)
@@ -96,7 +96,7 @@ module Mongo
           return servers.first if servers && !servers.compact.empty?
           cluster.scan!
         end
-        raise NoServerAvailable.new(self)
+        raise Error::NoServerAvailable.new(self)
       end
 
       # Get the timeout for server selection.
@@ -136,7 +136,7 @@ module Mongo
       # @since 2.0.0
       def primary(candidates)
         candidates.select do |server|
-          server.primary? || server.standalone?
+          server.primary?
         end
       end
 
@@ -187,23 +187,5 @@ module Mongo
         matches || []
       end
     end
-
-    # Raised when an invalid server preference is provided.
-    #
-    # @since 2.0.0
-    class InvalidServerPreference < Error
-
-      # Instantiate the new exception.
-      #
-      # @example Instantiate the exception.
-      #   Mongo::ServerSelector::InvalidServerPreference.new
-      #
-      # @param [ String ] name The preference name.
-      #
-      # @since 2.0.0
-      def initialize(name)
-        super("This server preference #{name} cannot be combined with tags.")
-      end
-    end
   end
 end

data/lib/mongo/uri.rb

@@ -80,6 +80,13 @@ module Mongo
     # @since 2.0.0
     URI = /#{SCHEME}#{CREDENTIALS}#{SERVERS}#{DATABASE}#{OPTIONS}/.freeze
 
+
+    # MongoDB URI format specification.
+    #
+    # @since 2.0.0
+    FORMAT = 'mongodb://[username:password@]host1[:port1][,host2[:port2]' +
+      ',...[,hostN[:portN]]][/[database][?options]]'.freeze
+
     # MongoDB URI (connection string) documentation url
     #
     # @since 2.0.0
@@ -117,7 +124,7 @@ module Mongo
     # @since 2.0.0
     def initialize(string)
       @match = string.match(URI)
-      raise Invalid.new(string) unless @match
+      raise Error::InvalidURI.new(string) unless @match
     end
 
     # Get the servers provided in the URI.
@@ -203,65 +210,12 @@ module Mongo
       parsed_options.split('&').reduce({}) do |options, option|
         key, value = option.split('=')
         strategy = OPTION_MAP[key]
-        raise InvalidOption.new(key) if strategy.nil?
+        raise Error::InvalidURIOption.new(key) if strategy.nil?
         add_option(strategy, value, options)
         options
       end
     end
 
-    # Exception that is raised when trying to parse a URI that does not match
-    # the specification.
-    #
-    # @since 2.0.0
-    class Invalid < RuntimeError
-
-      # MongoDB URI format specification.
-      #
-      # @since 2.0.0
-      FORMAT = 'mongodb://[username:password@]host1[:port1][,host2[:port2]' +
-        ',...[,hostN[:portN]]][/[database][?options]]'.freeze
-
-      # Creates a new instance of the BadURI error.
-      #
-      # @example Initialize the error.
-      #   BadURI.new(uri)
-      #
-      # @param [ String ] uri The bad URI.
-      #
-      # @since 2.0.0
-      def initialize(uri)
-        super(message(uri))
-      end
-
-      private
-
-      def message(uri)
-        "MongoDB URI must be in the following format: #{FORMAT}\n" +
-        "Please see the following URL for more information: #{HELP}\n" +
-        "Bad URI: #{uri}"
-      end
-    end
-
-    # Raised if the URI is in the correct format but an option is provided that
-    # is not recognized.
-    #
-    # @since 2.0.0
-    class InvalidOption < RuntimeError
-
-      # Create the error.
-      #
-      # @example Create the error with the invalid option name.
-      #   InvalidOption.new('nothing')
-      #
-      # @param [ String ] name The invalid option name.
-      #
-      # @since 2.0.0
-      def initialize(name)
-        super("Invalid option in URI: '#{name}'.\n" +
-          "Please see the following URL for more information: #{HELP}\n")
-      end
-    end
-
     private
 
     # Hash for storing map of URI option parameters to conversion strategies