candy 0.2.1 → 0.2.2

data/HISTORY.markdown

@@ -2,6 +2,14 @@
 
 This document aims to provide only an overview.  Further, we've only really been tracking things since **v0.2**.  For obsessive detail, just check out the `git log`.
 
+## v0.2.2 - 2010-04-12 (the "I hate reporting bugs to the MongoDB team" release)
+
+The Mongo gem has broken the BSON functions out into a separate bson gem, so I had to fix things.  This means Candy is no longer compatible with the Mongo gem < 0.20.1.  Que sera.  (Also, the bson_ext gem **must** be installed due to a bug.  I'll remove the dependency when they fix it.)  Additional minor bonus: authentication.
+
+* New BSON::* classes correctly referenced in Candy::Wrapper
+* Candy.username and Candy.password properties to automatically authenticate at the global level
+* Class-specific .username and .password properties for class-specific databases
+
 ## v0.2.1 - 2010-04-04 (the "Oops" release)
 
 I screwed up in my use of Jeweler, and managed to get my versions out of sync between Github and Rubygems.org.  I tried to `gem yank` the one from Rubygems, but it won't let me push again with the same version number.  To justify bumping the patch number, I added this changelog.  Yeah, I know.  Pathetic.

data/Rakefile

@@ -16,7 +16,9 @@ DESCRIPTION
     gem.email = "sfeley@gmail.com"
     gem.homepage = "http://github.com/SFEley/candy"
     gem.authors = ["Stephen Eley"]
-    gem.add_dependency "mongo", ">= 0.19.1"
+    gem.add_dependency "bson", ">= 0.20.1"
+    gem.add_dependency "bson_ext", '>= 0.20.1'
+    gem.add_dependency "mongo", ">= 0.20.1"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem.add_development_dependency "yard", ">= 0"
     gem.add_development_dependency "mocha", ">= 0.9.8"

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/candy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{candy}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Eley"]
-  s.date = %q{2010-04-05}
+  s.date = %q{2010-04-12}
   s.description = %q{Candy provides simple, transparent object persistence for the MongoDB database.  Classes that 
 include Candy modules save all properties to Mongo automatically, can be recursively embedded,
 and can retrieve records with chainable open-ended class methods, eliminating the need for 
@@ -76,16 +76,22 @@ method calls like 'save' and 'find.'
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongo>, [">= 0.19.1"])
+      s.add_runtime_dependency(%q<bson>, [">= 0.20.1"])
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0.20.1"])
+      s.add_runtime_dependency(%q<mongo>, [">= 0.20.1"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
     else
-      s.add_dependency(%q<mongo>, [">= 0.19.1"])
+      s.add_dependency(%q<bson>, [">= 0.20.1"])
+      s.add_dependency(%q<bson_ext>, [">= 0.20.1"])
+      s.add_dependency(%q<mongo>, [">= 0.20.1"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
     end
   else
-    s.add_dependency(%q<mongo>, [">= 0.19.1"])
+    s.add_dependency(%q<bson>, [">= 0.20.1"])
+    s.add_dependency(%q<bson_ext>, [">= 0.20.1"])
+    s.add_dependency(%q<mongo>, [">= 0.20.1"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])
   end

data/lib/candy/crunch.rb

@@ -58,7 +58,7 @@ module Candy
     when Mongo::DB
       @db = val
     when String
-      @db = Mongo::DB.new(val, connection)
+      @db = maybe_authenticate(Mongo::DB.new(val, connection))
     when nil
       @db = nil
     else 
@@ -69,7 +69,29 @@ module Candy
   # Returns the database you gave, or creates a default database named for your username (or 'candy' if it
   # can't find a username).
   def self.db
-    @db ||= Mongo::DB.new(Etc.getlogin || 'candy', connection, :strict => false)
+    @db ||= maybe_authenticate(Mongo::DB.new(Etc.getlogin || 'candy', connection, :strict => false))
+  end
+  
+  # Sets the user for Mongo authentication. Both username AND password must be set or nothing will happen.
+  # Also ignored if you supply your own Mongo::DB object instead of a string.
+  def self.username=(val)
+    @username = val
+  end
+  
+  # The user for Mongo authentication. 
+  def self.username
+    @username
+  end
+  
+  # Sets the password for Mongo authentication. Both username AND password must be set or nothing will happen.
+  # Also ignored if you supply your own Mongo::DB object instead of a string.
+  def self.password=(val)
+    @password = val
+  end
+  
+  # The password for Mongo authentication
+  def self.password
+    @password
   end
   
   # All of the hard crunchy bits that connect us to a collection within a Mongo database.
@@ -97,7 +119,7 @@ module Candy
         when Mongo::DB
           @db = val
         when String
-          @db = Mongo::DB.new(val, connection)
+          @db = maybe_authenticate(Mongo::DB.new(val, connection))
         when nil
           @db = nil
         else 
@@ -110,6 +132,30 @@ module Candy
         @db ||= Candy.db
       end
       
+      # Sets the user for Mongo authentication. Defaults to the global Candy.username. 
+      # Both username AND password must be set or nothing will happen.
+      # Also ignored if you supply your own Mongo::DB object instead of a string.
+      def username=(val)
+        @username = val
+      end
+
+      # The user for Mongo authentication. 
+      def username
+        @username ||= Candy.username
+      end
+
+      # Sets the password for Mongo authentication. Defaults to the global Candy.password.
+      # Both username AND password must be set or nothing will happen.
+      # Also ignored if you supply your own Mongo::DB object instead of a string.
+      def password=(val)
+        @password = val
+      end
+
+      # The password for Mongo authentication
+      def password
+        @password ||= Candy.password
+      end
+      
       # Accepts either a Mongo::Collection object or a string with the collection name.  If you provide a 
       # Mongo::Collection object, the default database and connection are not used.
       def collection=(val)
@@ -140,10 +186,23 @@ module Candy
         else
           raise TypeError, "Index direction should be :asc or :desc"
         end
-        collection.create_index(property => mongo_direction)
+        collection.create_index([[property, mongo_direction]])
       end
+      
+    private
+      # If we don't have a username AND password, returns the DB given.  If we do, returns the DB if-and-only-if
+      # we can authenticate on that DB.
+      def maybe_authenticate(db)
+        if @username && @password
+          db if db.authenticate(@username, @password)
+        else
+          db
+        end
+      end
+
     end
     
+    
     # We're implementing FindAndModify on Mongo 1.4 until the Ruby driver gets around to being updated...
     def findAndModify(query, update, sort={})
       command = OrderedHash[
@@ -154,9 +213,23 @@ module Candy
       ]
       result = self.class.db.command(command)
     end
+
     
     def self.included(receiver)
       receiver.extend         ClassMethods
     end
+    
   end
+  
+private 
+  # If we don't have a username AND password, returns the DB given.  If we do, returns the DB if-and-only-if
+  # we can authenticate on that DB.
+  def self.maybe_authenticate(db)
+    if @username && @password
+      db if db.authenticate(@username, @password)
+    else
+      db
+    end
+  end
+  
 end

data/lib/candy/wrapper.rb

@@ -1,4 +1,4 @@
-require 'mongo'
+require 'bson'
 require 'date'  # Only so we know what one is. Argh.
 require 'candy/qualified_const_get'
 
@@ -16,10 +16,10 @@ module Candy
                 Float, 
                 Time,
                 Regexp,
-                ByteBuffer, 
-                Mongo::ObjectID, 
-                Mongo::Code,
-                Mongo::DBRef]
+                BSON::ByteBuffer, 
+                BSON::ObjectID, 
+                BSON::Code,
+                BSON::DBRef]
     
     # Makes an object safe for the sharp pointy edges of MongoDB. Types properly serialized
     # by the BSON.serialize call get passed through unmolested; others are unpacked and their
@@ -28,8 +28,6 @@ module Candy
       # Pass the simple cases through
       return thing if BSON_SAFE.include?(thing.class)
       case thing
-      # when Symbol
-      #   wrap_symbol(thing)
       when Array
         wrap_array(thing)
       when Hash
@@ -71,11 +69,6 @@ module Candy
       wrapped
     end
     
-    # Returns a string that's distinctive enough for us to unwrap later and produce the same symbol.
-    def self.wrap_symbol(symbol)
-      "__:" + symbol.to_s
-    end
-    
     # Returns a nested hash containing the class and instance variables of the object.  It's not the
     # deepest we could ever go (it doesn't handle singleton methods, etc.) but it's a start.
     def self.wrap_object(object)

data/spec/candy/crunch_spec.rb

@@ -47,6 +47,8 @@ describe Candy::Crunch do
       PeanutBrittle.connection = nil
       PeanutBrittle.instance_variable_get(:@db).should be_nil
     end
+    
+      
 
     after(:each) do
       Candy.host = nil
@@ -98,6 +100,39 @@ describe Candy::Crunch do
       PeanutBrittle.instance_variable_get(:@collection).should be_nil
     end
     
+    it "takes a username and password if you provide them globally" do
+      Mongo::DB.any_instance.expects(:authenticate).with('johnny5','is_alive').returns(true)
+      Candy.username = 'johnny5'
+      Candy.password = 'is_alive'
+      PeanutBrittle.db.collection_names.should_not be_nil
+    end
+
+    it "takes a username and password if you provide them at the class level" do
+      Mongo::DB.any_instance.expects(:authenticate).with('johnny5','is_alive').returns(true)
+      PeanutBrittle.username = 'johnny5'
+      PeanutBrittle.password = 'is_alive'
+      PeanutBrittle.db = 'candy_test'
+      PeanutBrittle.db.collection_names.should_not be_nil
+    end
+
+    it "does not authenticate if only a username is given" do
+      Mongo::DB.any_instance.expects(:authenticate).never
+      Candy.username = 'johnny5'
+      PeanutBrittle.db.collection_names.should_not be_nil
+    end
+      
+    
+    it "does not authenticate if only a password is given" do
+      Mongo::DB.any_instance.expects(:authenticate).never
+      Candy.password = 'is_alive'
+      PeanutBrittle.db.collection_names.should_not be_nil
+    end
+
+    after(:each) do
+      Candy.username = nil
+      Candy.password = nil
+    end
+    
     after(:all) do
       Candy.db = 'candy_test'  # Get back to our starting point
     end
@@ -128,12 +163,12 @@ describe Candy::Crunch do
   describe "index" do
     it "can be created with just a property name" do
       PeanutBrittle.index(:blah)
-      PeanutBrittle.collection.index_information.values[1].should == [["blah", Mongo::ASCENDING]]
+      PeanutBrittle.collection.index_information.values[1]['key'].should == {"blah" => Mongo::ASCENDING}
     end
     
     it "can be created with a direction" do
       PeanutBrittle.index(:fwah, :desc)
-      PeanutBrittle.collection.index_information.values[1].should == [["fwah", Mongo::DESCENDING]]
+      PeanutBrittle.collection.index_information.values[1]['key'].should == {"fwah" => Mongo::DESCENDING}
     end
     
     it "throws an exception if you give it a type other than :asc or :desc" do

data/spec/candy/piece_spec.rb

@@ -21,7 +21,7 @@ describe Candy::Piece do
   
   it "knows its ID after inserting" do
     @this.name = 'Zagnut'
-    @this.id.should be_a(Mongo::ObjectID)
+    @this.id.should be_a(BSON::ObjectID)
   end
   
   
@@ -112,7 +112,7 @@ describe Candy::Piece do
     end
         
     it "returns nil on an object that can't be found" do
-      id = Mongo::ObjectID.new
+      id = BSON::ObjectID.new
       Zagnut(id).should be_nil
     end
     

data/spec/candy/wrapper_spec.rb

@@ -50,7 +50,7 @@ module Candy
       end
   
       it "can wrap an ObjectID" do
-        i = Mongo::ObjectID.new
+        i = BSON::ObjectID.new
         Wrapper.wrap(i).should == i
       end
 
@@ -65,12 +65,12 @@ module Candy
       end
   
       it "can wrap a Mongo code object (if we ever need to)" do
-        c = Mongo::Code.new('5')
+        c = BSON::Code.new('5')
         Wrapper.wrap(c).should == c
       end
   
       it "can wrap a Mongo DBRef (if we ever need to)" do
-        d = Mongo::DBRef.new('foo', Mongo::ObjectID.new)
+        d = BSON::DBRef.new('foo', BSON::ObjectID.new)
         Wrapper.wrap(d).should == d
       end
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Stephen Eley
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 -04:00
+date: 2010-04-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mongo
+  name: bson
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -26,15 +26,43 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 19
+        - 20
         - 1
-        version: 0.19.1
+        version: 0.20.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: bson_ext
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 20
+        - 1
+        version: 0.20.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 20
+        - 1
+        version: 0.20.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,11 +72,11 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -58,7 +86,7 @@ dependencies:
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 description: |
   Candy provides simple, transparent object persistence for the MongoDB database.  Classes that 
   include Candy modules save all properties to Mongo automatically, can be recursively embedded,