rubysync 0.0.3 → 0.0.4

data/HISTORY.txt

@@ -1,3 +1,7 @@
+== 0.0.4 / 2007-09-18
+
+* XML Connector now works correctly even if id used isn't a valid XML tag
+* Improved transformations
 
 == 0.0.3 / 2007-08-27
 

data/Manifest.txt

@@ -7,6 +7,14 @@ README.txt
 Rakefile
 bin/.DS_Store
 bin/rubysync
+bin/rubysync.rb
+docs/in_pipeline.graffle
+docs/init_openldap.ldif
+docs/out_pipeline.graffle
+docs/schema/99rubysync.ldif
+docs/schema/rubysync.schema
+docs/to_sync.txt
+docs/walkthru.txt
 examples/.DS_Store
 examples/ar_client_webapp/README
 examples/ar_client_webapp/Rakefile
@@ -179,6 +187,8 @@ lib/ruby_sync/connectors/base_connector.rb
 lib/ruby_sync/connectors/connector_event_processing.rb
 lib/ruby_sync/connectors/csv_file_connector.rb
 lib/ruby_sync/connectors/file_connector.rb
+lib/ruby_sync/connectors/ldap_associations.rb
+lib/ruby_sync/connectors/ldap_changelog_connector.rb
 lib/ruby_sync/connectors/ldap_connector.rb
 lib/ruby_sync/connectors/memory_connector.rb
 lib/ruby_sync/connectors/xml_connector.rb
@@ -193,6 +203,7 @@ nbproject/project.properties
 nbproject/project.xml
 rubysync.tmproj
 test/.DS_Store
+test/.LCKts_rubysync.rb~
 test/data/example1.ldif
 test/data/example2.ldif
 test/data/example3.ldif
@@ -202,17 +213,19 @@ test/data/example6.ldif
 test/data/example7.ldif
 test/hashlike_tests.rb
 test/ruby_sync_test.rb
+test/tc_active_record_connector.rb
+test/tc_base_connector.rb
+test/tc_base_pipeline.rb
+test/tc_changelog_ldap_connector.rb
+test/tc_csv_file_connector.rb
+test/tc_event.rb
+test/tc_ldap_changelog.rb
+test/tc_ldap_connector.rb
+test/tc_ldap_vault.rb
+test/tc_ldif.rb
+test/tc_memory_connectors.rb
+test/tc_rubysync.rb
+test/tc_transformation.rb
+test/tc_utilities.rb
 test/tc_xml_connectors.rb
-test/test_active_record_vault.rb
-test/test_base_connector.rb
-test/test_base_pipeline.rb
-test/test_csv_file_connector.rb
-test/test_event.rb
-test/test_ldap_changelog.rb
-test/test_ldap_connector.rb
-test/test_ldap_vault.rb
-test/test_ldif.rb
-test/test_memory_connectors.rb
-test/test_rubysync.rb
-test/test_utilities.rb
 test/ts_rubysync.rb

data/README.txt

@@ -17,8 +17,6 @@ for your organisation.
 
 == FEATURES/PROBLEMS:
   
-* Add support for running continually
-* Test suites. Individual tests work but test suites have trouble ???
 
 == SYNOPSIS:
 

data/bin/rubysync

@@ -112,6 +112,18 @@ class Controller < SimpleConsole::Controller
     end
   end
 
+  def start
+    pipeline_name = params[:id]
+    pipeline = pipeline_called pipeline_name
+    if pipeline
+      pipeline.start
+    else
+      log.error "Couldn't find a pipeline called '#{pipeline_name}'"
+    end
+  end
+
+
+
   # Create a Rubysync project directory
   def create
     config_path = params[:id]
@@ -207,6 +219,8 @@ Usage:
   * once {name}             
                           ; Execute the named pipeline within the current
                           ; configuration directory once and then exit
+                          
+  * start {name}          ; Execute the named pipeline
                         
   * example               ; Show an example of how this command might be used
 
@@ -236,9 +250,13 @@ puts <<"END"
   You would then edit the file pipelines/my_pipeline.rb to configure the
   policy for synchronizing between the two connectors.
                                         
-  You may then execute the pipeline in one-shot mode (daemon mode is coming):
+  You may then execute the pipeline in one-shot mode:
 
     $ rubysync once my
+    
+  or continually:
+  
+    $ rubysync start my
 END
 end
 
@@ -248,9 +266,6 @@ end
 
                                             
   
-  def start
-    puts "Not yet implemented"
-  end
 
 end
 
@@ -266,7 +281,6 @@ class #{name.to_s.camelize}Connector < #{type_class_name}
 end
     end;
   end
-  
 
   
   def pipeline_template name, vault_name, client_name
@@ -298,7 +312,7 @@ class #{name.to_s.camelize}Pipeline < RubySync::Pipelines::BasePipeline
   #    'first name' => 'givenName'
   # separate each mapping with a comma.
   # The following fields were detected on the client:
