em-mongo 0.2.14 → 0.3.1

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/lib/em-mongo/collection.rb

@@ -25,10 +25,10 @@ module EM::Mongo
       end
     end
 
-    def insert(obj)
-      obj['_id'] ||= BSON::ObjectId.new
-      @connection.insert(@name, obj)
-      obj
+    def insert(doc)
+      sanitize_id!(doc)
+      @connection.insert(@name, doc)
+      doc[:_id] # mongo-ruby-driver returns ID
     end
 
     def update(selector, updater, opts={})
@@ -36,10 +36,37 @@ module EM::Mongo
       true
     end
 
+    # XXX Missing tests
+    def save(doc, opts={})
+      id = has_id?(doc)
+      sanitize_id!(doc)
+      if id
+        update({:_id => id}, doc, :upsert => true)
+        id
+      else
+        insert(doc)
+      end
+    end
+
     def remove(obj = {})
       @connection.delete(@name, obj)
       true
     end
 
+    private
+
+    def has_id?(doc)
+      # mongo-ruby-driver seems to take :_id over '_id' for some reason
+      id = doc[:_id] || doc['_id']
+      return id if id
+      nil
+    end
+
+    def sanitize_id!(doc)
+      doc[:_id] = has_id?(doc) || BSON::ObjectId.new
+      doc.delete('_id')
+      doc
+    end
+
   end
 end

data/lib/em-mongo/connection.rb

@@ -239,25 +239,10 @@ module EM::Mongo
 
 end
 
-# Make EM::Mongo look like mongo-ruby-driver
 module EM::Mongo
-  class Database
-    def initialize(name = DEFAULT_DB, connection = nil)
-      @db_name = name
-      @em_connection = connection || EM::Mongo::Connection.new
-      @collection = nil
-    end
-
-    def collection(name = DEFAULT_NS)
-      @collection = EM::Mongo::Collection.new(@db_name, name, @em_connection)
-    end
-
-    def close
-      @em_connection.close
-    end
-  end
 
   class Connection
+
     def initialize(host = DEFAULT_IP, port = DEFAULT_PORT, timeout = nil, opts = {})
       @em_connection = EMConnection.connect(host, port, timeout, opts)
       @db = {}

data/lib/em-mongo/conversions.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+
+# --
+# Copyright (C) 2008-2010 10gen 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 #:nodoc:
+
+  # Utility module to include when needing to convert certain types of
+  # objects to mongo-friendly parameters.
+  module Conversions
+
+    ASCENDING_CONVERSION  = ["ascending", "asc", "1"]
+    DESCENDING_CONVERSION = ["descending", "desc", "-1"]
+
+    # Converts the supplied +Array+ to a +Hash+ to pass to mongo as
+    # sorting parameters. The returned +Hash+ will vary depending 
+    # on whether the passed +Array+ is one or two dimensional.
+    #
+    # Example:
+    #
+    # <tt>array_as_sort_parameters([["field1", :asc], ["field2", :desc]])</tt> =>
+    # <tt>{ "field1" => 1, "field2" => -1}</tt>
+    def array_as_sort_parameters(value)
+      order_by = BSON::OrderedHash.new
+      if value.first.is_a? Array
+        value.each do |param|
+          if (param.class.name == "String")
+            order_by[param] = 1
+          else
+            order_by[param[0]] = sort_value(param[1]) unless param[1].nil?
+          end
+        end
+      elsif !value.empty?
+        if order_by.size == 1
+          order_by[value.first] = 1
+        else
+          order_by[value.first] = sort_value(value[1])
+        end
+      end
+      order_by
+    end
+
+    # Converts the supplied +String+ or +Symbol+ to a +Hash+ to pass to mongo as
+    # a sorting parameter with ascending order. If the +String+
+    # is empty then an empty +Hash+ will be returned.
+    #
+    # Example:
+    #
+    # *DEPRECATED
+    #
+    # <tt>string_as_sort_parameters("field")</tt> => <tt>{ "field" => 1 }</tt>
+    # <tt>string_as_sort_parameters("")</tt> => <tt>{}</tt>
+    def string_as_sort_parameters(value)
+      return {} if (str = value.to_s).empty?
+      { str => 1 }
+    end
+
+    # Converts the +String+, +Symbol+, or +Integer+ to the 
+    # corresponding sort value in MongoDB.
+    #
+    # Valid conversions (case-insensitive):
+    #
+    # <tt>ascending, asc, :ascending, :asc, 1</tt> => <tt>1</tt>
+    # <tt>descending, desc, :descending, :desc, -1</tt> => <tt>-1</tt>
+    #
+    # If the value is invalid then an error will be raised.
+    def sort_value(value)
+      val = value.to_s.downcase
+      return 1 if ASCENDING_CONVERSION.include?(val)
+      return -1 if DESCENDING_CONVERSION.include?(val)
+      raise InvalidSortValueError.new(
+        "#{self} was supplied as a sort direction when acceptable values are: " +
+        "Mongo::ASCENDING, 'ascending', 'asc', :ascending, :asc, 1, Mongo::DESCENDING, " +
+        "'descending', 'desc', :descending, :desc, -1.")
+    end
+  end
+end

