church-community-builder 0.1.0

data/lib/api/mergeable_transaction_list.rb

@@ -0,0 +1,74 @@
+module ChurchCommunityBuilder
+
+  class MergeableTransactionList
+
+    include Enumerable
+
+    attr_reader :transaction_array #for debugging
+                
+
+    def initialize(transaction_list = nil)
+
+      if transaction_list.nil?
+        @transaction_array = []
+
+      else
+        @transaction_array = transaction_list.transaction_array
+
+      end
+      
+    end
+
+    def all_names
+      return [] unless @transaction_array
+      @transaction_array.collect { |transaction| transaction['individual']['content'] }
+    end
+
+    def [](index)
+      Transaction.new( @transaction_array[index] ) if @transaction_array and @transaction_array[index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @transaction_array.each{ |transaction| yield( Transaction.new(transaction) )}
+    end
+
+    # Get all the Transaction ids in the list.
+    #
+    # @return An array of Transaction ids.
+    def ids
+      (@transaction_array.collect { |transaction| transaction['id'] }).uniq
+    end
+
+    # Adds an TransactionList, MergeableTransactionList, or Transaction to this list.
+    #
+    def add(transaction_type)
+      
+      if transaction_type.is_a?(TransactionList)
+        @transaction_array += transaction_type.transaction_array
+
+      elsif transaction_type.is_a?(MergeableTransactionList)
+        @transaction_array += transaction_type.transaction_array
+      
+      elsif transaction_type.is_a?(Transaction)
+        @transaction_array << JSON.parse( transaction_type.to_json )
+
+      end
+
+    end   
+
+    alias_method :merge, :add
+
+    def count
+      @transaction_array.size
+    end
+
+
+    def empty?
+      self.count == 0 ? true : false
+    end
+
+  end
+
+end

data/lib/api/search.rb

@@ -0,0 +1,81 @@
+module ChurchCommunityBuilder
+
+  class Search
+
+    # Search CCB for individuals based off of the search parameters
+    # Note:
+    # Searches are performed as a LIKE query in the CCB database. 
+    # If the value provided for the criterion is found anywhere in the field,
+    # it will be considered a match.
+    def self.search_for_person_by_name(last_name = nil,first_name = nil)
+      options = {:url_data_params => {srv: "individual_search", 
+                                      last_name: last_name,
+                                      first_name: first_name
+                                      } 
+                }
+      reader = IndividualListReader.new(options)
+      IndividualList.new(reader.load_feed)
+    end
+
+    # Returns a list of all individuals in the Church Community Builder system.
+    def self.search_for_all_valid_individuals
+      options = {:url_data_params => {srv: "valid_individuals" }
+
+                }
+      reader = IndividualListReader.new(options)
+      ValidIndividualList.new(reader.load_feed)
+    end
+
+    # Leaving 'modified_since' as 'nil' will return all
+    # batches in the system.
+    #
+    # Specifying a date will return all batches created
+    # or modified since that date.
+    #
+    # Date format should be YYYY-MM-DD
+    def self.search_for_batch_by_date(modified_since = nil)
+      options = {:url_data_params => {srv: "batch_profiles", 
+                                      modified_since: modified_since
+                                      } 
+                }
+      reader = BatchListReader.new(options)
+      BatchList.new(reader.load_feed)
+    end
+
+    # Returns a BatchList of all batches posted in specified date range.
+    # End date is optional.
+    #
+    # Date format should be YYYY-MM-DD
+    def self.search_for_batch_by_date_range(start_date, end_date = nil)
+      options = {:url_data_params => {srv: "batch_profiles_in_date_range", 
+                                      date_start: start_date,
+                                      date_end: end_date
+                                      } 
+                }
+      options[:url_data_params].delete(:date_end) if end_date.nil?
+      reader = BatchListReader.new(options)
+      BatchList.new(reader.load_feed)
+    end
+
+    def self.search_for_batch_by_id(batch_id)
+      # options = {:url_data_params => {srv: "batch_profile_from_id", 
+      #                                 id: batch_id
+      #                                 } 
+      #           }
+      reader = BatchReader.new(batch_id)
+      Batch.new(reader.load_feed)
+    end
+
+    # This is currently undocumented, but found via spelunking
+    #
+    def self.search_for_all_campuses
+      options = {:url_data_params => {srv: "campus_list" }
+
+                }
+      reader = CampusListReader.new(options)
+      CampusList.new(reader.load_feed)
+    end
+
+  end
+
+end

data/lib/api/transaction.rb

@@ -0,0 +1,114 @@
+module ChurchCommunityBuilder
+
+  include Enumerable
+
+  class Transaction < ApiObject
+
+    ccb_attr_accessor :id,
+                      :campus,
+                      :individual,
+                      :date,
+                      :grouping,
+                      :payment_type,
+                      :check_number,
+                      :transaction_details,
+                      :creator,
+                      :modifier,
+                      :created,
+                      :modified
+
+                  
+
+    def initialize(json_data = nil, options = {})
+      initialize_from_json_object(json_data) unless json_data.nil?
+
+      if json_data["transaction"].nil?
+        transaction_json = json_data
+      else
+        transaction_json = json_data["transaction"]
+      end
+      
+      initialize_from_json_object(transaction_json) unless transaction_json.nil?
+    end
+
+    def campus_id
+      self.campus["id"]
+    end
+
+    def campus_name
+      self.campus["content"]
+    end
+
+    def individual_id
+      self.individual["id"]
+    end
+
+    def individual_name
+      self.individual["content"]
+    end
+
+    def multiple_transactions?
+      self.transaction_details["transaction_detail"].is_a?(Array)
+    end
+
+    def transaction_detail_id
+      if multiple_transactions?
+        self.transaction_details["transaction_detail"].each{ |trans| trans["id"] }
+      else
+        self.transaction_details["transaction_detail"]["id"]
+      end
+    end
+
+    def fund_id
+      if multiple_transactions?
+        self.transaction_details["transaction_detail"].each{ |trans| trans["coa"]["id"] }
+      else
+        self.transaction_details["transaction_detail"]["coa"]["id"]
+      end
+    end    
+
+    def fund_name
+      if multiple_transactions?
+        self.transaction_details["transaction_detail"].collect{ |trans| trans["coa"]["content"] }
+      else
+        self.transaction_details["transaction_detail"]["coa"]["content"]
+      end
+    end
+
+    def amount
+      if multiple_transactions?
+        self.transaction_details["transaction_detail"].collect{ |trans| trans["amount"] }     
+      else
+        self.transaction_details["transaction_detail"]["amount"]      
+      end
+    end
+
+
+    def as_splits
+      vals = []
+      if multiple_transactions?
+        self.transaction_details["transaction_detail"].each_with_index do |trans, indx| 
+          vals << {:transaction_detail_id => trans['id'],
+                   :fund_id => trans["coa"]["id"],
+                   :fund_name => trans["coa"]["content"],
+                   :amount => self.transaction_details["transaction_detail"][indx]["amount"]}
+        end
+      else 
+        vals << {:transaction_detail_id => self.transaction_details["transaction_detail"]["id"],
+                 :fund_id => self.transaction_details["transaction_detail"]["coa"]["id"],
+                 :fund_name => self.transaction_details["transaction_detail"]["coa"]["content"],
+                 :amount => self.transaction_details["transaction_detail"]["amount"]}
+      end
+      return vals
+    end
+
+    # def self.load_by_id(transaction_id)
+    #   reader = TransactionReader.new(transaction_id)
+    #   self.new(reader.load_feed)
+    # rescue
+    #   nil
+    # end
+
+  end
+
+end

data/lib/api/transaction_list.rb

@@ -0,0 +1,52 @@
+module ChurchCommunityBuilder
+
+  class TransactionList
+
+    include Enumerable
+
+    attr_reader :transaction_array #for debugging
+                
+
+
+    def initialize(json_data)
+      
+      # if @json_data['transaction'] is a single item, it will be returned
+      # as a Hash, rather than a single element Array, containing the Hash.
+      #
+      if json_data["transaction"].is_a?(Array)
+        @transaction_array = json_data["transaction"]
+      
+      elsif json_data["transaction"].is_a?(Hash)
+        @transaction_array = []
+        @transaction_array << json_data["transaction"] #array of each transaction
+      end
+
+    end
+
+    def all_names
+      return [] unless @transaction_array
+      @transaction_array.collect { |transaction| transaction['individual']['content'] }
+    end
+
+    def ids
+      (@transaction_array.collect { |transaction| transaction['id'] }).uniq
+    end
+
+    def [](index)
+      Transaction.new( @transaction_array[index] ) if @transaction_array and @transaction_array[index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @transaction_array.each{ |transaction| yield( Transaction.new(transaction) )}
+    end
+
+
+    def empty?
+      @transaction_array.size == 0 ? true : false
+    end
+
+  end
+
+end

data/lib/api/valid_individual.rb

@@ -0,0 +1,43 @@
+module ChurchCommunityBuilder
+
+  include Enumerable
+
+  # A ValidIndividual is the data returned when querying CCB for 'valid_individuals'
+  # A ValidIndividual is largely metadata about the individual,
+  # as well as the inviduals ID.  From the ID, the individual can be retrieved.
+  #
+  class ValidIndividual < ApiObject
+
+    ccb_attr_accessor :id,
+                      :active,
+                      :creator,
+                      :modifier,
+                      :created,
+                      :modified
+
+
+    def initialize(json_data = nil, options = {})
+      #@writer_object = PersonWriter
+      
+      # When we initialize from IndividualReader, the "Individual" is buried
+      if json_data["ccb_api"].nil?
+        individual_json = json_data
+      else
+        individual_json = json_data["ccb_api"]["response"]["individuals"]["individual"]
+      end
+      
+      initialize_from_json_object(individual_json) unless individual_json.nil?
+
+    end
+
+    # def self.load_by_id(individual_id)
+    #   reader = IndividualReader.new(individual_id)
+    #   self.new(reader.load_feed)
+    # rescue
+    #   nil
+    # end
+
+
+  end
+
+end

data/lib/api/valid_individual_list.rb

@@ -0,0 +1,49 @@
+module ChurchCommunityBuilder
+
+  # A ValidIndividualList is returned when querying CCB for 'valid_individuals'
+  # A ValidIndividualList is largely metadata about the individual,
+  # as well as the inviduals ID.  From here, an IndividualList can be built.
+  #
+  class ValidIndividualList
+
+    include Enumerable
+
+    attr_reader :request_data,
+                :response_data,
+                :service,
+                :individuals,
+                :count,
+                :individual_array,
+                :json_data #for debugging
+
+
+    def initialize(json)
+      @json_data = json["ccb_api"]
+      @request_data = @json_data["request"]
+      @response_data = @json_data["response"]
+      @service = @response_data["service"] #CCB service type accessed
+
+      @individuals  = @response_data['valid_individuals']
+
+      @count = @individuals["count"].to_i #number of records
+      @individual_array = @individuals['valid_individual'] #array of each individual
+    end
+
+    def [](index)
+      ValidIndividual.new( @individual_array[index] ) if @individual_array and @individual_array[index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @individual_array.each{ |individual| yield( ValidIndividual.new(individual) )}
+    end
+
+
+    def empty?
+      self.count == 0 ? true : false
+    end
+
+  end
+
+end

data/lib/auto_load.rb

@@ -0,0 +1,17 @@
+module ChurchCommunityBuilder
+
+  require CCB_LIB_DIR + '/exceptions.rb'
+
+  api_path = CCB_LIB_DIR + '/api/'
+  require api_path + 'api_object.rb'
+  Dir["#{api_path}/*.rb"].each { |f| require(f) }
+
+  readers_path = CCB_LIB_DIR + '/readers/'
+  require readers_path + 'api_reader.rb'
+  Dir["#{readers_path}/*.rb"].each { |f| require(f) }
+
+  writers_path = CCB_LIB_DIR + '/writers/'
+  require writers_path + 'api_writer.rb'
+  Dir["#{writers_path}/*.rb"].each { |f| require(f) }
+
+end

data/lib/ccb_api.rb

@@ -0,0 +1,33 @@
+require 'typhoeus'
+require 'json'
+require 'xmlsimple'
+require 'active_support/core_ext'
+
+# The path to the lib directory.
+CCB_LIB_DIR = File.dirname(__FILE__)
+
+require File.dirname(__FILE__) + '/auto_load.rb'
+
+require File.dirname(__FILE__) + '/common.rb'
+
+CCB_ENV = 'production' unless defined?(CCB_ENV)
+
+# This class is meant to be a wrapper ChurchCommunityBuilder API
+module ChurchCommunityBuilder
+
+  class Api
+    class << self
+      attr_reader :api_username, :api_password, :api_subdomain
+    end
+    
+    def self.connect(username, password, subdomain)
+      raise ChurchCommunityBuilderExceptions::UnableToConnectToChurchCommunityBuilder.new('Username, password, and subdomain cannot be nil.') if username.nil? or password.nil? or subdomain.nil?
+      @api_username = username
+      @api_password = password
+      @api_subdomain = subdomain
+      true
+    end
+
+  end
+
+end