mongo 1.12.5 → 2.0.0

data/lib/mongo/database/view.rb

@@ -0,0 +1,101 @@
+# 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 Database
+
+    # A class representing a view of a database.
+    #
+    # @since 2.0.0
+    class View
+      extend Forwardable
+      include Enumerable
+
+      def_delegators :@database, :cluster, :read_preference
+      def_delegators :cluster, :next_primary
+
+      # @return [ Integer ] batch_size The size of the batch of results
+      #   when sending the listCollections command.
+      attr_reader :batch_size
+
+      # @return [ Integer ] limit The limit when sending a command.
+      attr_reader :limit
+
+      # @return [ Collection ] collection The command collection.
+      attr_reader :collection
+
+      # Get all the names of the non system collections in the database.
+      #
+      # @example Get the collection names.
+      #   database.collection_names
+      #
+      # @param [ Hash ] options Options for the listCollections command.
+      #
+      # @option options [ Integer ] :batch_size  The batch size for results
+      #   returned from the listCollections command.
+      #
+      # @return [ Array<String> ] The names of all non-system collections.
+      #
+      # @since 2.0.0
+      def collection_names(options = {})
+        @batch_size = options[:batch_size]
+        server = next_primary
+        collections_info(server).collect do |info|
+          server.context.features.list_collections_enabled? ?
+            info['name'] : info['name'].sub("#{@database.name}.", '')
+        end
+      end
+
+      # Create the new database view.
+      #
+      # @example Create the new database view.
+      #   View::Index.new(database)
+      #
+      # @param [ Database ] database The database.
+      #
+      # @since 2.0.0
+      def initialize(database)
+        @database = database
+        @batch_size =  nil
+        @limit = -1
+        @collection = @database[Database::COMMAND]
+      end
+
+      private
+
+      def collections_info(server, &block)
+        cursor = Cursor.new(self, send_initial_query(server), server).to_enum
+        cursor.each do |doc|
+          yield doc
+        end if block_given?
+        cursor
+      end
+
+      def collections_info_spec
+        { selector: {
+            listCollections: 1,
+            cursor: batch_size ? { batchSize: batch_size } : {} },
+          db_name: @database.name }
+      end
+
+      def initial_query_op
+        Operation::Read::CollectionsInfo.new(collections_info_spec)
+      end
+
+      def send_initial_query(server)
+        initial_query_op.execute(server.context)
+      end
+    end
+  end
+end

data/lib/mongo/database.rb

