the-city-admin 0.5.2 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9aedbac713fcae49330b49c38fecdf4aaa92b354
+  data.tar.gz: f444b6444d42e4aae42bbbf7e6969f0357faa9e3
+SHA512:
+  metadata.gz: 676155448c9e815bb08fc898124024dbb703b9692133418e63b8b3c48190a589bc60335f1fffa552cfb8c32876deaff6578da1c0f45846cf046e88ef01d49ac3
+  data.tar.gz: c92561c0a923239e26f1586ebd82054ce5573c0065a35bee269b1413d5c52ae534c0ce614312b9d2822d52a36be34d3878b2e2aa5eda451b7f688aa600f5df2b

data/.rvmrc

@@ -1 +1 @@
-rvm ruby-1.9.2-p320@admin-api
+rvm ruby-1.9.2-p320@admin-api --create

data/examples/city_keys.rb

@@ -1,6 +1,6 @@
 module CityKeys
 
-  KEY = '66c59e2ee24553e7237259e30b4c17365681b95c'
-  TOKEN = 'a9ae4af3c3e80102'
+  KEY = '**** YOUR CITY API KEY ****'
+  TOKEN = '**** YOUR CITY API TOKEN ****'  
 
 end

data/examples/donations.rb

@@ -0,0 +1,33 @@
+# *******************************************
+# This is a demo file to show usage.
+#
+# @package TheCity::Admin
+# @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
+# ******************************************* 
+
+TCA_ENV = 'development' 
+THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
+key = '6910f0d2654c7704ceb3af054f52294db67b23ee'
+token = '3eaf0b8b967dde78'
+
+
+require 'ruby-debug'
+require File.dirname(__FILE__) + '/../lib/the_city_admin.rb'
+
+require File.dirname(__FILE__) + '/city_keys.rb'
+include CityKeys
+
+TheCity::AdminApi.connect(KEY, TOKEN)
+
+
+de_list = TheCity::DonationList.new
+de_list.each do |item|
+  puts "DonationExport: #{item.inspect}"
+end
+
+
+puts "------------------------------------"
+
+puts "####################################"
+
+

data/lib/api/address_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class AddressList 
+  class AddressList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -21,8 +19,9 @@ module TheCity
     #   AddressList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::AddressListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::AddressListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed      
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/api_list.rb

