mongo 2.5.3 → 2.6.0

data/lib/mongo/error/unchangeable_collection_option.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unexpected_chunk_length.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unexpected_response.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unknown_payload_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2017-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unsupported_array_filters.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unsupported_collation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unsupported_features.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/unsupported_message_type.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/error/write_retryable.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2018 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
+
+    # A module signifying the error is always write retryable.
+    #
+    # @since 2.6.0
+    module WriteRetryable
+      def write_retryable?
+        true
+      end
+    end
+  end
+end

data/lib/mongo/event.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 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,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/event/listeners'
-require 'mongo/event/publisher'
-require 'mongo/event/subscriber'
-require 'mongo/event/primary_elected'
-require 'mongo/event/member_discovered'
-require 'mongo/event/description_changed'
-require 'mongo/event/standalone_discovered'
-
 module Mongo
   module Event
 
@@ -46,3 +38,12 @@ module Mongo
     DESCRIPTION_CHANGED = 'description_changed'.freeze
   end
 end
+
+require 'mongo/event/base'
+require 'mongo/event/listeners'
+require 'mongo/event/publisher'
+require 'mongo/event/subscriber'
+require 'mongo/event/primary_elected'
+require 'mongo/event/member_discovered'
+require 'mongo/event/description_changed'
+require 'mongo/event/standalone_discovered'

data/lib/mongo/event/base.rb

@@ -0,0 +1,33 @@
+# Copyright (C) 2018 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
+
+    # Base class for all events.
+    #
+    # @since 2.6.0
+    class Base
+      # Returns a concise yet useful summary of the event.
+      # Meant to be overridden in derived classes.
+      #
+      # @return [ String ] String summary of the event.
+      #
+      # @since 2.6.0
+      def inspect
+        "#<#{self.class}>"
+      end
+    end
+  end
+end

data/lib/mongo/event/description_changed.rb

@@ -1,5 +1,5 @@
 
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
     # This handles a change in description.
     #
     # @since 2.0.6
-    class DescriptionChanged
+    class DescriptionChanged < Base
       include Monitoring::Publishable
 
       # @return [ Mongo::Cluster ] cluster The cluster.

data/lib/mongo/event/listeners.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/event/member_discovered.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 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,13 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/monitoring/publishable'
+
 module Mongo
   module Event
 
     # This handles member discovered events for server descriptions.
     #
     # @since 2.4.0
-    class MemberDiscovered
+    class MemberDiscovered < Base
       include Monitoring::Publishable
 
       # @return [ Mongo::Cluster ] cluster The cluster.

data/lib/mongo/event/primary_elected.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ module Mongo
     # @since 2.0.0
     #
     # @deprecated. Will be removed in 3.0
-    class PrimaryElected
+    class PrimaryElected < Base
 
       # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster

data/lib/mongo/event/publisher.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/event/standalone_discovered.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@ module Mongo
     # This handles when a standalone is discovered.
     #
     # @since 2.0.6
-    class StandaloneDiscovered
+    class StandaloneDiscovered < Base
 
       # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster

data/lib/mongo/event/subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/file.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/file/chunk.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -173,11 +173,11 @@ module Mongo
             io = StringIO.new(io) if io.is_a?(String)
             parts = Enumerator.new { |y| y << io.read(file_info.chunk_size) until io.eof? }
             parts.map.with_index do |bytes, n|
-              file_info.md5.update(bytes)
+              file_info.update_md5(bytes)
               Chunk.new(
                 data: BSON::Binary.new(bytes),
                 files_id: file_info.id,
-                n: n + offset,
+                n: n + offset
               )
             end
           end

data/lib/mongo/grid/file/info.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -134,8 +134,8 @@ module Mongo
         #
         # @since 2.0.0
         def initialize(document)
+          @client_md5 = Digest::MD5.new unless document[:disable_md5] == true
           @document = default_document.merge(Options::Mapper.transform(document, MAPPINGS))
-          @client_md5 = Digest::MD5.new
         end
 
         # Get a readable inspection for the object.
@@ -184,10 +184,31 @@ module Mongo
         # @return [ String ] The md5 hash as a string.
         #
         # @since 2.0.0
