simplesync 0.0.2

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2008 BehindLogic
+
+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

@@ -0,0 +1,40 @@
+== SimpleSync
+
+The purpose of this gem is to provide a body that can perform the synchronization necessary when given the right inputs.
+
+It is based on the idea that synchronization is a combination of: 1) data sources, 2) records, 3) attribute mappings, and 4) synchronization logic. This gem encapsulates all of these so that you don't have to worry about how they relate to each other -- only about defining what they are. You initialize your data sources, define how to find the relevant records, define how to map attributes between sources, and provide methods on your source that can be used to get and save records. See the example code:
+
+  @sync = SimpleSync::Syncer.new(Time.now - 30*24*60*60)
+
+  @local = @sync.add_source(Person, :local, :external_id) {@adapter = :local}.extended(@sync) do |s|
+    new_records {Person.get(:adapter => :local, :created_after => s.last_sync)}
+    changed_records {Person.get(:adapter => :local, :updated_after => s.last_sync)}
+    deleted_records {DeletedRecord.get(:adapter => :local, :object_type => 'Person', :deleted_after => s.last_sync)}
+  end
+
+  @remote = @sync.add_source(Person, :remote, :self) {@adapter = :opcon_local}.extended(@sync) do |s|
+    new_records {Person.get(:adapter => :remote, :created_after => s.last_sync)}
+    changed_records {Person.get(:adapter => :remote, :updated_after => s.last_sync)}
+    deleted_records {DeletedRecord.get(:adapter => :remote, :object_type => 'Person', :deleted_after => s.last_sync)}
+  end
+
+  # Mapping the attributes from one to the other.
+  @sync.mappings[@local => @remote] = {
+    'first_name' => 'first_name',
+    'last_name' => 'last_name',
+    'company_name' => 'company_name',
+    'birthdate' => 'birthdate',
+  }
+
+  # And the other direction -- usually just in invert.
+  @sync.mappings[@remote => @local] = @sync.mappings[@local => @remote].invert
+
+  # Now all we need to do is a simple loop where we sync and wait.
+  while(1)
+
+    puts "[#{Time.now}] Beginning Sync"
+    @sync.sync!
+    puts "[#{Time.now}] Finished Syncing"
+
+    sleep(30)
+  end

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_NAME = 'simplesync'
+PKG_VERSION = "0.0.2"
+
+PKG_FILES = FileList[
+    "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
+]
+
+desc "Default Task"
+task :default => [ :test ] do
+  # Run the unit tests
+  desc "Run all rspec tests (rake task not yet implemented!)"
+end
+
+# Make a console, useful when working on tests
+desc "Generate a test console"
+task :console do
+   verbose( false ) { sh "irb -I lib/ -r '#{PKG_NAME}'" }
+end
+
+# Genereate the RDoc documentation
+desc "Create documentation"
+Rake::RDocTask.new("doc") { |rdoc|
+  rdoc.title = "SimpleSync"
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+# Generate the package
+spec = Gem::Specification.new do |s|
+  #### Basic information.
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.description = s.summary = "QuickSync: an interface to synchronization logic."
+
+  #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
+  s.files = PKG_FILES
+
+  #### Load-time details: library and application (you will need one or both).
+  s.require_path = 'lib'
+
+  #### Documentation and testing.
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+
+  #### Author and project details.
+  s.author = "Daniel Parker"
+  s.email = "gems@behindlogic.com"
+  s.homepage = "http://simplesync.rubyforge.org"
+  s.rubyforge_project = 'simplesync'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  require 'code_statistics'
+  CodeStatistics.new(
+    ["Library", "lib"]
+  ).to_s
+end
+
+desc "Publish new documentation"
+task :publish => [:doc] do
+  `scp -r doc/* dcparker@rubyforge.org:/var/www/gforge-projects/simplesync`
+end

data/doc/classes/Hash.html

@@ -0,0 +1,153 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Hash</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Hash</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/simple_sync_rb.html">
+                lib/simple_sync.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+A little enhancement that we need&#8230;
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">transform_keys_by_mapping</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="Hash.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('Hash.src/M000001.html');return false;">
+          <span class="method-name">transform_keys_by_mapping</span><span class="method-args">(mapping)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Given a mapping (hash), this will transform the keys from the keys to the
+values in the mapping. For example:
+</p>
+<pre>
+  mapping = {:cat =&gt; :Cat, :dog =&gt; :Canine}
+  hash = {:cat =&gt; 'Felix', :dog =&gt; 'Toby'}
+  hash.transform_keys_by_mapping(mapping)
+  =&gt; {:Cat =&gt; 'Felix', :Canine =&gt; 'Toby'}
+</pre>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Hash.src/M000001.html

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>transform_keys_by_mapping (Hash)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/simple_sync.rb, line 374</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">transform_keys_by_mapping</span>(<span class="ruby-identifier">mapping</span>)
+    <span class="ruby-identifier">ddup</span> = {}
+    <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">mapping</span>[<span class="ruby-identifier">k</span>]
+        <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">mapping</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Proc</span>)
+          <span class="ruby-identifier">ddup</span> = <span class="ruby-identifier">mapping</span>[<span class="ruby-identifier">k</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">ddup</span>,<span class="ruby-identifier">v</span>)
+        <span class="ruby-keyword kw">else</span>
+          <span class="ruby-identifier">ddup</span>[<span class="ruby-identifier">mapping</span>[<span class="ruby-identifier">k</span>]] = <span class="ruby-identifier">v</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">ddup</span>
+  <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/SimpleSync.html

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: SimpleSync</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">SimpleSync</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/simple_sync_rb.html">
+                lib/simple_sync.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+See README for usage.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="SimpleSync/Record.html" class="link">SimpleSync::Record</a><br />
+Class <a href="SimpleSync/Mappings.html" class="link">SimpleSync::Mappings</a><br />
+Class <a href="SimpleSync/RecordSet.html" class="link">SimpleSync::RecordSet</a><br />
+Class <a href="SimpleSync/Source.html" class="link">SimpleSync::Source</a><br />
+Class <a href="SimpleSync/Syncer.html" class="link">SimpleSync::Syncer</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/SimpleSync/Mappings.html

@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: SimpleSync::Mappings</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">SimpleSync::Mappings</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/simple_sync_rb.html">
+                lib/simple_sync.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+<a href="Mappings.html">Mappings</a> represents and encapsulates the
+mappings for a group of sync sources.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000026">[]</a>&nbsp;&nbsp;
+      <a href="#M000027">[]=</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000026" class="method-detail">
+        <a name="M000026"></a>
+
+        <div class="method-heading">
+          <a href="Mappings.src/M000026.html" target="Code" class="method-signature"
+            onclick="popupCode('Mappings.src/M000026.html');return false;">
+          <span class="method-name">[]</span><span class="method-args">(src_tgt)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+The mappings hash is to be accessed not by a word-index but rather by a
+single key-value hash of {source =&gt; target_source} For example,
+mappings[@source_a =&gt; @source_b] should be set to a hash that represents
+the attribute mappings where @source_a&#8216;s attributes are the keys and
+@source_b&#8216;s attributes are the values.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000027" class="method-detail">
+        <a name="M000027"></a>
+
+        <div class="method-heading">
+          <a href="Mappings.src/M000027.html" target="Code" class="method-signature"
+            onclick="popupCode('Mappings.src/M000027.html');return false;">
+          <span class="method-name">[]=</span><span class="method-args">(src_tgt, mapping)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+See above.
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>