fellowshipone-api 0.6.0

data/lib/api/contribution_list.rb

@@ -0,0 +1,57 @@
+module FellowshipOne
+
+  class ContributionList
+
+    include Enumerable
+
+    attr_reader :count, :page_number, :total_records, :additional_pages
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    # :page - (optional) The page number to get.
+    # :reader - (optional) The Reader to use to load the data.
+    def initialize(options)
+      #options[:page] ||= 1
+      reader = options[:reader] || FellowshipOne::ContributionListReader.new(options)
+      @json_data = reader.load_feed
+
+      @count = @json_data['@count'].to_i
+      @page_number = @json_data['@pageNumber'].to_i
+      @total_records = @json_data['@totalRecords'].to_i
+      @additional_pages = @json_data['@additionalPages'].to_i
+    end
+
+
+    # Get the specified contribution.
+    #
+    # @param index The index of the contribution to get.
+    #
+    # @return Contribution
+    def [](index)
+      Contribution.new( @json_data['contributionReceipt'][index] ) if @json_data['contributionReceipt'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['contributionReceipt'].each{ |cont_recpt| yield( Contribution.new(cont_recpt) )}
+    end
+
+    # Alias the count method
+    alias :size :count
+
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      self.count == 0 ? true : false
+    end
+
+  end
+  
+end

data/lib/api/fund.rb

@@ -0,0 +1,40 @@
+module FellowshipOne
+
+  class Fund < ApiObject
+
+    f1_attr_accessor :id,
+                     :name,
+                     :fund_type,
+                     :fund_code,
+                     :is_web_enabled,
+                     :account_reference,
+                     :is_active,
+                     :created_date,
+                     :created_by_person,
+                     :last_updated_date,
+                     :last_updated_by_person
+
+    # Load the fund by the specified ID.
+    #
+    # @param fund_id The ID of the fund to load.
+    #
+    # Returns a new Fund object.
+    def self.load_by_id(fund_id)
+      reader = FundReader.new(fund_id)
+      self.new(reader)
+    end
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data. This can be a FundReader or Hash object.
+    def initialize(reader = nil)
+      if reader.is_a?(FundReader)    
+        initialize_from_json_object(reader.load_feed['fund'])
+      elsif reader.is_a?(Hash)        
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end

data/lib/api/fund_list.rb

@@ -0,0 +1,53 @@
+module FellowshipOne
+
+  class FundList
+
+    include Enumerable
+
+    attr_reader :count, :page_number, :total_records, :additional_pages
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    # :reader - (optional) The Reader to use to load the data.
+    def initialize(options = {})
+      reader = options[:reader] || FellowshipOne::FundListReader.new(options)
+      @json_data = reader.load_feed
+      @count = @json_data['funds']['fund'].size.to_i
+      @page_number = 1
+      @total_records = @count
+      @additional_pages = 0
+    end
+
+    # Get the specified fund.
+    #
+    # @param index The index of the fund to get.
+    #
+    # @return Fund
+    def [](index)
+      Fund.new( @json_data['funds']['fund'][index] ) if @json_data['funds']['fund'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['funds']['fund'].each{ |cont_recpt| yield( Fund.new(cont_recpt) )}
+    end
+
+    # Alias the count method
+    alias :size :count
+
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      self.count == 0 ? true : false
+    end
+
+  end
+  
+end

data/lib/api/household.rb

@@ -0,0 +1,50 @@
+module FellowshipOne
+
+  class Household < ApiObject
+
+    f1_attr_accessor :id,
+                     :uri,
+                     :old_id,
+                     :h_code,
+                     :household_name,
+                     :household_sort_name,
+                     :household_first_name,
+                     :last_security_authorization,
+                     :last_activity_date,
+                     :created_date,
+                     :last_updated_date # This is a datetime
+
+    # Loads the household by the specified ID.
+    #
+    def self.load_by_id(household_id)
+      reader = HouseholdReader.new(household_id)
+      self.new(reader)
+    end
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data. This can be a HouseholdReader or Hash object.
+    def initialize(reader = nil)
+      @writer_object = HouseholdWriter
+      if reader.is_a?(HouseholdReader)
+        initialize_from_json_object(reader.load_feed['household'])
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      else # new 
+        reader = HouseholdReader.new
+        initialize_from_json_object(reader.load_new['household'])        
+      end    
+    end
+    
+
+    def _field_map
+      {:id => '@id',
+       :uri => '@uri',
+       :oldId => '@oldID',
+       :hCode => '@hCode'}
+    end
+    
+  end
+
+end

data/lib/api/household_list.rb

@@ -0,0 +1,78 @@
+module FellowshipOne
+
+  class HouseholdList
+
+    include Enumerable
+
+    attr_reader :count, :page_number, :total_records, :additional_pages
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    # :page - (optional) The page number to get.
+    # :reader - (optional) The Reader to use to load the data.
+    # :household_id - The household ID to pull the info for.
+    def initialize(options)
+      #options[:page] ||= 1
+      reader = options[:reader] || FellowshipOne::HouseholdListReader.new(options)
+      @json_data = reader.load_feed
+
+      @count = @json_data['@count'].to_i
+      @page_number = @json_data['@pageNumber'].to_i
+      @total_records = @json_data['@totalRecords'].to_i
+      @additional_pages = @json_data['@additionalPages'].to_i
+    end
+
+
+
+    # Get the specified user.
+    #
+    # @param index The index of the user to get.
+    #
+    # @return [User]
+    def [](index)
+      Household.new( @json_data['household'][index] ) if @json_data['household'] and @json_data['household'][index]
+    end
+
+    def all_names
+      return [] unless @json_data['household']
+      @json_data['household'].collect { |household| household['householdName'] }
+    end
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['household'].each{ |household| yield( Household.new(household) )}
+    end
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      #@json_data['person'].empty?
+      self.count == 0 ? true : false
+    end
+
+    # Get all the household ids in the list.
+    #
+    # @return An array of household ids.
+    def ids
+      (@json_data['household'].collect { |household| household['@id'] }).uniq
+    end
+
+    # Access to the raw JSON data.  This method is needed for merging lists.
+    #
+    # @returns Raw JSON data.
+    def raw_data
+      @json_data
+    end
+
+
+  end
+    
+  
+end

data/lib/api/member_household_list.rb

@@ -0,0 +1,73 @@
+module FellowshipOne
+
+  class MemberHouseholdList
+
+    include Enumerable
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    # :page - (optional) The page number to get.
+    # :reader - (optional) The Reader to use to load the data.
+    # :household_id - The household ID to pull the info for.
+    def initialize(options)
+      raise 'Household ID not specified' if options[:household_id].nil?
+
+      #options[:page] ||= 1
+      reader = options[:reader] || FellowshipOne::MemberHouseholdListReader.new(options)
+      @json_data = reader.load_feed
+    end
+
+
+
+    # Get the specified user.
+    #
+    # @param index The index of the user to get.
+    #
+    # @return [User]
+    def [](index)
+      Person.new( @json_data['people']['person'][index] ) if @json_data['people']['person'] and @json_data['people']['person'][index]
+    end
+
+    def all_names
+      return [] unless @json_data['people']
+      @json_data['people']['person'].collect { |person| [person['firstName'], person['lastName']].join(' ') }
+    end
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['people']['person'].each{ |person| yield( Person.new(person) )}
+    end
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      #@json_data['person'].empty?
+      self.count == 0 ? true : false
+    end
+
+    # Get all the household ids in the list.
+    #
+    # @return An array of household ids.
+    def ids
+      @json_data['people']['person'].collect { |person| person['@id'] }
+    end
+
+    # Access to the raw JSON data.  This method is needed for merging lists.
+    #
+    # @returns Raw JSON data.
+    def raw_data
+      @json_data['people']['person']
+    end
+
+
+  end
+    
+  
+end

data/lib/api/mergeable_household_list.rb

@@ -0,0 +1,79 @@
+module FellowshipOne
+
+  class MergeableHouseholdList
+
+    include Enumerable
+
+		# Constructor.
+    # 
+    def initialize
+      @json_data = { 'household' => [] }
+       # commented out until can figure out what he was doing here.
+    end
+
+
+    # All the households in the list.
+    #
+    # @return array of names (first last).
+    def all_names
+      return [] unless @json_data['household']
+      @json_data['household'].collect { |household| household['householdName'] }
+    end
+
+    alias_method :names, :all_names
+
+
+    # Get the specified household.
+    #
+    # @param index The index of the household to get.
+    #
+    # @return [household]
+    def [](index)
+      Household.new( @json_data['household'][index] ) if @json_data['household'] and @json_data['household'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['household'].each{ |household| yield( Household.new(household) )}
+    end
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      #@json_data['household'].empty?
+      self.count == 0 ? true : false
+    end
+
+
+    # Get all the household ids in the list.
+    #
+    # @return An array of household ids.
+    def ids
+      (@json_data['household'].collect { |household| household['@id'] }).uniq
+    end
+
+
+    # Access to the raw JSON data.  This method is needed for merging lists.
+    #
+    # @returns Raw JSON data.
+    def raw_data
+      @json_data
+    end
+
+
+    # Adds a HouseholdList to this list.
+    #
+    def add(household_list)
+      @json_data['household'] += household_list.raw_data['household']
+    end   
+
+    alias_method :merge, :add  
+
+  end
+    
+end

data/lib/api/mergeable_person_list.rb

@@ -0,0 +1,110 @@
+module FellowshipOne
+
+  class MergeablePersonList
+
+    include Enumerable
+
+
+    # There is currently no way to list all people in FellowshipOne.
+    # This method will search all users, AA - AZ, or whatever
+    # range is specified, and load them into a MergedPersonList.
+    #
+    def self.load_all(alpha="aa",omega="zz")
+      mpl = MergeablePersonList.new
+      alpha.upto(omega).each do |x|
+        page = 1
+        person_list = Search.search_for_person_by_name(x)
+        mpl.add(person_list) unless person_list.empty?
+        while person_list.additional_pages > 0
+          page += 1
+          person_list = Search.search_for_person_by_name(x,page)
+          mpl.add(person_list) unless person_list.empty?
+        end
+      end
+      mpl
+    end
+
+
+    # Load all people created on or after the specified date and load them into a MergedPersonList.
+    #
+    def self.load_all_on_or_after(start_date)
+      mpl = MergeablePersonList.new
+      person_list = Search.search_for_person_created_on_or_after(start_date)
+      mpl.add(person_list) unless person_list.empty?
+      mpl
+    end    
+
+
+    # Constructor.
+    # 
+    def initialize
+      @json_data = { 'person' => [] }
+       # commented out until can figure out what he was doing here.
+    end
+
+
+    # All the people in the list.
+    #
+    # @return array of names (first last).
+    def all_names
+      return [] unless @json_data['person']
+      @json_data['person'].collect { |person| [person['firstName'], person['lastName']].join(' ') }
+    end
+
+    alias_method :names, :all_names
+
+
+    # Get the specified person.
+    #
+    # @param index The index of the person to get.
+    #
+    # @return [Person]
+    def [](index)
+      Person.new( @json_data['person'][index] ) if @json_data['person'] and @json_data['person'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['person'].each{ |person| yield( Person.new(person) )}
+    end
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      #@json_data['person'].empty?
+      self.count == 0 ? true : false
+    end
+
+
+    # Get all the people ids in the list.
+    #
+    # @return An array of people ids.
+    def ids
+      (@json_data['person'].collect { |person| person['@id'] }).uniq
+    end
+
+
+    # Access to the raw JSON data.  This method is needed for merging lists.
+    #
+    # @returns Raw JSON data.
+    def raw_data
+      @json_data
+    end
+
+
+    # Adds a PersonList to this list.
+    #
+    def add(person_list)
+      @json_data['person'] += person_list.raw_data['person']
+    end   
+
+    alias_method :merge, :add  
+
+  end
+    
+end