mongar 0.0.4

data/mongar.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongar"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Philippe Green"]
+  s.date = "2011-12-14"
+  s.description = "Replicates data from ActiveRecord (or other Ruby data mapping class) to MongoDB"
+  s.email = "phil@greenviewdata.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mongar.rb",
+    "lib/mongar/column.rb",
+    "lib/mongar/logger.rb",
+    "lib/mongar/mongo.rb",
+    "lib/mongar/mongo/collection.rb",
+    "lib/mongar/replica.rb",
+    "mongar.gemspec",
+    "spec/fixtures/configure.rb",
+    "spec/fixtures/full_configure.rb",
+    "spec/fixtures/sources.rb",
+    "spec/integration_spec.rb",
+    "spec/mongar/column_spec.rb",
+    "spec/mongar/mongo/collection_spec.rb",
+    "spec/mongar/mongo_spec.rb",
+    "spec/mongar/replica_spec.rb",
+    "spec/mongar_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/gdi/mongar"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Replicates data from ActiveRecord (or other Ruby data mapping class) to MongoDB"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<linguistics>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<linguistics>, [">= 0"])
+      s.add_dependency(%q<mongo>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<linguistics>, [">= 0"])
+    s.add_dependency(%q<mongo>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/fixtures/configure.rb

@@ -0,0 +1,27 @@
+Mongar.configure do
+  mongo :default do
+    database 'integration_spec'
+    
+    status_collection 'stati'
+  end
+  
+  replicate Domain do
+    column :name do
+      primary_index
+    end
+    
+    column :client_id
+    
+    set_deleted_finder do |last_replicated_date|
+      deleted_since last_replicated_date
+    end
+
+    set_updated_finder do |last_replicated_date|
+      updated_since last_replicated_date
+    end
+
+    set_created_finder do |last_replicated_date|
+      created_since last_replicated_date
+    end
+  end
+end

data/spec/fixtures/full_configure.rb

@@ -0,0 +1,60 @@
+Mongar.configure do
+  mongo :default do
+    database 'mydb'
+    user 'mongouser'
+    password 'password'
+    host '127.0.0.1'
+    port 27017
+  end
+  
+  mongo :otherdb do
+    database 'mydb'
+    user 'mongouser'
+    password 'password'
+    
+    status_collection :statuses
+  end
+  
+  replicate Domain => 'domains' do
+    use_mongodb :otherdb
+    
+    full_refresh :every => 60.minutes
+    
+    column :uri do
+      primary_index
+      transform :downcase
+    end
+    
+    column :allow_anyone_to_anyone_policy
+  end
+  
+  replicate Client do
+    column :id do
+      primary_index
+    end
+    
+    column :name
+  end
+  
+  replicate EmailAddress do
+    no_deleted_finder
+    set_updated_finder do |last_replicated_date|
+      find(:all, :conditions => ['something > ?', last_replicated_date])
+    end
+    set_created_finder do |last_replicated_date|
+      created_scope(last_replicated_date)
+    end
+    
+    full_refresh :if => Proc.new do |last_replicated_date|
+      # class eval'ed code
+      any_changes_since?(last_replicated_date)
+    end
+    
+    column :address do
+      index
+      transform do |value|
+        # some code to perform on the value
+      end
+    end
+  end
+end

data/spec/fixtures/sources.rb

@@ -0,0 +1,62 @@
+class Domain
+  attr_accessor :name, :client_id
+  attr_accessor :created_at, :updated_at, :deleted_at
+  
+  def initialize(args = {})
+    args.each do |key, value|
+      self.send(:"#{key}=", value)
+    end
+    self.created_at = Time.now
+  end
+  
+  def name=(val)
+    self.updated_at = Time.now
+    @name = val
+  end
+  
+  def client_id=(val)
+    self.updated_at = Time.now
+    @client_id = val
+  end
+  
+  class << self
+    def create(args)
+      @@items ||= []
+      d = Domain.new(args)
+      @@items << d
+      d
+    end
+    
+    def deleted_since(last_replicated_date)
+      last_replicated_date ||= Time.parse("1/1/1900 00:00:00")
+      #puts "Deleted Since: #{last_replicated_date} #{@@items.length}"
+        
+      @@items.find_all { |d| d.deleted_at && d.deleted_at > last_replicated_date }
+    end
+    
+    def created_since(last_replicated_date)
+      last_replicated_date ||= Time.parse("1/1/1900 00:00:00")
+      #puts "Created Since: #{last_replicated_date}"
+      
+      @@items.find_all { |d| !d.deleted_at && d.created_at && d.created_at > last_replicated_date }
+    end
+    
+    def updated_since(last_replicated_date)
+      last_replicated_date ||= Time.parse("1/1/1900 00:00:00")
+      #puts "Updated Since: #{last_replicated_date}"
+      
+      @@items.find_all { |d| !d.deleted_at && d.updated_at && d.updated_at > last_replicated_date }
+    end
+  end
+  
+  def destroy
+    self.deleted_at = Time.now
+    #puts "I was deleted at #{deleted_at}"
+  end
+end
+
+class Client
+end
+
+class EmailAddress
+end

data/spec/integration_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'sources'))
+
+describe "Mongar" do
+  before(:all) do
+    mongo = Mongar::Mongo.new(:name => :default, 
+                              :database => :integration_spec)
+    mongo.connection!.drop_database('integration_spec')
+  end
+  describe "run" do
+    before do
+      config_path = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'configure.rb'))
+      @mongar = eval(File.read(config_path))
+      
+      @collection = Mongar::Mongo.databases[:default].db['domains']
+    end
+    
+    it "should add, delete, and update items properly" do
+      # inserts
+      domain = Domain.create(:name => "test.com", :client_id => 1)
+      @mongar.run
+      @collection.find_one({ :name => 'test.com' }).should include({'name' => 'test.com', 'client_id' => 1})
+      
+      # updates
+      sleep 1
+      domain.client_id = 2
+      @mongar.run
+      @collection.find_one({ :name => 'test.com' }).should include({'name' => 'test.com', 'client_id' => 2})
+
+      # deletes
+      sleep 1
+      domain.destroy
+      @mongar.run
+      @collection.find_one({:name => "test.com"}).should be_nil
+      
+      collection = Mongar::Mongo.databases[:default].db['stati']
+      collection.find_one({ :collection_name => 'domains' }).should_not be_nil
+    end
+    
+    it "should handle an item that was added, updated, and deleted between runs" do
+      domain = Domain.create(:name => "test1.com", :client_id => 1)
+      domain.client_id = 2
+      domain.destroy
+      
+      @mongar.run
+      
+      @collection.find_one({:name => "test1.com"}).should be_nil
+    end
+  end
+end

