mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/protocol/reply.rb

@@ -0,0 +1,72 @@
+# 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 Protocol
+
+    # The MongoDB wire protocol message representing a reply
+    #
+    # @example
+    #   socket = TCPSocket.new('localhost', 27017)
+    #   query = Protocol::Query.new('xgen', 'users', {:name => 'Tyler'})
+    #   socket.write(query)
+    #   reply = Protocol::Reply::deserialize(socket)
+    #
+    # @api semipublic
+    class Reply < Message
+
+      private
+
+      # The operation code required to specify a Reply message.
+      # @return [Fixnum] the operation code.
+      def op_code
+        1
+      end
+
+      # Available flags for a Reply message.
+      FLAGS = [
+        :cursor_not_found,
+        :query_failure,
+        :shard_config_stale,
+        :await_capable
+      ]
+
+      public
+
+      # @!attribute
+      # @return [Array<Symbol>] The flags for this reply.
+      #
+      #   Supported flags: +:cursor_not_found+, +:query_failure+,
+      #   +:shard_config_stale+, +:await_capable+
+      field :flags, BitVector.new(FLAGS)
+
+      # @!attribute
+      # @return [Fixnum] The cursor id for this response. Will be zero
+      #   if there are no additional results.
+      field :cursor_id, Int64
+
+      # @!attribute
+      # @return [Fixnum] The starting position of the cursor for this Reply.
+      field :starting_from, Int32
+
+      # @!attribute
+      # @return [Fixnum] Number of documents in this Reply.
+      field :number_returned, Int32
+
+      # @!attribute
+      # @return [Array<Hash>] The documents in this Reply.
+      field :documents, Document, :@number_returned
+    end
+  end
+end

data/lib/mongo/protocol/serializers.rb

@@ -0,0 +1,180 @@
+# 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 Protocol
+
+    # Container for various serialization strategies
+    #
+    # Each strategy must have a serialization method named +serailize+
+    # and a deserialization method named +deserialize+
+    #
+    # Serialize methods must take buffer and value arguements and
+    # serialize the value into the buffer
+    #
+    # Deserialize methods must take an IO stream argument and
+    # deserialize the value from the stream of bytes
+    #
+    # @api private
+    module Serializers
+
+      private
+
+      ZERO = 0.freeze
+      NULL = 0.chr.freeze
+      INT32_PACK = 'l<'.freeze
+      INT64_PACK = 'q<'.freeze
+      HEADER_PACK = 'l<l<l<l<'.freeze
+
+      # MongoDB wire protocol serialization strategy for message headers.
+      #
+      # Serializes and de-serializes four 32-bit integers consisting
+      # of the length of the message, the request id, the response id,
+      # and the op code for the operation.
+      module Header
+
+        # Serializes the header value into the buffer
+        #
+        # @param buffer [String] Buffer to receive the serialized value.
+        # @param value [String] Header value to be serialized.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value)
+          buffer << value.pack(HEADER_PACK)
+        end
+
+        # Deserializes the header value from the IO stream
+        #
+        # @param io [IO] IO stream containing the message header.
+        # @return [Array<Fixnum>] Array consisting of the deserialized
+        #   length, request id, response id, and op code.
+        def self.deserialize(io)
+          io.read(16).unpack(HEADER_PACK)
+        end
+      end
+
+      # MongoDB wire protocol serialization strategy for C style strings.
+      #
+      # Serializes and de-serializes C style strings (null terminated).
+      module CString
+
+        # Serializes a C style string into the buffer
+        #
+        # @param buffer [String] Buffer to receive the serialized CString.
+        # @param value [String] The string to be serialized.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value)
+          buffer << value
+          buffer << NULL
+        end
+      end
+
+      # MongoDB wire protocol serialization strategy for 32-bit Zero.
+      #
+      # Serializes and de-serializes one 32-bit Zero.
+      module Zero
+
+        # Serializes a 32-bit Zero into the buffer
+        #
+        # @param buffer [String] Buffer to receive the serialized Zero.
+        # @param value [Fixnum] Ignored value.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value)
+          buffer << [ZERO].pack(INT32_PACK)
+        end
+      end
+
+      # MongoDB wire protocol serialization strategy for 32-bit integers.
+      #
+      # Serializes and de-serializes one 32-bit integer.
+      module Int32
+
+        # Serializes a fixnum to a 4-byte 32-bit integer
+        #
+        # @param buffer [String] Buffer to receive the serialized Int32.
+        # @param value [Fixnum] 32-bit integer to be serialized.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value)
+          buffer << [value].pack(INT32_PACK)
+        end
+
+        # Deserializes a 32-bit Fixnum from the IO stream
+        #
+        # @param io [IO] IO stream containing the 32-bit integer
+        # @return [Fixnum] Deserialized Int32
+        def self.deserialize(io)
+          io.read(4).unpack(INT32_PACK).first
+        end
+      end
+
+      # MongoDB wire protocol serialization strategy for 64-bit integers.
+      #
+      # Serializes and de-serializes one 64-bit integer.
+      module Int64
+
+        # Serializes a fixnum to an 8-byte 64-bit integer
+        #
+        # @param buffer [String] Buffer to receive the serialized Int64.
+        # @param value [Fixnum] 64-bit integer to be serialized.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value)
+          buffer << [value].pack(INT64_PACK)
+        end
+
+        # Deserializes a 64-bit Fixnum from the IO stream
+        #
+        # @param io [IO] IO stream containing the 64-bit integer.
+        # @return [Fixnum] Deserialized Int64.
+        def self.deserialize(io)
+          io.read(8).unpack(INT64_PACK).first
+        end
+      end
+
+      # MongoDB wire protocol serialization strategy for a BSON Document.
+      #
+      # Serializes and de-serializes a single document.
+      module Document
+
+        # Serializes a document into the buffer
+        #
+        # @param buffer [String] Buffer to receive the BSON encoded document.
+        # @param value [Hash] Document to serialize as BSON.
+        # @return [String] Buffer with serialized value.
+        def self.serialize(buffer, value, max_bson_size = nil)
+          start_size = buffer.size
+          value.to_bson(buffer)
+          if max_bson_size && buffer.size - start_size > max_bson_size
+            raise Error::MaxBSONSize.new(max_bson_size)
+          end
+        end
+
+        # Deserializes a document from the IO stream
+        #
+        # @param io [IO] IO stream containing the BSON encoded document.
+        # @return [Hash] The decoded BSON document.
+        def self.deserialize(io)
+          BSON::Document.from_bson(io)
+        end
+
+        # Whether there can be a size limit on this type after serialization.
+        #
+        # @return [ true ] Documents can be size limited upon serialization.
+        #
+        # @since 2.0.0
+        def self.size_limited?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mongo/protocol/update.rb

