fellowshipone-api 0.6.0

data/lib/oauth_monkey_patch.rb

@@ -0,0 +1,13 @@
+#
+# small monkey patch for the oauth-ruby gem, 
+# for compatibility with typhoeus > 0.5.0
+#
+module OAuth::RequestProxy::Typhoeus
+  class Request < OAuth::RequestProxy::Base
+
+    def method
+      request.options[:method].to_s.upcase
+    end
+    
+  end
+end

data/lib/readers/api_reader.rb

@@ -0,0 +1,34 @@
+module FellowshipOne
+
+  # This adapter is the standard for all loading objects.
+  class ApiReader
+    attr_reader :headers
+
+    # Retrieve an empty resource with the proper structure.
+    #
+    # @return a new empty resource.
+    def load_new
+      return if @url_new_data_path.nil?
+      return _load_data(@url_new_data_path, {})
+    end      
+
+    # Loads the list
+    #
+    # @return the data loaded in a JSON object.
+    def load_feed
+      @url_data_params ||= {}
+      return _load_data(@url_data_path, @url_data_params)
+    end
+
+    private
+
+    def _load_data(url_data_path, url_data_params)
+      response = FellowshipOne::api_request(:get, url_data_path, url_data_params)
+      data = JSON.parse(response.body)
+      @headers = response.headers
+      return data.keys == ['results'] ? data['results'] : data
+    end
+
+  end
+
+end

data/lib/readers/communication_reader.rb

@@ -0,0 +1,19 @@
+module FellowshipOne
+
+  class CommunicationReader < ApiReader
+
+    # Constructor.
+    #
+    # @param person_id The ID of the person to load the communication for.
+    # @param communication_id (optional) The ID of the communication to load.
+    def initialize(person_id, communication_id)
+      if communication_id.nil?
+        @url_new_data_path = "/v1/People/#{person_id}/Communications/new"
+      else
+        @url_data_path = "/v1/People/#{person_id}/Communications/#{communication_id}"
+      end      
+    end
+    
+  end
+
+end

data/lib/readers/contribution_list_reader.rb

@@ -0,0 +1,37 @@
+module FellowshipOne
+
+  class ContributionListReader < ApiReader
+
+    # Constructor.
+    #
+    # Options:
+    # :page - (optional) The page number to get.  The default is 1.
+    # :per_page - (optional) The number of items to return per page.
+    # :individual_id - (optional) search for receipts containing the individualID that is passed with this parameter.
+    # :household_id - (optional) search for receipts containing the householdID that is passed with this parameter.
+    # :start_date - (optional) search for receipts with a received date greater than or equal to this parameter.
+    # :end_date - (optional) search for receipts with a received date less than or equal to this parameter. Must be used in conjunction with startReceivedDate.
+    def initialize(options = {})
+      page = options[:page] || 1
+      per_page = options[:per_page] || 500
+
+      @url_data_params = {}
+      @url_data_path = '/giving/v1/contributionreceipts/search'
+      if options[:household_id].nil? and
+         options[:individual_id].nil? and 
+         options[:start_date].nil? and 
+         options[:end_date].nil? and 
+        @url_data_path = '/giving/v1/contributionreceipts'
+      end
+            
+      @url_data_params.merge!({:page => page}) if page
+      @url_data_params.merge!({:recordsPerPage => per_page}) if per_page      
+      @url_data_params.merge!({:individualID => options[:individual_id]}) if options[:individual_id]
+      @url_data_params.merge!({:householdID => options[:household_id]}) if options[:household_id]
+      @url_data_params.merge!({:startReceivedDate => options[:start_date]}) if options[:start_date]
+      @url_data_params.merge!({:endReceivedDate => options[:end_date]}) if options[:end_date]
+    end
+
+  end
+
+end

data/lib/readers/contribution_reader.rb

@@ -0,0 +1,18 @@
+module FellowshipOne
+
+  class ContributionReader < ApiReader
+
+    # Constructor.
+    #
+    # @param contribution_id (optional) The ID of the contribution to load.
+    def initialize(contribution_id = nil)
+      if contribution_id.nil?
+        @url_new_data_path = '/giving/v1/contributionreceipts/new'
+      else
+        @url_data_path = "/giving/v1/contributionreceipts/#{contribution_id}"
+      end      
+    end
+    
+  end
+
+end