data/spec/mongar/column_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Mongar::Replica" do
+  before do
+    @column = Mongar::Column.new(:name => :first_name)
+  end
+  describe "#name" do
+    it "should return the column name" do
+      @column.name.should == :first_name
+    end
+  end
+  describe "#transform" do
+    it "should optionally take a symbol, and set transformation to a block that executes that procedure" do
+      @column.transform :downcase
+      @column.transform_this("Something").should == 'something'
+    end
+    it "should optionally take a block" do
+      @column.transform do |value|
+        value.nil? ? 0 : value
+      end
+      @column.transform_this(nil).should == 0
+      @column.transform_this(1).should == 1
+    end
+    it "should take both a block and a symbol if you wish" do
+      @column.transform :reverse do
+        downcase
+      end
+      @column.transform_this("Something").should == 'gnihtemos'
+    end
+    it "should return the original value if there is no transformation specified" do
+      @column.transform_this("blah").should == "blah"
+    end
+  end
+  describe "#index" do
+    before do
+      @column.index
+    end
+    it "should set column#indexed? to true" do
+      @column.indexed?.should be_true
+    end
+  end
+  describe "#primary_index" do
+    before do
+      @column.primary_index
+    end
+    it "should set column#primary_index? to true" do
+      @column.primary_index?.should be_true
+    end
+  end
+end

data/spec/mongar/mongo/collection_spec.rb

