rubysync 0.0.1

data/test/ruby_sync_test.rb

@@ -0,0 +1,48 @@
+#!/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
+
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+
+require 'ruby_sync'
+require 'test/unit'
+
+module RubySyncTest
+
+
+  def initialize(test)
+    super(test)
+    @bob_details = {'givenName'=>['Robert'],
+                    'sn'=>['Smith'],
+                    'interests'=>['music', 'makeup']
+    }
+  end
+  
+
+  def setup
+    @pipeline = TestPipeline.new
+    @client = @pipeline.client
+    @vault = @pipeline.vault
+    @client.delete(client_path) if @client[client_path]
+    @vault.delete(vault_path) if @vault[vault_path]
+  end  
+
+  def banner(label)
+    puts '*' * 10 + " #{label} " + '*' * 10
+  end
+  
+  
+end

data/test/test_active_record_vault.rb

@@ -0,0 +1,113 @@
+#!/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
+
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+
+require 'ruby_sync_test'
+
+class MyActiveRecordConnector < RubySync::Connectors::ActiveRecordConnector
+  options(
+    :model=>:person,
+    :application=>"#{File.dirname(__FILE__)}/../examples/ar_webapp"
+    )
+end
+class MyMemoryConnector < RubySync::Connectors::MemoryConnector; end
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+  client :my_memory
+  vault :my_active_record
+  
+  allow_in :first_name, :last_name
+  allow_out :first_name, :last_name
+  
+  map_client_to_vault :givenName  => :first_name,
+                      :sn         => :last_name
+end
+
+
+
+class TestActiveRecordVault < Test::Unit::TestCase
+
+  include RubySyncTest
+
+  def client_path
+    'bob'
+  end
+  
+  def vault_path
+    @vault.path_for_association(RubySync::Association.new(@pipeline.association_context, self.client_path))
+  end
+
+  def initialize(test)
+    super(test)
+  end
+    
+    def start
+      # Wipe existing database content
+      # TODO: Find out how rails does this.
+      ::RubySyncAssociation.delete_all
+      ::Person.delete_all
+    end
+  
+  def test_client_to_vault
+    banner "test_client_to_vault"
+    @client.add client_path, @client.create_operations_for(@bob_details)
+    assert_nil find_bob, "Vault already contains bob"
+    @pipeline.run_once
+    assert_not_nil find_bob, "#{vault_path} wasn't created on the vault"
+    #assert_equal @bob_details, @vault[vault_path].reject {|k,v| [:modifier,:association].include? k}
+    if @client.respond_to? :delete
+      @client.delete client_path
+#      assert_equal @bob_details, @vault[vault_path].reject {|k,v| [:modifier,:association].include? k}
+      assert_nil @client[client_path], "Bob wasn't deleted from the client"
+      @pipeline.run_once
+      assert_nil @client[client_path], "Bob reappeared on the client"
+      assert_nil find_bob, "Bob wasn't deleted from the vault"
+      @pipeline.run_once # run again in case of echoes
+      assert_nil @client[client_path], "Bob reappeared on the client"
+      assert_nil find_bob, "Bob reappeared in the vault. He may have been created by an echoed add event"
+    end
+  end
+  
+  def test_vault_to_client
+    # Turn on the RubySyncObserver to track the changes to people
+    #ActiveRecord::Base.observers = ::RubySyncObserver
+    ::RubySyncObserver.observe ::Person
+    ::RubySyncObserver.instance
+    assert_nil ::RubySyncEvent.find(:first), "Pre-existing events in queue"
+    person = Person.create :first_name=>"Ritchie", :last_name=>"Young"
+    assert_not_nil ::RubySyncEvent.find_by_event_type('add'), "No add event generated"
+    @pipeline.run_once
+    # Find the association and use the key to look up the record on the client
+    key = @vault.association_key_for @pipeline.association_context, person.id
+    assert_not_nil key, "No association seems to have been created"
+    c_person = @client.entry_for_own_association_key key
+    assert_not_nil c_person, "Person wasn't created on client from vault; key='#{key}'\nClient contains:\n#{@client.inspect}"
+    assert_equal "Ritchie", c_person['givenName'][0]
+    assert_equal "Young", c_person['sn'][0]
+    ActiveRecord::Base.observers = [] # Stop tracking changes to people
+  end
+  
+  def find_bob
+    Person.find_by_first_name "Robert"
+  end
+  
+  def test_fields
+    assert_equal(%w{first_name last_name}.sort, ::MyActiveRecordConnector.fields.sort)
+  end
+  
+end

data/test/test_csv_file_connector.rb

