moped 1.5.3 → 2.0.0.beta

data/lib/moped/connection/queue.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+module Moped
+  class Connection
+
+    # This class contains behaviour of a queue of unpinned connections.
+    #
+    # @since 2.0.0
+    class Queue
+
+      # Initialize a queue with the provided size.
+      #
+      # @example Instantiate the queue.
+      #   Moped::Connection::Queue.new(10)
+      #
+      # @param [ Integer ] size The number of connections in the queue.
+      #
+      # @since 2.0.0
+      def initialize(size)
+        @queue = Array.new(size) { yield }
+        @mutex = Mutex.new
+        @resource = ConditionVariable.new
+      end
+
+      # Push a connection on the queue.
+      #
+      # @example Push a connection on the queue.
+      #   queue.push(connection)
+      #
+      # @param [ Moped::Connection ] connection The connection to add.
+      #
+      # @since 2.0.0
+      def push(connection)
+        mutex.synchronize do
+          queue.push(connection)
+          resource.broadcast
+        end
+      end
+
+      # Pop the next connection off the queue.
+      #
+      # @example Pop a connection off the queue.
+      #   queue.pop(0.5)
+      #
+      # @param [ Float ] timeout The time to wait for the connection.
+      #
+      # @return [ Moped::Connection ] The next connection.
+      #
+      # @since 2.0.0
+      def pop(timeout = 0.5)
+        mutex.synchronize do
+          wait_for_next(Time.now + timeout)
+        end
+      end
+
+      # Is the queue empty?
+      #
+      # @example Is the queue empty?
+      #   queue.empty?
+      #
+      # @return [ true, false ] Is the queue empty?
+      #
+      # @since 2.0.0
+      def empty?
+        queue.empty?
+      end
+
+      # Get the current size of the queue.
+      #
+      # @example Get the size of the queue.
+      #   queue.size
+      #
+      # @return [ Integer ] The number of connections in the queue.
+      #
+      # @since 2.0.0
+      def size
+        queue.size
+      end
+
+      private
+
+      attr_reader :queue, :mutex, :resource
+
+      def wait_for_next(deadline)
+        loop do
+          return queue.pop unless queue.empty?
+          wait = deadline - Time.now
+          raise Timeout::Error, "Waited for item but none was pushed." if wait <= 0
+          resource.wait(mutex, wait)
+        end
+      end
+    end
+  end
+end

data/lib/moped/connection/reaper.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+module Moped
+  class Connection
+
+    # This object cleans up connections on dead threads at a specified time
+    # interval.
+    #
+    # @since 2.0.0
+    class Reaper
+
+      # The default interval for reaping connections.
+      #
+      # @since 2.0.0
+      INTERVAL = 5
+
+      # @!attribute interval
+      #   @return [ Float ] The reaping interval, in seconds.
+      # @!attribute pool
+      #   @return [ Pool ] The connection pool to reap.
+      attr_reader :interval, :pool
+
+      # Initialize a new connection pool reaper.
+      #
+      # @example Initialize the reaper.
+      #   Moped::Connection::Reaper.new(5, pool)
+      #
+      # @param [ Float ] interval The reaping interval.
+      # @param [ Pool ] pool The connection pool to reap.
+      #
+      # @since 2.0.0
+      def initialize(interval, pool)
+        @interval = interval
+        @pool = pool
+      end
+
+      # Start the reaper. Will execute continually on a separate thread.
+      #
+      # @example Start the reaper.
+      #   reaper.start
+      #
+      # @since 2.0.0
+      def start
+        Thread.new(interval, pool) do |i, p|
+          while (true)
+            sleep(i)
+            p.reap
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moped/connection/socket.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require "moped/connection/socket/connectable"
+require "moped/connection/socket/tcp"
+require "moped/connection/socket/ssl"

data/lib/moped/connection/socket/connectable.rb