@@ -0,0 +1,111 @@
+# 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 Protocol
+
+    # MongoDB Wire protocol Update message.
+    #
+    # This is a client request message that is sent to the server in order
+    # to update documents matching the provided query.
+    #
+    # The default is to update a single document. In order to update many at
+    # a time users should set the +:multi_update+ flag for the update.
+    #
+    # If an upsert (update or insert) is desired, users can set the +:upsert+
+    # flag in order to indicate they would like to insert the merged selector
+    # and update if no document matching the update query currently exists.
+    #
+    # @api semipublic
+    class Update < Message
+
+      # Creates a new Update message
+      #
+      # @example Update single document
+      #   Update.new('xgen', 'users', {:name => 'Tyler'}, {:name => 'Bob'})
+      #
+      # @example Perform a multi update
+      #   Update.new('xgen', 'users',
+      #     {:age => 20}, {:age => 21}, :flags => [:multi_update])
+      #
+      # @example Perform an upsert
+      #   Update.new('xgen', 'users', {:name => 'Tyler'}, :flags => [:upsert])
+      #
+      # @param database [String, Symbol]  The database to update.
+      # @param collection [String, Symbol] The collection to update.
+      # @param selector [Hash] The update selector.
+      # @param update [Hash] The update to perform.
+      # @param options [Hash] The additional query options.
+      #
+      # @option options :flags [Array] The flags for the update message.
+      #
+      #   Supported flags: +:upsert+, +:multi_update+
+      def initialize(database, collection, selector, update, options = {})
+        @namespace   = "#{database}.#{collection}"
+        @selector    = selector
+        @update      = update
+        @flags       = options[:flags] || []
+      end
+
+      # The log message for an update operation.
+      #
+      # @example Get the log message.
+      #   update.log_message
+      #
+      # @return [ String ] The log message
+      #
+      # @since 2.0.0
+      def log_message
+        fields = []
+        fields << ["%s |", "UPDATE"]
+        fields << ["namespace=%s", namespace]
+        fields << ["selector=%s", selector.inspect]
+        fields << ["udpdate=%s", update.inspect]
+        fields << ["flags=%s", flags.inspect]
+        f, v = fields.transpose
+        f.join(" ") % v
+      end
+
+      private
+
+      # The operation code required to specify an Update message.
+      # @return [Fixnum] the operation code.
+      def op_code
+        2001
+      end
+
+      # Available flags for an Update message.
+      FLAGS = [:upsert, :multi_update]
+
+      # Field representing Zero encoded as an Int32.
+      field :zero, Zero
+
+      # @!attribute
+      # @return [String] The namespace for this Update message.
+      field :namespace, CString
+
+      # @!attribute
+      # @return [Array<Symbol>] The flags for this Update message.
+      field :flags, BitVector.new(FLAGS)
+
+      # @!attribute
+      # @return [Hash] The selector for this Update message.
+      field :selector, Document
+
+      # @!attribute
+      # @return [Hash] The update for this Delete message.
+      field :update, Document
+    end
+  end
+end

