rubysync 0.0.1

data/examples/ar_webapp/public/robots.txt

@@ -0,0 +1 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file

data/examples/ar_webapp/script/about

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/about'

data/examples/ar_webapp/script/breakpointer

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/breakpointer'

data/examples/ar_webapp/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/console'

data/examples/ar_webapp/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/destroy'

data/examples/ar_webapp/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/generate'

data/examples/ar_webapp/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/benchmarker'

data/examples/ar_webapp/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/profiler'

data/examples/ar_webapp/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/plugin'

data/examples/ar_webapp/script/process/inspector

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/inspector'

data/examples/ar_webapp/script/process/reaper

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/reaper'

data/examples/ar_webapp/script/process/spawner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/spawner'

data/examples/ar_webapp/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/runner'

data/examples/ar_webapp/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/server'

data/examples/ar_webapp/test/fixtures/association_keys.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/hobbies.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/interests.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/people.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+bob:
+  id: 1
+  first_name: Bob
+  last_name: Roberts
+sean:
+  id: 2
+  first_name: Sean
+  last_name: Connery

data/examples/ar_webapp/test/fixtures/ruby_sync_events.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/ruby_sync_operations.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/ruby_sync_states.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/fixtures/ruby_sync_values.yml

@@ -0,0 +1,5 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+two:
+  id: 2

data/examples/ar_webapp/test/test_helper.rb

@@ -0,0 +1,28 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class Test::Unit::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Add more helper methods to be used by all tests here...
+end

data/examples/ar_webapp/test/unit/association_key_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncAssociationTest < Test::Unit::TestCase
+  fixtures :ruby_sync_associations
+
+  # Replace this with your real tests.
+
+end

data/examples/ar_webapp/test/unit/hobby_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HobbyTest < Test::Unit::TestCase
+  fixtures :hobbies
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ar_webapp/test/unit/interest_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class InterestTest < Test::Unit::TestCase
+  fixtures :interests
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ar_webapp/test/unit/person_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PersonTest < Test::Unit::TestCase
+  fixtures :people
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ar_webapp/test/unit/ruby_sync_event_test.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncEventTest < Test::Unit::TestCase
+  fixtures :ruby_sync_events
+
+  # Replace this with your real tests.
+  def test_event_type
+    assert_nil RubySyncEvent.find_by_event_type(:add), "Already add events"
+    event = RubySyncEvent.create :event_type=>:add
+    assert_not_nil event = RubySyncEvent.find_by_event_type(:add), "Add event not created"
+  end
+end

data/examples/ar_webapp/test/unit/ruby_sync_observer_test.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncObserverTest < Test::Unit::TestCase
+  fixtures :people
+
+  def test_destroy
+    assert_nil RubySyncEvent.find_by_event_type('delete'), "Delete events already present"
+    Person.destroy people('bob')
+    event = RubySyncEvent.find_by_event_type 'delete'
+    assert_not_nil event, "Delete event not created on destroy"
+    assert_equal people('bob').id, event.trackable_id
+    assert_equal 'Person', event.trackable_type
+  end
+
+
+  def test_add
+    assert_nil RubySyncEvent.find_by_event_type('add'), "Add events already present"
+    p = Person.create(:first_name=>"Ritchie", :last_name=>"Young")
+    event = RubySyncEvent.find_by_event_type 'add'
+    assert_not_nil event, "Add event not created on create"
+    assert_equal p.id, event.trackable_id
+    assert_equal 'Person', event.trackable_type
+    # Ensure the fields were populated correctly
+    fn = event.operations.find_by_operation_and_field_name 'add', 'first_name'
+    assert_not_nil fn, "No add first_name operation"
+    assert_equal 1, fn.values.length
+    assert_equal "Ritchie", fn.values[0].value 
+    fn = event.operations.find_by_operation_and_field_name 'add', 'last_name'
+    assert_not_nil fn, "No add last_name operation"
+    assert_equal 1, fn.values.length
+    assert_equal "Young", fn.values[0].value
+    #TODO: Add support for multi-value fields (AKA has_many associations)
+  end
+
+
+  def test_modify
+    assert_nil RubySyncEvent.find_by_event_type('modify'), "Modify events already present"
+    p = Person.find people('bob').id
+    assert_not_nil p, "Couldn't find bob"
+    p.first_name = "Mary"
+    p.save
+    event = RubySyncEvent.find_by_event_type 'modify'
+    assert_not_nil event, "Modify event not created on save"
+    assert_equal people('bob').id, event.trackable_id
+    assert_equal 'Person', event.trackable_type
+    # Ensure the fields were populated correctly
+    fn = event.operations.find_by_operation_and_field_name 'replace', 'first_name'
+    assert_not_nil fn, "No replace first_name operation"
+    assert_equal 1, fn.values.length
+    assert_equal "Mary", fn.values[0].value 
+    #TODO: Add support for multi-value fields (AKA has_many associations)
+  end
+
+
+
+  
+end