@@ -0,0 +1,169 @@
+module Moped
+  class Connection
+    module Socket
+      module Connectable
+
+        attr_reader :host, :port
+
+        # Is the socket connection alive?
+        #
+        # @example Is the socket alive?
+        #   socket.alive?
+        #
+        # @return [ true, false ] If the socket is alive.
+        #
+        # @since 1.0.0
+        def alive?
+          if Kernel::select([ self ], nil, [ self ], 0)
+            !eof? rescue false
+          else
+            true
+          end
+        rescue IOError
+          false
+        end
+
+        # Bring in the class methods when included.
+        #
+        # @example Extend the class methods.
+        #   Connectable.included(class)
+        #
+        # @param [ Class ] klass The class including the module.
+        #
+        # @since 1.3.0
+        def self.included(klass)
+          klass.send(:extend, ClassMethods)
+        end
+
+        # Read from the TCP socket.
+        #
+        # @param [ Integer ] length The length to read.
+        #
+        # @return [ Object ] The data.
+        #
+        # @since 1.2.0
+        def read(length)
+          check_if_alive!
+          handle_socket_errors { super }
+        end
+
+        # Write to the socket.
+        #
+        # @example Write to the socket.
+        #   socket.write(data)
+        #
+        # @param [ Object ] args The data to write.
+        #
+        # @return [ Integer ] The number of bytes written.
+        #
+        # @since 1.0.0
+        def write(*args)
+          check_if_alive!
+          handle_socket_errors { super }
+        end
+
+        private
+
+        # Before performing a read or write operating, ping the server to check
+        # if it is alive.
+        #
+        # @api private
+        #
+        # @example Check if the connection is alive.
+        #   connectable.check_if_alive!
+        #
+        # @raise [ ConnectionFailure ] If the connectable is not alive.
+        #
+        # @since 1.4.0
+        def check_if_alive!
+          unless alive?
+            raise Errors::ConnectionFailure, "Socket connection was closed by remote host"
+          end
+        end
+
+        # Generate the message for the connection failure based of the system
+        # call error, with some added information.
+        #
+        # @api private
+        #
+        # @example Generate the error message.
+        #   connectable.generate_message(error)
+        #
+        # @param [ SystemCallError ] error The error.
+        #
+        # @return [ String ] The error message.
+        #
+        # @since 1.4.0
+        def generate_message(error)
+          "#{host}:#{port}: #{error.class.name} (#{error.errno}): #{error.message}"
+        end
+
+        # Handle the potential socket errors that can occur.
+        #
+        # @api private
+        #
+        # @example Handle the socket errors while executing the block.
+        #   handle_socket_errors do
+        #     socket.read(128)
+        #   end
+        #
+        # @raise [ Moped::Errors::ConnectionFailure ] If a system call error or
+        #   IOError occured which can be retried.
+        # @raise [ Moped::Errors::Unrecoverable ] If a system call error occured
+        #   which cannot be retried and should be re-raised.
+        #
+        # @return [ Object ] The result of the yield.
+        #
+        # @since 1.0.0
+        def handle_socket_errors
+          yield
+        rescue Errno::ECONNREFUSED => e
+          raise Errors::ConnectionFailure, generate_message(e)
+        rescue Errno::EHOSTUNREACH => e
+          raise Errors::ConnectionFailure, generate_message(e)
+        rescue Errno::EPIPE => e
+          raise Errors::ConnectionFailure, generate_message(e)
+        rescue Errno::ECONNRESET => e
+          raise Errors::ConnectionFailure, generate_message(e)
+        rescue Errno::ETIMEDOUT => e
+          raise Errors::ConnectionFailure, generate_message(e)
+        rescue IOError
+          raise Errors::ConnectionFailure, "Connection timed out to Mongo on #{host}:#{port}"
+        rescue OpenSSL::SSL::SSLError => e
+          raise Errors::ConnectionFailure, "SSL Error '#{e.to_s}' for connection to Mongo on #{host}:#{port}"
+        end
+
+        module ClassMethods
+
+          # Connect to the tcp server.
+          #
+          # @example Connect to the server.
+          #   TCPSocket.connect("127.0.0.1", 27017, 30)
+          #
+          # @param [ String ] host The host to connect to.
+          # @param [ Integer ] post The server port.
+          # @param [ Integer ] timeout The connection timeout.
+          #
+          # @return [ TCPSocket ] The socket.
+          #
+          # @since 1.0.0
+          def connect(host, port, timeout)
+            begin
+              Timeout::timeout(timeout) do
+                sock = new(host, port)
+                sock.set_encoding('binary')
+                timeout_val = [ timeout, 0 ].pack("l_2")
+                sock.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
+                sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_RCVTIMEO, timeout_val)
+                sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_SNDTIMEO, timeout_val)
+                sock
+              end
+            rescue Timeout::Error
+              raise Errors::ConnectionFailure, "Timed out connection to Mongo on #{host}:#{port}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moped/connection/socket/ssl.rb

@@ -0,0 +1,52 @@
+require "openssl"
+
+module Moped
+  class Connection
+    module Socket
+
+      # This is a wrapper around a tcp socket.
+      class SSL < OpenSSL::SSL::SSLSocket
+        include Connectable
+
+        attr_reader :socket
+
+        # Initialize the new TCPSocket with SSL.
+        #
+        # @example Initialize the socket.
+        #   SSL.new("127.0.0.1", 27017)
+        #
+        # @param [ String ] host The host.
+        # @param [ Integer ] port The port.
+        #
+        # @since 1.2.0
+        def initialize(host, port)
+          @host, @port = host, port
+          handle_socket_errors do
+            @socket = TCPSocket.new(host, port)
+            super(socket)
+            self.sync_close = true
+            connect
+          end
+        end
+
+        # Set the encoding of the underlying socket.
+        #
+        # @param [ String ] string The encoding.
+        #
+        # @since 1.3.0
+        def set_encoding(string)
+          socket.set_encoding(string)
+        end
+
+        # Set a socket option on the underlying socket.
+        #
+        # @param [ Array<Object> ] args The option arguments.
+        #
+        # @since 1.3.0
+        def setsockopt(*args)
+          socket.setsockopt(*args)
+        end
+      end
+    end
+  end
+end