data/lib/mongo/server.rb

@@ -0,0 +1,163 @@
+# 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/connectable'
+require 'mongo/server/connection'
+require 'mongo/server/connection_pool'
+require 'mongo/server/context'
+require 'mongo/server/description'
+require 'mongo/server/monitor'
+
+module Mongo
+
+  # Represents a single server on the server side that can be standalone, part of
+  # a replica set, or a mongos.
+  #
+  # @since 2.0.0
+  class Server
+    extend Forwardable
+
+    # @return [ String ] The configured address for the server.
+    attr_reader :address
+
+    # @return [ Monitor ] monitor The server monitor.
+    attr_reader :monitor
+
+    # @return [ Hash ] The options hash.
+    attr_reader :options
+
+    # Get the description from the monitor and scan on monitor.
+    def_delegators :monitor, :description, :scan!
+
+    # Delegate convenience methods to the monitor description.
+    def_delegators :description,
+                   :arbiter?,
+                   :features,
+                   :ghost?,
+                   :max_wire_version,
+                   :max_write_batch_size,
+                   :max_bson_object_size,
+                   :max_message_size,
+                   :tags,
+                   :average_round_trip_time,
+                   :mongos?,
+                   :other?,
+                   :primary?,
+                   :replica_set_name,
+                   :secondary?,
+                   :standalone?,
+                   :unknown?
+
+    # Is this server equal to another?
+    #
+    # @example Is the server equal to the other?
+    #   server == other
+    #
+    # @param [ Object ] other The object to compare to.
+    #
+    # @return [ true, false ] If the servers are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Server)
+      address == other.address
+    end
+
+    # Get a new context for this server in which to send messages.
+    #
+    # @example Get the server context.
+    #   server.context
+    #
+    # @return [ Mongo::Server::Context ] The server context.
+    #
+    # @since 2.0.0
+    def context
+      Context.new(self)
+    end
+
+    # Disconnect the server from the connection.
+    #
+    # @example Disconnect the server.
+    #   server.disconnect!
+    #
+    # @return [ true ] Always tru with no exception.
+    #
+    # @since 2.0.0
+    def disconnect!
+      context.with_connection do |connection|
+        connection.disconnect!
+      end
+      monitor.stop! and true
+    end
+
+    # Instantiate a new server object. Will start the background refresh and
+    # subscribe to the appropriate events.
+    #
+    # @example Initialize the server.
+    #   Mongo::Server.new('127.0.0.1:27017', listeners)
+    #
+    # @param [ Address ] address The host:port address to connect to.
+    # @param [ Event::Listeners ] event_listeners The event listeners.
+    # @param [ Hash ] options The server options.
+    #
+    # @since 2.0.0
+    def initialize(address, event_listeners, options = {})
+      @address = address
+      @options = options.freeze
+      @monitor = Monitor.new(address, event_listeners, options)
+      monitor.scan!
+      monitor.run!
+    end
+
+    # Get a pretty printed server inspection.
+    #
+    # @example Get the server inspection.
+    #   server.inspec
+    #
+    # @return [ String ] The nice inspection string.
+    #
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port}>"
+    end
+
+    # Get the connection pool for this server.
+    #
+    # @example Get the connection pool for the server.
+    #   server.pool
+    #
+    # @return [ Mongo::Pool ] The connection pool.
+    #
+    # @since 2.0.0
+    def pool
+      @pool ||= ConnectionPool.get(self)
+    end
+
+    # Determine if the provided tags are a subset of the server's tags.
+    #
+    # @example Are the provided tags a subset of the server's tags.
+    #   server.matches_tag_set?({ 'rack' => 'a', 'dc' => 'nyc' })
+    #
+    # @param [ Hash ] The tag set to compare to the server's tags.
+    #
+    # @return [ true, false ] If the provided tags are a subset of the server's tags.
+    #
+    # @since 2.0.0
+    def matches_tag_set?(tag_set)
+      tag_set.keys.all? do |k|
+        tags[k] && tags[k] == tag_set[k]
+      end
+    end
+  end
+end