church-community-builder 0.1.0

data/lib/common.rb

@@ -0,0 +1,41 @@
+module ChurchCommunityBuilder
+  require 'cgi'
+  require 'json'
+
+  def self.admin_request(method, params = {}, body = nil)
+    url = "https://#{ChurchCommunityBuilder::Api.api_subdomain}.ccbchurch.com/api.php"
+    username = ChurchCommunityBuilder::Api.api_username
+    password = ChurchCommunityBuilder::Api.api_password
+
+    response =
+    case method
+    when :post
+      Typhoeus::Request.post(url, {:headers => headers, :body => body})
+    when :get
+      Typhoeus::Request.get(url, params: params, userpwd: username+":"+password)
+    when :put
+      Typhoeus::Request.put(url, {:headers => headers, :body => body})
+    when :delete
+      Typhoeus::Request.delete(url, {:headers => headers, :params => params})
+    end    
+
+
+    unless response.success?
+      if response.code > 0
+        raise ChurchCommunityBuilderExceptions::UnableToConnectToChurchCommunityBuilder.new(response.body)
+      else
+        begin
+          error_messages = JSON.parse(response.body)['error_message']
+        rescue
+          response_code_desc = response.headers.partition("\r\n")[0].sub(/^\S+/, '') rescue nil
+          raise ChurchCommunityBuilderExceptions::UnknownErrorConnectingToChurchCommunityBuilder.new("Unknown error when connecting to The City.#{response_code_desc}")
+        else
+          raise ChurchCommunityBuilderExceptions::ChurchCommunityBuilderResponseError.new(error_messages)
+        end
+      end
+    end    
+    
+    response
+  end
+
+end

data/lib/exceptions.rb

@@ -0,0 +1,5 @@
+module ChurchCommunityBuilderExceptions
+  class UnableToConnectToChurchCommunityBuilder < StandardError; end
+  class UnknownErrorConnectingToChurchCommunityBuilder < StandardError; end
+  class ChurchCommunityBuilderResponseError < StandardError; end
+end

data/lib/readers/api_reader.rb

@@ -0,0 +1,35 @@
+module ChurchCommunityBuilder
+
+  # This adapter is the standard for all loading objects.
+  class ApiReader
+    attr_reader :headers
+
+    # Constructor
+    # def initialize
+    # end
+
+    # Loads the list
+    #
+    # @return the data loaded in a JSON object.
+    def load_feed
+   
+        @url_data_params ||= {}
+        response = ChurchCommunityBuilder::admin_request(:get, @url_data_params)
+        data = _xml2json(response.body)
+        @headers = response.headers
+  
+        return data
+    end
+
+    private
+
+    def _xml2json(xml)
+      # {KeepRoot: true, ForceArray: false, SuppressEmpty: true} were set to 
+      # maximize compatibility with Hash.from_xml, used previously.
+      #
+      XmlSimple.xml_in(xml, {KeepRoot: true, ForceArray: false, SuppressEmpty: true})
+    end
+
+  end
+
+end

data/lib/readers/batch_list_reader.rb

@@ -0,0 +1,17 @@
+module ChurchCommunityBuilder
+
+  class BatchListReader < ApiReader
+
+    # Constructor.
+    #
+    def initialize(options = {})
+      filter = options[:filter]
+      @url_data_params = options[:url_data_params]
+
+      @url_data_params.merge!({:filter => filter}) if filter
+
+    end
+
+  end
+
+end

data/lib/readers/batch_reader.rb

@@ -0,0 +1,14 @@
+module ChurchCommunityBuilder
+
+  class BatchReader < ApiReader
+
+    # Constructor.
+    #
+    # @param person_id The ID of the user to load.
+    def initialize(batch_id)
+    	@url_data_params = {srv: "batch_profile_from_id", id: batch_id}
+    end
+
+  end
+
+end

data/lib/readers/campus_list_reader.rb