-  # #{(client_fields.map {|f| "'#{f}'"}).join(", ")}
+  # #{(client_fields.map {|f| "'#{f}'"}).join(",")}
   map_vault_to_client({
     #{(vault_fields.map {|f| "#'#{f}' => 'a_client_field'"}).join(",\n\t\t")}
   })

data/bin/rubysync.rb

@@ -0,0 +1,333 @@
+#!/opt/local/bin/ruby
+
+
+  # == Synopsis
+  # 
+  #   Command line tool for running *rubysync* <em>A Free MetaDirectory.</em>
+  # 
+  # == Usage
+  #   
+  #     rubysync command name [options]
+  #   
+  #  Valid commands are::
+  #   * create {name}::            Create a rubysync configuration directory
+  # 
+  #   * connector {name} -t {type} [--vault {name}] [--client {name}]
+  #                           ; Create a connector of the given name in
+  #                           ; the current rubysync configuration directory
+  #                         
+  #   * fields {name}           ; list the fields detected by the named connector
+  # 
+  #   * pipeline {name}         ; Create a rubysync pipeline of the given name
+  #                           ; in the current rubysync configuration directory
+  #                         
+  #   * once {name}::             
+  #       Execute the named pipeline within the current configuration directory once and then exit
+  #                         
+  #   * example::          Show an example of how this command might be used
+  # 
+  # == Example
+  # 
+  #   This sets up the skeleton of a configuration for importing comma delimeted
+  #   text files into an xml file.
+  #     <tt>
+  #     $ rubysync create xml_demo
+  #     $ cd xml_demo
+  #     $ rubysync connector my_csv -t csv_file
+  #     $ rubysync connector my_xml -t xml
+  #     </tt>
+  #   
+  #   You would then edit the files::
+  # 
+  #     * +connectors/my_csv_connector.rb+:: where to get the CSV files, field names, etc
+  #     * +connectors/my_xml_connector.rb+::  how to connect to your XML file.
+  # 
+  #   And enter::
+  #     <tt>
+  #     $ rubysync pipeline my_pipeline -C my_csv -V my_xml
+  #     </tt>
+  # 
+  #   You would then edit the file +pipelines/my_pipeline.rb+ to configure the
+  #   policy for synchronizing between the two connectors.
+  #                                         
+  #   You may then execute the pipeline in one-shot mode (daemon mode is coming)::
+  # 
+  #     <tt>
+  #     $ rubysync once my_pipeline
+  #     </tt>
+  # 
+  # == Author
+  #   Ritchie Young, 9 to 5 Magic (http://9to5magic.com.au)
+  #  
+  # == Copyright
+  #   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 "simpleconsole"
+require 'rdoc/usage'
+
+
+class Controller < SimpleConsole::Controller
+
+  include RubySync::Utilities
+
+  before_filter :configure_logging
+  
+  params :string => {:p => :pipe,
+                     :t => :type,
+                     :V => :vault,
+                     :C => :client},
+         :int =>{:v => :verbose}
+
+  def default
+    #RDoc::usage 'Usage'
+  end
+  
+  def example
+    #RDoc::usage 'Example'
+  end
+  
+  # Run specified pipeline once then exit
+  def once
+    pipeline_name = params[:id]
+    pipeline = pipeline_called pipeline_name
+    if pipeline
+      pipeline.run_once
+    else
+      log.error "Couldn't find a pipeline called '#{pipeline_name}'"
+    end
+  end
+
+  def start
+    pipeline_name = params[:id]
+    pipeline = pipeline_called pipeline_name
+    if pipeline
+      pipeline.start
+    else
+      log.error "Couldn't find a pipeline called '#{pipeline_name}'"
+    end
+  end
+
+
+
+  # Create a Rubysync project directory
+  def create
+    config_path = params[:id]
+    ensure_dir_exists([
+      config_path,
+      "#{config_path}/pipelines",
+      "#{config_path}/connectors",
+      "#{config_path}/shared",
+      "#{config_path}/shared/pipelines",
+      "#{config_path}/shared/connectors",
+      "#{config_path}/shared/lib",
+      "#{config_path}/log",
+      "#{config_path}/db"
+    ])
+  end
+  
+  # Create a connector configuration file
+  def connector
+    name = params[:id]
+    type = params[:type]
+    unless name and type
+      puts "Usage: rubysync connector connector_name -t connector_type"
+      return
+    end
+    if base_path
+      File.open("#{base_path}/connectors/#{name}_connector.rb", "w") do |file|
+        file.puts connector_template(name, type)
+      end
+    else
+      puts 'Change into a config dir and try again or create a config dir with "rubysync create"'
+    end
+  end
+
+  # List the fields that the named connector can detect. This is
+  # a good way to test if a connector config is functional.
+  def fields
+    connector_name = params[:id]
+    connector = (connector_name)? ::RubySync::Connectors::BaseConnector.class_for(connector_name) : nil
+    @field_names = connector && connector.fields || []
+  end
+  
+  def pipeline
+    name = params[:id]
+    vault_name = params[:vault]
+    client_name = params[:client]
+    unless name
+      puts "Usage: rubysync pipeline pipeline_name [-V vault] [-C client]"
+      return
+    end
+    if base_path
+      File.open("#{base_path}/pipelines/#{name}_pipeline.rb", "w") do |file|
+        file.puts pipeline_template(name, vault_name, client_name)
+      end
+    else
+      puts 'Change into a config dir and try again or create a config dir with "rubysync create"'
+    end
+    
+  end
+  
+  
+  private
+  
+  def configure_logging
+    log_levels = [Logger::WARN, Logger::INFO, Logger::DEBUG]
+    verbosity = [(params[:verbose]||0), log_levels.size-1].min
+    log.level = log_levels[verbosity]
+  end
+  
+end
+
+
+class View < SimpleConsole::View
+
+
+def default
+puts <<"END"
+Usage:
+  
+    rubysync command name [options]
+  
+ Valid commands are:
+  * create {name}:            Create a rubysync configuration directory
+
+  * connector {name} -t {type} [--vault {name}] [--client {name}]
+                          ; Create a connector of the given name in
+                          ; the current rubysync configuration directory
+                        
+  * fields {name}         ; list the fields detected by the named connector
+
+  * pipeline {name}       ; Create a rubysync pipeline of the given name
+                          ; in the current rubysync configuration directory
+                        
+  * once {name}             
+                          ; Execute the named pipeline within the current
+                          ; configuration directory once and then exit
+                          
+  * start {name}          ; Execute the named pipeline
+                        
+  * example               ; Show an example of how this command might be used
+
+END
+end
+
+
+def example
+puts <<"END"
+  This sets up the skeleton of a configuration for importing comma delimeted
+  text files into a database. Note, if the application happens to be a Rails
+  app then it can also export changes.
+
+    $ rubysync create db_demo
+    $ cd db_demo
+    $ rubysync connector my_csv -t csv_file
+    $ rubysync connector my_db -t active_record
+  
+  You would then edit the files:
+
+    connectors/my_csv_connector.rb   ;where to get CSV files, field names, etc
+    connectors/my_db_connector.rb    ;how to connect to your DB or Rails app.
+
+  And enter:
+    $ rubysync pipeline my -C my_csv -V my_db
+
+  You would then edit the file pipelines/my_pipeline.rb to configure the
+  policy for synchronizing between the two connectors.
+                                        
+  You may then execute the pipeline in one-shot mode:
+
+    $ rubysync once my
+    
+  or continually:
+  
+    $ rubysync start my
+END
+end
+
+def fields
+  puts @field_names.join("\n")
+end
+
+                                            
+  
+
+end
+
+
+  def connector_template name, type
+    type_class_name = "RubySync::Connectors::#{type.to_s.camelize}Connector"
+    type_class = eval(type_class_name)
+    sample_config = (type_class && type_class.respond_to?("sample_config")) ?
+      type_class.sample_config : ""
+    return <<-"end;"
+class #{name.to_s.camelize}Connector < #{type_class_name}
+  #{sample_config}
+end
+    end;
+  end
+
+  
+  def pipeline_template name, vault_name, client_name
+    vault = (vault_name)? ::RubySync::Connectors::BaseConnector.class_for(vault_name) : nil
+    vault_fields = vault && vault.fields || %w{allow these fields through}
+    possible_fields = (vault_fields.map {|n| ":#{n}"}).join(", ")
+
+    client = (client_name)? ::RubySync::Connectors::BaseConnector.class_for(client_name) : nil
+    client_fields = client && client.fields || []
+
+    vault_specifier = (vault_name)? "vault :#{vault_name}" : "#vault :vault_connector_name"
+    client_specifier = (client_name)? "client :#{client_name}" : "#client :client_connector_name"
+    return <<-"end;"
+class #{name.to_s.camelize}Pipeline < RubySync::Pipelines::BasePipeline
+
+  #{client_specifier}
+
+  #{vault_specifier}
+
+  # Remove any fields that you don't want to set in the client from the vault
+  allow_out #{possible_fields}
+
+  # Remove any fields that you don't want to set in the vault from the client
+  allow_in #{possible_fields}
+
+  # 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:
+  # #{(client_fields.map {|f| "'#{f}'"}).join(",")}
+  map_vault_to_client({
+    #{(vault_fields.map {|f| "#'#{f}' => 'a_client_field'"}).join(",\n\t\t")}
+  })
+
+  # "in" means going from client to vault
+  #in_transform do
+  #end
+
+  # "out" means going from vault to client
+  #out_transform do
+  #end
+
+end
+    end;
+  end
+
+
+SimpleConsole::Application.run(ARGV, Controller, View)