rubysync 0.0.1 → 0.0.2

data/test/data/example3.ldif

@@ -0,0 +1,13 @@
+version: 1
+dn: cn=Gern Jensen, ou=Product Testing, dc=airius, dc=com
+objectclass: top
+objectclass: person
+objectclass: organizationalPerson
+cn: Gern Jensen
+cn: Gern O Jensen
+sn: Jensen
+uid: gernj
+telephonenumber: +1 408 555 1212
+description:: V2hhdCBhIGNhcmVmdWwgcmVhZGVyIHlvdSBhcmUhICBUaGlzIHZhbHVlIGlzIGJ
+ hc2UtNjQtZW5jb2RlZCBiZWNhdXNlIGl0IGhhcyBhIGNvbnRyb2wgY2hhcmFjdGVyIGluIGl0ICh
+ hIENSKS4NICBCeSB0aGUgd2F5LCB5b3Ugc2hvdWxkIHJlYWxseSBnZXQgb3V0IG1vcmUu

data/test/data/example4.ldif

@@ -0,0 +1,55 @@
+version: 1
+dn:: b3U95Za25qWt6YOoLG89QWlyaXVz
+# dn:: ou=<JapaneseOU>,o=Airius
+objectclass: top
+objectclass: organizationalUnit
+ou:: 5Za25qWt6YOo
+# ou:: <JapaneseOU>
+ou;lang-ja:: 5Za25qWt6YOo
+# ou;lang-ja:: <JapaneseOU>
+ou;lang-ja;phonetic:: 44GI44GE44GO44KH44GG44G2
+
+# ou;lang-ja:: <JapaneseOU_in_phonetic_representation>
+ou;lang-en: Sales
+description: Japanese office
+
+dn:: dWlkPXJvZ2FzYXdhcmEsb3U95Za25qWt6YOoLG89QWlyaXVz
+# dn:: uid=<uid>,ou=<JapaneseOU>,o=Airius
+userpassword: {SHA}O3HSv1MusyL4kTjP+HKI5uxuNoM=
+objectclass: top
+objectclass: person
+objectclass: organizationalPerson
+objectclass: inetOrgPerson
+uid: rogasawara
+mail: rogasawara@airius.co.jp
+givenname;lang-ja:: 44Ot44OJ44OL44O8
+# givenname;lang-ja:: <JapaneseGivenname>
+sn;lang-ja:: 5bCP56yg5Y6f
+# sn;lang-ja:: <JapaneseSn>
+cn;lang-ja:: 5bCP56yg5Y6fIOODreODieODi+ODvA==
+# cn;lang-ja:: <JapaneseCn>
+title;lang-ja:: 5Za25qWt6YOoIOmDqOmVtw==
+# title;lang-ja:: <JapaneseTitle>
+preferredlanguage: ja
+givenname:: 44Ot44OJ44OL44O8
+# givenname:: <JapaneseGivenname>
+sn:: 5bCP56yg5Y6f
+# sn:: <JapaneseSn>
+cn:: 5bCP56yg5Y6fIOODreODieODi+ODvA==
+# cn:: <JapaneseCn>
+title:: 5Za25qWt6YOoIOmDqOmVtw==
+# title:: <JapaneseTitle>
+givenname;lang-ja;phonetic:: 44KN44Gp44Gr44O8
+# givenname;lang-ja;phonetic::
+<JapaneseGivenname_in_phonetic_representation_kana>
+sn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJ
+# sn;lang-ja;phonetic:: <JapaneseSn_in_phonetic_representation_kana>
+cn;lang-ja;phonetic:: 44GK44GM44GV44KP44KJIOOCjeOBqeOBq+ODvA==
+# cn;lang-ja;phonetic:: <JapaneseCn_in_phonetic_representation_kana>
+title;lang-ja;phonetic:: 44GI44GE44GO44KH44GG44G2IOOBtuOBoeOCh+OBhg==
+# title;lang-ja;phonetic::
+# <JapaneseTitle_in_phonetic_representation_kana>
+givenname;lang-en: Rodney
+sn;lang-en: Ogasawara
+cn;lang-en: Rodney Ogasawara
+title;lang-en: Sales, Director

data/test/data/example5.ldif

@@ -0,0 +1,12 @@
+version: 1
+dn: cn=Horatio Jensen, ou=Product Testing, dc=airius, dc=com
+objectclass: top
+objectclass: person
+objectclass: organizationalPerson
+cn: Horatio Jensen
+
+cn: Horatio N Jensen
+sn: Jensen
+uid: hjensen
+telephonenumber: +1 408 555 1212
+jpegphoto:< file:///usr/local/directory/photos/hjensen.jpg

data/test/data/example6.ldif