data/examples/ar_webapp/test/unit/ruby_sync_operation_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncOperationTest < Test::Unit::TestCase
+  fixtures :ruby_sync_operations
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ar_webapp/test/unit/ruby_sync_state_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncStateTest < Test::Unit::TestCase
+  fixtures :ruby_sync_states
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ar_webapp/test/unit/ruby_sync_value_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class RubySyncValueTest < Test::Unit::TestCase
+  fixtures :ruby_sync_values
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/ims2/connectors/hr_db_connector.rb

@@ -0,0 +1,8 @@
+class HrDbConnector < RubySync::Connectors::ActiveRecordConnector
+            options(
+            :name=>"HR Database",
+            :application=>"#{File.dirname(__FILE__)}/../../ar_webapp",
+            :model=>:person
+          )
+
+end

data/examples/ims2/connectors/my_csv_connector.rb

@@ -0,0 +1,12 @@
+class MyCsvConnector < RubySync::Connectors::CsvFileConnector
+            options(
+            :name=>"MyCSV",
+            :field_names=>['given name', 'last name', 'phone number', 'email'],
+            :path_field=>'email',
+            :in_path=>'/tmp/csv/in',
+            :out_path=>'/tmp/csv/out',
+            :in_glob=>'*.csv',
+            :out_extension=>'.csv'
+          )
+
+end

data/examples/ims2/pipelines/hr_import_pipeline.rb

@@ -0,0 +1,33 @@
+class HrImportPipeline < RubySync::Pipelines::BasePipeline
+
+  client :my_csv
+
+  vault :hr_db
+
+  # Remove any fields that you don't want to set in the client from the vault
+  allow_out :first_name, :last_name
+
+  # Remove any fields that you don't want to set in the vault from the client
+  allow_in :first_name, :last_name
+
+  # If the client and vault have different names for the same field, define the
+  # the mapping here. For example, if the vault has a field called "first name" and
+  # the client has a field called givenName you may put:
+  #    'first name' => 'givenName'
+  # separate each mapping with a comma.
+  # The following fields were detected on the client:
+  # 'given name', 'last name', 'phone number', 'email'
+  map_vault_to_client(
+    'first_name' => 'given name',
+		'last_name' => 'last name'
+  )
+
+  # "in" means going from client to vault
+  #in_transform do
+  #end
+
+  # "out" means going from vault to client
+  #out_transform do
+  #end
+
+end

data/examples/my_ims/connectors/corp_directory_connector.rb

@@ -0,0 +1,12 @@
+class CorpDirectoryConnector < RubySync::Connectors::LdapConnector
+ 
+ options(
+   :host=>'localhost',
+   :port=>10389,
+   :username=>'uid=admin,ou=system',
+   :password=>'secret',
+   :search_filter=>"cn=*",
+   :search_base=>"dc=example,dc=com"
+  )
+  
+end

data/examples/my_ims/connectors/finance_connector.rb

@@ -0,0 +1,7 @@
+class FinanceConnector < RubySync::Connectors::ActiveRecordConnector
+  options(
+    :application => "#{File.dirname(__FILE__)}/../../ar_client_webapp",
+    :model => :user
+  )
+
+end