data/lib/moped/connection/socket/tcp.rb

@@ -0,0 +1,25 @@
+module Moped
+  class Connection
+    module Socket
+
+      # This is a wrapper around a tcp socket.
+      class TCP < ::TCPSocket
+        include Connectable
+
+        # Initialize the new TCPSocket.
+        #
+        # @example Initialize the socket.
+        #   TCPSocket.new("127.0.0.1", 27017)
+        #
+        # @param [ String ] host The host.
+        # @param [ Integer ] port The port.
+        #
+        # @since 1.2.0
+        def initialize(host, port)
+          @host, @port = host, port
+          handle_socket_errors { super }
+        end
+      end
+    end
+  end
+end

data/lib/moped/connection/sockets.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require "moped/connection/socket/connectable"
+require "moped/connection/socket/tcp"
+require "moped/connection/socket/ssl"

data/lib/moped/cursor.rb

@@ -4,6 +4,7 @@ module Moped
   #
   # @api private
   class Cursor
+    include Readable
 
     # @attribute [r] get_more_op The get more message.
     # @attribute [r] kill_cursor_op The kill cursor message.
@@ -127,15 +128,12 @@ module Moped
     #
     # @since 1.0.0
     def load_docs
-      consistency = session.consistency
-      @options[:flags] |= [:slave_ok] if consistency == :eventual
       @options[:flags] |= [:no_cursor_timeout] if @options[:no_timeout]
-
       options = @options.clone
       options[:limit] = request_limit
 
-      reply, @node = session.context.with_node do |node|
-        [ node.query(@database, @collection, @selector, options), node ]
+      reply, @node = read_preference.with_node(session.cluster) do |node|
+        [ node.query(@database, @collection, @selector, query_options(options)), node ]
       end
 
       @limit -= reply.count if limited?

data/lib/moped/database.rb

@@ -1,21 +1,17 @@
+# encoding: utf-8
 module Moped
 
   # The class for interacting with a MongoDB database. One only interacts with
   # this class indirectly through a session.
   #
-  # @example
-  #   session.use :moped
-  #   session.drop
-  #   session[:users].insert(name: "John")
-  #
-  # @example
-  #   session.with(database: :moped) do |moped|
-  #     moped[:users].drop
-  #   end
+  # @since 1.0.0
   class Database
+    include Readable
 
-    # @attribute [r] name The name of the database.
-    # @attribute [r] session The session.
+    # @!attribute name
+    #   @return [ String ] The name of the database.
+    # @!attribute session
+    #   @return [ Session ] The database session.
     attr_reader :name, :session
 
     # Get a collection by the provided name.
@@ -41,7 +37,7 @@ module Moped
     #
     # @since 1.0.0
     def collections
-      collection_names.map{|name| Collection.new(self, name)}
+      collection_names.map{ |name| Collection.new(self, name) }
     end
 
     # Get all non-system collection names from the database, this excludes
@@ -54,7 +50,7 @@ module Moped
     #
     # @since 1.0.0
     def collection_names
-      namespaces = Collection.new(self, "system.namespaces").find(name: { "$not" => /#{name}\.system\.|\$/ })
+      namespaces = self["system.namespaces"].find(name: { "$not" => /#{name}\.system\.|\$/ })
       namespaces.map do |doc|
         _name = doc["name"]
         _name[name.length + 1, _name.length]
@@ -73,7 +69,9 @@ module Moped
     #
     # @since 1.0.0
     def command(command)
-      session.context.command(name.to_s, command)
+      read_preference.with_node(cluster) do |node|
+        node.command(name, command, query_options({}))
+      end
     end
 
     # Drop the database.
@@ -85,8 +83,8 @@ module Moped
     #
     # @since 1.0.0
     def drop
-      session.with(consistency: :strong) do |session|
-        session.context.command(name, dropDatabase: 1)
+      session.with(read: :primary) do |session|
+        session.command(dropDatabase: 1)
       end
     end
 
@@ -100,12 +98,8 @@ module Moped
     #
     # @since 1.0.0
     def initialize(session, name)
-      if match = name.match(/\.|\s|\$|\\|\/|\x00/)
-        raise Errors::InvalidDatabaseName.new(
-          "Database names may not contain the character '#{match[0]}'."
-        )
-      end
-      @session, @name = session, name
+      @session = session
+      @name = name.to_s
     end
 
     # Log in with +username+ and +password+ on the current database.
@@ -118,7 +112,7 @@ module Moped
     #
     # @since 1.0.0
     def login(username, password)
-      session.context.login(name, username, password)
+      cluster.credentials[name] = [ username, password ]
     end
 
     # Log out from the current database.
@@ -128,7 +122,7 @@ module Moped
     #
     # @since 1.0.0
     def logout
-      session.context.logout(name)
+      cluster.credentials.delete(name)
     end
   end
 end