the-city-admin 0.1.5 → 0.2.0

data/README.rdoc

@@ -29,10 +29,7 @@ Next you will need to initialize a connection
 
 == Example usage
 
-
-=== Get list of group
-
-    TheCity::AdminApi.connect(THECITY_KEY, THECITY_TOKEN)
+  Checkout the examples folder.
 
 
 == Additional resources

data/index.rb

@@ -5,33 +5,245 @@
 # @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
 # ******************************************* 
 
+# TCA_ENV = 'development' 
+# THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
 
 require 'ruby-debug'
 require File.dirname(__FILE__) + '/lib/the_city_admin.rb'
 
-key = '132412341234123412341234'
-token = 'asdf1234asdf1234'
+# key = '66c59e2ee24553e7237259e30b4c17365681b95c'
+# token = 'a9ae4af3c3e80102'
 
+key = '2bcee1fdccd31f1ef35a7c6708daf5a446a61ee2'
+token = 'e37ae7fb2042a17a'
 
 TheCity::AdminApi.connect(key, token)
 
 
-done = false
-page = 1
-count = 0
+puts "-----------------------------"
+puts "##### FUNDS / DONATIONS / PLEDGES #######"
+puts "-----------------------------"
 
-while !done
-  group_list = TheCity::GroupList.new({:page => page})
 
-  group_list.each do |group|
-    count += 1
-    puts "#{count}) #{group.name}"
-  end
+# donation_list = TheCity::DonationList.new({:page => 1, :include_details => 1, :start_date => '2012-09-01', :end_date => '2012-09-30'})
 
-  if group_list.total_pages <= page
-    done = true
-  else
-    page += 1
-  end
+# donation_list.each do |donation|
+#   puts [donation.user_name, donation.amount].join(' :: ')
+# end
+
+
+fund_list = TheCity::FundList.new({:page => 1})
+
+fund_list.each do |fund|
+  puts [fund.id, fund.name].join(' :: ')
 end
 
+sfund = TheCity::Fund.load_fund_by_id(fund_list.first.id)
+
+puts [sfund.id, sfund.name].join(' :-: ')
+
+# done = false
+# page = 1
+# count = 0
+
+# while !done
+#   group_list = TheCity::GroupList.new({:page => page, :group_types => 'CG', :include_inactive => true})
+
+#   group_list.each do |group|
+#     count += 1
+#     puts "#{count}) #{group.name}"
+#   end
+
+#   if group_list.total_pages <= page
+#     done = true
+#   else
+#     page += 1
+#   end
+# end
+
+
+# done = false
+# page = 1
+# count = 0
+
+# while !done
+#   tag_list = TheCity::TagList.new({:page => page})
+  
+#   tag_list.each do |tag|
+#     count += 1
+#     puts "#{count}) #{tag.name} :: #{tag.id}"
+#   end
+
+#   if tag_list.total_pages <= page
+#     done = true
+#   else
+#     page += 1
+#   end
+# end
+
+
+
+
+
+# puts "-----------------------------"
+# puts "##### USERS #######"
+# puts "-----------------------------"
+
+
+# user_list = TheCity::UserList.new
+
+# user_list.each do |u|
+#   puts u.full_name
+# end
+
+# puts "-----------------------------"
+
+# user = TheCity::User.new
+# user.title = 'Deacon'
+# user.first = 'James'
+# user.middle = 'Wesley'
+# user.last = 'Hays'
+# user.nickname = 'Wes'
+# user.gender = TheCity::User::Gender[:male]
+# user.email = 'someguy@somewhere.org'
+# user.staff = false
+# user.member_since = Time.now.strftime("%Y-%m-%d")
+# user.birthdate = '1980-09-27'
+# user.primary_phone = '775-111-2222'
+# user.primary_phone_type = TheCity::User::PhoneType[:mobile]
+# user.secondary_phone = '775-333-4444'
+# user.secondary_phone_type = TheCity::User::PhoneType[:home]
+# user.marital_status = TheCity::User::MaritalStatus[:married]
+# #user.primary_campus_id
+# #user.external_id_1
+# #user.external_id_2
+# #user.external_id_3
+
+# if user.save
+#   puts "User #{user.full_name} saved (#{user.id})"
+# else
+#   user.error_messages.each { |em| puts em }
+# end
+
+# user2 = TheCity::User.load_by_id(user.id)
+# user2.email = 'somegirl@somewhere.org'
+# user2.nickname = 'dog'
+
+# if user2.save
+#   puts "User #{user2.full_name} updated (#{user2.id})"
+# else
+#   user2.error_messages.each { |em| puts em }
+# end
+
+# if user.delete
+#   puts "User #{user.full_name} deleted (#{user.id})"
+# else
+#   puts "Something bad happened"
+#   #user.error_messages.each { |em| puts em }
+# end
+
+
+# puts "-----------------------------"
+
+# user_list = TheCity::UserList.new
+
+# user = user_list[0]
+# puts user.full_name
+# user.first = 'Wes'
+# puts user.full_name
+# user.save
+# puts user.id
+
+# user2 = TheCity::User.load_by_id(user.id)
+# puts user2.full_name
+
+# puts "User has #{user.addresses.size} addresses"
+# puts "User has #{user.family.size} family members"
+# puts "User has #{user.notes.size} notes"
+# puts "User has #{user.roles.size} roles"
+# puts "User has #{user.skills.size} skills"
+# #puts "User has #{user.processes.size} processes"
+# puts "User has #{user.invitations.size} invitations"
+# #puts "User has #{user.admin_privileges.size} admin_privileges"
+
+
+# This is currenly returning a 404 if no family members are found
+# puts user.family[0].name
+
+
+
+# puts "-----------------------------"
+
+
+# group_list = TheCity::GroupList.new(:)
+# puts group.name
+# group.name = 'Wes Group'
+# puts group.name
+# group.save
+# group2 = TheCity::Group.load_by_id(group.id)
+# puts group2.name
+
+
+# puts "-----------------------------"
+# puts "##### GROUPS #######"
+# puts "-----------------------------"
+
+# group_list = TheCity::GroupList.new
+
+# group = group_list[13]
+# puts "Group Name: #{group.name} (#{group.id})"
+
+# if group.roles.size == 0
+#   puts "No group roles found"
+# else
+#   puts group.roles[0].title
+# end
+
+# if group.tags.size == 0
+#   puts "No group tags found"
+# else
+#   puts group.tags[0].name
+# end
+
+# if group.invitations.size == 0
+#   puts "No group invitations found"
+# else
+#   puts group.invitations[0].id
+# end
+
+
+# puts "-----------------------------"
+# puts "##### SKILLS #######"
+# puts "-----------------------------"
+
+# skill_list = TheCity::SkillList.new
+
+# puts skill_list.inspect
+
+# # skill_list.each do |skill|
+# #   puts skill.name
+# # end
+
+
+# puts "-----------------------------"
+# puts "##### USERS #######"
+# puts "-----------------------------"
+
+# done = false
+# page = 1
+
+
+# while !done
+#   user_list = TheCity::UserList.new({:page => page})
+
+#   user_list.each do |user|
+#     puts user.full_name
+#   end
+
+#   if user_list.total_pages <= page
+#     done = true
+#   else
+#     page += 1
+#   end
+# end
+

