shelby-arena-api 0.1.0

data/lib/api/fund_list.rb

@@ -0,0 +1,49 @@
+module ShelbyArena
+
+  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] || ShelbyArena::FundListReader.new(options)    
+      @json_data = reader.load_data['FundListResult']['Funds']['Fund']
+    end
+
+    # Get the specified fund.
+    #
+    # @param index The index of the fund to get.
+    #
+    # @return Fund
+    def [](index)
+      Fund.new( @json_data[index] ) unless @json_data[index].nil?
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data.each{ |fund| yield( Fund.new(fund) )}
+    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/person.rb

@@ -0,0 +1,79 @@
+module ShelbyArena
+
+  class Person < ApiObject
+    attribute :addresses, Array[Address]
+    attribute :campus_id, Integer
+    attribute :campus_name, String
+    attribute :family_id, Integer
+    attribute :family_member_role_id, Integer
+    attribute :family_member_role_value, String
+    attribute :gender, String
+    attribute :first_name, String
+    attribute :nick_name, String
+    attribute :last_name, String
+    attribute :birth_date, Date
+    attribute :age, Integer
+    attribute :home_phone, String
+    attribute :cell_phone, String
+    attribute :first_active_email, String  
+    attribute :member_status_id, Integer
+    attribute :member_status_value, String
+    attribute :person_guid, String
+    attribute :person_id, Integer
+    attribute :person_link, String
+    attribute :record_status_value, String
+    attribute :bloblink, String
+    attribute :area_name, String
+
+
+    # Loads the user by the specified ID.
+    #
+    # @param person_id The ID of the person to load.
+    #
+    # Returns a new Person object.
+    def self.load_by_id(person_id)
+      reader = PersonReader.new(person_id)
+      self.new(reader)
+    rescue
+      nil      
+    end
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data.  This can be a PersonReader or Hash object.
+    # @param options (optional) Options for including more information.
+    def initialize(reader = nil, options = {})       
+      @writer_object = PersonWriter
+      if reader.is_a?(PersonReader)
+        initialize_from_json_object(reader.load_data['Person'])
+      elsif reader.is_a?(Hash) 
+        initialize_from_json_object(reader)        
+      else # new empty
+        raise 'Not sure about this one yet'
+        # reader = PersonReader.new
+        # initialize_from_json_object(reader.load_new['person'])
+      end         
+    end
+
+
+    # def is_head_of_household?
+    #  # I do not see a way to get this yet.
+    # end
+
+
+    def family_role
+      self.family_member_role_value.blank? ? 'Other' : self.family_member_role_value
+    end
+
+
+    def is_child?
+      self.family_member_role_value.downcase == 'child'
+    end
+
+    def email_address
+      self.first_active_email
+    end
+  end
+
+end

data/lib/api/person_list.rb

@@ -0,0 +1,53 @@
+module ShelbyArena
+
+  class PersonList
+
+    include Enumerable
+
+    # 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] || ShelbyArena::PersonListReader.new(options)
+      @json_data = reader.load_data['PersonListResult']['Persons']['Person']
+    end
+
+    # Get the specified person.
+    #
+    # @param index The index of the person to get.
+    #
+    # @return [Person]
+    def [](index)
+      Person.new( @json_data[index] ) unless @json_data[index].nil?
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data.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
+
+    # 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/shelby_session.rb

@@ -0,0 +1,17 @@
+module ShelbyArena
+
+  class ShelbySession < ApiObject
+    attribute :id, String
+    attribute :expires_at, DateTime
+
+    # Constructor.
+    #
+    # @param response_data Session response data from the Shelby service.
+    def initialize(response_data)  
+      self.id = response_data['ApiSession']['SessionID']
+      self.expires_at = response_data['ApiSession']['DateExpires']
+    end
+
+  end
+
+end

data/lib/auto_load.rb

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

data/lib/common.rb