data/examples/my_ims/connectors/hr_db_connector.rb

@@ -0,0 +1,7 @@
+class HrDbConnector < RubySync::Connectors::ActiveRecordConnector
+  
+  options(
+    :application => "#{File.dirname(__FILE__)}/../../ar_webapp",
+    :model => :person
+  )
+end

data/examples/my_ims/pipelines/finance_pipeline.rb

@@ -0,0 +1,33 @@
+class FinancePipeline < RubySync::Pipelines::BasePipeline
+
+  client :finance
+
+  vault :hr_db
+
+  # Remove any fields that you don't want to set in the client from the vault
+  allow_out :first_name
+
+  # Remove any fields that you don't want to set in the vault from the client
+  allow_in :first_name, :last_name
+
+  # If the client and vault have different names for the same field, define the
+  # the mapping here. For example, if the vault has a field called "first name" and
+  # the client has a field called givenName you may put:
+  #    'first name' => 'givenName'
+  # separate each mapping with a comma.
+  # The following fields were detected on the client:
+  # 'username', 'name', 'email'
+  map_vault_to_client(
+    'first_name' => 'name'
+		#'last_name' => 'a_client_field'
+  )
+
+  # in means going from client to vault
+  #in_transform do
+  #end
+
+  # out means going from vault to client
+  #out_transform do
+  #end
+
+end

data/examples/my_ims/pipelines/hr_import_pipeline.rb

@@ -0,0 +1,29 @@
+class HrImportPipeline < RubySync::Pipelines::BasePipeline
+
+  client :corp_directory
+  vault :hr_db
+
+  map_client_to_vault :givenname  => :first_name,
+                      :sn         => :last_name
+                      
+
+
+  allow_out :first_name, :last_name
+  allow_in :first_name, :last_name
+
+
+  # in means going from client to vault
+  #in_transform do
+  #end
+
+  # out means going from vault to client
+  out_transform do
+    add_default :cn, "Ritchie"
+  end
+
+  def out_place event
+    #event.target_path = "blah"
+    event.target_path = "cn=Ritchie,dc=example,dc=com"
+  end
+  
+end

data/lib/ruby_sync/connectors/active_record_connector.rb

