mongo 1.12.5 → 2.0.0.beta

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

@@ -0,0 +1,223 @@
+# 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 Grid
+    class File
+
+      # Encapsulates behaviour around GridFS file metadata.
+      #
+      # @since 2.0.0
+      class Metadata
+
+        # Name of the files collection.
+        #
+        # @since 2.0.0
+        COLLECTION = 'files'.freeze
+
+        # Mappings of user supplied fields to db specification.
+        #
+        # @since 2.0.0
+        MAPPINGS = {
+          :chunk_size => :chunkSize,
+          :content_type => :contentType,
+          :filename => :filename,
+          :_id => :_id,
+          :md5 => :md5,
+          :metadata => :metadata,
+          :upload_date => :uploadDate
+        }.freeze
+
+        # Default content type for stored files.
+        #
+        # @since 2.0.0
+        DEFAULT_CONTENT_TYPE = 'binary/octet-stream'.freeze
+
+        # @return [ BSON::Document ] document The file metadata document.
+        attr_reader :document
+
+        # Is this metadata equal to another?
+        #
+        # @example Check metadata equality.
+        #   metadata == 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?(Metadata)
+          document == other.document
+        end
+
+        # Get the BSON type for a metadata document.
+        #
+        # @example Get the BSON type.
+        #   metadata.bson_type
+        #
+        # @return [ Integer ] The BSON type.
+        #
+        # @since 2.0.0
+        def bson_type
+          BSON::Hash::BSON_TYPE
+        end
+
+        # Get the metadata chunk size.
+        #
+        # @example Get the chunk size.
+        #   metadata.chunk_size
+        #
+        # @return [ Integer ] The chunksize in bytes.
+        #
+        # @since 2.0.0
+        def chunk_size
+          document[:chunkSize]
+        end
+
+        # Get the metadata content type.
+        #
+        # @example Get the content type.
+        #   metadata.content_type
+        #
+        # @return [ String ] The content type.
+        #
+        # @since 2.0.0
+        def content_type
+          document[:contentType]
+        end
+
+        # Get the metadata filename.
+        #
+        # @example Get the filename.
+        #   metadata.filename
+        #
+        # @return [ String ] The filename.
+        def filename
+          document[:filename]
+        end
+
+        # Get the metadata id.
+        #
+        # @example Get the metadata id.
+        #   metadata.id
+        #
+        # @return [ BSON::ObjectId ] The metadata id.
+        #
+        # @since 2.0.0
+        def id
+          document[:_id]
+        end
+
+        # Create the new metadata document.
+        #
+        # @example Create the new metadata document.
+        #   Metadata.new(:filename => 'test.txt')
+        #
+        # @param [ BSON::Document ] document The document to create from.
+        #
+        # @since 2.0.0
+        def initialize(document)
+          @document = default_document.merge(normalize(document))
+          @client_md5 = Digest::MD5.new
+        end
+
+        # Get the length of the document in bytes.
+        #
+        # @example Get the length
+        #   metadata.length
+        #
+        # @return [ Integer ] The length.
+        #
+        # @since 2.0.0
+        def length
+          document[:length]
+        end
+        alias :size :length
+
+        # Get the additional metadata.
+        #
+        # @example Get additional metadata.
+        #   metadata.metadata
+        #
+        # @return [ String ] The additional metadata.
+        #
+        # @since 2.0.0
+        def metadata
+          document[:metadata]
+        end
+
+        # Get the md5 hash.
+        #
+        # @example Get the md5 hash.
+        #   metadata.md5
+        #
+        # @return [ String ] The md5 hash as a string.
+        #
+        # @since 2.0.0
+        def md5
+          document[:md5] || @client_md5
+        end
+
+        # Conver the metadata to BSON for storage.
+        #
+        # @note If no md5 exists in the metadata (it was loaded from the server
+        #   and is not a new file) then we digest the md5 and set it.
+        #
+        # @example Convert the metadata to BSON.
+        #   metadata.to_bson
+        #
+        # @param [ String ] encoded The encoded data to append to.
+        #
+        # @return [ String ] The raw BSON data.
+        #
+        # @since 2.0.0
+        def to_bson(encoded = ''.force_encoding(BSON::BINARY))
+          document[:md5] ||= @client_md5.hexdigest
+          document.to_bson(encoded)
+        end
+
+        # Get the upload date.
+        #
+        # @example Get the upload date.
+        #   metadata.upload_date
+        #
+        # @return [ Time ] The upload date.
+        #
+        # @since 2.0.0
+        def upload_date
+          document[:uploadDate]
+        end
+
+        private
+
+        def normalize(document)
+          document.reduce(BSON::Document.new) do |doc, (key, value)|
+            doc[MAPPINGS[key] || key] = value
+            doc
+          end
+        end
+
+        def default_document
+          BSON::Document.new(
+            :_id => BSON::ObjectId.new,
+            :chunkSize => Chunk::DEFAULT_SIZE,
+            :uploadDate => Time.now.utc,
+            :contentType => DEFAULT_CONTENT_TYPE
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongo/grid/fs.rb

@@ -0,0 +1,149 @@
+# 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 Grid
+
+    # Represents a view of the GridFS in the database.
+    #
+    # @since 2.0.0
+    class FS
+      extend Forwardable
+
+      # The default root prefix.
+      #
+      # @since 2.0.0
+      DEFAULT_ROOT = 'fs'.freeze
+
+      # The specification for the chunks index.
+      #
+      # @since 2.0.0
+      INDEX_SPEC = { :files_id => 1, :n => 1 }.freeze
+
+      # @return [ Collection ] chunks_collection The chunks collection.
+      attr_reader :chunks_collection
+
+      # @return [ Database ] database The database.
+      attr_reader :database
+
+      # @return [ Collection ] files_collection The files collection.
+      attr_reader :files_collection
+
+      # Get write concern from database.
+      def_delegators :database, :write_concern
+
+      # Find a file in the GridFS.
+      #
+      # @example Find a file by it's id.
+      #   fs.find_one(_id: id)
+      #
+      # @example Find a file by it's filename.
+      #   fs.find_one(filename: 'test.txt')
+      #
+      # @param [ Hash ] selector The selector.
+      #
+      # @return [ Grid::File ] The file.
+      #
+      # @since 2.0.0
+      def find_one(selector = nil)
+        metadata = files_collection.find(selector).first
+        return nil unless metadata
+        chunks = chunks_collection.find(:files_id => metadata[:_id]).sort(:n => 1)
+        Grid::File.new(chunks.to_a, metadata)
+      end
+
+      # Insert a single file into the GridFS.
+      #
+      # @example Insert a single file.
+      #   fs.insert_one(file)
+      #
+      # @param [ Grid::File ] file The file to insert.
+      #
+      # @return [ Result ] The result of the insert.
+      #
+      # @since 2.0.0
+      def insert_one(file)
+        files_collection.insert_one(file.metadata)
+        result = chunks_collection.insert_many(file.chunks)
+        if write_concern.get_last_error
+          validate_md5!(file)
+        else
+          result
+        end
+      end
+
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FS.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+        chunks_collection.indexes.create(INDEX_SPEC, :unique => true)
+      end
+
+      # Get the prefix for the GridFS
+      #
+      # @example Get the prefix.
+      #   fs.prefix
+      #
+      # @return [ String ] The GridFS prefix.
+      #
+      # @since 2.0.0
+      def prefix
+        @options[:fs_name] || DEFAULT_ROOT
+      end
+
+      # Remove a single file from the GridFS.
+      #
+      # @example Remove a file from the GridFS.
+      #   fs.remove_one(file)
+      #
+      # @param [ Grid::File ] file The file to remove.
+      #
+      # @return [ Result ] The result of the remove.
+      #
+      # @since 2.0.0
+      def remove_one(file)
+        files_collection.find(:_id => file.id).remove_one
+        chunks_collection.find(:files_id => file.id).remove_many
+      end
+
+      private
+
+      def chunks_name
+        "#{prefix}.#{Grid::File::Chunk::COLLECTION}"
+      end
+
+      def files_name
+        "#{prefix}.#{Grid::File::Metadata::COLLECTION}"
+      end
+
+      def validate_md5!(file)
+        md5 = database.command(:filemd5 => file.id, :root => prefix).documents[0][:md5]
+        raise Error::InvalidFile.new(file.md5, md5) unless file.md5 == md5
+      end
+    end
+  end
+end

data/lib/mongo/index.rb

@@ -0,0 +1,64 @@
+# 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/index/view'
+
+module Mongo
+
+  # Contains constants for indexing purposes.
+  #
+  # @since 2.0.0
+  module Index
+
+    # Specify ascending order for an index.
+    #
+    # @since 2.0.0
+    ASCENDING = 1
+
+    # Specify descending order for an index.
+    #
+    # @since 2.0.0
+    DESCENDING = -1
+
+    # Specify a 2d Geo index.
+    #
+    # @since 2.0.0
+    GEO2D = '2d'.freeze
+
+    # Specify a 2d sphere Geo index.
+    #
+    # @since 2.0.0
+    GEO2DSPHERE = '2dsphere'.freeze
+
+    # Specify a geoHaystack index.
+    #
+    # @since 2.0.0
+    GEOHAYSTACK = 'geoHaystack'.freeze
+
+    # Encodes a text index.
+    #
+    # @since 2.0.0
+    TEXT = 'text'.freeze
+
+    # Specify a hashed index.
+    #
+    # @since 2.0.0
+    HASHED = 'hashed'.freeze
+
+    # Constant for the indexes collection.
+    #
+    # @since 2.0.0
+    COLLECTION = 'system.indexes'.freeze
+  end
+end

data/lib/mongo/index/view.rb

@@ -0,0 +1,205 @@
+# 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 Index
+
+    # A class representing a view of indexes.
+    #
+    # @since 2.0.0
+    class View
+      extend Forwardable
+      include Enumerable
+
+      # @return [ Collection ] collection The indexes collection.
+      attr_reader :collection
+
+      # @return [ Integer ] batch_size The size of the batch of results
+      #   when sending the listIndexes command.
+      attr_reader :batch_size
+
+      def_delegators :@collection, :cluster, :database, :read_preference
+      def_delegators :cluster, :next_primary
+
+      # The index key field.
+      #
+      # @since 2.0.0
+      KEY = 'key'.freeze
+
+      # The index name field.
+      #
+      # @since 2.0.0
+      NAME = 'name'.freeze
+
+      # Drop an index by its specification.
+      #
+      # @example Drop the index by spec.
+      #   view.drop(name: 1)
+      #
+      # @example Drop an index by its name.
+      #   view.drop('name_1')
+      #
+      # @param [ Hash, String ] spec The index spec or name to drop.
+      #
+      # @return [ Result ] The response.
+      #
+      # @since 2.0.0
+      def drop(spec)
+        Operation::Write::DropIndex.new(
+          db_name: database.name,
+          coll_name: collection.name,
+          index_name: spec.is_a?(String) ? spec : index_name(spec)
+        ).execute(next_primary.context)
+      end
+
+      # Drop all indexes on the collection.
+      #
+      # @example Drop all indexes on the collection.
+      #   view.drop_all
+      #
+      # @return [ Result ] The response.
+      #
+      # @since 2.0.0
+      def drop_all
+        drop('*')
+      end
+
+      #  Creates an index on the collection.
+      #
+      # @param [ Hash ] spec A hash of field name/direction pairs.
+      # @param [ Hash ] options Options for this index.
+      #
+      # @option options [ true, false ] :unique (false) If true, this index will enforce
+      #   a uniqueness constraint on that field.
+      # @option options [ true, false ] :background (false) If true, the index will be built
+      #   in the background (only available for server versions >= 1.3.2 )
+      # @option options [ true, false ] :drop_dups (false) If creating a unique index on
+      #   this collection, this option will keep the first document the database indexes
+      #   and drop all subsequent documents with duplicate values on this field.
+      # @option options [ Integer ] :bucket_size (nil) For use with geoHaystack indexes.
+      #   Number of documents to group together within a certain proximity to a given
+      #   longitude and latitude.
+      # @option options [ Integer ] :max (nil) Specify the max latitude and longitude for
+      #   a geo index.
+      # @option options [ Integer ] :min (nil) Specify the min latitude and longitude for
+      #   a geo index.
+      #
+      # @note Note that the options listed may be subset of those available.
+      # See the MongoDB documentation for a full list of supported options by server version.
+      #
+      # @return [ Result ] The response.
+      #
+      # @since 2.0.0
+      def create(spec, options = {})
+        Operation::Write::EnsureIndex.new(
+          index: spec,
+          db_name: database.name,
+          coll_name: collection.name,
+          index_name: options[:name] || index_name(spec),
+          options: options
+        ).execute(next_primary.context)
+      end
+
+      # Convenience method for getting index information by a specific name or
+      # spec.
+      #
+      # @example Get index information by name.
+      #   view.get('name_1')
+      #
+      # @example Get index information by spec.
+      #   view.get(name: 1)
+      #
+      # @param [ Hash, String ] spec The index name or spec.
+      #
+      # @return [ Hash ] The index information.
+      #
+      # @since 2.0.0
+      def get(spec)
+        find do |index|
+          (index[NAME] == spec) || (index[KEY] == normalize_keys(spec))
+        end
+      end
+
+      # Iterate over all indexes for the collection.
+      #
+      # @example Get all the indexes.
+      #   view.each do |index|
+      #     ...
+      #   end
+      #
+      # @since 2.0.0
+      def each(&block)
+        server = next_primary
+        cursor = Cursor.new(self, send_initial_query(server), server).to_enum
+        cursor.each do |doc|
+          yield doc
+        end if block_given?
+        cursor
+      end
+
+      # Create the new index view.
+      #
+      # @example Create the new index view.
+      #   View::Index.new(collection)
+      #
+      # @param [ Collection ] collection The collection.
+      # @param [ Hash ] options Options for getting a list of indexes.
+      #   Only relevant for when the listIndexes command is used with server
+      #   versions >=2.8.
+      #
+      # @option options [ Integer ] :batch_size The batch size for results
+      #   returned from the listIndexes command.
+      #
+      # @since 2.0.0
+      def initialize(collection, options = {})
+        @collection = collection
+        @batch_size = options[:batch_size]
+      end
+
+      private
+
+      def limit
+        -1
+      end
+
+      def indexes_spec
+        { selector: {
+            listIndexes: collection.name,
+            cursor: batch_size ? { batchSize: batch_size } : {} },
+          coll_name: collection.name,
+          db_name: database.name }
+      end
+
+      def initial_query_op
+        Operation::Read::Indexes.new(indexes_spec)
+      end
+
+      def send_initial_query(server)
+        initial_query_op.execute(server.context)
+      end
+
+      def index_name(spec)
+        spec.to_a.join('_')
+      end
+
+      def normalize_keys(spec)
+        return false if spec.is_a?(String)
+        spec.reduce({}) do |normalized, (key, value)|
+          normalized[key.to_s] = value
+          normalized
+        end
+      end
+    end
+  end
+end