@@ -0,0 +1,75 @@
+module ShelbyArena
+
+  def self.request_session
+    response = Typhoeus::Request.post(ShelbyArena::Api.service_url+'/login', {body: {username: ShelbyArena::Api.username, password: ShelbyArena::Api.password, api_key: ShelbyArena::Api.api_key}})
+    raise ShelbyArenaExceptions::UnableToConnectToShelbyArena.new(response.body) unless response.success?
+    self._xml2json(response.body)
+  end
+
+
+  def self.api_request(method, path, params = {}, body = nil)
+    url = [ShelbyArena::Api.service_url, path].join('/')
+    mparams = params.merge({api_session: ShelbyArena::Api.session_key})
+    mparams = mparams.merge({api_sig: self._generate_api_signature(path, params)})
+
+    response =
+    case method
+    when :post
+      raise 'Shelby POST not tested yet'
+      #Typhoeus::Request.post(url, {:headers => headers, :body => body})
+    when :get
+      Typhoeus::Request.get(url, params: mparams)
+    when :put
+      raise 'Shelby PUT not tested yet'
+      # Typhoeus::Request.put(url, {:headers => headers, :body => body})
+    when :delete
+      raise 'Shelby DELETE not tested yet'
+      # Typhoeus::Request.delete(url, {:headers => headers, :params => params})
+    end    
+    
+    if !response.success?
+      if response.code > 0
+        raise ShelbyArenaExceptions::UnableToConnectToShelbyArena.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 ShelbyArenaExceptions::UnknownErrorConnectingToShelbyArena.new("Unknown error when connecting to Shelby Arena.#{response_code_desc}")
+        else
+          raise ShelbyArenaExceptions::ShelbyArenaResponseError.new(error_messages)
+        end
+      end
+    end   
+    
+    response
+  end  
+
+
+  def self._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  
+
+
+  def self._generate_api_signature(path, params)
+    get_vars = ''
+    if params.to_a.size > 0
+      get_vars = '?' + params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1].to_s}" }.join('&').downcase
+    end
+    utoken = get_vars.empty? ? '?' : '&'
+    Digest::MD5.hexdigest("#{ShelbyArena::Api.api_secret}_#{path.downcase}#{get_vars}#{utoken}api_session=#{ShelbyArena::Api.session_key}")
+  end
+
+
+  # This is a helper method
+  def self.attr_underscore(str)
+    str.gsub(/::/, '/')
+       .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+       .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+       .tr("-", "_")
+       .downcase
+  end    
+end

data/lib/exceptions.rb

@@ -0,0 +1,5 @@
+module ShelbyArenaExceptions
+  class UnableToConnectToShelbyArena < StandardError; end
+  class UnknownErrorConnectingToShelbyArena< StandardError; end
+  class ShelbyArenaResponseError < StandardError; end
+end

data/lib/readers/api_reader.rb

@@ -0,0 +1,26 @@
+
+module ShelbyArena
+
+  # This class is the base class for all ShelbyArena objects and is meant to be inherited.
+  class ApiReader
+    attr_reader :headers 
+
+    # Loads the data.
+    #
+    # @return the data loaded in a JSON object.
+    def load_data
+      @url_data_params ||= {}
+      return _load_data(@url_data_path, @url_data_params)
+    end
+
+    private
+
+    def _load_data(url_data_path, url_data_params)
+      response = ShelbyArena::api_request(:get, url_data_path, url_data_params)
+      @headers = response.headers
+      ShelbyArena::_xml2json(response.body)
+    end
+
+  end
+
+end

data/lib/readers/contribution_list_reader.rb

@@ -0,0 +1,28 @@
+module ShelbyArena
+
+  class ContributionListReader < ApiReader
+
+    # Constructor.
+    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'
+    end
+
+    def valid_fields
+      %W(Active
+         CanPledge
+         EndDate
+         FundId
+         FundName
+         OnlineName
+         StartDate
+         TaxDeductible).sort
+    end
+
+  end
+
+end

data/lib/readers/contribution_reader.rb

@@ -0,0 +1,19 @@
+module ShelbyArena
+
+  class ContributionReader < ApiReader
+
+    # Constructor.
+    #
+    # @param contribution_id (optional) The ID of the contribution to load.
+    def initialize(contribution_id = nil)
+      if contribution_id.nil?
+        raise 'The create endpoint is not known yet.'
+        @url_new_data_path = nil # Not sure yet
+      else
+        @url_data_path = "contribution/#{contribution_id}"
+      end      
+    end
+    
+  end
+
+end

data/lib/readers/family_reader.rb

@@ -0,0 +1,21 @@
+module ShelbyArena
+
+  class FamilyReader < ApiReader
+
+    # Constructor.
+    #
+    # @param family_id (optional) The ID of the family to load.
+    def initialize(family_id = nil)
+      if family_id.nil?
+        raise 'The create endpoint is not known yet.'
+        @url_new_data_path = nil # Not sure yet
+      else
+        @url_data_path = "family/#{family_id}"
+      end
+    end
+    
+  end
+
+end
+
+

data/lib/readers/fund_list_reader.rb

@@ -0,0 +1,28 @@
+module ShelbyArena
+
+  class FundListReader < ApiReader
+
+    # Constructor.
+    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 = 'fund/list'
+    end
+
+    def valid_fields
+      %W(Active
+         CanPledge
+         EndDate
+         FundId
+         FundName
+         OnlineName
+         StartDate
+         TaxDeductible).sort
+    end
+
+  end
+
+end

data/lib/readers/fund_reader.rb

@@ -0,0 +1,19 @@
+module ShelbyArena
+
+  class FundReader < ApiReader
+
+    # Constructor.
+    #
+    # @param fund_id (optional) The ID of the fund to load.
+    def initialize(fund_id = nil)
+      if fund_id.nil?
+        raise 'The create endpoint is not known yet.'
+        @url_new_data_path = nil # Not sure yet
+      else
+        @url_data_path = "fund/#{fund_id}"
+      end      
+    end
+    
+  end
+
+end