mince_mongo_db 1.0.0.pre.3 → 1.0.1

data/lib/mince_mongo_db/config.rb

@@ -6,34 +6,84 @@ module MinceMongoDb # :nodoc:
   # Config specifies the configuration settings
   #
   # @author Matt Simpson
+  #
+  # The following fields can be changed:
+  # * database_name - Defaults to 'mince'
+  # * database_host - Defaults to '127.0.0.1'
+  # * username - Defaults to nil
+  # * password - Defaults to nil
+  #
+  # The following fields cannot be changed:
+  # * primary_key
+  # * test_env_number
+  #
+  # You can change a field by passing a hash:
+  #
+  #   MinceMongoDb::Config.options = {
+  #     username: 'my_db_user',
+  #     password: 'my_db_passw0rd'
+  #   }
+  #
+  # Or you can change a field individually:
+  #
+  #   MinceMongoDb::Config.username = 'my_db_user'
+  #
+  # If you are running tests in parallel, make sure that
+  # ENV['TEST_ENV_NUMBER'] is set for the instance number for each
+  # parallel test.  This number is amended to the database name.
   class Config
     include Singleton
 
-    # Returns the primary key identifier for records.  This is necessary because not all databases use the same
-    # primary key.
-    #
-    # @return [Symbol] the name of the primary key field.
-    def self.primary_key
-      instance.primary_key
+    OPTIONS = %w(database_name database_host username password)
+
+    class << self
+      getters = %w(primary_key)
+      accessors = OPTIONS
+
+      (getters+accessors).each do |field|
+        define_method(field) do
+          instance.send(field)
+        end
+      end
+
+      accessors.each do |field|
+        define_method("#{field}=") do |val|
+          instance.send("#{field}=", val)
+        end
+      end
+    end
+
+    def self.options
+      {
+        database_name: database_name,
+        database_host: database_host,
+        username: username,
+        password: password
+      }
     end
 
-    def self.database_name
-      instance.database_name
+    def self.options=(new_options)
+      whitelist_keys(new_options).each do |key, value|
+        send("#{key}=", value)
+      end
     end
 
-    def self.database_name=(val)
-      instance.database_name = val
+    def self.whitelist_keys(options)
+      options.select{|key, value| OPTIONS.include?(key.to_s) }
     end
 
+    # Returns the test environment number, useful for when testing with multiple
+    # processes in parallel
     def self.test_env_number
       ENV['TEST_ENV_NUMBER']
     end
 
-    attr_accessor :primary_key, :database_name
+    attr_accessor :primary_key, :database_name, :database_host, :username, :password
 
     def initialize
       self.primary_key = '_id'
       self.database_name = 'mince'
+      self.database_host = '127.0.0.1'
     end
 
     def database_name=(name)

data/lib/mince_mongo_db/connection.rb

@@ -17,16 +17,31 @@ module MinceMongoDb
     end
 
     def initialize
-      self.connection = Mongo::Connection.new
+      self.connection = Mongo::Connection.new(Config.database_host)
     end
 
     def connection=(con)
       @connection = con
       self.db = connection.db(database_name)
+      auth
+    end
+
+    def auth
+      db.authenticate(Config.username, Config.password) if auth_provided?
+    end
+
+    def auth_provided?
+      !!Config.username && !!Config.password
     end
 
     def database_name
       Config.database_name
     end
   end
+
+  class Db
+    def initialize
+      
+    end
+  end
 end

data/lib/mince_mongo_db/interface.rb

@@ -51,16 +51,16 @@ module MinceMongoDb
       collection(collection_name).find
     end
 
-    def self.find(collection_name, key, value)
-      collection(collection_name).find_one({key.to_s => value})
+    def self.find(collection_name, value)
+      collection(collection_name).find_one({primary_key.to_s => value})
     end
 
-    def self.push_to_array(collection_name, identifying_key, identifying_value, array_key, value_to_push)
-      collection(collection_name).update({identifying_key.to_s => identifying_value}, {'$push' => {array_key.to_s => value_to_push}})
+    def self.push_to_array(collection_name, identifying_value, array_key, value_to_push)
+      collection(collection_name).update({primary_key.to_s => identifying_value}, {'$push' => {array_key.to_s => value_to_push}})
     end
 
-    def self.remove_from_array(collection_name, identifying_key, identifying_value, array_key, value_to_remove)
-      collection(collection_name).update({identifying_key.to_s => identifying_value}, {'$pull' => {array_key.to_s => value_to_remove}})
+    def self.remove_from_array(collection_name, identifying_value, array_key, value_to_remove)
+      collection(collection_name).update({primary_key.to_s => identifying_value}, {'$pull' => {array_key.to_s => value_to_remove}})
     end
 
     def self.containing_any(collection_name, key, values)

data/lib/mince_mongo_db/version.rb

@@ -9,7 +9,7 @@ module MinceMongoDb
     end
 
     def self.patch
-      "0.pre.3"
+      1
     end
   end
 

data/spec/units/mince_mongo_db/config_spec.rb

@@ -5,6 +5,19 @@ describe MinceMongoDb::Config do
     described_class.primary_key.should == '_id'
   end
 
+  it 'contains a database host' do
+    described_class.database_host.should == '127.0.0.1'
+  end
+
+  it 'can change the database host' do
+    original_host = described_class.database_host
+    new_host = mock
+    described_class.database_host = new_host
+    described_class.database_host.should == new_host
+
+    described_class.database_host = original_host
+  end
+
   describe 'the database name' do
     subject { described_class.database_name }
 
@@ -37,4 +50,74 @@ describe MinceMongoDb::Config do
       end
     end
   end
