church-community-builder 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+
+church-community-builder-*.gem

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p392@church-community-builder-api --create

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'typhoeus', '0.5.1'
+gem 'json'
+gem 'xml-simple'
+
+group :development, :test do
+  gem 'colored'
+  gem 'autotest'
+  gem 'rspec'
+  gem 'debugger'
+  gem 'factory_girl'
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.9.1)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    colored (1.2)
+    columnize (0.3.6)
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
+    diff-lcs (1.2.4)
+    ethon (0.5.3)
+      ffi (~> 1.0.11)
+      mime-types (~> 1.18)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    ffi (1.0.11)
+    i18n (0.6.1)
+    json (1.8.0)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    typhoeus (0.5.1)
+      ethon (= 0.5.3)
+    xml-simple (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  colored
+  debugger
+  factory_girl
+  json
+  rspec
+  typhoeus (= 0.5.1)
+  xml-simple

data/README.rdoc

@@ -0,0 +1,54 @@
+= The Church Community Builder API
+
+This Ruby project is an API wrapper for Church Community Builder API.
+
+
+== Install / Setup
+
+Installing the gem
+
+    gem install church-community-builder
+
+
+To add it to your Gemfile
+
+    gem 'church-community-builder', :require => 'ccb_api'
+
+
+Add your church's API Token and API Key to [RAILS_ROOT]/config/initializers/ccb_config.rb
+
+    CCB_USERNAME = '**** YOUR CCB API USERNAME ****'
+    CCB_PASSWORD = '**** YOUR CCB API PASSWORD ****'
+    CCB_SUBDOMAIN = '**** YOUR CCB API SUBDOMAIN ****'
+
+
+Next you will need to initialize a connection
+
+    ChurchCommunityBuilder::Api.connect(CCB_USERNAME, CCB_PASSWORD, CCB_SUBDOMAIN)
+
+
+
+== Example usage
+
+  Checkout the examples folder.
+
+
+== Additional resources
+
+
+
+== License
+
+This project is released under the MIT license (see LICENSE).
+
+This project is maintained by Wes Hays (https://github.com/weshays).
+
+
+== Contributors
+
+Chad Feller: https://github.com/cfeller
+
+
+== Want to Contribute?
+
+If you would like to get involved in this project, then please fork the project. Make changes, add features, write some tests, and then send us a pull request. 

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rspec/core/rake_task'
+
+
+desc 'Default: run specs.'
+task :default => :spec
+task :test => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+
+
+namespace :docs do
+
+  desc 'Build the docs for The City Admin API.'
+  task :build do
+    system('rm -rf doc')
+    system('yardoc --no-private --protected lib/**/*.rb')
+  end
+
+end

data/ccb_api.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  PROJECT_GEM = 'church-community-builder'
+  PROJECT_GEM_VERSION = '0.1.0'
+  
+  s.name = PROJECT_GEM
+  s.version = PROJECT_GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  #s.date = '2009-01-05'
+
+  s.homepage = 'https://github.com/weshays/church-community-builder-api-ruby'
+  s.rubyforge_project = 'Project on www.github.com'
+  s.authors = ['Wes Hays', 'Chad Feller']
+  s.email = ['weshays@gbdev.com','feller@cs.unr.edu']
+
+  s.summary = 'Ruby gem/plugin to interact with the Church Community Builder API.'
+  s.description = 'Ruby gem/plugin to interact with the Church Community Builder API. Checkout the project on github for more detail.'
+
+  s.add_dependency('typhoeus', '0.5.1')
+  s.add_dependency('xml-simple')
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/examples/batch.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/ccb_api.rb'
+
+# Load batch by id
+batch_1 = ChurchCommunityBuilder::Search.search_for_batch_by_id(469)
+
+# Pull TransactionList from given Batch
+trans_list_1 = ChurchCommunityBuilder::TransactionList.new(batch_1.transactions)
+
+# Search for transactions by date
+start_date = "2013-05-03"
+end_date = nil #optional
+batch_2 = ChurchCommunityBuilder::Search.search_for_batch_by_date_range(start_date,end_date)
+
+# Create MergeableTransactionList, and load all transactions from batch_2 into it
+mtl = ChurchCommunityBuilder::MergeableTransactionList.new
+
+batch_2.each do |batch|
+	trans_list = ChurchCommunityBuilder::TransactionList.new(batch.transactions)
+	mtl.add(trans_list)
+end
+
+puts mtl.all_names
+
+# Create MergeableIndividualList, and lookup all Individuals from mtl.
+individual_list = ChurchCommunityBuilder::MergeableIndividualList.new
+
+mtl.each do |transaction|
+	individual = ChurchCommunityBuilder::Individual.load_by_id(transaction.individual_id)
+	individual_list.add(individual)
+end
+
+puts "********************************************************************"
+# Batch reporting
+individual_list = ChurchCommunityBuilder::MergeableIndividualList.new
+
+mtl.each do |transaction|
+	individual = ChurchCommunityBuilder::Individual.load_by_id(transaction.individual_id)
+
+	puts transaction.date + "\t" +
+			 individual.family_name + "\t" +
+	     individual.full_name + "\t" +
+			 "$" + transaction.amount.to_s #unless transaction.multiple_transactions?
+	puts transaction.fund_id.to_s + "\t" +
+			 transaction.fund_name.to_s + "\t" +
+			 transaction.payment_type + "\t" +
+			 transaction.check_number.to_s #check_number will be nil if not paid by check
+	puts "********************************************************************"
+end

data/examples/calendar.rb

@@ -0,0 +1,18 @@
+# #!/usr/bin/env ruby
+
+# require 'json'
+# require 'yaml'
+# require 'typhoeus'
+# require 'active_support/core_ext'
+
+# y = YAML.load(File.read("config/ccb.yml"))
+# resp1 = Typhoeus::Request.get(y[:url], 
+# 															params: {srv: "public_calendar_listing",
+# 																			 date_start: "2008-11-25", 
+# 																			 #date_end: "2008-12-31"
+# 																			 }, 
+# 																       username: y[:username], 
+# 																       password: y[:password]
+# 																       )
+# jresp1 = JSON.parse(Hash.from_xml(resp1.body).to_json)
+# puts jresp1.inspect

data/examples/campus.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/ccb_api'
+require 'pp'
+
+campus_list = ChurchCommunityBuilder::Search.search_for_all_campuses
+
+puts campus_list.all_names
+puts campus_list.ids
+
+campus_0 = campus_list[0]
+
+pp campus_0

data/examples/individual.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/ccb_api'
+
+# IndividualList is returned from Search
+x_names = ChurchCommunityBuilder::Search.search_for_person_by_name("x")
+puts x_names.all_names
+
+# Individual is created here
+individual = ChurchCommunityBuilder::Individual.load_by_id(2)
+puts "Name ==> " + individual.full_name
+puts "Address: "
+puts individual.mailing_address.street_address + "\n" +
+		 individual.mailing_address.city + ", " + 
+		 individual.mailing_address.state + " " +
+		 individual.mailing_address.zip
+
+puts "Phone ==>" + individual.contact_phone
+puts "Email ==> " + individual.email
+
+puts "Gender ==> " + individual.gender
+puts "Birthday ==> " + individual.birthday
+puts "Marital Status ==> " + individual.marital_status
+
+puts "Family Name ==> " + individual.family_name
+puts "Campus Name ==> " + individual.campus_name
+
+# Grab all individuals
+all_valid_individuals = ChurchCommunityBuilder::Search.search_for_all_valid_individuals
+
+# all individuals is a ValidIndividualList.
+# we can use this to build an IndividualList
+mil = ChurchCommunityBuilder::MergeableIndividualList.new
+
+all_valid_individuals.each do |vi|
+	individual = ChurchCommunityBuilder::Individual.load_by_id(vi.id)
+	mil.add(individual)
+end

data/examples/sync_data.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'debugger'
+require File.dirname(__FILE__) + '/../lib/ccb_api'
+
+
+start_date = "2013-04-01"
+end_date = "2013-04-21"
+batch_list = ChurchCommunityBuilder::Search.search_for_batch_by_date_range(start_date, end_date)
+
+batch_list.each do |batch|
+  if batch.has_transactions?
+    transaction_list = ChurchCommunityBuilder::TransactionList.new(batch.transactions)
+
+    puts "-----------------------------"
+    transaction_list.each do |transaction|
+      # Info to use
+      puts "Campus: #{transaction.campus_name}"
+      puts "Amount: #{transaction.amount}"
+      puts "Donor: #{transaction.individual_id}"
+      puts "Entered On: #{transaction.date}"
+      puts "Fund: #{transaction.fund_name}"
+      puts "Instrument Type: #{transaction.payment_type}"
+      puts "-----------------------------"
+
+      individual = ChurchCommunityBuilder::Individual.load_by_id(transaction.individual_id)
+
+      puts '#########################'
+      puts "First name: #{individual.first_name}"
+      puts "Last name: #{individual.last_name}"
+      puts "Full name: #{individual.full_name}"
+      puts "Campus name: #{individual.campus_name}"
+      puts "Donor ID: #{individual.giving_number}"
+      puts "Family ID: #{individual.family_id}"
+      puts "Address: #{individual.home_address}"
+      puts "Phone number 1: #{individual.home_phone}"
+      puts "Phone number 2: #{individual.mobile_phone}"
+      puts "Date of Birth: #{individual.birthday}"
+      puts "Gender: #{individual.gender}"
+      puts "Email: #{individual.email}"
+      puts "Marital status: #{individual.marital_status}"
+      puts '#########################'
+    end
+
+  else
+    puts "Batch #{batch.id} has no transactions"
+  end
+end

data/lib/api/address.rb

@@ -0,0 +1,28 @@
+module ChurchCommunityBuilder
+
+  include Enumerable
+
+  class Address < ApiObject
+    
+    # Type = {mailing: 'mailing', home: 'home', work: 'work', other: 'other'}
+
+    ccb_attr_accessor :type,
+                      :street_address,
+                      :city,
+                      :state,
+                      :zip,
+                      :country,
+                      :line_1,
+                      :line_2,
+                      :latitude,
+                      :longitude
+                      
+
+    def initialize(json)
+      initialize_from_json_object(json) unless json.nil?
+    end
+
+
+  end
+
+end

data/lib/api/api_object.rb

@@ -0,0 +1,116 @@
+module ChurchCommunityBuilder
+
+  # This class is the base class for all ChurchCommunityBuilder objects and is meant to be inherited.
+  #
+  class ApiObject
+    attr_reader :error_messages, :marked_for_destruction
+    
+
+    # Used to specify a list of getters and setters.
+    def self.ccb_attr_accessor(*vars)
+      @__ccb_attributes ||= []
+      @__ccb_attributes.concat(vars)
+      attr_accessor(*vars)
+    end
+
+
+    # A list of ccb_attr_accessors that have been specified.
+    def self.__ccb_attributes
+      @__ccb_attributes
+    end
+
+    # Initializes the current object from the JSON data that was loaded into the Hash
+    #
+    # @param object_attributes A Hash of values to load into the current object.
+    def initialize_from_json_object(object_attributes)
+      # puts "CALLER"
+      # puts caller[0]
+      # puts "DONE PUTTING CALLER"
+      if object_attributes.is_a?( Hash )
+        object_attributes.each do |key, value| 
+
+          method_to_call = "#{key.to_s.downcase.gsub(' ', '_')}="
+          
+          if respond_to?(method_to_call)
+            # puts "Sending :=> ".green + method_to_call.to_s + value.to_s
+            self.send(method_to_call, value) 
+          else
+            # puts "Missing :=> ".red + method_to_call.to_s  # Show the missing methods
+          end
+        end
+      end     
+    end
+
+
+    # Returns the status of the current object.
+    def is_deleted?
+      @_deleted ||= false
+    end
+    
+    # Gets the current object's attributes in a Hash.
+    #
+    # @return A hash of all the attributes.
+    def to_attributes 
+      vals = {}
+      vals = {:marked_for_destruction => self.is_deleted?} if self.is_deleted?
+      self.class.__ccb_attributes.each do |tca| 
+        rep = self.send(tca)               
+        if rep.class == Array   
+          rep.collect! { |r| r.respond_to?(:to_attributes) ? r.to_attributes : r }
+        end
+        vals[tca] = rep
+      end
+      vals
+    end
+
+
+    # Sets the current object's attributes from a hash
+    def set_attributes(attribute_data)
+      attribute_data.each { |key, value| self.send("#{key}=", value) if self.respond_to?("#{key}=") }
+    end
+
+
+    # # Save this object.
+    # #
+    # # @return True on success, otherwise false.
+    # def save
+    #   writer = @writer_object.new(self.to_attributes) 
+    #   result = writer.save_object
+    #   if result === false
+    #     @error_messages = writer.error_messages
+    #   else
+    #     self.set_attributes(result)
+    #   end
+    #   result === false ? false : true
+    # end
+
+
+    # # Delete this object.
+    # #
+    # # @return True on success, otherwise false.
+    # def delete
+    #   writer = @writer_object.new(self.to_attributes) 
+    #   result = writer.delete_object
+    #   if result === false
+    #     @error_messages = writer.error_messages
+    #   else
+    #     @_deleted = true
+    #   end
+    #   result === false ? false : true
+    # end
+
+    private
+
+    def _attr_underscore(str)
+      str.gsub(/::/, '/')
+         .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+         .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+         .tr("-", "_")
+         .downcase
+    end
+
+  end
+
+end
+
+