data/lib/readers/fund_list_reader.rb

@@ -0,0 +1,13 @@
+module FellowshipOne
+
+  class FundListReader < ApiReader
+
+    # Constructor.    
+    def initialize(options = {})
+      @url_data_params = options[:url_data_params]
+      @url_data_path = options[:url_data_path] || "/giving/v1/funds"
+    end
+
+  end
+
+end

data/lib/readers/fund_reader.rb

@@ -0,0 +1,14 @@
+module FellowshipOne
+
+  class FundReader < ApiReader
+
+    # Constructor.
+    #
+    # @param fund_id The ID of the fund to load.
+    def initialize(fund_id)
+      @url_data_path = "/giving/v1/funds/#{fund_id}"
+    end
+    
+  end
+
+end

data/lib/readers/household_list_reader.rb

@@ -0,0 +1,62 @@
+module FellowshipOne
+
+  class HouseholdListReader < ApiReader
+
+    # Constructor.
+    #
+    # Options:
+    # :page - (optional) The page number to get.
+    # :per_page - (optional) The number of items to return per page.
+    # :household_id - The household ID to pull the info for.
+    # :search_for - (optional) Search for name in the request.
+    def initialize(options = {})
+      raise 'Household ID not specified' if options[:household_id].nil? and options[:search_for].nil?
+
+      page = options[:page] || 1
+      per_page = options[:per_page] || 100
+      
+      @url_data_params = {}
+      @url_data_path = options[:search_for].nil? ? "/v1/Households/#{options[:household_id].to_i}/People" : '/v1/Households/Search'
+
+      @url_data_params.merge!({:page => page}) if page
+      @url_data_params.merge!({:recordsPerPage => per_page}) if per_page
+      @url_data_params.merge!({:search_for => options[:search_for]}) if options[:search_for]      
+    end
+
+  end
+
+end
+
+
+######### This will be refactored later.
+
+
+# # Constructor.
+# #
+# # Options:
+# # :page - (optional) The page number to get.
+# #
+# # Only one of the optional parameters below can be specified.
+# # :search_for - (optional) This parameter will be used as: parameter.searchfor like household.householdName.
+# # :last_activity_date - (optional) This parameter will be used as: parameter.lastActivityDate >= household.lastActivityDate.
+# # :last_updated_date - (optional) This parameter will be used as: parameter.lastUpdatedDate >= household.lastUpdatedDate.
+# # :created_date - (optional) This parameter will be used as: parameter.createdDate >= household.createdDate.
+# def initialize(options = {})
+#   page = options[:page] || 1
+
+#   @url_data_params = {:page => page}
+#   @url_data_path = '/v1/Households/Search'
+
+#   @url_data_params.merge!({:page => page}) if page
+#   if options[:search_for]
+#     @url_data_params.merge!({:searchfor => options[:search_for]})
+#   elsif options[:last_activity_date]
+#     @url_data_params.merge!({:lastActivityDate => options[:last_activity_date]})
+#   elsif options[:last_updated_date]
+#     @url_data_params.merge!({:lastUpdatedDate => options[:last_updated_date]})
+#   elsif options[:created_date]
+#     @url_data_params.merge!({:createdDate => options[:created_date]})
+#   end
+#   ....
+# end
+

data/lib/readers/household_reader.rb

@@ -0,0 +1,18 @@
+module FellowshipOne
+
+  class HouseholdReader < ApiReader
+
+    # Constructor.
+    #
+    # @param household_id (optional) The ID of the household to load.
+    def initialize(household_id = nil)
+      if household_id.nil?
+        @url_new_data_path = '/v1/Households/New'
+      else
+        @url_data_path = "/v1/Households/#{household_id}"
+      end
+    end
+    
+  end
+
+end

data/lib/readers/member_household_list_reader.rb

