mongar 0.0.4

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'linguistics'
+gem 'mongo'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bson (1.5.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linguistics (1.0.9)
+    mongo (1.5.1)
+      bson (= 1.5.1)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  linguistics
+  mongo
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Greenview Data, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,100 @@
+= mongar
+
+!! This is still fresh off the oven and hasn't been thoroughly tested yet in production. !!
+
+Ruby GEM to facilitate replicating data from ActiveRecord (or any data represented by a set of Ruby classes) to MongoDB.
+
+== Adding to a rails project
+
+Put your Mongar config into config/mongar.rb (See Example Config below)
+
+Put the following code into script/mongar.rb
+
+  require 'mongar'
+  mongar_config = File.join(Rails.root, 'config', 'mongar.rb')
+  mongar = eval(File.read(mongar_config))
+  mongar.run
+
+Run it with rails runner (rails 3.x) or script/runner (rails 2.x) script/mongar.rb
+
+== Example Config
+
+  Mongar.configure do
+    log_level :debug
+    
+    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
+
+      column :employee_count do
+        transform do |value|
+          value.nil? ? 0 : value
+        end
+      end
+    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
+    end
+  end
+
+== Contributing to mongar
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Greenview Data, Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongar"
+  gem.homepage = "http://github.com/gdi/mongar"
+  gem.license = "MIT"
+  gem.summary = %Q{Replicates data from ActiveRecord (or other Ruby data mapping class) to MongoDB}
+  gem.description = %Q{Replicates data from ActiveRecord (or other Ruby data mapping class) to MongoDB}
+  gem.email = "phil@greenviewdata.com"
+  gem.authors = ["Philippe Green"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/mongar/column.rb

@@ -0,0 +1,42 @@
+class Mongar
+  class Column
+    attr_accessor :name, :transformation, :is_indexed, :is_primary_index
+    
+    def initialize(args = {})
+      self.name = args[:name]
+      self.transformation = nil
+      self.is_indexed = false
+      self.is_primary_index = false
+    end
+    
+    def transform(proc_name = nil, &block)
+      self.transformation = lambda do
+        result = self
+        result = instance_exec(result, &block) if block_given?
+        result = result.send(proc_name) if proc_name
+        result
+      end
+    end
+    
+    def transform_this(object)
+      return object unless transformation && transformation.is_a?(Proc)
+      object.instance_exec(&transformation)
+    end
+    
+    def index
+      self.is_indexed = true
+    end
+    
+    def primary_index
+      self.is_primary_index = true
+    end
+    
+    def indexed?
+      self.is_indexed
+    end
+    
+    def primary_index?
+      self.is_primary_index
+    end
+  end
+end

data/lib/mongar/logger.rb

@@ -0,0 +1,15 @@
+class Mongar
+  module Logger
+    def info(log_message)
+      return unless @log_level && [:info, :debug].include?(@log_level)
+      
+      puts "Info: #{log_message}"
+    end
+    
+    def debug(log_message)
+      return unless @log_level && @log_level == :debug
+      
+      puts "Debug: #{log_message}"
+    end
+  end
+end

data/lib/mongar/mongo/collection.rb

@@ -0,0 +1,93 @@
+class Mongar::Mongo
+  class Collection
+    include Mongar::Logger
+    
+    attr_reader :name, :log_level
+    attr_accessor :replica
+    
+    def initialize(args = {})
+      @name = args[:name]
+      @replica = args[:replica]
+      @log_level = args[:log_level]
+    end
+    
+    def mongodb
+      replica.mongodb
+    end
+    
+    def connection
+      mongodb.connection!
+    end
+    
+    def database
+      mongodb.db
+    end
+    
+    def collection
+      database[name]
+    end
+    
+    def status_collection
+      mongodb.status_collection_accessor
+    end
+    
+    def last_replicated_at
+      status = status_collection.find_one({ :collection_name => name })
+      return Time.parse("1/1/1902 00:00:00") unless status && status['last_replicated_at']
+      status['last_replicated_at']
+    end
+    
+    def last_replicated_at=(date)
+      info "Saving #{name} last_replicated_at to #{date}"
+      status_collection.update({ :collection_name => name }, 
+                               { :collection_name => name, :last_replicated_at => date }, 
+                               { :upsert => true })
+    end
+    
+    def find(key)
+      debug "#{name}.find #{key.inspect}"
+      collection.find_one(key)
+    end
+    
+    def create(document)
+      debug "#{name}.create #{document.inspect}"
+      !collection.insert(document).nil?
+    end
+    
+    def delete(key)
+      debug "#{name}.delete #{key.inspect}"
+      collection.remove(key, { :safe => true })
+    end
+    
+    def update(key, document)
+      debug "#{name}.update #{key.inspect} with #{document.inspect}"
+      collection.update(key, document, { :safe => true })
+    end
+    
+    def create_or_update(key, document)
+      debug "#{name}.create_or_update #{key.inspect} with #{document.inspect}"
+      
+      collection.update(key, document, {:upsert => true, :safe => true})
+    end
+    
+    def mark_all_items_pending_deletion
+      info "Marking all items in #{name} for pending deletion"
+      
+      collection.update({ '_id' => { '$exists' => true } }, { "$set" => { :pending_deletion => true } }, { :multi => true, :safe => true })
+    end
+    
+    def delete_all_items_pending_deletion
+      info "Deleting all items in #{name} that are pending deletion"
+      
+      collection.remove({ :pending_deletion => true }, { :safe => true })
+    end
+    
+    [:create, :delete, :update, :create_or_update, :mark_all_items_pending_deletion, :delete_all_items_pending_deletion].each do |method_name|
+      define_method(:"#{method_name}!") do |*args|
+        result = self.send(method_name, *args)
+        raise StandardError, "#{method_name} returned #{result.inspect}" unless result == true || result['err'].nil?
+        result
+      end
+    end
+  end
+end

data/lib/mongar/mongo.rb

@@ -0,0 +1,51 @@
+require 'mongo'
+class Mongar
+  class Mongo
+    autoload :Collection, 'mongar/mongo/collection'
+    
+    attr_reader :name
+    
+    class << self
+      def databases
+        @databases ||= {}
+      end
+    end
+    
+    def initialize(args = {})
+      args.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+      
+      @host ||= '127.0.0.1'
+      @port ||= 27017
+      @status_collection ||= 'statuses'
+    end
+    
+    [:database, :user, :password, :host, :port, :status_collection].each do |attr_name|
+      define_method(attr_name) do |*args|
+        val = args.first
+        return instance_variable_get(:"@#{attr_name}") if val.nil?
+        instance_variable_set(:"@#{attr_name}", val)
+      end
+    end
+    
+    def connection
+      @connection = ::Mongo::Connection.new(host, port)
+      return @connection if self.user.nil? || @connection.authenticate(user, password)
+      @connection.close
+      @connection = nil
+    end
+    
+    def connection!
+      connection or raise StandardError, "Could not establish '#{name}' MongoDB connection for #{database} at #{host}:#{port}"
+    end
+    
+    def db
+      @db ||= connection!.db(database.to_s)
+    end
+    
+    def status_collection_accessor
+      db[status_collection]
+    end
+  end
+end

data/lib/mongar/replica.rb

@@ -0,0 +1,153 @@
+class Mongar
+  class Replica
+    include Mongar::Logger
+    
+    attr_accessor :source, :destination, :log_level
+    attr_accessor :mongodb_name
+    attr_accessor :created_finder, :deleted_finder, :updated_finder
+    attr_accessor :columns
+    
+    def initialize(args = {})
+      self.log_level = args[:log_level]
+      self.source = args[:source]
+      self.destination = args[:destination]
+      self.mongodb_name = args[:mongodb_name] || :default
+      self.columns = []
+      
+      self.destination.replica = self if self.destination
+      
+      self.deleted_finder = lambda do |last_replicated_at|
+        find_every_with_deleted(:conditions => ["deleted_at > ?", last_replicated_at])
+      end
+      self.created_finder = Proc.new do |last_replicated_at|
+        find(:all, :conditions => ["created_at > ? AND deleted_at IS NULL", last_replicated_at])
+      end
+      self.updated_finder = Proc.new do |last_replicated_at|
+        find(:all, :conditions => ["updated_at > ? AND deleted_at IS NULL", last_replicated_at])
+      end 
+    end
+    
+    def run
+      time = Time.now
+      if do_full_refresh?
+        info "Running full refresh on Replica #{source.to_s} to #{destination.name}"
+        
+        destination.mark_all_items_pending_deletion!
+        
+        run_sync_for([:created_or_updated], Time.parse('1/1/1902 00:00:00'))
+        
+        destination.delete_all_items_pending_deletion!
+      else
+        last_replicated_at = destination.last_replicated_at
+        
+        info "Running incremental replication on Replica #{source.to_s} to #{destination.name} from #{last_replicated_at}"
+        
+        run_sync_for([:deleted, :created_or_updated, :updated], last_replicated_at)
+      end
+      destination.last_replicated_at = time
+    end
+    
+    def run_sync_for(types, last_replicated_at)
+      # find deleted
+      find(:deleted, last_replicated_at).each do |deleted_item|
+        destination.delete! source_object_to_primary_key_hash(deleted_item)
+      end if types.include?(:deleted)
+      
+      # find created
+      find(:created, last_replicated_at).each do |created_item|
+        destination.create! source_object_to_hash(created_item)
+      end if types.include?(:created)
+      
+      # find created & updated
+      find(:created, last_replicated_at).each do |created_item|
+        destination.create_or_update! source_object_to_primary_key_hash(created_item), source_object_to_hash(created_item)
+      end if types.include?(:created_or_updated)
+      
+      # find updated
+      find(:updated, last_replicated_at).each do |updated_item|
+        destination.update! source_object_to_primary_key_hash(updated_item), source_object_to_hash(updated_item)
+      end if types.include?(:updated)
+    end
+    
+    def source_object_to_hash(object)
+      columns.inject({}) do |hash, column|
+        name = column.name.to_sym
+        hash[name] = column.transform_this(object.send(name))
+        hash
+      end
+    end
+    
+    def source_object_to_primary_key_hash(object)
+      column = primary_index
+      { column.name => column.transform_this(object.send(column.name.to_sym)) }
+    end
+    
+    def column(name, &block)
+      new_column = Mongar::Column.new(:name => name)
+      new_column.instance_eval(&block) if block_given?
+      self.columns << new_column
+      new_column
+    end
+    
+    def primary_index
+      columns.find { |c| c.primary_index? }
+    end
+    
+    def full_refresh(condition = nil)
+      return @full_refresh if condition.nil?
+      
+      @full_refresh = if condition[:if]
+        condition[:if]
+      elsif condition[:every]
+        condition[:every]
+      else
+        raise StandardError, 'You must specify either :if or :every as a condition for full refresh'
+      end
+    end
+    
+    def use_mongodb(name)
+      self.mongodb_name = name
+    end
+    
+    def mongodb_name=(val)
+      @mongodb = nil
+      @mongodb_name = val
+    end
+    
+    def mongodb
+      return nil unless mongodb_name
+      @mongodb ||= Mongar::Mongo.databases[mongodb_name]
+    end
+    
+    def do_full_refresh?(last_replicated_time = nil)
+      last_replicated_time ||= destination.last_replicated_at
+      
+      if @full_refresh.nil?
+        false
+      elsif @full_refresh.is_a?(Proc)
+        source.instance_exec last_replicated_time, &@full_refresh
+      elsif last_replicated_time.nil?
+        true
+      else
+        (Time.now - last_replicated_time) > @full_refresh
+      end
+    end
+    
+    def find(type, last_replicated_time)
+      finder_function = self.send("#{type}_finder".to_sym)
+      return [] if finder_function.nil?
+      # execute the finder proc on the source object with an argument of the last replicated date/time
+      source.instance_exec(last_replicated_time, &finder_function) || []
+    end
+    
+    [:deleted, :created, :updated].each do |finder_type|
+      define_method("set_#{finder_type}_finder".to_sym) do |&block|
+        self.send("#{finder_type}_finder=".to_sym, block)
+      end
+      
+      define_method("no_#{finder_type}_finder") do
+        self.send("#{finder_type}_finder=".to_sym, nil)
+      end
+    end
+  end
+end

data/lib/mongar.rb

@@ -0,0 +1,65 @@
+require 'linguistics'
+
+class Mongar
+  autoload :Replica, 'mongar/replica'
+  autoload :Column, 'mongar/column'
+  autoload :Mongo, 'mongar/mongo'
+  autoload :Logger, 'mongar/logger'
+
+  include Mongar::Logger
+
+  Linguistics.use :en  
+  
+  attr_accessor :replicas, :status_collection, :log_level
+  
+  class << self
+    def configure &block
+      mongar = self.new
+      mongar.instance_eval(&block)
+      mongar
+    end
+  end
+  
+  def initialize
+    self.replicas = []
+  end
+  
+  def log_level(level = nil)
+    return @log_level if level.nil?
+    @log_level = level
+  end
+  
+  def run
+    replicas.each do |replica|
+      replica.run
+    end
+  end
+  
+  def replicate(what, &block)
+    if what.is_a?(Hash)
+      source = what.keys.first
+      destination = what.values.first
+    else
+      source = what
+      destination = what.to_s.downcase.en.plural
+    end
+    
+    destination = Mongar::Mongo::Collection.new(:name => destination, :log_level => log_level)
+    
+    self.replicas ||= []
+    replica = Replica.new(:source => source, :destination => destination, :log_level => log_level)
+    replica.instance_eval(&block)
+    self.replicas << replica
+  end
+  
+  def mongo(name, &block)
+    mongo_db = Mongar::Mongo.new(:name => name)
+    mongo_db.instance_eval(&block)
+    Mongar::Mongo.databases[name] = mongo_db
+    mongo_db
+  end
+  
+  def set_status_collection(val)
+    self.status_collection = val
+  end
+end