mongo 1.12.5 → 2.0.0

data/lib/mongo/error/invalid_signature.rb

@@ -0,0 +1,47 @@
+# 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 Error
+
+    # This exception is raised when the server verifier does not match the
+    # expected signature on the client.
+    #
+    # @since 2.0.0
+    class InvalidSignature < Error
+
+      # @return [ String ] verifier The server verifier string.
+      attr_reader :verifier
+
+      # @return [ String ] server_signature The expected server signature.
+      attr_reader :server_signature
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   InvalidSignature.new(verifier, server_signature)
+      #
+      # @param [ String ] verifier The verifier returned from the server.
+      # @param [ String ] server_signature The expected value from the
+      #   server.
+      #
+      # @since 2.0.0
+      def initialize(verifier, server_signature)
+        @verifier = verifier
+        @server_signature = server_signature
+        super("Expected server verifier '#{verifier}' to match '#{server_signature}'.")
+      end
+    end
+  end
+end

data/{test/functional/ssl_test.rb → lib/mongo/error/invalid_update_document.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,18 +12,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'test_helper'
-require 'shared/ssl_shared'
+module Mongo
+  class Error
 
-class SSLTest < Test::Unit::TestCase
-  include Mongo
-  include SSLTests
+    # Exception raised if the object is not a valid update document.
+    #
+    # @since 2.0.0
+    class InvalidUpdateDocument < Error
 
-  def setup
-    @client_class     = MongoClient
-    @uri_info         = 'server'
-    @connect_info     = ['server', 27017]
-    @bad_connect_info = ['localhost', 27017]
-  end
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid update document provided'.freeze
 
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidUpdateDocument.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
 end

data/lib/mongo/error/max_bson_size.rb

@@ -0,0 +1,40 @@
+# 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 serialize a document that
+    # exceeds max BSON object size.
+    #
+    # @since 2.0.0
+    class MaxBSONSize < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = "Document exceeds allowed max BSON size.".freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::MaxBSONSize.new(max)
+      #
+      # @since 2.0.0
+      def initialize(max_size = nil)
+        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/max_message_size.rb

@@ -0,0 +1,42 @@
+# 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 send a message that exceeds max
+    # message size.
+    #
+    # @since 2.0.0
+    class MaxMessageSize < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = "Message exceeds allowed max message size.".freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::MaxMessageSize.new(max)
+      #
+      # @param [ Integer ] max_size The maximum message size.
+      #
+      # @since 2.0.0
+      def initialize(max_size = nil)
+        super(max_size ?  MESSAGE + " The max is #{max_size}." : MESSAGE)
+      end
+    end
+  end
+end

data/{test/functional/db_connection_test.rb → lib/mongo/error/multi_index_drop.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,14 +12,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'test_helper'
+module Mongo
+  class Error
 
-class DBConnectionTest < Test::Unit::TestCase
+    # Exception raised if '*' is passed to drop_one on indexes.
+    #
+    # @since 2.0.0
+    class MultiIndexDrop < Error
 
-  def test_no_exceptions
-    db = standard_connection.db(TEST_DB)
-    coll = db.collection('test')
-    coll.remove
-    db.get_last_error
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::MultiIndexDrop.new
+      #
+      # @since 2.0.0
+      def initialize
+        super("Passing '*' to #drop_one would cause all indexes to be dropped. Please use #drop_all")
+      end
+    end
   end
 end

data/lib/mongo/{utils.rb → error/need_primary_server.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,8 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/utils/conversions'
-require 'mongo/utils/core_ext'
-require 'mongo/utils/server_version'
-require 'mongo/utils/support'
-require 'mongo/utils/thread_local_variable_manager'
+module Mongo
+  class Error
+
+    # Raised when a primary server is needed but not found.
+    #
+    # @since 2.0.0
+    class NeedPrimaryServer < Error; end
+  end
+end

data/lib/mongo/{connection.rb → error/operation_failure.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,8 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/connection/socket'
-require 'mongo/connection/node'
-require 'mongo/connection/pool'
-require 'mongo/connection/pool_manager'
-require 'mongo/connection/sharding_pool_manager'
+module Mongo
+  class Error
+
+    # Raised when a command failes for some reason.
+    #
+    # @since 2.0.0
+    class OperationFailure < Error; end
+  end
+end

data/lib/mongo/error/parser.rb

@@ -0,0 +1,77 @@
+# 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 Error
+
+    # Class for parsing the various forms that errors can come in from MongoDB
+    # command responses.
+    #
+    # @since 2.0.0
+    class Parser
+
+      # @return [ BSON::Document ] document The returned document.
+      attr_reader :document
+
+      # @return [ String ] message The error message parsed from the document.
+      attr_reader :message
+
+      # Create the new parser with the returned document.
+      #
+      # @example Create the new parser.
+      #   Parser.new({ 'errmsg' => 'failed' })
+      #
+      # @param [ BSON::Document ] document The returned document.
+      #
+      # @since 2.0.0
+      def initialize(document)
+        @document = document
+        parse!
+      end
+
+      private
+
+      def parse!
+        @message = ""
+        parse_single(@message, ERR)
+        parse_single(@message, ERROR)
+        parse_single(@message, ERRMSG)
+        parse_multiple(@message, WRITE_ERRORS)
+        parse_multiple(@message, WRITE_CONCERN_ERROR)
+      end
+
+      def parse_single(message, key, doc = document)
+        if error = doc[key]
+          append(message ,"#{error} (#{doc[CODE]})")
+        end
+      end
+
+      def parse_multiple(message, key)
+        if errors = document[key]
+          errors.each do |error|
+            parse_single(message, ERRMSG, error)
+          end
+        end
+      end
+
+      def append(message, error)
+        if message.length > 1
+          message.concat(", #{error}")
+        else
+          message.concat(error)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/{connection/socket.rb → error/socket_error.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# 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.
@@ -12,7 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/connection/socket/socket_util.rb'
-require 'mongo/connection/socket/ssl_socket.rb'
-require 'mongo/connection/socket/tcp_socket.rb'
-require 'mongo/connection/socket/unix_socket.rb'
+module Mongo
+  class Error
+
+    # Raised when a socket has an error.
+    #
+    # @since 2.0.0
+    class SocketError < Error; end
+  end
+end

data/lib/mongo/error/socket_timeout_error.rb

@@ -0,0 +1,23 @@
+# 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 Error
+
+    # Raised when a socket connection times out.
+    #
+    # @since 2.0.0
+    class SocketTimeoutError < Error; end
+  end
+end

data/lib/mongo/error/unsupported_features.rb

@@ -0,0 +1,43 @@
+# 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 the driver does not support the complete set of server
+    # features.
+    #
+    # @since 2.0.0
+    class UnsupportedFeatures < Error
+
+      # Initialize the exception.
+      #
+      # @example Initialize the exception.
+      #   Unsupported.new(0..3)
+      #
+      # @param [ Range ] server_wire_versions The server's supported wire
+      #   versions.
+      #
+      # @since 2.0.0
+      def initialize(server_wire_versions)
+        super(
+          "This version of the driver, #{Mongo::VERSION}, only supports wire " +
+          "protocol versions #{Server::Description::Features::DRIVER_WIRE_VERSIONS} " +
+          "and the server supports wire versions #{server_wire_versions}. " + 
+          "Please upgrade the driver to be able to support this server version."
+        )
+      end
+    end
+  end
+end

data/lib/mongo/error.rb

@@ -0,0 +1,82 @@
+# 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
+  # Base error class for all Mongo related errors.
+  #
+  # @since 2.0.0
+  class Error < StandardError
+
+    # The error code field.
+    #
+    # @since 2.0.0
+    CODE = 'code'.freeze
+
+    # An error field, MongoDB < 2.6
+    #
+    # @since 2.0.0
+    ERR = '$err'.freeze
+
+    # An error field, MongoDB < 2.4
+    #
+    # @since 2.0.0
+    ERROR = 'err'.freeze
+
+    # The standard error message field, MongoDB 3.0+
+    #
+    # @since 2.0.0
+    ERRMSG = 'errmsg'.freeze
+
+    # The constant for the writeErrors array.
+    #
+    # @since 2.0.0
+    WRITE_ERRORS = 'writeErrors'.freeze
+
+    # The constant for write concern errors.
+    #
+    # @since 2.0.0
+    WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
+
+    # Constant for an unknown error.
+    #
+    # @since 2.0.0
+    UNKNOWN_ERROR = 8.freeze
+
+    # Constant for a bad value error.
+    #
+    # @since 2.0.0
+    BAD_VALUE = 2.freeze
+  end
+end
+
+require 'mongo/error/parser'
+require 'mongo/error/bulk_write_error'
+require 'mongo/error/operation_failure'
+require 'mongo/error/invalid_bulk_operation'
+require 'mongo/error/invalid_bulk_operation_type'
+require 'mongo/error/invalid_collection_name'
+require 'mongo/error/invalid_database_name'
+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_signature'
+require 'mongo/error/invalid_update_document'
+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/socket_error'
+require 'mongo/error/socket_timeout_error'
+require 'mongo/error/unsupported_features'

data/lib/mongo/event/listeners.rb

@@ -0,0 +1,63 @@
+# 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
+  module Event
+
+    # The queue of events getting processed in the client.
+    #
+    # @since 2.0.0
+    class Listeners
+
+      # Initialize the event listeners.
+      #
+      # @example Initialize the event listeners.
+      #   Listeners.new
+      #
+      # @since 2.0.0
+      def initialize
+        @listeners = {}
+      end
+
+      # Add an event listener for the provided event.
+      #
+      # @example Add an event listener
+      #   publisher.add_listener("my_event", listener)
+      #
+      # @param [ String ] event The event to listen for.
+      # @param [ Object ] listener The event listener.
+      #
+      # @return [ Array<Object> ] The listeners for the event.
+      #
+      # @since 2.0.0
+      def add_listener(event, listener)
+        listeners_for(event).push(listener)
+      end
+
+      # Get the listeners for a specific event.
+      #
+      # @example Get the listeners.
+      #   publisher.listeners_for("test")
+      #
+      # @param [ String ] event The event name.
+      #
+      # @return [ Array<Object> ] The listeners.
+      #
+      # @since 2.0.0
+      def listeners_for(event)
+        @listeners[event] ||= []
+      end
+    end
+  end
+end

data/lib/mongo/event/primary_elected.rb

@@ -0,0 +1,53 @@
+# 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
+  module Event
+
+    # This handles primary elected events for server descriptions.
+    #
+    # @since 2.0.0
+    class PrimaryElected
+
+      # @return [ Mongo::Cluster ] cluster The event publisher.
+      attr_reader :cluster
+
+      # Initialize the new primary elected event handler.
+      #
+      # @example Create the new handler.
+      #   PrimaryElected.new(cluster)
+      #
+      # @param [ Mongo::Cluster ] cluster The cluster to publish from.
+      #
+      # @since 2.0.0
+      def initialize(cluster)
+        @cluster = cluster
+      end
+
+      # This event tells the cluster to take all previous primaries to an
+      # unknown state.
+      #
+      # @example Handle the event.
+      #   primary_elected.handle(description)
+      #
+      # @param [ Server::Description ] description The description of the
+      #   elected server.
+      #
+      # @since 2.0.0
+      def handle(description)
+        cluster.elect_primary!(description)
+      end
+    end
+  end
+end

data/lib/mongo/event/publisher.rb

@@ -0,0 +1,42 @@
+# 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 Event
+
+    # This module is included for objects that need to publish events.
+    #
+    # @since 2.0.0
+    module Publisher
+
+      # @return [ Event::Listeners ] event_listeners The listeners.
+      attr_reader :event_listeners
+
+      # Publish the provided event.
+      #
+      # @example Publish an event.
+      #   publisher.publish("my_event", "payload")
+      #
+      # @param [ String ] event The event to publish.
+      # @param [ Array<Object> ] args The objects to pass to the listeners.
+      #
+      # @since 2.0.0
+      def publish(event, *args)
+        event_listeners.listeners_for(event).each do |listener|
+          listener.handle(*args)
+        end
+      end
+    end
+  end
+end