@@ -0,0 +1,62 @@
+version: 1
+# Add a new entry
+dn: cn=Fiona Jensen, ou=Marketing, dc=airius, dc=com
+changetype: add
+objectclass: top
+objectclass: person
+objectclass: organizationalPerson
+cn: Fiona Jensen
+sn: Jensen
+uid: fiona
+telephonenumber: +1 408 555 1212
+jpegphoto:< file:///etc/hosts
+
+# Delete an existing entry
+dn: cn=Robert Jensen, ou=Marketing, dc=airius, dc=com
+changetype: delete
+
+# Modify an entry's relative distinguished name
+dn: cn=Paul Jensen, ou=Product Development, dc=airius, dc=com
+changetype: modrdn
+newrdn: cn=Paula Jensen
+deleteoldrdn: 1
+
+# Rename an entry and move all of its children to a new location in
+# the directory tree (only implemented by LDAPv3 servers).
+dn: ou=PD Accountants, ou=Product Development, dc=airius, dc=com
+changetype: modrdn
+newrdn: ou=Product Development Accountants
+deleteoldrdn: 0
+newsuperior: ou=Accounting, dc=airius, dc=com
+
+# Modify an entry: add an additional value to the postaladdress
+# attribute, completely delete the description attribute, replace
+# the telephonenumber attribute with two values, and delete a specific
+# value from the facsimiletelephonenumber attribute
+dn: cn=Paula Jensen, ou=Product Development, dc=airius, dc=com
+changetype: modify
+add: postaladdress
+postaladdress: 123 Anystreet $ Sunnyvale, CA $ 94086
+-
+
+delete: description
+-
+replace: telephonenumber
+telephonenumber: +1 408 555 1234
+telephonenumber: +1 408 555 5678
+-
+delete: facsimiletelephonenumber
+facsimiletelephonenumber: +1 408 555 9876
+-
+
+# Modify an entry: replace the postaladdress attribute with an empty
+# set of values (which will cause the attribute to be removed), and
+# delete the entire description attribute. Note that the first will
+# always succeed, while the second will only succeed if at least
+# one value for the description attribute is present.
+dn: cn=Ingrid Jensen, ou=Product Support, dc=airius, dc=com
+changetype: modify
+replace: postaladdress
+-
+delete: description
+-

data/test/data/example7.ldif

@@ -0,0 +1,8 @@
+version: 1
+# Delete an entry. The operation will attach the LDAPv3
+# Tree Delete Control defined in [9]. The criticality
+# field is "true" and the controlValue field is
+# absent, as required by [9].
+dn: ou=Product Development, dc=airius, dc=com
+control: 1.2.840.113556.1.4.805 true
+changetype: delete

data/test/test_active_record_vault.rb

@@ -20,11 +20,10 @@ $:.unshift lib_path unless $:.include?(lib_path) || $:.include?(File.expand_path
 require 'ruby_sync_test'
 
 class MyActiveRecordConnector < RubySync::Connectors::ActiveRecordConnector
-  options(
-    :model=>:person,
-    :application=>"#{File.dirname(__FILE__)}/../examples/ar_webapp"
-    )
+    model :person
+    application "#{File.dirname(__FILE__)}/../examples/ar_webapp"
 end
+
 class MyMemoryConnector < RubySync::Connectors::MemoryConnector; end
 
 class TestPipeline < RubySync::Pipelines::BasePipeline

data/test/test_base_pipeline.rb

@@ -0,0 +1,58 @@
+#!/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 ClientConnector < RubySync::Connectors::MemoryConnector
+end
+
+class VaultConnector < RubySync::Connectors::MemoryConnector
+end
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+
+  client :client
+  vault :vault
+  
+  allow_in :cn, :givenName, :sn
+  allow_out :id, :name
+  
+  # This is experimental at this stage
+  # map_vault_to_client :cn => :id,
+  #                     :givenName => calc { :name.split(/\w+/)[0] },
+  #                     :sn => calc { :name.split(/\w+/)[1] }
+                      
+end
+
+class TestBasePipeline < Test::Unit::TestCase
+  
+  
+  def setup
+    @pipeline = TestPipeline.new
+    @client = @pipeline.client
+    @vault = @pipeline.vault
+  end
+  
+  def test_mappings
+    
+  end
+  
+  
+end

data/test/test_csv_file_connector.rb

@@ -23,6 +23,10 @@ require 'csv'
 
 
 class TestCsvFileConnector < RubySync::Connectors::CsvFileConnector
+  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")
 end
 
 class TestMemoryConnector < RubySync::Connectors::MemoryConnector
@@ -30,11 +34,7 @@ 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")
+  client :test_csv_file
          
   vault :test_memory
   
@@ -67,9 +67,9 @@ class TestCsvConnector < Test::Unit::TestCase
     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}
+    modded_bob={}; @bob_details.each_pair {|k,v| modded_bob[k.to_s]=v.as_array}
     assert_equal modded_bob, @vault["bob"].reject {|k,v| ['modifier',:association].include? k}
     @pipeline.run_once
   end