+        #
+        # @deprecated as of 2.6.0
         def md5
           document[:md5] || @client_md5
         end
 
+        # Update the md5 hash if there is one.
+        #
+        # @example Update the md5 hash.
+        #   file_info.update_md5(bytes)
+        #
+        # @note This method is transitional and is provided for backwards compatibility.
+        # It will be removed when md5 support is deprecated entirely.
+        #
+        # @param [ String ] The bytes to use to update the digest.
+        #
+        # @return [ Digest::MD5 ] The md5 hash object.
+        #
+        # @since 2.6.0
+        #
+        # @deprecated as of 2.6.0
+        def update_md5(bytes)
+          md5.update(bytes) if md5
+        end
+
         # Convert the file information document to BSON for storage.
         #
         # @note If no md5 exists in the file information document (it was loaded
@@ -203,7 +224,9 @@ module Mongo
         #
         # @since 2.0.0
         def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = BSON::Config.validating_keys?)
-          document[:md5] ||= @client_md5.hexdigest
+          if @client_md5 && !document[:md5]
+            document[:md5] = @client_md5.hexdigest
+          end
           document.to_bson(buffer)
         end
 

data/lib/mongo/grid/fs_bucket.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream/read.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream/write.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/index.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/index/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/loggable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/logger.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2017 MongoDB, Inc.
+# Copyright (C) 2015-2018 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,16 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/monitoring/event'
-require 'mongo/monitoring/publishable'
-require 'mongo/monitoring/command_log_subscriber'
-require 'mongo/monitoring/sdam_log_subscriber'
-require 'mongo/monitoring/server_description_changed_log_subscriber'
-require 'mongo/monitoring/server_closed_log_subscriber'
-require 'mongo/monitoring/server_opening_log_subscriber'
-require 'mongo/monitoring/topology_changed_log_subscriber'
-require 'mongo/monitoring/topology_opening_log_subscriber'
-
 module Mongo
 
   # The class defines behaviour for the performance monitoring API.
@@ -81,15 +71,22 @@ module Mongo
       end
     end
 
-    # Provides behaviour around global subscribers.
+    # Contains subscription methods common between monitoring and
+    # global event subscriptions.
     #
-    # @since 2.1.0
-    module Global
-      extend self
-
+    # @since 2.6.0
+    module Subscribable
       # Subscribe a listener to an event topic.
       #
+      # @note It is possible to subscribe the same listener to the same topic
+      # multiple times, in which case the listener will be invoked as many
+      # times as it is subscribed and to unsubscribe it the same number
+      # of unsubscribe calls will be needed.
+      #
       # @example Subscribe to the topic.
+      #   monitoring.subscribe(QUERY, subscriber)
+      #
+      # @example Subscribe to the topic globally.
       #   Monitoring::Global.subscribe(QUERY, subscriber)
       #
       # @param [ String ] topic The event topic.
@@ -100,10 +97,50 @@ module Mongo
         subscribers_for(topic).push(subscriber)
       end
 
-      # Get all the global subscribers.
+      # Unsubscribe a listener from an event topic.
+      #
+      # If the listener was subscribed to the event topic multiple times,
+      # this call removes a single subscription.
+      #
+      # If the listener was not subscribed to the topic, this operation
+      # is a no-op and no exceptions are raised.
+      #
+      # @note Global subscriber registry is separate from per-client
+      #   subscriber registry. The same subscriber can be subscribed to
+      #   events from a particular client as well as globally; unsubscribing
+      #   globally will not unsubscribe that subscriber from the client
+      #   it was explicitly subscribed to.
+      #
+      # @note Currently the list of global subscribers is copied into
+      #   a client whenever the client is created. Thus unsubscribing a
+      #   subscriber globally has no effect for existing clients - they will
+      #   continue sending events to the unsubscribed subscriber.
+      #
+      # @example Unsubscribe from the topic.
+      #   monitoring.unsubscribe(QUERY, subscriber)
+      #
+      # @example Unsubscribe from the topic globally.
+      #   Mongo::Monitoring::Global.unsubscribe(QUERY, subscriber)
+      #
+      # @param [ String ] topic The event topic.
+      # @param [ Object ] subscriber The subscriber to be unsubscribed.
+      #
+      # @since 2.6.0
+      def unsubscribe(topic, subscriber)
+        subs = subscribers_for(topic)
+        index = subs.index(subscriber)
+        if index
+          subs.delete_at(index)
+        end
+      end
+
+      # Get all the subscribers.
+      #
+      # @example Get all the subscribers.
+      #   monitoring.subscribers
       #
       # @example Get all the global subscribers.