+
+  it 'does not contain a username' do
+    described_class.username.should be_nil
+  end
+
+  it 'can change the database username' do
+    new_username = mock
+    described_class.username = new_username
+    described_class.username.should == new_username
+
+    described_class.username = nil
+  end
+
+  it 'does not contain a password' do
+    described_class.password.should be_nil
+  end
+
+  it 'can change the database password' do
+    new_password = mock
+    described_class.password = new_password
+    described_class.password.should == new_password
+
+    described_class.password = nil
+  end
+
+  it 'can return all writable options' do
+    described_class.options.should == {
+      database_name: described_class.database_name,
+      database_host: described_class.database_host,
+      username: described_class.username,
+      password: described_class.password
+    }
+  end
+
+  it 'can change the options by passing a hash' do
+    original_options = described_class.options
+    new_options = {
+      database_name: 'new_database_name',
+      database_host: mock,
+      username: mock,
+      password: mock      
+    }
+    described_class.options = new_options
+    described_class.options.should == new_options
+
+    described_class.options = original_options
+  end
+
+  it 'can change a select number of the options by passing a hash' do
+    original_options = described_class.options
+    new_options = {
+      database_name: 'new_database_name',
+      database_host: mock
+    }
+    described_class.options = new_options
+    described_class.options.should == original_options.merge(new_options)
+
+    described_class.options = original_options
+  end
+
+  it 'does not allow assigning unacceptable options' do
+    original_options = described_class.options
+    new_options = {
+      foo: 'foo'
+    }
+    described_class.options = new_options
+    described_class.options.should == original_options
+
+    described_class.options = original_options
+  end
 end

data/spec/units/mince_mongo_db/connection_spec.rb

@@ -6,13 +6,38 @@ describe MinceMongoDb::Connection do
   let(:mongo_connection) { mock 'a mongo connection object', :db => db }
   let(:db) { mock 'db'}
   let(:database_name) { mock }
+  let(:database_host) { mock }
 
   before do
-    MinceMongoDb::Config.stub(database_name: database_name)
-    subject.connection = mongo_connection
+    MinceMongoDb::Config.stub(database_name: database_name, database_host: database_host, username: nil, password: nil)
+    Mongo::Connection.stub(:new).with(database_host).and_return(mongo_connection)
   end
 
-  it 'is a mongo connection' do
+  it 'is a mongo connection for the configured host' do
+    subject.connection = mongo_connection
+
     subject.connection.should == mongo_connection
   end
+
+  it 'uses the configured database name' do
+    mongo_connection.should_receive(:db).with(database_name).and_return(db)
+    subject.connection = mongo_connection
+
+    subject.db.should == db
+  end
+
+  context 'when authentication information is provided' do
+    let(:username) { mock }
+    let(:password) { mock }
+
+    before do
+      MinceMongoDb::Config.stub(username: username, password: password)
+    end    
+
+    it 'auths the connection' do
+      db.should_receive(:authenticate).with(username, password)
+
+      subject.connection = mongo_connection
+    end
+  end
 end

data/spec/units/mince_mongo_db/interface_spec.rb

@@ -82,6 +82,12 @@ describe MinceMongoDb::Interface do
 
     interface.find_all(collection_name).should == return_data
   end
+  
+  it 'can find a record by id' do
+    collection.should_receive(:find_one).with(primary_key.to_s => mock_id).and_return(return_data)
+
+    interface.find(collection_name, mock_id).should == return_data
+  end
 
   it 'can replace a record' do
     collection.should_receive(:update).with({primary_key => data[primary_key]}, data)
@@ -92,10 +98,11 @@ describe MinceMongoDb::Interface do
   it 'can get one document' do
     field = "stuff"
     value = "more stuff"
+    mongo_scope = mock first: return_data
 
-    collection.should_receive(:find_one).with(field => value).and_return(return_data)
+    collection.should_receive(:find).with(field => value).and_return(mongo_scope)
 
-    interface.find(collection_name, field, value).should == return_data
+    interface.get_for_key_with_value(collection_name, field, value).should == return_data
   end
 
   it 'can clear the data store' do
@@ -133,14 +140,14 @@ describe MinceMongoDb::Interface do
   end
 
   it 'can push a value to an array for a specific record' do
-    collection.should_receive(:update).with({"key" => "value"}, { '$push' => { "array_key" => "value_to_push"}}).and_return(return_data)
+    collection.should_receive(:update).with({interface.primary_key.to_s => "value"}, { '$push' => { "array_key" => "value_to_push"}}).and_return(return_data)
 
-    interface.push_to_array(collection_name, :key, "value", :array_key, "value_to_push").should == return_data
+    interface.push_to_array(collection_name, "value", :array_key, "value_to_push").should == return_data
   end
 
   it 'can remove a value from an array for a specific record' do
-    collection.should_receive(:update).with({"key" => "value"}, { '$pull' => { "array_key" => "value_to_remove"}}).and_return(return_data)
+    collection.should_receive(:update).with({interface.primary_key.to_s => "value"}, { '$pull' => { "array_key" => "value_to_remove"}}).and_return(return_data)
 
-    interface.remove_from_array(collection_name, :key, "value", :array_key, "value_to_remove").should == return_data
+    interface.remove_from_array(collection_name, "value", :array_key, "value_to_remove").should == return_data
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: mince_mongo_db
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.3
-  prerelease: 6
+  version: 1.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Matt Simpson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -148,7 +148,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -156,23 +156,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mince
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.2
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
@@ -220,18 +220,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1499999616384769131
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: mince_mongo_db
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Lightweight MongoDB ORM for Ruby.