shelby-arena-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 931e155b3330e3297457065c53aaea47172a4875
-  data.tar.gz: a9dfb77ccee9f40d6dc9579988f69f20d7927fbe
+  metadata.gz: 11b64f9a4f298bbe902f7ab4572836428f253a4a
+  data.tar.gz: c311075fa91a574c0848df1f295d6e6072148ddb
 SHA512:
-  metadata.gz: bd8f6dc7dc5c054693b48b16a627466222bf571df86b1199d90449bdb5b6c96b9b4986c0fafc893650f079a0c2fcd9a33225b3ebbccde24d6fb457037e82a37e
-  data.tar.gz: c0948853eed75f02d0ed68da5ad52f5c4da3769db3a418e6e14f8302208ddccef5d05621638e346dfd570485047161feb91ba19b50f69b0cd4ab351bc1896e19
+  metadata.gz: a46c778cf608e1e35b6438c1d0e2aa88f2b5addad1295865087a882613331d0fa20a1b5dedd0d67abaa1de7bfc7b19f2e42e21ee94f49ff4657827caedf022be
+  data.tar.gz: 00b5bdcbfce8e8125e0f1b56289d13f828a874b7c17c652a80d4f47f3fca57cda6c5f299469c8cb94ee7b6fd82530b241e0fd28f38bd87f00f0fd6607bb537ff

data/lib/api/contribution.rb

@@ -37,6 +37,58 @@ module ShelbyArena
       end
     end
 
+
+    # Helper methods
+
+    def fund_id
+      begin
+        self.contribution_funds['ContributionFund']['Fund']['FundId']
+      rescue
+        nil
+      end
+    end
+
+
+    def fund_name
+      begin
+        self.contribution_funds['ContributionFund']['Fund']['FundName']
+      rescue
+        nil
+      end
+    end
+
+
+    def first_name_with_nickname
+      begin
+        fname = self.person_information['FirstName']
+        if self.person_information['NickName'].strip != '' and 
+           self.person_information['NickName'].strip != fname
+          fname += " (#{self.person_information['NickName']})"
+        end
+        fname
+      rescue
+        nil
+      end
+    end
+
+
+    def first_name
+      begin
+        self.person_information['FirstName']
+      rescue
+        nil
+      end
+    end
+
+
+    def last_name
+      begin
+        self.person_information['NickName']
+      rescue
+        nil
+      end
+    end
+    
   end
 
 end

data/lib/api/contribution_list.rb

@@ -14,8 +14,13 @@ module ShelbyArena
     # Options:
     # :reader - (optional) The Reader to use to load the data.
     def initialize(options = {})
-      reader = options[:reader] || ShelbyArena::ContributionListReader.new(options)    
-      @json_data = reader.load_data['ContributionListResult']['Contributions']['Contribution']
+      @json_data = []
+      reader = options[:reader] || ShelbyArena::ContributionListReader.new(options)         
+      data = reader.load_data['ContributionListResult']['Contributions']    
+      unless data.nil?
+        # needs to be an array of hashes.
+        @json_data = data['Contribution'].is_a?(Array) ? data['Contribution'] : [data['Contribution']]
+      end
     end
 
     # Get the specified contribution.

data/lib/api/family.rb

@@ -39,9 +39,10 @@ module ShelbyArena
       # The data loaded from family_members is useless.  It is best to just reload all the family 
       # members as person objects so all attributes are set.     
       # fm[0] is 'Person'
-      # fm[1] is a Hash of person info to match some, not all, of the attributes above.
+      # fm[1] is an array of Hashes or a sigle Hash of person info to match some, not all, of the attributes above.
       method_to_call = "#{ShelbyArena::attr_underscore('family_members')}="
-      self.send(method_to_call, self.family_members.collect { |fm| ShelbyArena::Person.load_by_id(fm[1]['PersonID']) })       
+      members = self.family_members.first[1].is_a?(Array) ? self.family_members.first[1] : [self.family_members.first[1]] 
+      self.send(method_to_call, members.collect { |m| ShelbyArena::Person.load_by_id(m['PersonID']) })       
     end
 
   end