-      #   Monitoring::Global.subscribers
+      #   Mongo::Monitoring::Global.subscribers
       #
       # @return [ Hash<String, Object> ] The subscribers.
       #
@@ -112,6 +149,23 @@ module Mongo
         @subscribers ||= {}
       end
 
+      # Determine if there are any subscribers for a particular event.
+      #
+      # @example Are there subscribers?
+      #   monitoring.subscribers?(COMMAND)
+      #
+      # @example Are there global subscribers?
+      #   Mongo::Monitoring::Global.subscribers?(COMMAND)
+      #
+      # @param [ String ] topic The event topic.
+      #
+      # @return [ true, false ] If there are subscribers for the topic.
+      #
+      # @since 2.1.0
+      def subscribers?(topic)
+        !subscribers_for(topic).empty?
+      end
+
       private
 
       def subscribers_for(topic)
@@ -119,6 +173,20 @@ module Mongo
       end
     end
 
+    # Allows subscribing to events for all Mongo clients.
+    #
+    # @note Global subscriptions must be established prior to creating
+    #   clients. When a client is constructed it copies subscribers from
+    #   the Global module; subsequent subscriptions or unsubscriptions
+    #   on the Global module have no effect on already created clients.
+    #
+    # @since 2.1.0
+    module Global
+      extend Subscribable
+    end
+
+    include Subscribable
+
     # Initialize the monitoring.
     #
     # @api private
@@ -126,7 +194,9 @@ module Mongo
     # @example Create the new monitoring.
     #   Monitoring.new(:monitoring => true)
     #
-    # @param [ Hash ] options The options.
+    # @param [ Hash ] options Options. Client constructor forwards its
+    #   options to Monitoring constructor, although Monitoring recognizes
+    #   only a subset of the options recognized by Client.
     #
     # @since 2.1.0
     def initialize(options = {})
@@ -184,53 +254,20 @@ module Mongo
       subscribers_for(topic).each{ |subscriber| subscriber.failed(event) }
     end
 
-    # Subscribe a listener to an event topic.
-    #
-    # @example Subscribe to the topic.
-    #   monitoring.subscribe(QUERY, subscriber)
-    #
-    # @param [ String ] topic The event topic.
-    # @param [ Object ] subscriber The subscriber to handle the event.
-    #
-    # @since 2.1.0
-    def subscribe(topic, subscriber)
-      subscribers_for(topic).push(subscriber)
-    end
-
-    # Get all the subscribers.
-    #
-    # @example Get all the subscribers.
-    #   monitoring.subscribers
-    #
-    # @return [ Hash<String, Object> ] The subscribers.
-    #
-    # @since 2.1.0
-    def subscribers
-      @subscribers ||= {}
-    end
-
-    # Determine if there are any subscribers for a particular event.
-    #
-    # @example Are there subscribers?
-    #   monitoring.subscribers?(COMMAND)
-    #
-    # @param [ String ] topic The event topic.
-    #
-    # @return [ true, false ] If there are subscribers for the topic.
-    #
-    # @since 2.1.0
-    def subscribers?(topic)
-      !subscribers_for(topic).empty?
-    end
-
     private
 
     def initialize_copy(original)
       @subscribers = original.subscribers.dup
     end
-
-    def subscribers_for(topic)
-      subscribers[topic] ||= []
-    end
   end
 end
+
+require 'mongo/monitoring/event'
+require 'mongo/monitoring/publishable'
+require 'mongo/monitoring/command_log_subscriber'
+require 'mongo/monitoring/sdam_log_subscriber'
+require 'mongo/monitoring/server_description_changed_log_subscriber'
+require 'mongo/monitoring/server_closed_log_subscriber'
+require 'mongo/monitoring/server_opening_log_subscriber'
+require 'mongo/monitoring/topology_changed_log_subscriber'
+require 'mongo/monitoring/topology_opening_log_subscriber'