onebody-updateagent 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f882b057fa7b6a9b26e58f52e4d1daf9d2bf2f08
-  data.tar.gz: 47dfca0fd1b69709334dbc69a008434dc4de2b85
+  metadata.gz: 88611bbe2a5b4450576348abf72db06d09a4b0ab
+  data.tar.gz: c57e12c5adf720dfdd8ae0cbecd543ffeb86dbf6
 SHA512:
-  metadata.gz: 7e17fa87e0aad25a61d349eacfc32084269f64c00a8435df4134c47f05d2a05af60d2df2a0923236b7b03057adefc78d6f319d6b4005815475472b97b6477049
-  data.tar.gz: 0faff4c42a61b7ed3ecac915c7ae063a1a1e1dd383533e061921745f2a8fdd30191eca76600cb8f1fa074f0e00e01c23a7a37d31bad4575152fcf91a79bb97a7
+  metadata.gz: 6ee0543089c62bb82465e818d016a3642264652e2de3e54907cb834578d57ed9d36caf60c7057739ff81a1abddb4b75edf9a081d7f76b7e69ebaac9eb5866ce0
+  data.tar.gz: 6e508220ff584cdd428fce12e24476e39519414b3480f1f50994e722a61e0f9b421a12be1eadca73a4172f1e2955ad4479b74a1ff8ac1ccf5c264c275cea3cec

data/README.md