@@ -0,0 +1,224 @@
+# 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/database/view'
+
+module Mongo
+
+  # Represents a database on the db server and operations that can execute on
+  # it at this level.
+  #
+  # @since 2.0.0
+  class Database
+    extend Forwardable
+
+    # The admin database name.
+    #
+    # @since 2.0.0
+    ADMIN = 'admin'.freeze
+
+    # The "collection" that database commands operate against.
+    #
+    # @since 2.0.0
+    COMMAND = '$cmd'.freeze
+
+    # The default database options.
+    #
+    # @since 2.0.0
+    DEFAULT_OPTIONS = { :database => ADMIN }.freeze
+
+    # The name of the collection that holds all the collection names.
+    #
+    # @since 2.0.0
+    NAMESPACES = 'system.namespaces'.freeze
+
+    # @return [ Client ] client The database client.
+    attr_reader :client
+
+    # @return [ String ] name The name of the database.
+    attr_reader :name
+
+    # @return [ Hash ] options The options.
+    attr_reader :options
+
+    # Get cluster, read preference, and write concern from client.
+    def_delegators :@client,
+                   :cluster,
+                   :read_preference,
+                   :write_concern
+
+    # Check equality of the database object against another. Will simply check
+    # if the names are the same.
+    #
+    # @example Check database equality.
+    #   database == other
+    #
+    # @param [ Object ] other The object to check against.
+    #
+    # @return [ true, false ] If the objects are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Database)
+      name == other.name
+    end
+
+    # Get a collection in this database by the provided name.
+    #
+    # @example Get a collection.
+    #   database[:users]
+    #
+    # @param [ String, Symbol ] collection_name The name of the collection.
+    # @param [ Hash ] options The options to the collection.
+    #
+    # @return [ Mongo::Collection ] The collection object.
+    #
+    # @since 2.0.0
+    def [](collection_name, options = {})
+      Collection.new(self, collection_name, options)
+    end
+    alias_method :collection, :[]
+
+    # Get all the names of the non system collections in the database.
+    #
+    # @example Get the collection names.
+    #   database.collection_names
+    #
+    # @return [ Array<String> ] The names of all non-system collections.
+    #
+    # @since 2.0.0
+    def collection_names(options = {})
+      View.new(self).collection_names(options)
+    end
+
+    # Get all the collections that belong to this database.
+    #
+    # @example Get all the collections.
+    #   database.collections
+    #
+    # @return [ Array<Mongo::Collection> ] All the collections.
+    #
+    # @since 2.0.0
+    def collections
+      collection_names.map { |name| collection(name) }
+    end
+
+    # Execute a command on the database.
+    #
+    # @example Execute a command.
+    #   database.command(:ismaster => 1)
+    #
+    # @param [ Hash ] operation The command to execute.
+    # @param [ Hash ] opts The command options.
+    #
+    # @option opts :read [ Hash ] The read preference for this command.
+    #
+    # @return [ Hash ] The result of the command execution.
+    def command(operation, opts = {})
+      preference = opts[:read] ? ServerSelector.get(opts[:read], options) : read_preference
+      server = preference.select_server(cluster)
+      Operation::Command.new({
+        :selector => operation,
+        :db_name => name,
+        :options => { :limit => -1 },
+        :read => preference
+      }).execute(server.context)
+    end
+
+    # Drop the database and all its associated information.
+    #
+    # @example Drop the database.
+    #   database.drop
+    #
+    # @return [ Result ] The result of the command.
+    #
+    # @since 2.0.0
+    def drop
+      command(:dropDatabase => 1)
+    end
+
+    # Instantiate a new database object.
+    #
+    # @example Instantiate the database.
+    #   Mongo::Database.new(client, :test)
+    #
+    # @param [ Mongo::Client ] client The driver client.
+    # @param [ String, Symbol ] name The name of the database.
+    # @param [ Hash ] options The options.
+    #
+    # @raise [ Mongo::Database::InvalidName ] If the name is nil.
+    #
+    # @since 2.0.0
+    def initialize(client, name, options = {})
+      raise Error::InvalidDatabaseName.new unless name
+      @client = client
+      @name = name.to_s.freeze
+      @options = options.freeze
+    end
+
+    # Get a pretty printed string inspection for the database.
+    #
+    # @example Inspect the database.
+    #   database.inspect
+    #
+    # @return [ String ] The database inspection.
+    #
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Database:0x#{object_id} name=#{name}>"
+    end
+
+    # Get the Grid "filesystem" for this database.
+    #
+    # @example Get the GridFS.
+    #   database.fs
+    #
+    # @return [ Grid::FS ] The GridFS for the database.
+    #
+    # @since 2.0.0
+    def fs(options = {})
+      Grid::FS.new(self, options)
+    end
+
+    # Get the user view for this database.
+    #
+    # @example Get the user view.
+    #   database.users
+    #
+    # @return [ View::User ] The user view.
+    #
+    # @since 2.0.0
+    def users
+      Auth::User::View.new(self)
+    end
+
+    # Create a database for the provided client, for use when we don't want the
+    # client's original database instance to be the same.
+    #
+    # @api private
+    #
+    # @example Create a database for the client.
+    #   Database.create(client)
+    #
+    # @param [ Client ] client The client to create on.
+    #
+    # @return [ Database ] The database.
+    #
+    # @since 2.0.0
+    def self.create(client)
+      database = Database.new(client, client.options[:database], client.options)
+      client.instance_variable_set(:@database, database)
+    end
+  end
+end

data/lib/mongo/error/bulk_write_error.rb

@@ -0,0 +1,41 @@
+# 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 raised if there are write errors upon executing the bulk
+    # operation.
+    #
+    # @since 2.0.0
+    class BulkWriteError < Error
+
+      # @return [ BSON::Document ] result The error result.
+      attr_reader :result
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::BulkWriteFailure.new(response)
+      #
+      # @param [ Hash ] result A processed response from the server
+      #   reporting results of the operation.
+      #
+      # @since 2.0.0
+      def initialize(result)
+        @result = result
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_bulk_operation.rb

