etapper 0.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.tmproj
+pkg/**
+tmp/**

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-03-27
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/etapper.rb
+script/console
+script/destroy
+script/generate
+spec/etapper_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on etapper, see http://etapper.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= etapper
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Stephen Eley
+
+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/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "etapper"
+    gem.summary = %Q{Ruby gem to connect to eTapestry's SOAP API}
+    # gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "seley@aarweb.org"
+    gem.homepage = "http://github.com/SFEley/etapper"
+    gem.authors = ["Stephen Eley"]
+    gem.rubyforge_project = "etapper"
+    gem.add_dependency "httpclient"
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "etapper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :etap do
+  desc "Update the eTapestry API Web site mirror in /doc/api"
+  task :api do
+    Dir.chdir(File.join(File.dirname(__FILE__),'doc','api')) do
+      system "wget -mkp -nH --cut-dirs=2 http://www.etapestry.com/files/api/index.html"
+    end
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/doc/APIQueryExample.java

@@ -0,0 +1,61 @@
+// Construct Request Object
+PagedExistingQueryResultsRequest request = new PagedExistingQueryResultsRequest();
+
+// Specify the maximum number of results you would like to return
+// when processing the query, anything from 1 to 500
+request.setCount(500);
+
+// Create your query in eTapestry first and reference it here.  I'm not
+// sure what data you are seeking to pull (Accounts or Journal Entries)
+// or the query criteria you will be using (perhaps Created By and Last
+// Modified By Date), but I could assist if needed.  FYI: This example
+// assumes your query return type is Accounts.
+request.setQuery("QueryCategoryName::QueryName");
+
+// Make Request
+PagedQueryResultsResponse response = APIConnection.getExistingQueryResults(request);
+
+// Output Results
+printNames(response);
+
+// Determine if more results exist (result count exceeds request count)
+while (APIConnection.hasMoreQueryResults())
+{
+    printNames(APIConnection.getNextQueryResults());
+}
+
+// Output Account Name Method
+private void printNames(response)
+{
+    if (response.getData() == null) return;
+
+    Iterator itr = response.getData().iterator();
+    while (itr.hasNext())
+    {
+	Account account = (Account) itr.next();
+
+        System.out.println("Name: " + account.getName());
+    }
+}
+
+
+// Complex Type Details
+
+PagedExistingQueryResultsRequest
+
+start - set to zero (indexed based position within the query results to start retrieving results)
+count - see not above within code
+clearCache - set to false (successive calls to retrieve results for the same query will use the cached results from the initial call)
+query - set as "QueryCategoryName::QueryName" (required)
+accountType - set to zero
+
+
+PagedQueryResultsResponse
+
+start - indexed based position the query results started from
+count - number of query results returned
+total - total number of results within query
+pages - number of query result pages (based upon request count and total)
+usedCache - whether query result cache was used or query was run real time
+data - collection/array of query results (could be Accounts of Journal Entries - determined by query itself)
+

data/doc/api/SortTable.js

@@ -0,0 +1,176 @@
+/**
+ * Sort a table, leaving all "fixed" rows in place
+ */
+function sortTable(tableId, col)
+{
+    // Grab the table, its body and an array of rows
+    var table = document.getElementById(tableId);
+    var tbody = table.getElementsByTagName("tbody")[0];
+	var rows = filterForParents(tbody.getElementsByTagName("tr"), tbody);
+
+    // Figure out ascending or descending
+    var lastSort = table.getAttribute("sort");
+    var asc = lastSort != col;
+
+    // Keep 3 arrays around. sorted is the running list of "already sorted" rows
+    // that we add to only when we need to "flush" the current group. Current bunch is
+    // all of the "sortable" rows we find in between fixed rows (a group). Classnames is 
+    // an array of the original class names so that even though the data in the rows changes,
+    // it all still looks the same since the class isn't changing
+    var sorted = new Array();
+    var currentBunch = new Array();
+    var classNames = new Array();
+    var groupedElements = new Array();
+    var groupCounter = 1;
+
+    // Iterate the rows, adding sortable rows to the current bunch. When we hit a fixed
+    // row, sort the current bunch since that group is now finished.
+	
+    for (var i = 0; i < rows.length; i++)
+    {
+        var row = rows[i];
+        var data = new Object();
+        data.row = row;
+        classNames[i] = row.className;
+
+        if (row.getAttribute("fixed"))  // fixed row. sort current group (if exists)
+        {
+            // sort the current set of rows in the group
+            currentBunch.sort(getSortFunc(asc));
+
+            // append the newly sorted rows to the entire sorted list
+            for( var q = 0; q < currentBunch.length; q++ )
+            {
+                var groupedElem = "false";
+
+                // Check if the current row is supposed to have a grouped row after it
+                for (var z = 0 ; z < groupedElements.length ; z++)
+                {
+                    if (currentBunch[q].group && groupedElements[z].group == currentBunch[q].group)
+                    {
+                        groupedElem = groupedElements[z];
+                        groupedElements.splice(z, 1); // remove it from the array so we don't search it again
+                    }
+                }
+
+                // Append onto the entire list, then append a grouped elem if necessary
+                sorted[sorted.length] = currentBunch[q];
+                if (groupedElem != "false")
+                {
+                    sorted[sorted.length] = groupedElem;
+                }
+            }
+
+            // add the fixed line and start the unsorted set over
+            sorted[sorted.length] = data;
+            currentBunch = new Array();
+            groupedElements = new Array();
+        }
+        else if (row.getAttribute("groupWithPrevious")) // If a row is specified as "group with previous" row, store it in a separate array
+        {
+            data.group = groupCounter;
+            if (currentBunch.length > 0)
+            {
+                currentBunch[currentBunch.length-1].group = groupCounter;
+            }
+
+            groupedElements[groupedElements.length] = data;
+            groupCounter++;
+        }
+        else
+        {
+            // non-fixed row, find its sort key and add it to the current unsorted bunch
+			var cells = filterForParents(row.getElementsByTagName("td"), row);
+            data.key = getSortKey(cells[col]);
+            currentBunch[currentBunch.length] = data;
+        }
+    }
+    
+    // Add the remaining bunch (possibly everything if no fixed fields)
+    currentBunch.sort(getSortFunc(asc));
+    for( var q = 0; q < currentBunch.length; q++ )
+    {
+        var groupedElem = "false";
+
+        // Check if the current row is supposed to have a grouped row after it
+        for (var z = 0 ; z < groupedElements.length ; z++)
+        {
+            if (currentBunch[q].group && groupedElements[z].group == currentBunch[q].group)
+            {
+                groupedElem = groupedElements[z];
+                groupedElements.splice(z, 1); // remove it from the array so we don't search it again
+            }
+        }
+
+        // Append onto the entire list, then append a grouped elem if necessary
+        sorted[sorted.length] = currentBunch[q];
+        if (groupedElem != "false")
+        {
+            sorted[sorted.length] = groupedElem;
+        }
+    }
+
+    // Take the sorted rows and replace the table's rows with those
+    var keys = "";
+    for (var i = 0; i < sorted.length; i++)
+    {
+        sorted[i].row.className = classNames[i];
+        tbody.appendChild(sorted[i].row);
+    }
+
+    // Reverse ascending/descending attribute for next time
+    table.setAttribute("sort", asc ? col : -1);
+}
+
+function filterForParents(items, targetParent)
+{
+    var filteredItems = new Array();
+    for( var i = 0; i < items.length; i++ )
+        if( items[i].parentNode == targetParent )
+            filteredItems[filteredItems.length] = items[i];
+			
+    return filteredItems;
+}
+
+/**
+ * Given some TD cell in a row, return its sort key (if it has one).
+ */
+function getSortKey(cell)
+{
+    var key = "";
+    if (cell)
+    {
+        var key = cell.getAttribute("sort");
+        if( key )
+            return key;
+		
+		key = "";
+        var child = cell.firstChild;
+        while( child && !key )   // have more children w/o finding a valid sort key
+        {
+            key = child.nodeValue;
+            child = child.firstChild;
+        }
+    }
+    return key;
+}
+
+/**
+ * Based on an "asc" flag, return a function that will compare the keys in an 
+ * ascending or descending fashion
+ */
+function getSortFunc(asc)
+{
+    return asc ? function(a, b)
+                 {
+                     if (a.key.toUpperCase() < b.key.toUpperCase()) return -1;
+                     if (a.key.toUpperCase() > b.key.toUpperCase()) return 1;
+                     return 0;
+                 }
+               : function(a, b)
+                 {
+                     if (a.key.toUpperCase() > b.key.toUpperCase()) return -1;
+                     if (a.key.toUpperCase() < b.key.toUpperCase()) return 1;
+                     return 0;
+                 };
+}