@@ -0,0 +1,50 @@
+module TheCity
+
+  # This class is the base class for all TheCity objects and is meant to be inherited.
+  #
+  class ApiList
+    
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+    
+    def self.load(options = {}) 
+      self.new(options)
+    end
+
+    # Checks if there is a next page.
+    #
+    # @return true for yes, false for no.
+    def next_page?
+      @current_page < @total_pages
+    end
+
+    # Gets the next page of results.
+    # 
+    # @return [UserList] or nil if there are no more pages.
+    def next_page
+      return nil unless next_page?
+      self.class.new( @options.merge({:page => @options[:page]+1}) )
+    end
+
+    # Loads the next page of results and replaces self with the results.
+    # 
+    # @return true on success or otherwise false.
+    def next_page!
+      return false unless next_page?
+
+      @options[:page] += 1
+      @options[:reader] = @options[:reader].class.new(@options)
+      @json_data = @options[: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'] 
+
+      return true
+    end    
+
+  end
+
+end
+
+

data/lib/api/checkin_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class CheckinList 
+  class CheckinList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -21,8 +19,9 @@ module TheCity
     #   CheckinList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::CheckinListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::CheckinListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/donation.rb

@@ -1,25 +1,37 @@
 module TheCity
 
   class Donation < ApiObject
-    tc_attr_accessor :id, 
-                     :user_id, 
-                     :fund_id, 
+    tc_attr_accessor :split_id,
+                     :external_id,
+                     :amount,
+                     :id,
+                     :date,
+                     :note,
+                     :instrument,
+                     :state,
                      :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
+                     :user,
+                     :fund
+    
+    # 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.
     #
@@ -44,6 +56,12 @@ module TheCity
       end
     end
 
+    # Convert amount to cents.
+    #
+    # @return Amount in cents.
+    def amount_cents 
+      (self.amount.to_f * 100).round.to_i
+    end
   end
 
 end

data/lib/api/donation_export_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class DonationExportList 
+  class DonationExportList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   DonationExportList.new({:donation_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::DonationExportListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::DonationExportListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/donation_list.rb

@@ -1,12 +1,9 @@
 module TheCity
 
-  class DonationList 
+  class DonationList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -23,9 +20,10 @@ module TheCity
     #   DonationList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::DonationListReader.new(options)   
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::DonationListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/fund_list.rb

@@ -1,12 +1,9 @@
 module TheCity
 
-  class FundList 
+  class FundList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -23,9 +20,10 @@ module TheCity
     #   FundList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::FundListReader.new(options)   
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::FundListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_address_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupAddressList 
+  class GroupAddressList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupAddressList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupAddressListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupAddressListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_checkin_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupCheckinList 
+  class GroupCheckinList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupCheckinList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupCheckinListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupCheckinListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_event_attendance_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupEventAttendanceList 
+  class GroupEventAttendanceList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupEventAttendanceList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupEventAttendanceListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupEventAttendanceListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_export.rb

@@ -15,6 +15,7 @@ module TheCity
     # @param group_export_id The ID of the group export to load.
     # @param options A hash of options for requesting data from the server.
     #                :: group_id is required    
+    #                :: user_type is optional. It can be "Users" or "OfflineUsers"
     #
     # Returns a new {GroupExport} object.
     def self.load_by_id(group_export_id, options = {})

data/lib/api/group_export_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupExportList 
+  class GroupExportList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupExportList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupExportListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupExportListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_invitation_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupInvitationList 
+  class GroupInvitationList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupInvitationList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupInvitationListReader.new(options)    
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupInvitationListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_list.rb

@@ -1,12 +1,9 @@
 module TheCity
 
-  class GroupList 
+  class GroupList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -23,9 +20,10 @@ module TheCity
     #   UserList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::GroupListReader.new(options)   
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::GroupListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_role_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupRoleList 
+  class GroupRoleList < ApiList
 
     include Enumerable    
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupRoleList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupRoleListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupRoleListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/group_tag_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class GroupTagList 
+  class GroupTagList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   GroupTagList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::GroupTagListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::GroupTagListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/invitation_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class InvitationList 
+  class InvitationList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -22,8 +20,9 @@ module TheCity
     #   InvitationList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::InvitationListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::InvitationListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/metric_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class MetricList 
+  class MetricList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of filters for loading the list.
@@ -31,9 +29,10 @@ module TheCity
     #   MetricList.new({:page => 2, :filter => :contact_updated_in_the_last_2_weeks})
     #
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::MetricListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::MetricListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/metric_measurement_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class MetricMeasurementList 
+  class MetricMeasurementList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -21,9 +19,10 @@ module TheCity
     #   MetricMeasurementList.new({:group_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::MetricMeasurementListReader.new(options)   
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::MetricMeasurementListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/pledge_list.rb

@@ -1,12 +1,9 @@
 module TheCity
 
-  class PledgeList 
+  class PledgeList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
-
     # Constructor.
     #
     # @param options A hash of options for loading the list.
@@ -23,9 +20,10 @@ module TheCity
     #   PledgeList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::PledgeListReader.new(options)   
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::PledgeListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']

data/lib/api/role_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class RoleList 
+  class RoleList < ApiList
 
     include Enumerable
 
-    attr_reader :total_entries, :total_pages, :per_page, :current_page
-
     # Constructor.
     #
     # @param options A hash of options for loading the skill list.
@@ -21,9 +19,10 @@ module TheCity
     #   RoleList.new(reader, {:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::RoleListReader.new(options)      
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::RoleListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @total_entries = @json_data['total_entries']
       @total_pages = @json_data['total_pages']