-  
+
 end

data/test/test_ldap_connector.rb

@@ -23,18 +23,30 @@ require 'ruby_sync/connectors/ldap_connector'
 require 'ruby_sync/connectors/memory_connector'
 
 
-class MyLdapConnector < RubySync::Connectors::LdapConnector; end
+class ChangeLogConnector < RubySync::Connectors::LdapConnector
+  host        '10.1.1.4'
+  port        389
+  username    'cn=directory manager'
+  password    'password'
+  changelog_dn 'cn=changelog'
+  search_filter "cn=*"
+  search_base   "ou=people,dc=9to5magic,dc=com,dc=au"
+end
+
+class MyLdapConnector < RubySync::Connectors::LdapConnector
+  host          'localhost'
+  port          10389
+  username      'uid=admin,ou=system'
+  password      'secret'
+  search_filter "cn=*"
+  search_base   "dc=example,dc=com"
+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"
+  client :my_ldap
 
   vault :my_memory
   
@@ -73,17 +85,63 @@ class TestLdapConnector < Test::Unit::TestCase
 
   def test_ldap_add
     assert_nil @client[client_path], "#{client_path} already exists on client"
-    ldap_attr = {
+    @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
+
+
+  # Add various types of record and verifies that the appropriate
+  # changelog entries appear.
+  # Other activity on the LDAP server may interfere with this test.
+  def test_get_changes
+    banner "test_get_changes"
+    c = ChangeLogConnector.new
+    path = "cn=bob,#{c.search_base}"
+    c.delete(path) if c[path]
+    c.each_change do |event|
+    end # Ignore up til now
+
+    
+    c.add(path, c.create_operations_for(ldap_attr))
+    assert_event :add, c, path
+    
+    c.modify(path, [
+      RubySync::Operation.replace('mail', "bob@fischer.com"),
+      RubySync::Operation.add('givenName', "Robert")
+      ])
+    event = assert_event :modify, c, path
+    puts event.payload.inspect
+    
+    c.delete(path)
+    assert_event :delete, c, path
+  end
+
+private
+
+  def 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
+  def assert_event type, connector, path
+    events = 0
+    the_event=nil
+    connector.each_change do |event|
+      the_event = event
+      events += 1
+      assert_equal type.to_sym, event.type
+      assert_equal connector, event.source
+      assert_equal path, event.source_path
+    end
+    assert_equal 1, events, "wrong number of events on #{type.to_s}"
+    the_event
   end
 
-end
+end

data/test/test_ldap_vault.rb

@@ -0,0 +1,91 @@
+#!/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_test'
+require 'hashlike_tests'
+require 'ruby_sync/connectors/ldap_connector'
+require 'ruby_sync/connectors/memory_connector'
+
+
+class MyLdapConnector < RubySync::Connectors::LdapConnector
+  host        '10.1.1.4'
+  port        389
+  username    'cn=directory manager'
+  password    'password'
+  changelog_dn 'cn=changelog'
+  search_filter "cn=*"
+  search_base   "ou=people,dc=9to5magic,dc=com,dc=au"
+  
+  def initialize options={}
+    super(options)
+    skip_existing_changelog_entries
+  end
+
+end
+
+class MyMemoryConnector < RubySync::Connectors::MemoryConnector; end
+
+class TestPipeline < RubySync::Pipelines::BasePipeline
+  
+  client :my_memory
+
+  vault :my_ldap
+  
+  allow_out :cn, :givenName, :sn
+  allow_in :cn, :givenName, :sn, :objectclass
+  
+  def in_place(event)
+    event.target_path = "cn=#{event.source_path},ou=people,dc=9to5magic,dc=com,dc=au"
+  end
+  
+  def out_place(event)
+    event.target_path =~ /cn=(.+?),/oi
+    event.source_path = $1
+  end
+  
+  in_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', 'organizationalPerson', 'person', 'top', 'RubySyncSynchable'])
+    end
+  end
+
+end
+
+
+class TestLdapVault < Test::Unit::TestCase
+
+  include RubySyncTest
+  include HashlikeTests
+ 
+  
+  def unsynchable
+    ["objectclass", "interests", "cn", "dn", "rubysyncassociation"]
+  end  
+  
+  def client_path
+    'bob'
+  end
+  
+  def vault_path
+    'cn=bob,ou=people,dc=9to5magic,dc=com,dc=au'
+  end
+
+
+end

data/test/test_ldif.rb

@@ -0,0 +1,122 @@
+#!/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 'net/ldif'
+require 'test/unit'
+
+# TODO: Work out a cross platform method for testing file:// URL imports
+class TestLDIF < Test::Unit::TestCase
+  
+  def setup
+    @ldif = Net::LDIF    
+  end
+  
+  def test_tokenizer
+    a = array_for_file "example1.ldif"
+    #a.each_index {|i| puts "#{i}\t#{a[i][0]}:#{a[i][1]}"}
+    assert_equal ["version", "1"], a[0]
+    assert_equal ["dn", "cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com"],a[1]
+    assert_equal [nil,nil], a[12], "Blank line didn't yield nil name"
+    assert_equal ["telephonenumber", "+1 408 555 1212"], a[19]
+
+    a = array_for_file "example2.ldif"
+    assert_equal ["description", "Babs is a big sailing fan, and travels extensively in search of perfect sailing conditions."],a[11]
+    assert_equal ["title", "Product Manager, Rod and Reel Division"],a[12]
+  end
+
+  def test_tokenize_base64
+    a = array_for_file "example3.ldif"
+    #a.each_index {|i| puts "#{i}\t#{a[i][0]}:#{a[i][1]}"}
+    assert_equal ["description", "What a careful reader you are!  This value is"+
+      " base-64-encoded because it has a control character in it (a CR).\r"+
+      "  By the way, you should really get out more."], a[10]
+  end
+
+
+  def test_tokenize_hyphens
+    a = array_for_file "example6.ldif"
+    #a.each_index {|i| puts "#{i}\t#{a[i][0]}:#{a[i][1]}"}
+    assert_equal ["telephonenumber","+1 408 555 1212"], a[9]
+    [30,33,37,40,45,47].each {|i| assert_equal ["-","-"], a[i]}
+    
+  end
+  
+  def test_parse_simple_content
+    c = changes_for("example1.ldif")
+    assert_equal 2, c.length
+    assert_equal 'add', c[0].changetype
+    assert_equal 'cn=Barbara Jensen, ou=Product Development, dc=airius, dc=com', c[0].dn
+    assert_equal ['top','person','organizationalPerson'], c[0].data['objectclass']
+    assert_equal ['Barbara Jensen','Barbara J Jensen','Babs Jensen'], c[0].data['cn']
+    assert_equal 'Jensen', c[0].data['sn']
+    assert_equal 'A big sailing fan.', c[0].data['description']
+    
+    assert_equal 'add', c[1].changetype
+    assert_equal "cn=Bjorn Jensen, ou=Accounting, dc=airius, dc=com", c[1].dn
+    assert_equal '+1 408 555 1212', c[1].data['telephonenumber']
+  end
+
+  def test_parse_change_records
+    c = changes_for("example6.ldif")
+    assert_equal 6, c.length
+    #puts c.join("\n---\n")
+    assert_equal "cn=Fiona Jensen, ou=Marketing, dc=airius, dc=com", c[0].dn
+    assert_equal 'add', c[0].changetype
+    assert_equal ['top', 'person', 'organizationalPerson'], c[0].data['objectclass']
+
+    assert_equal "Fiona Jensen", c[0].data['cn']
+    assert_equal "+1 408 555 1212", c[0].data['telephonenumber']
+    
+  end
+
+private
+
+  def changes_for(filename)
+    content = []
+    with_file(filename) do |file|
+      @ldif.parse(file) do |record|
+        assert_kind_of Net::ChangeRecord, record
+        content << record
+      end
+    end
+    content
+  end
+
+
+  def array_for_file filename
+    array = []
+    tokenize_file(filename) {|name, value| array << [name, value]}
+    array    
+  end
+
+  def tokenize_file filename
+    with_file(filename) do |file|
+      @ldif.tokenize(file) { |name, value| yield name,value }
+    end
+  end
+
+  def with_file(filename)
+    File.open(path_for(filename), 'r') {|file| yield file}
+  end
+
+  def path_for filename
+    "#{File.dirname(__FILE__)}/data/#{filename}"
+  end
+  
+end

data/test/test_utilities.rb

@@ -0,0 +1,63 @@
+#!/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'
+
+RIGHT = "this is right"
+WRONG = "this is wrong"
+
+class A
+  include RubySync::Utilities
+
+  option :just_one
+  option :pet, :just_default, :with_default
+  just_default RIGHT
+  with_default WRONG
+end
+
+class B < A
+  pet RIGHT
+  with_default RIGHT
+  just_one RIGHT
+end
+
+class C < A
+  pet WRONG
+  with_default WRONG
+  just_one WRONG
+end
+
+
+class TestUtilities < Test::Unit::TestCase
+
+  def test_class_option
+    b = B.new
+    assert_equal RIGHT, b.pet
+    assert_equal RIGHT, b.just_default
+    assert_equal RIGHT, b.with_default
+    assert_equal RIGHT, b.just_one
+    c = C.new
+    assert_equal WRONG, c.pet
+    assert_equal RIGHT, c.just_default
+    assert_equal WRONG, c.with_default
+    assert_equal WRONG, c.just_one
+  end
+  
+end