data/lib/api/donation.rb

@@ -0,0 +1,51 @@
+module TheCity
+
+  class Donation < ApiObject
+    tc_attr_accessor :id, 
+                     :user_id, 
+                     :fund_id, 
+                     :batch_id,
+                     :amount, 
+                     :instrument_type, 
+                     :donation_state, 
+                     :donation_date, 
+                     :created_at, 
+                     :updated_at,
+                     :fund_name,
+                     :primary_campus_id,
+                     :user_name,
+                     :user_type,
+                     :user_api_url,
+                     :user_is_member,
+                     :spouse_id,
+                     :spouse_name,
+                     :spouse_is_member
+
+    # Loads the donation by the specified ID.
+    #
+    # @param donation_id The ID of the donation to load.
+    #
+    # Returns a new {Donation} object.
+    def self.load_donation_by_id(pledge_id)
+      donation_reader = DonationReader.new(Pledge_id)
+      self.new(donation_reader)
+    end       
+
+
+
+    # Constructor.
+    #
+    # @param reader (optional) The object that has the data.  This can be a {DonationReader} or Hash object.
+    def initialize(reader = nil)
+      if reader.is_a?(DonationReader)
+        initialize_from_json_object(reader.load_feed) 
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end
+
+

data/lib/api/donation_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class DonationList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #   :search -  (optional) A donation name to search on.
+    #
+    #
+    # Examples:
+    #   DonationList.new
+    #
+    #   DonationList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::DonationListReader.new(options)   
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the donations in the list.
+    #
+    # @return array of donation names.
+    def all_names
+      @json_data['donations'].collect { |donation| donation['user_name'] }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified donation.
+    #
+    # @param index The index of the donation to get.
+    #
+    # @return [donation]
+    def [](index)
+      Donation.new( @json_data['donations'][index] ) if @json_data['donations'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['donations'].each{ |donation| yield( Donation.new(donation) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['donations'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/fund.rb

@@ -0,0 +1,45 @@
+module TheCity
+
+  class Fund < ApiObject
+    tc_attr_accessor :id,
+                     :name,
+                     :tax_deductible,
+                     :group_id,
+                     :fund_state,
+                     :pledge_type,
+                     :pledge_state,
+                     :pledge_inactive_date,
+                     :pledge_description,
+                     :online_givable,
+                     :external_id,
+                     :created_at,
+                     :updated_at
+
+    # Loads the fund by the specified ID.
+    #
+    # @param fund_id The ID of the fund to load.
+    #
+    # Returns a new {Fund} object.
+    def self.load_fund_by_id(fund_id)
+      fund_reader = FundReader.new(fund_id)
+      self.new(fund_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) 
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      end
+    end
+
+  end
+
+end
+
+

data/lib/api/fund_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class FundList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #   :search -  (optional) A fund name to search on.
+    #
+    #
+    # Examples:
+    #   FundList.new
+    #
+    #   FundList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::FundListReader.new(options)   
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # All the funds in the list.
+    #
+    # @return array of fund names.
+    def all_names
+      @json_data['funds'].collect { |fund| fund['user_name'] }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified fund.
+    #
+    # @param index The index of the fund to get.
+    #
+    # @return [fund]
+    def [](index)
+      Fund.new( @json_data['funds'][index] ) if @json_data['funds'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['funds'].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?
+      @json_data['funds'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/pledge.rb

@@ -7,7 +7,16 @@ module TheCity
                      :amount, 
                      :pledge_date, 
                      :created_at, 
-                     :updated_at
+                     :updated_at,
+                     :fund_name,
+                     :primary_campus_id,
+                     :user_name,
+                     :user_type,
+                     :user_api_url,
+                     :user_is_member,
+                     :spouse_id,
+                     :spouse_name,
+                     :spouse_is_name
 
 
     # Loads the pledge by the specified ID.
@@ -17,7 +26,7 @@ module TheCity
     # Returns a new {Pledge} object.
     def self.load_pledge_by_id(pledge_id)
       pledge_reader = PledgeReader.new(Pledge_id)
-      self.new(Pledge_reader)
+      self.new(pledge_reader)
     end       
 
 

data/lib/api/pledge_list.rb

@@ -18,9 +18,9 @@ module TheCity
     #
     #
     # Examples:
-    #   UserList.new
+    #   PledgeList.new
     #
-    #   UserList.new({:page => 2})
+    #   PledgeList.new({:page => 2})
     #    
     def initialize(options = {}) 
       options[:page] ||= 1
@@ -38,7 +38,7 @@ module TheCity
     #
     # @return array of pledge names.
     def all_names
-      @json_data['pledges'].collect { |pledge| pledge['id'] }
+      @json_data['pledges'].collect { |pledge| pledge['user_name'] }
     end
     alias :names :all_names
     
@@ -49,7 +49,7 @@ module TheCity
     #
     # @return [pledge]
     def [](index)
-      pledge.new( @json_data['pledges'][index] ) if @json_data['pledges'][index]
+      Pledge.new( @json_data['pledges'][index] ) if @json_data['pledges'][index]
     end
 
 

data/lib/readers/donation_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class DonationListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param page The page number to get.  Default is 1.
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+
+      #@class_key = "pledge_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
+      @url_data_path = "/donations"
+      @url_data_params = options
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/donation_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class DonationReader < ApiReader
+
+    # Constructor.
+    #
+    # <b>donation_id</b> The ID of the donation to load.
+    # <b>CacheAdapter cacher</b> (optional) The cacher to be used to cache data.
+    def initialize(donation_id, cacher = nil)
+      #@class_key = "donations_#{donation_id}"   
+      @url_data_path = "/donations/#{donation_id}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/fund_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class FundListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param page The page number to get.  Default is 1.
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+
+      #@class_key = "pledge_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
+      @url_data_path = "/funds"
+      @url_data_params = options
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/fund_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class FundReader < ApiReader
+
+    # Constructor.
+    #
+    # <b>fund_id</b> The ID of the fund to load.
+    # <b>CacheAdapter cacher</b> (optional) The cacher to be used to cache data.
+    def initialize(fund_id, cacher = nil)
+      #@class_key = "funds_#{fund_id}"   
+      @url_data_path = "/funds/#{fund_id}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.1.5'
+  PROJECT_GEM_VERSION = '0.2.0'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -66,8 +66,12 @@ files:
 - lib/api/barcode.rb
 - lib/api/checkin.rb
 - lib/api/checkin_list.rb
+- lib/api/donation.rb
+- lib/api/donation_list.rb
 - lib/api/family.rb
 - lib/api/family_member.rb
+- lib/api/fund.rb
+- lib/api/fund_list.rb
 - lib/api/group.rb
 - lib/api/group_address.rb
 - lib/api/group_address_list.rb
@@ -135,7 +139,11 @@ files:
 - lib/readers/api_reader.rb
 - lib/readers/checkin_list_reader.rb
 - lib/readers/checkin_reader.rb
+- lib/readers/donation_list_reader.rb
+- lib/readers/donation_reader.rb
 - lib/readers/family_reader.rb
+- lib/readers/fund_list_reader.rb
+- lib/readers/fund_reader.rb
 - lib/readers/group_address_list_reader.rb
 - lib/readers/group_checkin_list_reader.rb
 - lib/readers/group_event_attendance_list_reader.rb