@@ -0,0 +1,17 @@
+module ChurchCommunityBuilder
+
+  class CampusListReader < ApiReader
+
+    # Constructor.
+    #
+    def initialize(options = {})
+      filter = options[:filter]
+      @url_data_params = options[:url_data_params]
+
+      @url_data_params.merge!({:filter => filter}) if filter
+
+    end
+
+  end
+
+end

data/lib/readers/individual_list_reader.rb

@@ -0,0 +1,18 @@
+module ChurchCommunityBuilder
+
+  # This reader works with both Individual List and ValidIndividualList
+  #
+  class IndividualListReader < ApiReader
+
+    # Constructor.
+    #
+    def initialize(options = {})
+      filter = options[:filter]
+
+      @url_data_params = options[:url_data_params]
+      @url_data_params.merge!({:filter => filter}) if filter
+    end
+
+  end
+
+end

data/lib/readers/individual_reader.rb

@@ -0,0 +1,14 @@
+module ChurchCommunityBuilder
+
+  class IndividualReader < ApiReader
+
+    # Constructor.
+    #
+    # @param individual_id The ID of the user to load.
+    def initialize(individual_id)
+    	@url_data_params = {srv: "individual_profile_from_id", individual_id: individual_id}
+    end
+
+  end
+
+end

data/lib/writers/api_writer.rb

@@ -0,0 +1,64 @@
+module ChurchCommunityBuilder
+
+  # This adapter is the standard for all saving objects.
+  class ApiWriter
+    attr_reader :error_messages, :response_code
+
+    # # Saves this object.
+    # #
+    # # @return True or ID on success, otherwise false.
+    # def save_object
+    #   @url_data_params ||= {}
+    #   success = true
+
+    #   if @url_data_path.nil?
+    #     @error_messages = ["#{@url_action.to_s.upcase} not implemented for #{self.class.to_s}"]
+    #     return false
+    #   end
+
+    #   if @updatable_fields and !@updatable_fields.empty?
+    #     fields_to_remove = @url_data_params.keys - @updatable_fields  
+    #     fields_to_remove.each { |ftr| @url_data_params.delete(ftr) }
+    #   end
+
+    #   begin
+    #     response = ChurchCommunityBuilder::admin_request(@url_action, @url_data_path, nil, @url_data_params.to_json)   
+    #     @response_code = response.code
+    #     # No content but is a success
+    #     success = response.code == 204 ? {'success' => true} : JSON.parse(response.body)  
+    #   rescue Exception => e  
+    #     @error_messages = e.message.split(',')
+    #     success = false
+    #   end 
+
+    #   return success
+    # end
+
+
+    # # Deletes this object.
+    # #
+    # # @return True or ID on success, otherwise false.
+    # def delete_object
+    #   success = true
+
+    #   if @url_data_delete_path.nil?
+    #     @error_messages = ["DELETE not implemented for #{self.class.to_s}"]
+    #     return false
+    #   end
+
+    #   begin
+    #     # @url_data_path should be the same as :put if this object is already
+    #     # setup and mapped to an object that exists
+    #     response = ChurchCommunityBuilder::admin_request(:delete, @url_data_delete_path)           
+    #     success = response.code == 204 ? true : false # No content but is a success
+    #   rescue Exception => e  
+    #     @error_messages = e.message.split(',')
+    #     success = false
+    #   end 
+
+    #   return success
+    # end    
+
+  end
+
+end

data/lib/writers/user_writer.rb

@@ -0,0 +1,46 @@
+module ChurchCommunityBuilder
+
+  class UserWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id] 
+        @url_action = :put
+        @url_data_path = "/users/#{data[:id]}"   
+      else
+        @url_action = :post   
+        @url_data_path = "/users"   
+      end
+      @url_data_delete_path = "/users/#{data[:id]}" 
+
+      @url_data_params = data
+
+      @updatable_fields = [:title,
+                           :first,
+                           :middle,
+                           :last,
+                           :nickname,
+                           :gender,
+                           :email,
+                           :staff,
+                           :primary_campus_id,
+                           :member_since,
+                           :birthdate,
+                           :primary_phone,
+                           :primary_phone_type,
+                           :secondary_phone,
+                           :secondary_phone_type,
+                           :external_id_1,
+                           :external_id_2,
+                           :external_id_3,
+                           :marital_status,
+                           :is_an_organization]      
+    end
+    
+  end
+
+end
+
+