@@ -0,0 +1,198 @@
+#!/usr/bin/env ruby
+#
+#  Copyright (c) 2007 Ritchie Young. All rights reserved.
+#
+# This file is part of RubySync.
+# 
+# RubySync is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+# 
+# RubySync is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along with RubySync; if not, write to the
+# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+
+require 'erb'
+$VERBOSE=false
+require "active_record"
+#$VERBOSE=true
+require "ruby_sync/connectors/base_connector"
+
+
+module RubySync::Connectors
+
+  # You can initialize this connector with the name of a model and the path to a rails application:
+  # eg: vault :ActiveRecord, :application=>'path/to/rails/application', :model=>:user
+  class ActiveRecordConnector < RubySync::Connectors::BaseConnector
+
+
+    attr_accessor :ar_class, :model, :application, :rails_env, :db_type, :db_host, :db_name
+    
+    def initialize options={}
+      super options
+      @rails_env ||= 'development'
+      @db_type ||= 'mysql'
+      @db_host ||= 'localhost'
+      @db_name ||= "rubysync_#{@rails_env}"
+      # Default db_config in case we're not sucking the config out of a rails app
+      @db_config = {
+        :adapter=>@db_type,
+        :host=>@db_host,
+        :database=>@db_name
+      }
+
+      # Rails app specified, use it to configure
+      if defined? @application
+        # Load the database configuration
+        rails_app_path = File.expand_path(@application, File.dirname(__FILE__))
+        db_config_filename = File.join(rails_app_path, 'config', 'database.yml')
+        @db_config = YAML::load(ERB.new(IO.read(db_config_filename)).result)[@rails_env]
+        # Require the models
+        log.debug "Loading the models for #{self.class.name}:"
+        Dir.chdir(File.join(rails_app_path,'app','models')) do
+          Dir.glob('*.rb') do |filename|
+            log.debug("\t#{filename}")
+            require filename
+            class_name = filename[0..-4].camelize
+            klass = class_name.constantize
+            klass.establish_connection @db_config if defined? klass.establish_connection
+          end
+        end
+      end
+
+      @model ||= :user
+      @ar_class ||= @model.to_s.camelize.constantize
+    end
+
+      
+      def self.fields
+        c = self.new
+        c.ar_class.content_columns.map {|col| col.name }
+      end
+      
+      def self.sample_config
+          return <<END
+          options(
+            #:application=>'/path/to/a/rails/application',
+            #:model=>'name_of_model_to_sync'
+          )
+END
+      end
+      
+      
+    # Process each RubySyncEvent and then delete it from the db.
+    def check
+      ::RubySyncEvent.find(:all).each do |rse|
+        event = RubySync::Event.new(rse.event_type, self, rse.trackable_id, nil, to_payload(rse))
+        yield event
+        ::RubySyncEvent.delete rse
+      end
+    end
+
+    # Create a hash suitable to use as rubysync event payload
+    def to_payload ar_event
+      ar_event.operations.map do |op|
+        RubySync::Operation.new(op.operation.to_sym, op.field_name, op.values.map {|v| v.value})
+      end
+    end
+
+    # Override default perform_add because ActiveRecord is different in that
+    # the target path is ignored when adding a record. ActiveRecord determines
+    # the id on creation.
+    def perform_add event
+      log.info "Adding '#{event.target_path}' to '#{name}'"
+      @ar_class.new() do |record|
+        populate(record, perform_operations(event.payload))
+        log.info(record.inspect)
+        record.save!
+        if is_vault?
+          associate event.association, record.id
+        end
+        record.id
+      end
+    rescue => ex
+      log.warn ex
+      #puts ex.backtrace.join("\n")
+      return nil
+    end
+
+      
+    def modify(path, operations)
+      @ar_class.find(path) do |record|
+        populate(record, perform_operations(operations))
+        record.save
+      end
+    end
+    
+    def delete(path)
+      @ar_class.destroy path
+    end
+  
+    # Implement vault functionality
+
+    def associate association, path
+      log.debug "Associating '#{association}' with '#{path}'"
+      ruby_sync_association.create :synchronizable_id=>path, :synchronizable_type=>@ar_class.name,
+                                   :context=>association.context, :key=>association.key
+    end
+
+    def find_associated association
+      ruby_sync_association.find_by_context_and_key association.context, association.key
+    end
+
+    def path_for_association association
+      assoc = ruby_sync_association.find_by_context_and_key association.context, association.key
+      (assoc)? assoc.synchronizable_id : nil
+    end
+
+    def association_key_for context, path
+      record = ruby_sync_association.find_by_synchronizable_id_and_synchronizable_type_and_context path, @model.to_s, context
+      record and record.key
+    end
+    
+    def associations_for(path)
+      ruby_sync_association.find_by_synchronizable_id_and_synchronizable_type(path, @model.to_s)
+    rescue ActiveRecord::RecordNotFound
+      return nil
+    end
+    
+    def remove_association association
+       ruby_sync_association.find_by_context_and_key(association.context, association.key).destroy
+    rescue ActiveRecord::RecordNotFound
+       return nil
+    end
+
+
+    def [](path)
+      @ar_class.find(path)
+    rescue ActiveRecord::RecordNotFound
+      return nil
+    end
+
+private
+
+    def ruby_sync_association
+      unless @ruby_sync_association
+        @ruby_sync_association = ::RubySyncAssociation
+        ::RubySyncAssociation.establish_connection(@db_config)
+      end
+      @ruby_sync_association
+    end
+
+    def populate record, content
+      @ar_class.content_columns.each do |c|
+        record[c.name] = content[c.name][0] if content[c.name]
+      end
+    end
+
+    def create_operations_for_active_record record
+      operations = record.class.content_columns.map do |col|
+        key = col.name
+        value = record.send key
+        RubySync::Operation.new(:add, key.to_s, value) if key and value
+      end
+      operations.compact
+    end
+  end
+end