data/lib/em-mongo/database.rb

@@ -0,0 +1,59 @@
+module EM::Mongo
+  class Database
+
+    SYSTEM_NAMESPACE_COLLECTION = "system.namespaces"
+    SYSTEM_INDEX_COLLECTION = "system.indexes"
+    SYSTEM_PROFILE_COLLECTION = "system.profile"
+    SYSTEM_USER_COLLECTION = "system.users"
+    SYSTEM_JS_COLLECTION = "system.js"
+    SYSTEM_COMMAND_COLLECTION = "$cmd"
+
+    def initialize(name = DEFAULT_DB, connection = nil)
+      @db_name = name
+      @em_connection = connection || EM::Mongo::Connection.new
+      @collection = nil
+      @collections = {}
+    end
+
+    def collection(name = EM::Mongo::DEFAULT_NS)
+      @collections[@db_name] ||= EM::Mongo::Collection.new(@db_name, name, @em_connection)
+    end
+
+    def connection
+      @em_connection
+    end
+
+    def close
+      @em_connection.close
+    end
+
+    def authenticate(username, password)
+      self.collection(SYSTEM_COMMAND_COLLECTION).first({'getnonce' => 1}) do |res|
+        yield false if not res or not res['nonce']
+
+        auth                 = BSON::OrderedHash.new
+        auth['authenticate'] = 1
+        auth['user']         = username
+        auth['nonce']        = res['nonce']   
+        auth['key']          = Mongo::Support.auth_key(username, password, res['nonce'])
+
+        self.collection(SYSTEM_COMMAND_COLLECTION).first(auth) do |res|
+          if Mongo::Support.ok?(res)
+            yield true
+          else
+            yield res
+          end
+        end
+      end
+    end
+
+    def add_user(username, password, &blk)
+      self.collection(SYSTEM_USER_COLLECTION).first({:user => username}) do |res|
+        user = res || {:user => username}
+        user['pwd'] = Mongo::Support.hash_password(username, password)
+        yield self.collection(SYSTEM_USER_COLLECTION).save(user)
+      end
+    end
+
+  end
+end

data/lib/em-mongo/support.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+# --
+# Copyright (C) 2008-2010 10gen 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 'digest/md5'
+
+module Mongo
+  module Support
+    include Mongo::Conversions
+    extend self
+
+    # Generate an MD5 for authentication.
+    #
+    # @param [String] username
+    # @param [String] password
+    # @param [String] nonce
+    #
+    # @return [String] a key for db authentication.
+    def auth_key(username, password, nonce)
+      Digest::MD5.hexdigest("#{nonce}#{username}#{hash_password(username, password)}")
+    end
+
+    # Return a hashed password for auth.
+    #
+    # @param [String] username
+    # @param [String] plaintext
+    #
+    # @return [String]
+    def hash_password(username, plaintext)
+      Digest::MD5.hexdigest("#{username}:mongo:#{plaintext}")
+    end
+
+
+    def validate_db_name(db_name)
+      unless [String, Symbol].include?(db_name.class)
+        raise TypeError, "db_name must be a string or symbol"
+      end
+
+      [" ", ".", "$", "/", "\\"].each do |invalid_char|
+        if db_name.include? invalid_char
+          raise Mongo::InvalidNSName, "database names cannot contain the character '#{invalid_char}'"
+        end
+      end
+      raise Mongo::InvalidNSName, "database name cannot be the empty string" if db_name.empty?
+      db_name
+    end
+
+    def format_order_clause(order)
+      case order
+        when String, Symbol then string_as_sort_parameters(order)
+        when Array then array_as_sort_parameters(order)
+        else
+          raise InvalidSortValueError, "Illegal sort clause, '#{order.class.name}'; must be of the form " +
+            "[['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]"
+      end
+    end
+
+    # Determine if a database command has succeeded by
+    # checking the document response.
+    #
+    # @param [Hash] doc
+    #
+    # @return [Boolean] true if the 'ok' key is either 1 or *true*.
+    def ok?(doc)
+      doc['ok'] == 1.0 || doc['ok'] == true
+    end
+  end
+end