data/spec/api/user_spec.rb

@@ -0,0 +1,37 @@
+# require File.join(Dir.pwd, 'spec', 'spec_helper')
+
+# describe 'User' do
+
+#   before do
+#     simulate_connection_to_server
+#   end
+
+#   after do
+
+#   end
+
+#   it 'should pass retrieving a user from list' do
+#     request_data = FactoryGirl.attributes_for(:user_list, {
+#       :total_entries => 1,
+#       :total_pages => 1,
+#       :users => [FactoryGirl.attributes_for(:user)]
+#     }).to_json
+#     TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+
+#     user_list = TheCity::UserList.new
+
+#     user = user_list[0]
+#     user.full_name.should == "Sammy Shepherd"
+#   end
+
+
+#   it 'should pass retrieving a user' do
+#     request_data = FactoryGirl.attributes_for(:user).to_json
+#     TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+#     user = TheCity::User.load_by_id(123)
+#     user.full_name.should == "Sammy Shepherd"
+#   end  
+
+# end
+
+

data/spec/factories/user.rb

@@ -0,0 +1,51 @@
+# module TheCity
+#   FactoryGirl.define do
+    
+#     factory :user, :class => TheCity::User do
+#       api_url "https://api.onthecity.org/users/946060874" 
+#       updated_at "05/15/2012 07:24 AM (UTC)" 
+#       last_logged_in "05/16/2012 04:52 AM (UTC)" 
+#       secondary_phone "" 
+#       last_engaged "05/16/2012 04:52 AM (UTC)" 
+#       title "Pastor" 
+#       internal_url "http://local.devthecity.org:3000/users/946060874" 
+#       id 946060874 
+#       first "Sam" 
+#       primary_campus_name nil 
+#       last "Shepherd" 
+#       head_of_household true 
+#       nickname "Sammy" 
+#       active true 
+#       primary_phone_type "home" 
+#       primary_phone "" 
+#       member_since "05/14/2012" 
+#       birthdate "1974-11-09" 
+#       email_bouncing false 
+#       secondary_phone_type "home" 
+#       primary_campus_id nil 
+#       marital_status nil 
+#       contact_updated_at "05/15/2012 12:24 AM (UTC)" 
+#       type "User" 
+#       staff true 
+#       admin_url "http://church.onthecity.org/admin/users/946060874" 
+#       created_at "05/14/2012 05:51 PM (UTC)" 
+#       gender "Male" 
+#       external_id_1 nil 
+#       external_id_2 nil 
+#       external_id_3 nil 
+#       middle "" 
+#       email "zack@church.org"
+#       last_checkin_date "05/14/2012 05:51 PM (UTC)" 
+#       last_donation_date "05/14/2012 05:51 PM (UTC)" 
+#       last_attendance_date "05/14/2012 05:51 PM (UTC)" 
+#       in_community true
+#       in_service true
+#       in_welcome true
+#       in_campus true
+#       in_neighborhood true      
+#     end
+
+#   end
+# end
+
+

data/spec/functional/ccb_spec.rb

@@ -0,0 +1,20 @@
+# require File.join(Dir.pwd, 'spec', 'spec_helper')
+
+# describe 'AdminApi' do
+
+#   before do
+#     simulate_connection_to_server
+#   end
+
+#   after do
+
+#   end
+
+#   it 'should get a list of users without any paramters'
+#   it 'should get a list of users with parameters'
+#   it 'should get a user count without any paramters'
+#   it 'should get a user count with the specified paramters'
+
+# end
+
+

