mongo 2.0.6 → 2.1.0

data/lib/mongo/database.rb

@@ -36,7 +36,17 @@ module Mongo
     # The default database options.
     #
     # @since 2.0.0
-    DEFAULT_OPTIONS = { :database => ADMIN }.freeze
+    DEFAULT_OPTIONS = Options::Redacted.new(:database => ADMIN).freeze
+
+    # Database name field constant.
+    #
+    # @since 2.1.0
+    NAME = 'name'.freeze
+
+    # Databases constant.
+    #
+    # @since 2.1.0
+    DATABASES = 'databases'.freeze
 
     # The name of the collection that holds all the collection names.
     #
@@ -138,7 +148,7 @@ module Mongo
     #
     # @return [ Hash ] The result of the command execution.
     def command(operation, opts = {})
-      preference = opts[:read] ? ServerSelector.get(opts[:read], options) : read_preference
+      preference = opts[:read] ? ServerSelector.get(client.options.merge(opts[:read])) : read_preference
       server = preference.select_server(cluster)
       Operation::Command.new({
         :selector => operation,
@@ -196,11 +206,11 @@ module Mongo
     # @example Get the GridFS.
     #   database.fs
     #
-    # @return [ Grid::FS ] The GridFS for the database.
+    # @return [ Grid::FSBucket ] The GridFS for the database.
     #
     # @since 2.0.0
     def fs(options = {})
-      Grid::FS.new(self, options)
+      Grid::FSBucket.new(self, options)
     end
 
     # Get the user view for this database.

data/lib/mongo/dbref.rb

@@ -0,0 +1,113 @@
+# 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
+
+  # Represents a DBRef document in the database.
+  #
+  # @since 2.1.0
+  class DBRef
+    include BSON::JSON
+
+    # The constant for the collection reference field.
+    #
+    # @since 2.1.0
+    COLLECTION = '$ref'.freeze
+
+    # The constant for the id field.
+    #
+    # @since 2.1.0
+    ID = '$id'.freeze
+
+    # The constant for the database field.
+    #
+    # @since 2.1.0
+    DATABASE = '$db'.freeze
+
+    # @return [ String ] collection The collection name.
+    attr_reader :collection
+
+    # @return [ BSON::ObjectId ] id The referenced document id.
+    attr_reader :id
+
+    # @return [ String ] database The database name.
+    attr_reader :database
+
+    # Get the DBRef as a JSON document
+    #
+    # @example Get the DBRef as a JSON hash.
+    #   dbref.as_json
+    #
+    # @return [ Hash ] The max key as a JSON hash.
+    #
+    # @since 2.1.0
+    def as_json(*args)
+      document = { COLLECTION => collection, ID => id }
+      document.merge!(DATABASE => database) if database
+      document
+    end
+
+    # Instantiate a new DBRef.
+    #
+    # @example Create the DBRef.
+    #   Mongo::DBRef.new('users', id, 'database')
+    #
+    # @param [ String ] collection The collection name.
+    # @param [ BSON::ObjectId ] id The object id.
+    # @param [ String ] database The database name.
+    #
+    # @since 2.1.0
+    def initialize(collection, id, database = nil)
+      @collection = collection
+      @id = id
+      @database = database
+    end
+
+    # Converts the DBRef to raw BSON.
+    #
+    # @example Convert the DBRef to raw BSON.
+    #   dbref.to_bson
+    #
+    # @param [ String ] encoded The encoded BSON to append to.
+    #
+    # @return [ String ] The raw BSON.
+    #
+    # @since 2.1.0
+    def to_bson(encoded = ''.force_encoding(BSON::BINARY))
+      as_json.to_bson(encoded)
+    end
+
+    module ClassMethods
+
+      # Deserialize the hash from BSON, converting to a DBRef if appropriate.
+      #
+      # @param [ IO ] bson The bson representing a hash.
+      #
+      # @return [ Hash, DBRef ] The decoded hash or DBRef.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 2.0.0
+      def from_bson(bson)
+        decoded = super
+        if ref = decoded[COLLECTION]
+          decoded = DBRef.new(ref, decoded[ID], decoded[DATABASE])
+        end
+        decoded
+      end
+    end
+  end
+
+  ::Hash.send(:extend, DBRef::ClassMethods)
+end

data/lib/mongo/error/closed_stream.rb

@@ -0,0 +1,34 @@
+# 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 if the GridFS::Stream object is closed and an operation is attempted.
+    #
+    # @since 2.1.0
+    class ClosedStream < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::ClosedStream.new
+      #
+      # @since 2.1.0
+      def initialize
+        super("The stream is closed and cannot be written to or read from.")
+      end
+    end
+  end
+end

data/lib/mongo/error/extra_file_chunk.rb

@@ -0,0 +1,34 @@
+# 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 if an extra chunk is found.
+    #
+    # @since 2.1.0
+    class ExtraFileChunk < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::ExtraFileChunk.new
+      #
+      # @since 2.1.0
+      def initialize
+        super("Extra file chunk found.")
+      end
+    end
+  end
+end

data/lib/mongo/error/{invalid_uri_option.rb → file_not_found.rb}

@@ -15,23 +15,22 @@
 module Mongo
   class Error
 
-    # Raised if the URI is in the correct format but an option is provided that
-    # is not recognized.
+    # Raised if a file is deleted from a GridFS but it is not found.
     #
-    # @since 2.0.0
-    class InvalidURIOption < Error
+    # @since 2.1.0
+    class FileNotFound < Error
 
-      # Create the error.
+      # Create the new exception.
       #
-      # @example Create the error with the invalid option name.
-      #   InvalidURIOption.new('nothing')
+      # @example Create the new exception.
+      #   Mongo::Error::FileNotFound.new(id, :id)
       #
-      # @param [ String ] name The invalid option name.
+      # @param [ Object ] value The property value used to find the file.
+      # @param [ String, Symbol ] property The name of the property used to find the file.
       #
-      # @since 2.0.0
-      def initialize(name)
-        super("Invalid option in URI: '#{name}'.\n" +
-          "Please see the following URL for more information: #{Mongo::URI::HELP}\n")
+      # @since 2.1.0
+      def initialize(value, property)
+        super("File with #{property} '#{value}' not found.")
       end
     end
   end

data/lib/mongo/error/invalid_file.rb

@@ -21,9 +21,9 @@ module Mongo
     # @since 2.0.0
     class InvalidFile < Error
 
-      # Create the nex exception.
+      # Create the new exception.
       #
-      # @example Create the mew exception.
+      # @example Create the new exception.
       #   Mongo::Error::InvalidFile.new(file_md5, server_md5)
       #
       # @param [ String ] client_md5 The client side file md5.

data/lib/mongo/error/invalid_file_revision.rb

@@ -0,0 +1,37 @@
+# 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 if the requested file revision is not found.
+    #
+    # @since 2.1.0
+    class InvalidFileRevision < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::InvalidFileRevision.new('some-file.txt', 3)
+      #
+      # @param [ String ] filename The name of the file.
+      # @param [ Integer ] revision The requested revision.
+      #
+      # @since 2.1.0
+      def initialize(filename, revision)
+        super("No revision #{revision} found for file '#{filename}'.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_uri.rb

@@ -27,10 +27,11 @@ module Mongo
       #   Mongo::Error::InvalidURI.new(uri)
       #
       # @since 2.0.0
-      def initialize(uri)
-        super("MongoDB URI must be in the following format: #{Mongo::URI::FORMAT}\n" +
-        "Please see the following URL for more information: #{Mongo::URI::HELP}\n" +
-        "Bad URI: #{uri}")
+      def initialize(uri, details)
+        super("Bad URI: #{uri}\n" +
+        "#{details}\n" +
+        "MongoDB URI must be in the following format: #{Mongo::URI::FORMAT}\n" +
+        "Please see the following URL for more information: #{Mongo::URI::HELP}\n")
       end
     end
   end

data/lib/mongo/error/missing_file_chunk.rb

@@ -0,0 +1,38 @@
+# 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 if the next chunk when reading from a GridFSBucket does not have the
+    # expected sequence number (n).
+    #
+    # @since 2.1.0
+    class MissingFileChunk < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::MissingFileChunk.new(expected_n, chunk)
+      #
+      # @param [ Integer ] expected_n The expected index value.
+      # @param [ Grid::File::Chunk ] chunk The chunk read from GridFS.
+      #
+      # @since 2.1.0
+      def initialize(expected_n, chunk)
+        super("Unexpected chunk in sequence. Expected next chunk to have index #{expected_n} but it has index #{chunk.n}")
+      end
+    end
+  end
+end

data/lib/mongo/error/operation_failure.rb

@@ -15,7 +15,7 @@
 module Mongo
   class Error
 
-    # Raised when a command failes for some reason.
+    # Raised when an operation fails for some reason.
     #
     # @since 2.0.0
     class OperationFailure < Error; end

data/lib/mongo/error/parser.rb

@@ -36,7 +36,7 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(document)
-        @document = document
+        @document = document || {}
         parse!
       end
 

data/lib/mongo/error/unchangeable_collection_option.rb

@@ -0,0 +1,38 @@
+# 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 if a new collection is created from an existing one and options other than the
+    # changeable ones are provided.
+    #
+    # @since 2.1.0
+    class UnchangeableCollectionOption < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::UnchangeableCollectionOption.new(option)
+      #
+      # @param [ String, Symbol ] option The option that was attempted to be changed.
+      #
+      # @since 2.1.0
+      def initialize(option)
+        super("The option #{option} cannot be set on a new collection instance." +
+                  " The options that can be updated are #{Collection::CHANGEABLE_OPTIONS}")
+      end
+    end
+  end
+end

data/lib/mongo/error/unexpected_chunk_length.rb

@@ -0,0 +1,39 @@
+# 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 if the next chunk when reading from a GridFSBucket does not have the
+    # expected length.
+    #
+    # @since 2.1.0
+    class UnexpectedChunkLength < Error
+
+      # Create the new exception.
+      #
+      # @example Create the new exception.
+      #   Mongo::Error::UnexpectedChunkLength.new(expected_len, chunk)
+      #
+      # @param [ Integer ] expected_len The expected length.
+      # @param [ Grid::File::Chunk ] chunk The chunk read from GridFS.
+      #
+      # @since 2.1.0
+      def initialize(expected_len, chunk)
+        super("Unexpected chunk length. Chunk has length #{chunk.data.data.size} but expected length " +
+          "#{expected_len} or for it to be the last chunk in the sequence.")
+      end
+    end
+  end
+end

data/lib/mongo/error.rb

@@ -43,11 +43,16 @@ module Mongo
     # @since 2.0.0
     WRITE_ERRORS = 'writeErrors'.freeze
 
-    # The constant for write concern errors.
+    # The constant for a write concern error.
     #
     # @since 2.0.0
     WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
 
+    # The constant for write concern errors.
+    #
+    # @since 2.1.0
+    WRITE_CONCERN_ERRORS = 'writeConcernErrors'.freeze
+
     # Constant for an unknown error.
     #
     # @since 2.0.0
@@ -62,6 +67,9 @@ end
 
 require 'mongo/error/parser'
 require 'mongo/error/bulk_write_error'
+require 'mongo/error/closed_stream'
+require 'mongo/error/extra_file_chunk'
+require 'mongo/error/file_not_found'
 require 'mongo/error/operation_failure'
 require 'mongo/error/invalid_bulk_operation'
 require 'mongo/error/invalid_bulk_operation_type'
@@ -69,13 +77,13 @@ 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_file_revision'
 require 'mongo/error/invalid_nonce'
 require 'mongo/error/invalid_replacement_document'
 require 'mongo/error/invalid_server_preference'
 require 'mongo/error/invalid_signature'
 require 'mongo/error/invalid_update_document'
 require 'mongo/error/invalid_uri'
-require 'mongo/error/invalid_uri_option'
 require 'mongo/error/max_bson_size'
 require 'mongo/error/max_message_size'
 require 'mongo/error/multi_index_drop'
@@ -83,4 +91,7 @@ require 'mongo/error/need_primary_server'
 require 'mongo/error/no_server_available'
 require 'mongo/error/socket_error'
 require 'mongo/error/socket_timeout_error'
+require 'mongo/error/unchangeable_collection_option'
+require 'mongo/error/unexpected_chunk_length'
+require 'mongo/error/missing_file_chunk'
 require 'mongo/error/unsupported_features'

data/lib/mongo/event/description_changed.rb

@@ -42,7 +42,7 @@ module Mongo
       # @example Handle the event.
       #   server_added.handle('127.0.0.1:27018')
       #
-      # @param [ Address ] address The added host.
+      # @param [ Server::Description ] updated The changed description.
       #
       # @since 2.0.0
       def handle(updated)

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

@@ -160,17 +160,17 @@ module Mongo
           #   Chunks.split(data)
           #
           # @param [ String ] data The raw bytes.
-          # @param [ Metadata ] metadata The file metadata.
+          # @param [ File::Info ] file_info The files collection file doc.
           #
           # @return [ Array<Chunk> ] The chunks of the data.
           #
           # @since 2.0.0
-          def split(data, metadata)
-            chunks, index, n = [], 0, 0
+          def split(data, file_info, offset = 0)
+            chunks, index, n = [], 0, offset
             while index < data.length
-              bytes = data.slice(index, metadata.chunk_size)
-              metadata.md5.update(bytes)
-              chunk = Chunk.new(:data => BSON::Binary.new(bytes), :files_id => metadata.id, :n => n)
+              bytes = data.slice(index, file_info.chunk_size)
+              file_info.md5.update(bytes)
+              chunk = Chunk.new(:data => BSON::Binary.new(bytes), :files_id => file_info.id, :n => n)
               chunks.push(chunk)
               index += bytes.length
               n += 1