@@ -0,0 +1,75 @@
+#!/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
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+
+require 'ruby_sync_test'
+require 'ruby_sync/connectors/csv_file_connector'
+require 'ruby_sync/connectors/memory_connector'
+require 'csv'
+
+
+class TestCsvFileConnector < RubySync::Connectors::CsvFileConnector
+end
+
+class TestMemoryConnector < RubySync::Connectors::MemoryConnector
+end
+
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+  client :test_csv_file,
+         :field_names => ['id', 'given name', 'last name', 'email'],
+         :path_field => 'id',
+         :in_path => File.expand_path("~/rubysync/csv_test/in"),
+         :out_path => File.expand_path("~/rubysync/csv_test/out")
+         
+  vault :test_memory
+  
+  map_client_to_vault 'id'=>:cn,
+                      'given name'=>:givenName,
+                      'last name'=>:sn,
+                      "email"=>:mail
+  
+end
+
+class TestCsvConnector < Test::Unit::TestCase
+  
+  include RubySyncTest
+    
+  def setup
+    @pipeline = TestPipeline.new
+    @client = @pipeline.client
+    @vault = @pipeline.vault
+    @filename = "#{@client.in_path}/client_to_vault.csv"
+    @pipeline.run_once # create the in and out directories if necessary
+    File.delete @filename if File.exists? @filename
+    @bob_details = {:cn=>'bob', :givenName=>"Robert", :sn=>"Smith", :mail=>'bob@thecure.com'}
+  end
+
+  def test_client_to_vault
+    banner :test_client_to_vault
+    CSV.open(@filename, 'w') do |csv|
+      csv << [:cn, :givenName, :sn, :mail].collect {|key| @bob_details[key]}
+    end
+    assert_nil @vault["bob"], "Vault already contains bob"
+    @pipeline.run_once
+    assert_not_nil @vault["bob"], "Bob wasn't created in vault"
+    modded_bob={}; @bob_details.each_pair {|k,v| modded_bob[k]=v.as_array}
+    assert_equal modded_bob, @vault["bob"].reject {|k,v| ['modifier',:association].include? k}
+    @pipeline.run_once
+  end
+  
+end

data/test/test_event.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby -w
+#
+#  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
+
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+
+require 'ruby_sync'
+require 'test/unit'
+
+class TestEvent < Test::Unit::TestCase
+  
+  def setup
+    payload = [
+      RubySync::Operation.add("name", "Matthew"),
+      RubySync::Operation.add(:modifier, "rubysync")
+    ]
+    @connector = RubySync::Connectors::MemoryConnector.new :name=>"Test"
+    @event = RubySync::Event.modify @connector, 'source_path', nil, payload
+    puts @event.to_yaml
+  end
+
+  def test_sets_value?
+    assert @event.sets_value?(:modifier, "rubysync")
+    assert !@event.sets_value?(:modifier, "Matthew")
+  end
+
+end

data/test/test_ldap_connector.rb

@@ -0,0 +1,89 @@
+#!/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
+
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+$:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+
+require 'ruby_sync_test'
+require 'hashlike_tests'
+require 'ruby_sync/connectors/ldap_connector'
+require 'ruby_sync/connectors/memory_connector'
+
+
+class MyLdapConnector < RubySync::Connectors::LdapConnector; end
+class MyMemoryConnector < RubySync::Connectors::MemoryConnector; end
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+  
+  client :my_ldap,
+        :host=>'localhost',
+        :port=>10389,
+        :username=>'uid=admin,ou=system',
+        :password=>'secret',
+        :search_filter=>"cn=*",
+        :search_base=>"dc=example,dc=com"
+
+  vault :my_memory
+  
+  allow_out :cn, :givenName, :sn
+  
+  out_transform do
+    if type == :add or type == :modify
+      each_operation_on("givenName") { |operation| append operation.same_but_on('cn') }
+      append RubySync::Operation.new(:add, "objectclass", ['inetOrgPerson'])
+    end
+  end
+
+end
+
+
+class TestLdapConnector < Test::Unit::TestCase
+    
+  include RubySyncTest
+  include HashlikeTests
+
+  def unsynchable
+    [:objectclass, :interests, :cn, :dn]
+  end
+
+
+  def vault_path
+    # TODO: Try using a different path for the vault that's derived from the client source path
+    'cn=bob,dc=example,dc=com'
+  end
+
+
+  def client_path
+    'cn=bob,dc=example,dc=com'
+  end
+
+
+  def test_ldap_add
+    assert_nil @client[client_path], "#{client_path} already exists on client"
+    ldap_attr = {
+      "objectclass"=>['inetOrgPerson'],
+      "cn"=>'bob',
+      "sn"=>'roberts',
+      "mail"=>"bob@roberts.com"
+    }
+    @client.add client_path, @client.create_operations_for(ldap_attr)
+    assert_not_nil @client[client_path], "#{client_path} wasn't created"
+  end
+
+  def test_client_to_vault
+  end
+
+end

data/test/test_memory_connectors.rb

@@ -0,0 +1,40 @@
+#!/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
+
+#
+# Performs end-to-end tests of the memory based testing connectors.
+#
+[File.dirname(__FILE__) + '/../lib', File.dirname(__FILE__)].each do |lib_path|
+  $:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path(lib_path))
+end
+require 'ruby_sync_test'
+require 'hashlike_tests'
+require 'ruby_sync/connectors/memory_connector'
+
+
+class TestConnector < RubySync::Connectors::MemoryConnector
+end
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+  client :test
+  vault :test
+end
+
+class TestMemoryConnectors < Test::Unit::TestCase
+  
+  include RubySyncTest
+  include HashlikeTests
+
+end

data/test/ts_rubysync.rb

@@ -0,0 +1,20 @@
+#!/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 'test/unit'
+require 'test_memory_connectors'
+require 'test_csv_file_connector'
+require 'test_ldap_connector'
+require 'test_active_record_connector'