data/spec/readers/user_reader_spec.rb

@@ -0,0 +1,7 @@
+# require 'spec_helper'
+
+# describe 'UserReader' do
+  
+#   it 'should pass if ....' 
+
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# # Project::    TheCity Admin API 
+# # File::       the_city.rb
+# #
+# # Author:: Wes Hays <weshays@gbdev.com> 
+# # Link:: https://github.com/weshays/admin-api-ruby
+# # Package:: TheCity::Admin
+
+
+# require File.expand_path( File.dirname(__FILE__) + '/../lib/the_city_admin.rb')
+
+# require 'rubygems'
+# require 'rspec'
+# require 'ruby-debug'
+# require 'date'
+
+# require 'factory_girl'
+# Dir.glob(File.dirname(__FILE__) + "/factories/*").each { |f| require f }
+
+
+# TheCityResponse = Struct.new(:code, :body, :headers)
+
+# RSpec.configure do |config|
+#   config.tty = true
+#   config.mock_with :rspec
+#   config.include FactoryGirl::Syntax::Methods
+# end
+
+
+# def simulate_connection_to_server
+#   @the_city = TheCity::AdminApi.new('cf2903151e3213e66fd8080c7d8b65b1d6ccdd31', '5c88b32edda7653c')
+# end

data/spec/writers/user_writer_spec.rb

@@ -0,0 +1,80 @@
+# require 'spec_helper'
+
+# describe 'UserWriter' do
+
+#   it 'should show connection error messages if server cannot be reached' do
+#     TheCity.stub(:admin_request) { raise TheCityExceptions::UnableToConnectToTheCity.new('Unable to connect to server') }
+#     user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+#     user = TheCity::User.new(user_data)
+#     user.id.should be_nil
+#     user.save.should === false
+#     user.id.should be_nil
+#     user.error_messages.should == ['Unable to connect to server']
+#   end  
+
+
+#   it 'should save if all data is valid for new user' do
+#     request_data = FactoryGirl.attributes_for(:user, {:id => 12345}).to_json
+#     TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+#     user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+#     user = TheCity::User.new(user_data)
+#     user.id.should be_nil
+#     user.save.should === true
+#     user.id.should == 12345
+#   end
+
+
+#   it 'should show error messages if save fails for new user' do
+#     TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('email address already exists') }
+#     user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+#     user = TheCity::User.new(user_data)
+#     user.id.should be_nil
+#     user.save.should === false
+#     user.id.should be_nil
+#     user.error_messages.should == ['email address already exists']
+#   end  
+
+
+#   it 'should save if all data is valid for existing user' do
+#     request_data = FactoryGirl.attributes_for(:user, {:id => 12345}).to_json
+#     TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )    
+#     user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+#     user = TheCity::User.new(user_data)
+#     user.id.should == 12345
+#     user.save.should === true
+#     user.id.should == 12345
+#   end
+
+
+#   it 'should show error messages if save fails for existing user' do
+#     TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+#     user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+#     user = TheCity::User.new(user_data)
+#     user.id.should == 12345
+#     user.save.should === false
+#     user.id.should == 12345
+#     user.error_messages.should == ['something bad happened']
+#   end  
+
+
+#   it 'should delete if data ID exists for the existing user' do
+#     TheCity.stub(:admin_request).and_return( TheCityResponse.new(204, '{}') ) 
+#     user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+#     user = TheCity::User.new(user_data)
+#     user.is_deleted?.should === false
+#     user.delete
+#     user.is_deleted?.should === true
+#   end
+
+
+#   it 'should show error messages if data fails to be deleted' do
+#     TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+#     user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+#     user = TheCity::User.new(user_data)
+#     user.is_deleted?.should === false
+#     user.delete
+#     user.is_deleted?.should === false
+#     user.error_messages.should == ['something bad happened']
+#   end  
+
+# end