@@ -0,0 +1,201 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Mongar::Mongo::Collection" do
+  after(:all) do
+    # Completely clear out the database
+    mongo = Mongar::Mongo.new(:name => :default, 
+                              :database => :mongar_test)
+    mongo.connection!.drop_database('mongar_test')
+  end
+  
+  before do
+    @mongo = Mongar::Mongo.new(:name => :default, 
+                               :database => :mongar_test)
+                               
+    @mongo.db.collections.each do |collection|
+        collection.remove
+    end
+    
+    Mongar::Mongo.databases[:default] = @mongo
+    @replica = Mongar::Replica.new(:mongodb_name => :default)
+    @collection = Mongar::Mongo::Collection.new(:name => 'clients', :replica => @replica)
+    
+    @existing_key = { :id => 123 }
+    @existing_document = { :id => 123, :name => 'Otis' }
+    
+    @new_key = { :id => 1234 }
+    @new_document = { :id => 1234, :name => 'George' }
+  end
+  
+  describe ".new" do
+    it "should return a new collection" do
+      @collection.should be_a_kind_of(Mongar::Mongo::Collection)
+    end
+  end
+  
+  describe "#database" do
+    it "should not be nil" do
+      @collection.database.should_not be_nil
+    end
+  end
+  
+  describe "#find" do
+    before do
+      @collection.create!({ :id => 2, :test => 1 })
+    end
+    it "should return nil if it can't find the document" do
+      @collection.find({ :id => 1 }).should be_nil
+    end
+    it "should return the document found" do
+      @collection.find({ :id => 2 }).should include({"id"=>2, "test"=>1})
+    end
+  end
+  
+  describe "#create_or_update" do
+    it "should update an existing document" do
+      @collection.create_or_update(@existing_key, @existing_document).should be_true
+    end
+    it "should create a new document" do
+      @collection.create_or_update(@new_key, @new_document).should be_true
+      @collection.find({:id => 1234}).should_not be_nil
+    end
+  end
+  
+  describe "#create_or_update!" do
+    it "should call create_or_update and return true on success" do
+      @collection.should_receive(:create_or_update).with({ :a => 1 }, { :a => 1, :b => 2 }).and_return(true)
+      @collection.create_or_update!({ :a => 1 }, { :a => 1, :b => 2 }).should be_true
+    end
+    
+    it "should call create_or_update and raise an error on failure" do
+      @collection.stub!(:create_or_update).with({ :a => 1 }, { :a => 1, :b => 2 }).and_return(false)
+      lambda { @collection.create_or_update!({ :a => 1 }, { :a => 1, :b => 2 }) }.should raise_error
+    end
+  end
+  
+  describe "#mark_all_items_pending_deletion" do
+    before do
+      @collection.create_or_update(@new_key, @new_document)
+    end
+    
+    it "should mark every item with { :pending_deletion => true }" do
+      @collection.mark_all_items_pending_deletion
+      updated_doc = @collection.find(@new_key)
+      updated_doc['pending_deletion'].should be_true
+    end
+  end
+  
+  describe "#mark_all_items_pending_deletion!" do
+    it "should call mark_all_items_pending_deletion and return true on success" do
+      @collection.should_receive(:mark_all_items_pending_deletion).and_return(true)
+      @collection.mark_all_items_pending_deletion!({}, {}).should be_true
+    end
+
+    it "should call mark_all_items_pending_deletion and raise an error on failure" do
+      @collection.stub!(:mark_all_items_pending_deletion).and_return(false)
+      lambda { @collection.mark_all_items_pending_deletion!({}, {}) }.should raise_error
+    end
+  end
+  
+  describe "#delete_all_items_pending_deletion" do
+    before do
+      @collection.create!({ :id => 1, :test => 1, :pending_deletion => true })
+      @collection.create!({ :id => 2, :test => 1, :pending_deletion => false })
+      @collection.create!({ :id => 3, :test => 1 })
+    end
+    
+    it "should delete all items where { :pending_deletion => true }" do
+      @collection.delete_all_items_pending_deletion
+      @collection.find({ :id => 1 }).should be_nil
+    end
+    it "should not delete items where { :pending_deletion => false }" do
+      @collection.delete_all_items_pending_deletion
+      @collection.find({ :id => 2 }).should_not be_nil
+    end
+    it "should not delete items where :pending_deletion key does not exist" do
+      @collection.delete_all_items_pending_deletion
+      @collection.find({ :id => 3 }).should_not be_nil
+    end
+  end
+  
+  describe "#delete_all_items_pending_deletion!" do
+    it "should call delete_all_items_pending_deletion and return true on success" do
+      @collection.should_receive(:delete_all_items_pending_deletion).and_return(true)
+      @collection.delete_all_items_pending_deletion!({}, {}).should be_true
+    end
+
+    it "should call delete_all_items_pending_deletion and raise an error on failure" do
+      @collection.stub!(:delete_all_items_pending_deletion).and_return(false)
+      lambda { @collection.delete_all_items_pending_deletion!({}, {}) }.should raise_error
+    end
+  end
+  
+  describe "#delete" do
+    it "should delete a document" do
+      @collection.delete(@existing_key).should be_true
+    end
+    
+    it "should return true even if the document didn't exist" do
+      @collection.delete({ :id => 83838 }).should be_true
+    end
+  end
+  
+  describe "#delete!" do
+    it "should call delete and return true on success" do
+      @collection.should_receive(:delete).and_return(true)
+      @collection.delete!({}, {}).should be_true
+    end
+
+    it "should call delete and raise an error on failure" do
+      @collection.stub!(:delete).and_return(false)
+      lambda { @collection.delete!({}, {}) }.should raise_error
+    end
+  end
+  
+  describe "#create" do
+    it "should create a new document" do
+      @collection.create(@new_document).should be_true
+    end
+  end
+  
+  describe "#create!" do
+    it "should call create and return true on success" do
+      @collection.should_receive(:create).and_return(true)
+      @collection.create!({}, {}).should be_true
+    end
+
+    it "should call create and raise an error on failure" do
+      @collection.stub!(:create).and_return(false)
+      lambda { @collection.create!({}, {}) }.should raise_error
+    end
+  end
+  
+  describe "#update" do
+    it "should update the document" do
+      @collection.update(@existing_key, { :name => 'Phil' }).should be_true
+    end
+  end
+  
+  describe "#update!" do
+    it "should call update and return true on success" do
+      @collection.should_receive(:update).and_return(true)
+      @collection.update!({}, {}).should be_true
+    end
+
+    it "should call update and raise an error on failure" do
+      @collection.stub!(:update).and_return(false)
+      lambda { @collection.update!({}, {}) }.should raise_error
+    end
+  end
+  
+  describe "#last_replicated_at" do
+    it "should return the last replicated_at date" do
+      response = @collection.last_replicated_at = Time.parse("1/1/2012 1:00:00")
+      @collection.last_replicated_at.should == Time.parse("1/1/2012 1:00:00")
+    end
+    
+    it "should return 1/1/1902 00:00:00 if there was no last_replicated_at" do
+      @collection.last_replicated_at.should == Time.parse("1/1/1902 00:00:00")
+    end
+  end
+end

