mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/server/monitor/connection.rb

@@ -0,0 +1,88 @@
+# 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 Server
+    class Monitor
+
+      # This class models the monitor connections and their behavior.
+      #
+      # @since 2.0.0
+      class Connection
+        include Connectable
+
+        # Tell the underlying socket to establish a connection to the host.
+        #
+        # @example Connect to the host.
+        #   connection.connect!
+        #
+        # @note This method mutates the connection class by setting a socket if
+        #   one previously did not exist.
+        #
+        # @return [ true ] If the connection succeeded.
+        #
+        # @since 2.0.0
+        def connect!
+          unless socket
+            @socket = address.socket(timeout, ssl_options)
+            @socket.connect!
+          end
+          true
+        end
+
+        # Disconnect the connection.
+        #
+        # @example Disconnect from the host.
+        #   connection.disconnect!
+        #
+        # @note This method mutates the connection by setting the socket to nil
+        #   if the closing succeeded.
+        #
+        # @return [ true ] If the disconnect succeeded.
+        #
+        # @since 2.0.0
+        def disconnect!
+          if socket
+            socket.close
+            @socket = nil
+          end
+          true
+        end
+
+        # Initialize a new socket connection from the client to the server.
+        #
+        # @example Create the connection.
+        #   Connection.new(address)
+        #
+        # @param [ Mongo::Address ] address The address the connection is for.
+        # @param [ Hash ] options The connection options.
+        #
+        # @since 2.0.0
+        def initialize(address, options = {})
+          @address = address
+          @options = options.freeze
+          @ssl_options = options.reject { |k, v| !k.to_s.start_with?('ssl') }
+          @socket = nil
+        end
+
+        private
+
+        def write(messages, buffer = '')
+          messages.each{ |message| message.serialize(buffer) }
+          ensure_connected{ |socket| socket.write(buffer) }
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server_selector.rb

@@ -0,0 +1,81 @@
+# 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.
+
+require 'mongo/server_selector/selectable'
+require 'mongo/server_selector/nearest'
+require 'mongo/server_selector/primary'
+require 'mongo/server_selector/primary_preferred'
+require 'mongo/server_selector/secondary'
+require 'mongo/server_selector/secondary_preferred'
+
+module Mongo
+
+  # Functionality for getting an object able to select a server, given a preference.
+  #
+  # @since 2.0.0
+  module ServerSelector
+    extend self
+
+    # Hash lookup for the selector classes based off the symbols
+    #   provided in configuration.
+    #
+    # @since 2.0.0
+    PREFERENCES = {
+        nearest: Nearest,
+        primary: Primary,
+        primary_preferred: PrimaryPreferred,
+        secondary: Secondary,
+        secondary_preferred: SecondaryPreferred
+    }.freeze
+
+    # Create a server selector object.
+    #
+    # @example Get a server selector object for selecting a secondary with
+    #   specific tag sets.
+    #   Mongo::ServerSelector.get({ :mode => :secondary, :tag_sets => [{'dc' => 'nyc'}] })
+    #
+    # @param [ Hash ] preference The server preference.
+    # @param [ Hash ] options The preference options.
+    #
+    # @option preference :mode [ Symbol ] The preference mode.
+    # @option preference :tag_sets [ Array<Hash> ] The tag sets.
+    #
+    # @since 2.0.0
+    def get(preference = {}, options = {})
+      PREFERENCES.fetch(preference[:mode] || :primary).new(
+        preference[:tag_sets] || [],
+        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)
+      #
+      # @params [ 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/nearest.rb

@@ -0,0 +1,94 @@
+# 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 ServerSelector
+
+    # Encapsulates specifications for selecting near servers given a list
+    #   of candidates.
+    #
+    # @since 2.0.0
+    class Nearest
+      include Selectable
+
+      # Get the name of the server mode type.
+      #
+      # @example Get the name of the server mode for this preference.
+      #   preference.name
+      #
+      # @return [ Symbol ] :nearest
+      #
+      # @since 2.0.0
+      def name
+        :nearest
+      end
+
+      # Whether the slaveOk bit should be set on wire protocol messages.
+      #   I.e. whether the operation can be performed on a secondary server.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def slave_ok?
+        true
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a mongos server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::Nearest.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        preference = { :mode => 'nearest' }
+        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference
+      end
+
+      private
+
+      # Select the near servers taking into account any defined tag sets and
+      #   local threshold between the nearest server and other servers.
+      #
+      # @example Select nearest servers given a list of candidates.
+      #   preference = Mongo::Serverreference::Nearest.new
+      #   preference.select_server(cluster)
+      #
+      # @return [ Array ] The nearest servers from the list of candidates.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        if tag_sets.empty?
+          near_servers(candidates)
+        else
+          near_servers(match_tag_sets(candidates))
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/primary.rb

@@ -0,0 +1,88 @@
+# 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 ServerSelector
+
+    # Encapsulates specifications for selecting the primary server given a list
+    #   of candidates.
+    #
+    # @since 2.0.0
+    class Primary
+      include Selectable
+
+      # Get the name of the server mode type.
+      #
+      # @example Get the name of the server mode for this preference.
+      #   preference.name
+      #
+      # @return [ Symbol ] :primary
+      #
+      # @since 2.0.0
+      def name
+        :primary
+      end
+
+      # Whether the slaveOk bit should be set on wire protocol messages.
+      #   I.e. whether the operation can be performed on a secondary server.
+      #
+      # @return [ false ] false
+      #
+      # @since 2.0.0
+      def slave_ok?
+        false
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ false ] false
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        false
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a mongos server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::Primary.new
+      #   preference.to_mongos
+      #
+      # @return [ nil ] nil
+      #
+      # @since 2.0.0
+      def to_mongos
+        nil
+      end
+
+      private
+
+      # Select the primary server from a list of candidates.
+      #
+      # @example Select the primary server given a list of candidates.
+      #   preference = Mongo::ServerSelector::Primary.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] The primary server from the list of candidates.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        primary(candidates)
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/primary_preferred.rb

@@ -0,0 +1,94 @@
+# 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 ServerSelector
+
+    # Encapsulates specifications for selecting servers, with the
+    #   primary preferred, given a list of candidates.
+    #
+    # @since 2.0.0
+    class PrimaryPreferred
+      include Selectable
+
+      # Get the name of the server mode type.
+      #
+      # @example Get the name of the server mode for this preference.
+      #   preference.name
+      #
+      # @return [ Symbol ] :primary_preferred
+      #
+      # @since 2.0.0
+      def name
+        :primary_preferred
+      end
+
+      # Whether the slaveOk bit should be set on wire protocol messages.
+      #   I.e. whether the operation can be performed on a secondary server.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def slave_ok?
+        true
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a mongos server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        preference = { :mode => 'primaryPreferred' }
+        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference
+      end
+
+      private
+
+      # Select servers taking into account any defined tag sets and
+      #   local threshold, with the primary preferred.
+      #
+      # @example Select servers given a list of candidates,
+      #   with the primary preferred.
+      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] A list of servers matching tag sets and acceptable
+      #   latency with the primary preferred.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        primary = primary(candidates)
+        primary.first ? primary : near_servers(secondaries(candidates))
+      end
+    end
+  end
+end