data/doc/api/basics.html

@@ -0,0 +1,23 @@
+<html>
+<head>
+  <title>eTapestry API Help</title>
+  <link rel='StyleSheet' href='main.css' type='text/css'>
+  <script src='SortTable.js'></script>
+</head>
+<body>
+
+<p><big>SOAP Session</big><br>
+<span class='normalText'>The eTapestry API is SOAP based.  The login method must be called first so eTapestry can validate the login information provided and verify the user has the appropriate license to access the api.  A session cookie is returned that must be passed back to eTapestry for each subsequent call.  If an api method other than login is called without the appropriate session cookie, a soap fault will occur indicating that access is denied.  Most implementations of SOAP have the ability to maintain client cookies.</span></p>
+<p><big>WSDL File</big><br>
+<span class='normalText'>The current eTapestry WSDL file can be found at <a href='https://app.etapestry.com/v2messaging/service?WSDL' target='_blank'>https://app.etapestry.com/v2messaging/service?WSDL</a></span></p>
+<p><big>Login Id</big><br>
+<span class='normalText'>eTapestry recommends a new login id be created for each implementation of the api.  This login id should have full administrator rights and be used exclusively by the api.</span></p>
+<p><big>Errors & How to Avoid Them</big><br>
+<span class='normalText'>All errors are thrown as soap faults.  A soap fault can be thrown during eTapestry's execution of any method.  It is important to properly handle errors in your code.  The best way to avoid errors is to review the comments provided for each method and complex type.  The ROA column on each complex type means <i>Required on Add</i>, ROU means <i>Required on Update</i>.  Pay close attention to these columns for each complex type you use.</span></p>
+<p><big>Using Complex Types</big><br>
+<span class='normalText'>Before calling a method with a complex type, it is important you review its documentation.  Most complex types have fields that are required to have particular values.  If you are looking to perform an add method (e.g. addAccount, addGift, etc...), pay close attention to the ROA column.  These fields are required when an add method is called.  If you are looking to perform an update method (e.g. updateAccount, updateNote, etc...), pay close attention to the ROU column.  These fields are required when an update method is called.  As a final note, pay close attention to any comments provided for any other field you will populate on a complex type.</span></p>
+<p><big>Using Update Methods</big><br>
+<span class='normalText'>All account and journal entry update methods will completely overwrite data that currently exists on that database item (regardless of whether that variable has content or not).  This means if an account currently has two phone types populated (say Voice and Fax) and updateAccount is processed without any phone data, the account will now have zero phone types populated.  The same thing applies for defined values and all object variables that aren't marked read only within the API documentation.  Before processing an update, eTapestry highly recommends retrieving the database object first, updating that retrieved object accordingly and using that updated object for the update method.  Sensitive data can be completely lost if this practice is not followed.</span></p>
+</body>
+</html>
+