data/lib/em-mongo.rb

@@ -1,21 +1,32 @@
-
-require "eventmachine"
-begin; require "bson_ext"; rescue LoadError; require "bson"; end
+begin
+  require "rubygems"
+  require "bundler"
+  Bundler.setup(:default)
+rescue LoadError
+ensure
+  require "eventmachine"
+  begin
+    require "bson_ext"
+  rescue LoadError
+    require "bson"
+  end
+end
 
 module EM::Mongo
 
   module Version
-    MAJOR = 0
-    MINOR = 2
-    TINY  = 10
-    STRING = [MAJOR, MINOR, TINY].join('.')
+    STRING = File.read(File.dirname(__FILE__) + '/../VERSION')
+    MAJOR, MINOR, TINY = STRING.split('.') 
   end
-
+ 
   NAME    = 'em-mongo'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH    = ::File.dirname(LIBPATH) + ::File::SEPARATOR
 end
 
+require File.join(EM::Mongo::LIBPATH, "em-mongo/conversions")
+require File.join(EM::Mongo::LIBPATH, "em-mongo/support")
+require File.join(EM::Mongo::LIBPATH, "em-mongo/database")
 require File.join(EM::Mongo::LIBPATH, "em-mongo/connection")
 require File.join(EM::Mongo::LIBPATH, "em-mongo/collection")
 

data/spec/integration/collection_spec.rb

@@ -4,69 +4,79 @@ describe EMMongo::Collection do
   include EM::Spec
 
   it 'should insert an object' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
 
-   obj = @coll .insert('hello' => 'world')
-   obj.keys.should include '_id'
-   obj['_id'].should be_a_kind_of(BSON::ObjectId)
-   done
+    doc = {'hello' => 'world'}
+    id = @coll.insert(doc)
+    id.should be_a_kind_of(BSON::ObjectId)
+    doc[:_id].should be_a_kind_of(BSON::ObjectId)
+    done
   end
 
   it 'should insert an object with a custom _id' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
 
-   obj = @coll .insert('_id' => 1234, 'hello' => 'world')
-   obj.keys.should include '_id'
-   obj['_id'].should == 1234
-   r = @coll.find({"hello" => "world"},{}) do |res|
-     res.size.should >= 1
-     res[0]['_id'].should == 1234
-     done
-   end
+    id = @coll.insert(:_id => 1234, 'hello' => 'world')
+    id.should == 1234
+    @coll.first({'hello' => 'world'}) do |res|
+      res['_id'].should == 1234
+      done
+    end
   end
 
   it 'should find an object by attribute' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
     
-   @coll.insert("hello" => 'world')
-   r = @coll.find({"hello" => "world"},{}) do |res|
-     res.size.should >= 1
-     res[0]["hello"].should == "world"
-     done
-   end
+    @coll.insert("hello" => 'world')
+    @coll.find({"hello" => "world"},{}) do |res|
+      res.size.should >= 1
+      res[0]["hello"].should == "world"
+      done
+    end
+  end
+
+  it 'should take strings or symbols for hashes' do
+    @conn, @coll = connection_and_collection
+
+    obj = @coll.insert({:_id => 1234, 'foo' => 'bar', :hello => 'world'})
+    @coll.first({:_id => 1234},{}) do |res|
+      res['hello'].should == 'world' 
+      res['foo'].should == 'bar'
+      done
+    end
   end
 
   it 'should find an object by symbol' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
     
-   @coll.insert('hello' => 'world')
-   r = @coll.find({:hello => "world"},{}) do |res|
-     res.size.should >= 1
-     res[0]["hello"].should == "world"
-     done
-   end
+    @coll.insert('hello' => 'world')
+    @coll.find({:hello => "world"},{}) do |res|
+      res.size.should >= 1
+      res[0]["hello"].should == "world"
+      done
+    end
   end
 
   it 'should find an object by id' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
     
-   obj = @coll.insert('hello' => 'world')
-   @coll.find({'_id' => obj['_id']},{}) do |res|
-     res.size.should >= 1
-     res[0]['hello'].should == "world"
-     done
-   end
+    id = @coll.insert('hello' => 'world')
+    @coll.find({:_id => id},{}) do |res|
+      res.size.should >= 1
+      res[0]['hello'].should == "world"
+      done
+    end
   end
 
   it 'should find all objects' do