data/spec/mongar/mongo_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Mongar::Mongo" do
+  before do
+    @mongo = Mongar::Mongo.new(:name => :somedb, 
+                               :database => :mydb, 
+                               :user => 'mongouser',
+                               :password => 'password',
+                               :host => '127.0.0.99',
+                               :port => 9999,
+                               :status_collection => 'stati')
+  end
+  
+  describe "#database" do
+    it "should set the database name if an argument is passed" do
+      @mongo.database(:something)
+      @mongo.instance_variable_get(:"@database").should == :something
+    end
+    
+    it "should return the database name if no argument is passed" do
+      @mongo.database.should == :mydb
+    end
+  end
+  
+  describe "#user" do
+    it "should set the user if an argument is passed" do
+      @mongo.user(:something)
+      @mongo.instance_variable_get(:"@user").should == :something
+    end
+    
+    it "should return the user if no argument is passed" do
+      @mongo.user.should == 'mongouser'
+    end
+  end
+  
+  describe "#password" do
+    it "should set the password if an argument is passed" do
+      @mongo.password(:something)
+      @mongo.instance_variable_get(:"@password").should == :something
+    end
+    
+    it "should return the password if no argument is passed" do
+      @mongo.password.should == 'password'
+    end
+  end
+  
+  describe "#host" do
+    it "should set the host if an argument is passed" do
+      @mongo.host(:something)
+      @mongo.instance_variable_get(:"@host").should == :something
+    end
+    
+    it "should return the host if no argument is passed" do
+      @mongo.host.should == '127.0.0.99'
+    end
+    
+    it "should default to 127.0.0.1" do
+      Mongar::Mongo.new.host.should == '127.0.0.1'
+    end
+  end
+  
+  describe "#port" do
+    it "should set the port if an argument is passed" do
+      @mongo.port(:something)
+      @mongo.instance_variable_get(:"@port").should == :something
+    end
+    
+    it "should return the port if no argument is passed" do
+      @mongo.port.should == 9999
+    end
+    
+    it "should default to 27017" do
+      Mongar::Mongo.new.port.should == 27017
+    end
+  end
+  
+  describe "#status_collection" do
+    it "should set the status_collection if an argument is passed" do
+      @mongo.status_collection(:something)
+      @mongo.instance_variable_get(:"@status_collection").should == :something
+    end
+    
+    it "should return the status_collection if no argument is passed" do
+      @mongo.status_collection.should == 'stati'
+    end
+    
+    it "should default to statuses" do
+      Mongar::Mongo.new.status_collection.should == 'statuses'
+    end
+  end
+end