data/doc/api/complexTypeSubMenu.html

@@ -0,0 +1,41 @@
+<html>
+<head>
+  <title>eTapestry API Documentation</title>
+  <link rel='StyleSheet' href='menu.css' type='text/css'>
+</head>
+<body>
+<div class='mainItem'>Complex Types</div>
+<div id='complexTypeDiv'>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Account.html' target='main'>Account</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Attachment.html' target='main'>Attachment</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Bond.html' target='main'>Bond</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Cash.html' target='main'>Cash</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Check.html' target='main'>Check</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Contact.html' target='main'>Contact</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_CreditCard.html' target='main'>CreditCard</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_CustomPaymentSchedule.html' target='main'>CustomPaymentSchedule</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_DefinedValue.html' target='main'>DefinedValue</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Disbursement.html' target='main'>Disbursement</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_DuplicateAccountSearch.html' target='main'>DuplicateAccountSearch</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_ElectronicFundsTransfer.html' target='main'>ElectronicFundsTransfer</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Gift.html' target='main'>Gift</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_InKind.html' target='main'>InKind</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Insurance.html' target='main'>Insurance</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_JournalSummary.html' target='main'>JournalSummary</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Note.html' target='main'>Note</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Payment.html' target='main'>Payment</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Phone.html' target='main'>Phone</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Pledge.html' target='main'>Pledge</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_QueryResultStats.html' target='main'>QueryResultStats</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_RealEstate.html' target='main'>RealEstate</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_RecurringGift.html' target='main'>RecurringGift</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_RecurringGiftSchedule.html' target='main'>RecurringGiftSchedule</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_SegmentedDonation.html' target='main'>SegmentedDonation</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_SegmentedPledge.html' target='main'>SegmentedPledge</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_SoftCredit.html' target='main'>SoftCredit</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_StandardPaymentSchedule.html' target='main'>StandardPaymentSchedule</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Stock.html' target='main'>Stock</a></div>
+<div class='offsetItem'><img src='images/arrow.gif'/> <a href='ct_Valuable.html' target='main'>Valuable</a></div>
+</div>
+</body>
+</html>