data/lib/api/fund_list.rb

@@ -14,8 +14,13 @@ module ShelbyArena
     # Options:
     # :reader - (optional) The Reader to use to load the data.
     def initialize(options = {})
-      reader = options[:reader] || ShelbyArena::FundListReader.new(options)    
-      @json_data = reader.load_data['FundListResult']['Funds']['Fund']
+      @json_data = []
+      reader = options[:reader] || ShelbyArena::FundListReader.new(options)  
+      data = reader.load_data['FundListResult']['Funds']   
+      unless data.nil?
+        # needs to be an array of hashes.
+        @json_data = data['Fund'].is_a?(Array) ? data['Fund'] : [data['Fund']]
+      end      
     end
 
     # Get the specified fund.

data/lib/api/person.rb

@@ -62,6 +62,11 @@ module ShelbyArena
     # end
 
 
+    def active
+      self.record_status_value.downcase == 'active'
+    end
+
+
     def family_role
       self.family_member_role_value.blank? ? 'Other' : self.family_member_role_value
     end

data/lib/api/person_list.rb

@@ -11,8 +11,13 @@ module ShelbyArena
     # Options:
     # :reader - (optional) The Reader to use to load the data.
     def initialize(options = {})
+      @json_data = []
       reader = options[:reader] || ShelbyArena::PersonListReader.new(options)
-      @json_data = reader.load_data['PersonListResult']['Persons']['Person']
+      data = reader.load_data['PersonListResult']['Persons']  
+      unless data.nil?
+        # needs to be an array of hashes.
+        @json_data = data['Person'].is_a?(Array) ? data['Person'] : [data['Person']]
+      end            
     end
 
     # Get the specified person.

data/lib/api/search.rb

@@ -0,0 +1,19 @@
+module ShelbyArena
+
+  class Search
+
+    def self.search_for_contributions_by_date_range(start_date, end_date)
+      options = {from_date: start_date, to_date: end_date}
+      reader = ShelbyArena::ContributionListReader.new(options)
+      ContributionList.new({reader: reader})
+    end       
+
+    def self.search_for_contributions_by_person(first_name, last_name)
+      options = {first_name: first_name, last_name: last_name}
+      reader = ShelbyArena::ContributionListReader.new(options)
+      ContributionList.new({reader: reader})
+    end       
+
+  end
+
+end

data/lib/readers/contribution_list_reader.rb

@@ -3,26 +3,34 @@ module ShelbyArena
   class ContributionListReader < ApiReader
 
     # Constructor.
+    #
+    # Options:
+    # :person_id - (optional) search for receipts containing the PersonId 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. 
     def initialize(options = {})
       # page = options[:page] || 1
       # per_page = options[:per_page] || 100
 
       @url_data_params = {}
       valid_fields.each { |field| @url_data_params[field] = options[ShelbyArena::attr_underscore(field).to_sym] unless options[ShelbyArena::attr_underscore(field).to_sym].nil? }
-      @url_data_path = 'contribution/list'
+      @url_data_path = 'contribution/list' 
+
     end
 
     def valid_fields
-      %W(Active
-         CanPledge
-         EndDate
-         FundId
-         FundName
-         OnlineName
-         StartDate
-         TaxDeductible).sort
+      %W(FirstName
+         LastName
+         FromDate
+         ToDate
+         TypeFilter
+         FundFilter
+         ProjectFilter
+         Transaction
+         SortExpression).sort
     end
 
   end
 
 end
+

data/shelby_arena_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'shelby-arena-api'
-  PROJECT_GEM_VERSION = '0.1.0'
+  PROJECT_GEM_VERSION = '0.2.0'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shelby-arena-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wes Hays
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -63,6 +63,7 @@ files:
 - lib/api/fund_list.rb
 - lib/api/person.rb
 - lib/api/person_list.rb
+- lib/api/search.rb
 - lib/api/shelby_session.rb
 - lib/auto_load.rb
 - lib/common.rb