moped 1.5.3 → 2.0.0.beta

data/lib/moped/read_preference/secondary_preferred.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Moped
+  module ReadPreference
+
+    # Encapsulates behaviour around a secondary read preference.
+    #
+    # @since 2.0.0
+    class SecondaryPreferred
+      include Selectable
+
+      # Get the name for the read preference on the server side.
+      #
+      # @example Get the name of the read preference.
+      #   secondary_preferred.name
+      #
+      # @return [ Symbol ] :secondaryPreferred.
+      #
+      # @since 2.0.0
+      def name
+        :secondaryPreferred
+      end
+
+      # Select a secondary node from the cluster. If no secondary is available then
+      # use a primary. If no primary is found then an exception will be raised.
+      #
+      # @example Read a secondary or primary node from the cluster.
+      #   preference.with_node(cluster) do |node|
+      #     node.command(ismaster: 1)
+      #   end
+      #
+      # @note If tag sets are provided then secondary selection will need to
+      #   match the provided tags.
+      #
+      # @param [ Cluster ] cluster The cluster of nodes to select from.
+      #
+      # @raise [ Errors::ConnectionFailure ] If no secondary or primary node was
+      #   available in the cluster.
+      #
+      # @return [ Object ] The result of the block.
+      #
+      # @since 2.0.0
+      def with_node(cluster, &block)
+        with_retry(cluster) do
+          begin
+            cluster.with_secondary(&block)
+          rescue Errors::ConnectionFailure
+            cluster.with_primary(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moped/read_preference/selectable.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+module Moped
+  module ReadPreference
+
+    # Provides the shared behaviour for read preferences that can filter by a
+    # tag set or add query options.
+    #
+    # @since 2.0.0
+    module Selectable
+
+      # @!attribute tags
+      #   @return [ Array<Hash> ] The tag sets.
+      attr_reader :tags
+
+      # Instantiate the new taggable read preference.
+      #
+      # @example Instantiate the taggable.
+      #   Moped::ReadPreference::Secondary.new({ east_coast: 1 })
+      #
+      # @param [ Array<Hash> ] tags The tag sets.
+      #
+      # @since 2.0.0
+      def initialize(tags = nil)
+        @tags = tags
+      end
+
+      # Get the provided options as query options for this read preference.
+      #
+      # @example Get the query options.
+      #   preference.query_options({})
+      #
+      # @param [ Hash ] options The existing options for the query.
+      #
+      # @return [ Hash ] The options plus additional query options.
+      #
+      # @since 2.0.0
+      def query_options(options)
+        options[:flags] ||= []
+        options[:flags] |= [ :slave_ok ]
+        options
+      end
+
+      private
+
+      # Execute the provided block on the cluster and retry if the execution
+      # fails.
+      #
+      # @api private
+      #
+      # @example Execute with retry.
+      #   preference.with_retry(cluster) do
+      #     cluster.with_primary do |node|
+      #       node.refresh
+      #     end
+      #   end
+      #
+      # @param [ Cluster ] cluster The cluster.
+      # @param [ Integer ] retries The number of times to retry.
+      #
+      # @return [ Object ] The result of the block.
+      #
+      # @since 2.0.0
+      def with_retry(cluster, retries = cluster.max_retries, &block)
+        begin
+          block.call
+        rescue Errors::ConnectionFailure => e
+          if retries > 0
+            Loggable.warn("  MOPED:", "Retrying connection attempt #{retries} more time(s).", "n/a")
+            sleep(cluster.retry_interval)
+            cluster.refresh
+            with_retry(cluster, retries - 1, &block)
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moped/readable.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+module Moped
+
+  # Provides behaviour around readable objects.
+  #
+  # @since 2.0.0
+  module Readable
+
+    private
+
+    # Convenience method for getting the cluster from the session.
+    #
+    # @api private
+    #
+    # @example Get the cluster from the session.
+    #   database.cluster
+    #
+    # @return [ Cluster ] The cluster.
+    #
+    # @since 2.0.0
+    def cluster
+      session.cluster
+    end
+
+    # Convenience method for getting the read preference from the session.
+    #
+    # @api private
+    #
+    # @example Get the read preference.
+    #   database.read_preference
+    #
+    # @return [ Object ] The session's read preference.
+    #
+    # @since 2.0.0
+    def read_preference
+      session.read_preference
+    end
+
+    # Get the query options from the read preference.
+    #
+    # @api private
+    #
+    # @example Get the query options.
+    #   database.query_options
+    #
+    # @param [ Hash ] options The existing options on the query.
+    #
+    # @return [ Hash ] The new query options.
+    #
+    # @since 2.0.0
+    def query_options(options = {})
+      read_preference.query_options(options)
+    end
+  end
+end

data/lib/moped/session.rb

@@ -1,3 +1,11 @@
+# encoding: utf-8
+require "moped/read_preference"
+require "moped/readable"
+require "moped/write_concern"
+require "moped/collection"
+require "moped/cluster"
+require "moped/database"
+
 module Moped
 
   # A session in moped is root for all interactions with a MongoDB server or
@@ -8,31 +16,28 @@ module Moped
   #
   # @example Single database (console-style)
   #   session = Moped::Session.new(["127.0.0.1:27017"])
-  #   session.use :moped
-  #   session[:users].find.one # => { name: "John" }
+  #   session.use(:moped)
+  #   session[:users].find.one
   #
   # @example Multiple databases
   #   session = Moped::Session.new(["127.0.0.1:27017"])
-  #
   #   session.with(database: :admin) do |admin|
-  #     admin.command ismaster: 1
-  #   end
-  #
-  #   session.with(database: :moped) do |moped|
-  #     moped[:users].find.one # => { name: "John" }
+  #     admin.command(ismaster: 1)
   #   end
   #
   # @example Authentication
-  #
   #   session = Moped::Session.new %w[127.0.0.1:27017],
   #   session.with(database: "admin").login("admin", "s3cr3t")
   #
+  # @since 1.0.0
   class Session
+    include Optionable
 
-    # @attribute [r] cluster The session cluster.
-    # @attribute [r] context The session context.
-    # @attribute [r] options The session options.
-    attr_reader :cluster, :context, :options
+    # @!attribute cluster
+    #   @return [ Cluster ] The cluster of nodes.
+    # @!attribute options
+    #   @return [ Hash ] The configuration options.
+    attr_reader :cluster, :options
 
     # Return +collection+ from the current database.
     #
@@ -164,54 +169,91 @@ module Moped
       current_database.logout
     end
 
-    # Get the session's consistency.
+    # Setup validation of allowed write concern options.
+    #
+    # @since 2.0.0
+    option(:write).allow({ w: Optionable.any(Integer) }, { "w" => Optionable.any(Integer) })
+    option(:write).allow({ w: Optionable.any(String) }, { "w" => Optionable.any(String) })
+    option(:write).allow({ j: true }, { "j" => true })
+    option(:write).allow({ j: false }, { "j" => false })
+    option(:write).allow({ fsync: true }, { "fsync" => true })
+    option(:write).allow({ fsync: false }, { "fsync" => false })
+
+    # Setup validation of allowed read preference options.
+    #
+    # @since 2.0.0
+    option(:read).allow(
+      :nearest,
+      :primary,
+      :primary_preferred,
+      :secondary,
+      :secondary_preferred,
+      "nearest",
+      "primary",
+      "primary_preferred",
+      "secondary",
+      "secondary_preferred"
+    )
+
+    # Setup validation of allowed database options. (Any string or symbol)
     #
-    # @example Get the session consistency.
-    #   session.consistency
+    # @since 2.0.0
+    option(:database).allow(Optionable.any(String), Optionable.any(Symbol))
+
+    # Setup validation of allowed max retry options. (Any integer)
     #
-    # @return [ :strong, :eventual ] The session's consistency.
+    # @since 2.0.0
+    option(:max_retries).allow(Optionable.any(Integer))
+
+    # Setup validation of allowed pool size options. (Any integer)
     #
-    # @since 1.0.0
-    def consistency
-      options[:consistency]
-    end
+    # @since 2.0.0
+    option(:pool_size).allow(Optionable.any(Integer))
+
+    # Setup validation of allowed retry interval options. (Any numeric)
+    #
+    # @since 2.0.0
+    option(:retry_interval).allow(Optionable.any(Numeric))
+
+    # Setup validation of allowed reap interval options. (Any numeric)
+    #
+    # @since 2.0.0
+    option(:reap_interval).allow(Optionable.any(Numeric))
+
+    # Setup validation of allowed ssl options. (Any boolean)
+    #
+    # @since 2.0.0
+    option(:ssl).allow(true, false)
+
+    # Setup validation of allowed timeout options. (Any numeric)
+    #
+    # @since 2.0.0
+    option(:timeout).allow(Optionable.any(Numeric))
 
     # Initialize a new database session.
     #
     # @example Initialize a new session.
     #   Session.new([ "localhost:27017" ])
     #
-    # @param [ Array ] seeds an of host:port pairs
-    # @param [ Hash ] options
-    #
-    # @option options [ Boolean ] :safe (false) Ensure writes are persisted.
-    # @option options [ Hash ] :safe Ensure writes are persisted with the
-    #   specified safety level e.g., "fsync: true", or "w: 2, wtimeout: 5".
-    # @option options [ Symbol, String ] :database The database to use.
-    # @option options [ :strong, :eventual ] :consistency (:eventual).
-    # @option options [ Boolean ] :ssl Connect using SSL.
-    # @option options [ Integer ] :max_retries The maximum number of attempts
-    #   to retry an operation. (30)
-    # @option options [ Integer ] :retry_interval The time in seconds to retry
-    #   connections to a secondary or primary after a failure. (1)
-    # @option options [ Integer ] :timeout The time in seconds to wait for an
-    #   operation to timeout. (5)
+    # @param [ Array ] seeds An array of host:port pairs.
+    # @param [ Hash ] options The options for the session.
+    #
+    # @see Above options validations for allowed values in the options hash.
     #
     # @since 1.0.0
     def initialize(seeds, options = {})
-      @cluster = Cluster.new(seeds, options)
-      @context = Context.new(self)
+      validate_strict(options)
       @options = options
-      @options[:consistency] ||= :eventual
+      @cluster = Cluster.new(seeds, options)
     end
 
     # Create a new session with +options+ and use new socket connections.
     #
     # @example Change safe mode
-    #   session.with(safe: { w: 2 })[:people].insert(name: "Joe")
+    #   session.with(write: { w: 2 })[:people].insert(name: "Joe")
     #
     # @example Change safe mode with block
-    #   session.with(safe: { w: 2 }) do |session|
+    #   session.with(write: { w: 2 }) do |session|
     #     session[:people].insert(name: "Joe")
     #   end
     #
@@ -247,29 +289,17 @@ module Moped
       end
     end
 
-    # Is the session operating in safe mode?
-    #
-    # @example Is the session operating in safe mode?
-    #   session.safe?
-    #
-    # @return [ true, false ] Whether the current session requires safe
-    #   operations.
-    #
-    # @since 1.0.0
-    def safe?
-      !!safety
-    end
-
-    # Get the safety level for the session.
+    # Get the read preference for the session. Will default to primary if none
+    # was provided.
     #
-    # @example Get the safety level.
-    #   session.safety
+    # @example Get the session's read preference.
+    #   session.read_preference
     #
-    # @return [ Boolean, Hash ] The safety level for this session.
+    # @return [ Object ] The read preference.
     #
-    # @since 1.0.0
-    def safety
-      options[:safe].__safe_options__
+    # @since 2.0.0
+    def read_preference
+      @read_preference ||= ReadPreference.get(options[:read] || :primary)
     end
 
     # Switch the session's current database.
@@ -289,10 +319,10 @@ module Moped
     # Create a new session with +options+ reusing existing connections.
     #
     # @example Change safe mode
-    #   session.with(safe: { w: 2 })[:people].insert(name: "Joe")
+    #   session.with(write: { w: 2 })[:people].insert(name: "Joe")
     #
     # @example Change safe mode with block
-    #   session.with(safe: { w: 2 }) do |session|
+    #   session.with(write: { w: 2 }) do |session|
     #     session[:people].insert(name: "Joe")
     #   end
     #
@@ -327,6 +357,19 @@ module Moped
       end
     end
 
+    # Get the write concern for the session. Will default to propagate if none
+    # was provided.
+    #
+    # @example Get the session's write concern.
+    #   session.write_concern
+    #
+    # @return [ Object ] The write concern.
+    #
+    # @since 2.0.0
+    def write_concern
+      @write_concern ||= WriteConcern.get(options[:write] || { w: 1 })
+    end
+
     class << self
 
       # Create a new session from a URI.
@@ -340,7 +383,7 @@ module Moped
       #
       # @since 3.0.0
       def connect(uri)
-        uri = MongoUri.new(uri)
+        uri = Uri.new(uri)
         session = new(*uri.moped_arguments)
         session.login(uri.username, uri.password) if uri.auth_provided?
         session
@@ -349,8 +392,18 @@ module Moped
 
     private
 
+    # Get the database that the session is currently using.
+    #
+    # @api private
+    #
+    # @example Get the current database.
+    #   session.current_database
+    #
+    # @return [ Database ] The current database or nil.
+    #
+    # @since 2.0.0
     def current_database
-      return @current_database if defined?(@current_database)
+      return @current_database if @current_database
       if database = options[:database]
         set_current_database(database)
       else
@@ -359,15 +412,14 @@ module Moped
     end
 
     def current_database_name
-      defined?(@current_database) ? current_database.name : :none
+      @current_database ? current_database.name : :none
     end
 
     def initialize_copy(_)
-      @context = Context.new(self)
       @options = @options.dup
-      if defined?(@current_database)
-        remove_instance_variable(:@current_database)
-      end
+      @read_preference = nil
+      @write_concern = nil
+      @current_database = nil
     end
 
     def set_current_database(database)