-   @conn, @coll = connection_and_collection
+    @conn, @coll = connection_and_collection
 
-   @coll.insert('one' => 'one')
-   @coll.insert('two' => 'two')
-   @coll.find do |res|
-     res.size.should >= 2
-     done
-   end
+    @coll.insert('one' => 'one')
+    @coll.insert('two' => 'two')
+    @coll.find do |res|
+      res.size.should >= 2
+      done
+    end
   end
 
   it 'should find large sets of objects' do
@@ -85,9 +95,9 @@ describe EMMongo::Collection do
   it 'should update an object' do
     @conn, @coll = connection_and_collection
 
-    obj = @coll.insert('hello' => 'world')
+    id = @coll.insert('hello' => 'world')
     @coll.update({'hello' => 'world'}, {'hello' => 'newworld'})
-    @coll.find({'_id' => obj['_id']},{}) do |res|
+    @coll.find({:_id => id},{}) do |res|
       res[0]['hello'].should == 'newworld'
       done
     end
@@ -96,9 +106,9 @@ describe EMMongo::Collection do
   it 'should update an object wxith $inc' do
     @conn, @coll = connection_and_collection
 
-    obj = @coll.insert('hello' => 'world')
+    id = @coll.insert('hello' => 'world')
     @coll.update({'hello' => 'world'}, {'$inc' => {'count' => 1}})
-    @coll.find({'_id' => obj['_id']},{}) do |res|
+    @coll.find({:_id => id},{}) do |res|
       res.first['hello'].should == 'world'
       res.first['count'].should == 1
       done
@@ -108,8 +118,8 @@ describe EMMongo::Collection do
   it 'should remove an object' do
     @conn, @coll = connection_and_collection
 
-    obj = @coll.insert('hello' => 'world')
-    @coll.remove('_id' => obj['_id'])
+    id = @coll.insert('hello' => 'world')
+    @coll.remove(:_id => id)
     @coll.find({'hello' => "world"}) do |res|
       res.size.should == 0
       done
@@ -153,9 +163,10 @@ describe EMMongo::Collection do
       'regex' => /abc$/ix
     }
     retobj = @coll.insert(obj)
-    @coll.find({'_id' => obj['_id']}) do |ret|
+    @coll.find({:_id => obj[:_id]}) do |ret|
       ret.size.should == 1
       ret[0].each_key do |key|
+        next if key == '_id'
         ret[0][key].should == obj[key]
       end
       done
@@ -209,7 +220,7 @@ describe EMMongo::Collection do
   it 'should handle multiple pending queries' do
     @conn, @coll = connection_and_collection
     
-    id = @coll.insert("foo" => "bar")['_id']
+    id = @coll.insert("foo" => "bar")
     received = 0
 
     10.times do |n|

data/spec/integration/database_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__) + '/../')
+
+describe EMMongo::Database do
+  include EM::Spec
+
+  it 'should add a user' do
+    @conn = EM::Mongo::Connection.new
+    @db = @conn.db
+    @db.add_user('test', 'test') do |res| 
+      res.should_not == nil
+      res.should be_a_kind_of(BSON::ObjectId)
+      done
+    end
+  end
+
+  # This test requires the above test.
+  it 'should authenticate a user' do
+    @conn = EM::Mongo::Connection.new
+    @db = @conn.db
+    @db.authenticate('test', 'test') do |res|
+      res.should == true
+      done
+    end
+  end 
+
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 14
-  version: 0.2.14
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - bcg
@@ -47,7 +47,22 @@ dependencies:
         version: 0.20.1
   type: :runtime
   version_requirements: *id002
-description: EventMachine drive for MongoDB.
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 20
+        - 1
+        version: 0.20.1
+  type: :runtime
+  version_requirements: *id003
+description: EventMachine driver for MongoDB.
 email: brenden.grace@gmail.com
 executables: []
 
@@ -56,11 +71,16 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- VERSION
 - lib/em-mongo/collection.rb
 - lib/em-mongo/connection.rb
+- lib/em-mongo/conversions.rb
+- lib/em-mongo/database.rb
+- lib/em-mongo/support.rb
 - lib/em-mongo.rb
 - spec/integration/collection_spec.rb
 - spec/integration/connection_spec.rb
+- spec/integration/database_spec.rb
 has_rdoc: true
 homepage: 
 licenses: []
@@ -96,3 +116,4 @@ summary: EventMachine driver for MongoDB.
 test_files: 
 - spec/integration/collection_spec.rb
 - spec/integration/connection_spec.rb
+- spec/integration/database_spec.rb