@@ -0,0 +1,27 @@
+module FellowshipOne
+
+  class MemberHouseholdListReader < ApiReader
+
+    # Constructor.
+    #
+    # Options:
+    # :page - (optional) The page number to get.
+    # :filter - (optional) Filter options for the request.
+    # :household_id - The household ID to pull the info for.
+    def initialize(options = {})
+      raise 'Household ID not specified' if options[:household_id].nil?
+
+      page = options[:page] || 1
+      filter = options[:filter]
+      household_id = options[:household_id]
+
+      @url_data_params = options[:url_data_params] || {}
+      @url_data_path = options[:url_data_path] || "/v1/Households/#{household_id}/People"
+
+      @url_data_params.merge!({:page => page}) if page
+      @url_data_params.merge!({:filter => filter}) if filter
+    end
+
+  end
+
+end

data/lib/readers/person_list_reader.rb

@@ -0,0 +1,37 @@
+module FellowshipOne
+
+  class PersonListReader < ApiReader
+
+    # Constructor.
+    #
+    # Options:
+    # :page - (optional) The page number to get.  The default is 1.
+    # :per_page - (optional) The number of items to return per page.
+    # :search_for - (optional) Search for name in the request.
+    # :created_date - (optional) Search for those created on or after specified date.
+    #
+    # ** search params are mutually exclusive and cannot be used with any other search parameters
+    def initialize(options = {})
+      page = options[:page] || 1
+      per_page = options[:per_page] || 100
+
+      @url_data_params = {}
+      @url_data_path = '/v1/People/Search'
+      if options[:search_for].nil? and 
+         options[:communication].nil? and 
+         options[:created_date].nil? and 
+         options[:hsdid].nil?
+        @url_data_path = '/v1/People'
+      end
+
+      @url_data_params.merge!({:page => page, :include => 'addresses,communications'}) if page
+      @url_data_params.merge!({:recordsPerPage => per_page}) if per_page      
+      @url_data_params.merge!({:hsdid => options[:hsdid]}) if options[:hsdid]
+      @url_data_params.merge!({:searchFor => options[:search_for]}) if options[:search_for]
+      @url_data_params.merge!({:communication => options[:communication]}) if options[:communication]
+      @url_data_params.merge!({:createdDate => options[:created_date]}) if options[:created_date]
+    end
+
+  end
+
+end

data/lib/readers/person_reader.rb

@@ -0,0 +1,20 @@
+module FellowshipOne
+
+  class PersonReader < ApiReader
+
+    # Constructor.
+    #
+    # @param person_id (optional) The ID of the person to load.
+    def initialize(person_id = nil)
+      if person_id.nil?
+        @url_new_data_path = '/v1/People/New'
+      else
+        @url_data_path = "/v1/People/#{person_id}"
+      end
+    end
+    
+  end
+
+end
+
+

data/lib/writers/api_writer.rb

@@ -0,0 +1,64 @@
+module FellowshipOne
+
+  # 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 = FellowshipOne::api_request(@url_action, @url_data_path, [], @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 = FellowshipOne::api_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/communication_writer.rb

@@ -0,0 +1,27 @@
+module FellowshipOne
+
+  class CommunicationWriter < ApiWriter
+
+    # Constructor.
+    # Note: writer will get data after it has been mapped to the FellowshipOne
+    # resource so the hash keys will be the same as FellowshipOne
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/v1/People/#{data['person']['@id']}/Communications/#{data['@id']}"
+      else
+        @url_action = :post
+        @url_data_path = "/v1/People/#{data['person']['@id']}/Communications"
+      end
+      @url_data_delete_path = "/v1/Communications/#{data['@id']}"
+
+      @url_data_params = @url_data_params = {:communication => data}
+
+      @updatable_fields = []
+    end
+    
+  end
+
+end

data/lib/writers/contribution_writer.rb

@@ -0,0 +1,28 @@
+module FellowshipOne
+
+  class ContributionWriter < ApiWriter
+
+    # Constructor.
+    #
+    # @param data The json object data to save.
+    def initialize(data)
+      if data[:id]
+        @url_action = :put
+        @url_data_path = "/giving/v1/contributionreceipts/#{data[:id]}"
+      else
+        @url_action = :post
+        @url_data_path = "/giving/v1/contributionreceipts"
+      end
+      @url_data_delete_path = "/giving/v1/contributionreceipts/#{data[:id]}"
+
+      @url_data_params = @url_data_params = {:contributionReceipt => data}
+
+      @updatable_fields = [:amount,
+                           :fund,              #required
+                           :received_date,     #required
+                           :contribution_type] #required
+    end
+    
+  end
+
+end