@@ -0,0 +1,129 @@
+# OneBody UpdateAgent
+
+Ruby gem that pushes data from a membership data source to a remote OneBody instance via the REST API.
+
+## Download and Install
+
+Install [Ruby](http://ruby-lang.org) if you don't already have it.
+
+Run the following command ("sudo" may be required in some environments):
+
+    gem install onebody-updateagent
+
+## Configuration
+
+1. Run `update_onebody` at a terminal, then take note of where the example.yml config file resides.
+2. Copy the example config file to a convenient location and edit appropriately.
+
+Your "site" address will probably be something like "http://example.com" or "http://members.yourchurch.com".
+
+You can get your user api key from OneBody (you must be a super admin) by running the following command (on the server):
+
+    cd /path/to/onebody
+    rake onebody:api:key EMAIL=admin@example.com
+
+## Preparation
+
+Using your membership management software, reporting solution, database utility, custom script, etc., export your people and family data to a single comma separated values (CSV) file, e.g. people.csv.
+
+Duplicate family data (the same family name, home phone, address, etc.) will be present for each member of the same family -- that's ok!
+
+The first row of the file is the attribute headings and must match the attributes available:
+
+    first_name
+    last_name
+    suffix
+    gender
+    mobile_phone
+    work_phone
+    fax
+    birthday
+    anniversary
+    description
+    website
+    activities
+    interests
+    music
+    tv_shows
+    movies
+    books
+    quotes
+    about
+    testimony
+    share_
+    business_
+    alternate_email
+    visible
+    messages_enabled
+    friends_enabled
+    photo
+    email
+    classes
+    shepherd
+    mail_group
+    member
+    staff
+    elder
+    deacon
+    visible_
+    can_sign_in
+    full_access
+    child
+    custom_type
+    medical_notes
+    can_pick_up
+    cannot_pick_up
+    sequence
+    family_id
+    legacy_id
+    legacy_family_id
+    family_name
+    family_last_name
+    family_home_phone
+    family_address1
+    family_address2
+    family_city
+    family_state
+    family_zip
+    family_share_
+    family_visible
+    family_photo
+    family_email
+    family_legacy_id
+    family_barcode_id
+    family_alternate_barcode_id
+
+Not all attributes are required.
+
+Optionally, you can use Export to CSV button in the Admin panel of your running instance of OneBody to get an example CSV to start.
+
+Use the following attributes to track the identity/foreign keys from your existing membership management database. Do *not* include `id` and `family_id` columns as they will interfere with the primary keys OneBody uses.
+
+    legacy\_id
+    legacy\_family\_id
+
+There is an example csv file in this directory for reference.
+
+## Converters
+
+As of this writing, one Church Management System (ChMS) is supported via a Converter. The Converter translates field names and data into the formats and locations expected by OneBody.
+
+To use a converter, you must specify it in your config file. The example config file has these settings disabled; simply remove the pound sign at the beginning of each line to enable the use of the converter. Specify the name and any additional settings.
+
+## Usage
+
+To run UpdateAgent:
+
+    update_onebody -c path/to/config.yml path/to/people.csv
+
+If you plan to schedule UpdateAgent to run periodically without human intervention, you'll want to at least use the `-y` switch, which assumes *yes* to any questions:
+
+    update_onebody -c path/to/config.yml -y path/to/people.csv
+
+You may also log all output:
+
+    update_onebody -c path/to/config.yml -y -l path/to/updateagent.log path/to/people.csv
+
+# Copyright
+
+Copyright (c) Tim Morgan. Licensed MIT - See LICENSE file for details.

data/VERSION

@@ -1 +1 @@
-0.6.6
+0.6.7

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onebody-updateagent
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - Tim Morgan
@@ -59,7 +59,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.markdown
+- README.md
 - VERSION
 - bin/update_onebody
 - example.csv
@@ -72,7 +72,7 @@ files:
 - lib/updateagent/updateagent.rb
 - lib/updateagent/updaters/family_updater.rb
 - lib/updateagent/updaters/people_updater.rb
-homepage: http://github.com/seven1m/onebody-updateagent
+homepage: http://github.com/churchio/onebody-updateagent
 licenses: []
 metadata: {}
 post_install_message: 

data/README.markdown

@@ -1,85 +0,0 @@
-OneBody UpdateAgent
-===================
-
-Ruby gem that pushes data from a membership data source to a remote OneBody instance via the REST API.
-
-Download and Install
---------------------
-
-Install [Ruby](http://ruby-lang.org) if you don't already have it.
-
-Run the following command ("sudo" may be required in some environments):
-
-    gem install onebody-updateagent -s http://gemcutter.org
-    
-Configuration
--------------
-
-1. Run `update_onebody` at a terminal, then take note of where the example.yml config file resides.
-2. Copy the example config file to a convenient location and edit appropriately.
-
-Your "site" address will probably be something like "http://example.com" or
-"http://yoursite.beonebody.com".
-
-You can get your user api key from OneBody (you must be a super admin) by running the following
-command (on the server):
-
-    cd /path/to/onebody
-    rake onebody:api:key EMAIL=admin@example.com
-    
-If your instance is hosted at <http://beonebody.com>, you may email <support@beonebody.com>
-to get your api key.
-
-Preparation
------------
-
-Using your membership management software, reporting solution, database utility, custom script, etc.,
-export your people and family data to a single comma separated values (CSV) file, e.g. people.csv.
-
-Duplicate family data should be present for each member of the same family.
-
-The first row of the file is the attribute headings, and must match the attributes available:
-
-* [Person Attributes](http://github.com/seven1m/onebody/tree/master/app/models/person.rb)
-* [Family Attributes](http://github.com/seven1m/onebody/tree/master/app/models/family.rb)
-  (prefix each attribute with "family_")
-
-Not all attributes are required.
-
-Optionally, if you have shell access to your hosted instance of OneBody, you can run
-`rake onebody:export:people:csv` to export the current OneBody data (if you have any records in
-the OneBody database) as a starting point.
-
-Use the following attributes to track the identity/foreign keys from your existing membership
-management database. Do *not* include "id" and "family_id" columns.
-
-* legacy\_id
-* legacy\_family\_id
-
-There is an example csv file in this directory for reference.
-
-Converters
-----------
-
-As of this writing, one Church Management System (ChMS) is supported via a Converter. The
-Converter translates field names and data into the formats and locations expected by OneBody.
-
-To use a converter, you must specify it in your config file. The example config file has these
-settings disabled; simply remove the pound sign at the beginning of each line to enable the
-use of the converter. Specify the name and any additional settings.
-
-Usage
------
-
-To run UpdateAgent:
-
-    update_onebody -c path/to/config.yml path/to/people.csv
-    
-If you plan to schedule UpdateAgent to run periodically without human intervention,
-you'll want to at least use the `-y` switch, which assumes *yes* to any questions:
-
-    update_onebody -c path/to/config.yml -y path/to/people.csv
-    
-You may also log all output:
-
-    update_onebody -c path/to/config.yml -y -l path/to/updateagent.log path/to/people.csv