@@ -0,0 +1,36 @@
+# 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 raised if an non-existent operation type is used.
+    #
+    # @since 2.0.0
+    class InvalidBulkOperation < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidBulkOperation.new(name)
+      #
+      # @param [ String ] name The attempted operation name.
+      #
+      # @since 2.0.0
+      def initialize(type, operation)
+        super("Invalid document format for bulk #{type} operation: #{operation}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_bulk_operation_type.rb

@@ -0,0 +1,36 @@
+# 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 raised if an non-existent operation type is used.
+    #
+    # @since 2.0.0
+    class InvalidBulkOperationType < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidBulkOperationType.new(type)
+      #
+      # @param [ String ] type The attempted operation type.
+      #
+      # @since 2.0.0
+      def initialize(type)
+        super("Invalid bulk operation type: #{type}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_collection_name.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
+
+    # Exception that is raised when trying to create a collection with no name.
+    #
+    # @since 2.0.0
+    class InvalidCollectionName < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = 'nil is an invalid collection name. Please provide a string or symbol.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Collection::InvalidName.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_database_name.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
+
+    # Exception that is raised when trying to create a database with no name.
+    #
+    # @since 2.0.0
+    class InvalidDatabaseName < Error
+
+      # The message is constant.
+      #
+      # @since 2.0.0
+      MESSAGE = 'nil is an invalid database name. Please provide a string or symbol.'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidDatabaseName.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end

data/{test/replica_set/ssl_test.rb → lib/mongo/error/invalid_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,21 +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 ReplicaSetSSLTest < Test::Unit::TestCase
-  include Mongo
-  include SSLTests
+    # Exception raised if the object is not a valid document.
+    #
+    # @since 2.0.0
+    class InvalidDocument < Error
 
-  SEEDS     = ['server:3000','server:3001','server:3002']
-  BAD_SEEDS = ['localhost:3000','localhost:3001','localhost:3002']
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid document provided'.freeze
 
-  def setup
-    @client_class     = MongoReplicaSetClient
-    @uri_info         = SEEDS.join(',')
-    @connect_info     = SEEDS
-    @bad_connect_info = BAD_SEEDS
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidDocument.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
   end
-
 end

data/lib/mongo/error/invalid_file.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 file md5 and server md5 do not match when acknowledging
+    # GridFS writes.
+    #
+    # @since 2.0.0
+    class InvalidFile < Error
+
+      # Create the nex exception.
+      #
+      # @example Create the mew exception.
+      #   Mongo::Error::InvalidFile.new(file_md5, server_md5)
+      #
+      # @param [ String ] client_md5 The client side file md5.
+      # @param [ String ] server_md5 The server side file md5.
+      #
+      # @since 2.0.0
+      def initialize(client_md5, server_md5)
+        super("File MD5 on client side is #{client_md5} but the server reported #{server_md5}.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_nonce.rb

@@ -0,0 +1,46 @@
+# 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 nonce returned does not
+    # match the client nonce sent to it.
+    #
+    # @since 2.0.0
+    class InvalidNonce < Error
+
+      # @return [ String ] nonce The client nonce.
+      attr_reader :nonce
+
+      # @return [ String ] rnonce The server nonce.
+      attr_reader :rnonce
+
+      # Instantiate the new exception.
+      #
+      # @example Create the exception.
+      #   InvalidNonce.new(nonce, rnonce)
+      #
+      # @param [ String ] nonce The client nonce.
+      # @param [ String ] rnonce The server nonce.
+      #
+      # @since 2.0.0
+      def initialize(nonce, rnonce)
+        @nonce = nonce
+        @rnonce = rnonce
+        super("Expected server rnonce '#{rnonce}' to start with client nonce '#{nonce}'.")
+      end
+    end
+  end
+end

data/lib/mongo/error/invalid_replacement_document.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
+
+    # Exception raised if the object is not a valid replacement document.
+    #
+    # @since 2.0.0
+    class InvalidReplacementDocument < Error
+
+      # The error message.
+      #
+      # @since 2.0.0
+      MESSAGE = 'Invalid replacement document provided'.freeze
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::Error::InvalidReplacementDoc.new
+      #
+      # @since 2.0.0
+      def initialize
+        super(MESSAGE)
+      end
+    end
+  end
+end