the-city-admin 0.5.2 → 0.6.0

data/lib/api/skill_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class SkillList 
+  class SkillList < 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
     #   SkillList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::SkillListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::SkillListReader.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/skilled_user_id_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class SkilledUserIdList 
+  class SkilledUserIdList < 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
     #   SkilledUserList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::SkilledUserIdListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::SkilledUserIdListReader.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/skilled_user_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class SkilledUserList 
+  class SkilledUserList < 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
     #   SkilledUserList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::SkilledUserListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::SkilledUserListReader.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/tag_group_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class TagGroupList 
+  class TagGroupList < 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
     #   SkilledUserList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::TagGroupListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::TagGroupListReader.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/tag_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class TagList 
+  class TagList < 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
     #   TagList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::TagListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::TagListReader.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/terminology_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class TerminologyList 
+  class TerminologyList < 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
     #   TerminologyList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::TerminologyListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::TerminologyListReader.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/user.rb

@@ -42,17 +42,24 @@ module TheCity
                      :external_id_3,
                      :middle,
                      :email,
-                     :marital_status  
+                     :marital_status,
+
+                     :addresses, # include_addresses
+
+                     :family_id,         # include_family
+                     :family_role,       # include_family
+                     :external_family_id # include_family
 
 
     # Loads the user by the specified ID.
     #
     # @param user_id The ID of the user to load.
+    # @param options (optional) Options for including more information.
     #
     # Returns a new {User} object.
-    def self.load_by_id(user_id)
-      reader = UserReader.new(user_id)
-      self.new(reader.load_feed)
+    def self.load_by_id(user_id, options = {})
+      reader = UserReader.new(user_id, options)
+      self.new(reader.load_feed, options)
     rescue
       nil      
     end       
@@ -66,7 +73,10 @@ module TheCity
       @writer_object = UserWriter
       initialize_from_json_object(json_data) unless json_data.nil?
 
-      @address_list = nil
+      unless options[:include_addresses].nil?
+        @addresses = @addresses.collect { |addr| UserAddress.new(addr.merge({:user_id => self.id})) }
+      end
+
       @family_list = nil
       @note_list = nil
       @role_list = nil
@@ -77,6 +87,15 @@ module TheCity
     end
     
 
+    # The first with the nickname in parens if available.
+    #
+    # @return A string of the first name with the nickname if available.
+    def first_name_with_nickname
+      with_nickname = self.nickname.to_s.empty? ? nil : "(#{self.nickname})"
+      [self.first, with_nickname].compact.join(' ')
+    end
+
+
     # The first and last name of the user.
     #
     # @return A string of the full name
@@ -86,24 +105,6 @@ module TheCity
     end
 
 
-    # Address information.
-    #
-    # @param force_reload (optional) Data is cached on first call.  If data needs to be 
-    #                                reloaded from the server on a subsequent call then 
-    #                                a force reload is need.
-    #
-    # @return [UserAddressList]
-    def addresses(force_reload = false)
-      unless force_reload
-        return @address_list unless @address_list.nil?  
-      end
-      return nil unless self.id
-         
-      @address_list = UserAddressList.new({:user_id => self.id})
-      return @address_list
-    end
-
-
     # The family information.
     #
     # @return [UserFamilyList]

data/lib/api/user_address.rb

@@ -2,18 +2,19 @@ module TheCity
 
   class UserAddress < ApiObject
 
-    tc_attr_accessor :city, 
-                     :created_at, 
-                     :id, 
-                     :latitude, 
-                     :location_type, 
-                     :longitude, 
-                     :privacy, 
-                     :state, 
-                     :street, 
-                     :updated_at, 
-                     :user_id, 
-                     :zipcode
+    tc_attr_accessor :user_id,
+                     :id,
+                     :city,
+                     :state,
+                     :street,
+                     :street2,
+                     :zipcode,
+                     :longitude,
+                     :latitude,
+                     :location_type,
+                     :privacy,
+                     :created_at,
+                     :updated_at
 
 
     # Constructor.
@@ -23,6 +24,10 @@ module TheCity
       @writer_object = UserAddressWriter
       initialize_from_json_object(json_data) unless json_data.nil?
     end
+
+    def home_address?
+      self.location_type.downcase == 'home'
+    end
     
   end
 

data/lib/api/user_address_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserAddressList 
+  class UserAddressList < 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
     #   UserAddressList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      reader = options[:reader] || TheCity::UserAddressListReader.new(options)      
-      @json_data = reader.load_feed
+      @options = options
+      @options[:reader] = TheCity::UserAddressListReader.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/user_admin_privilege_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserAdminPrivilegeList 
+  class UserAdminPrivilegeList < 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,9 +20,10 @@ module TheCity
     #   UserAdminPrivilegeList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserAdminPrivilegeListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserAdminPrivilegeListReader.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/user_family_list.rb

@@ -1,6 +1,6 @@
 module TheCity
 
-  class UserFamilyList 
+  class UserFamilyList < ApiList
 
     include Enumerable
 
@@ -22,9 +22,10 @@ module TheCity
     #   UserFamilyList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserFamilyListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserFamilyListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @id = @json_data['id']
       @created_at = @json_data['created_at']

data/lib/api/user_invitation_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserInvitationList 
+  class UserInvitationList < 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,9 +20,10 @@ module TheCity
     #   UserInvitationList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserInvitationListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserInvitationListReader.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/user_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserList 
+  class UserList < 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
     #   UserList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserListReader.new(options)      
-      @json_data = reader.load_feed
+      @options = options.clone
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserListReader.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/user_note_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserNoteList 
+  class UserNoteList < 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,9 +20,10 @@ module TheCity
     #   UserNoteList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserNoteListReader.new(options)     
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserNoteListReader.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/user_process_answer_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserProcessAnswerList
+  class UserProcessAnswerList < 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 +21,10 @@ module TheCity
     #   UserProcessAnswerList.new({:user_id => 12345, :process_id => 23456, :page => 2})
     #
     def initialize(options = {})
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserProcessAnswerListReader.new(options)
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserProcessAnswerListReader.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/user_process_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserProcessList 
+  class UserProcessList < 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,9 +20,10 @@ module TheCity
     #   UserProcessList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserProcessListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserProcessListReader.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/user_role_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserRoleList 
+  class UserRoleList < 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,9 +20,10 @@ module TheCity
     #   UserRoleList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserRoleListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserRoleListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @user_id = options[:user_id] || nil
       @total_entries = @json_data['total_entries']

data/lib/api/user_skill_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class UserSkillList 
+  class UserSkillList < 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,9 +20,10 @@ module TheCity
     #   UserSkillList.new({:user_id => 12345, :page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::UserSkillListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::UserSkillListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed 
 
       @user_id = options[:user_id] || nil
       @total_entries = @json_data['total_entries']

data/lib/api/web_hook_list.rb

@@ -1,11 +1,9 @@
 module TheCity
 
-  class WebHookList 
+  class WebHookList < 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
     #   UserSkillList.new({:page => 2})
     #    
     def initialize(options = {}) 
-      options[:page] ||= 1
-      reader = options[:reader] || TheCity::WebHookListReader.new(options)  
-      @json_data = reader.load_feed
+      @options = options
+      @options[:page] ||= 1
+      @options[:reader] = TheCity::WebHookListReader.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/auto_load.rb

@@ -3,6 +3,7 @@ module TheCity
   require THECITY_LIB_DIR + '/exceptions.rb'
 
   api_path = THECITY_LIB_DIR + '/api/'
+  require api_path + 'api_list.rb'
   require api_path + 'api_object.rb'
   Dir["#{api_path}/*.rb"].each { |f| require(f) }
 

data/lib/readers/address_list_reader.rb

@@ -7,15 +7,19 @@ module TheCity
     # @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) 
-      page = options[:page] || 1
+      options[:page] ||= 1
       #@class_key = "address_list_#{page}"   
       @url_data_path = "/addresses"
-      @url_data_params = {:page => page}
+      @url_data_params = white_list_options(options)
       
       # The object to store and load the cache.
       @cacher = cacher unless cacher.nil?    
     end
 
+    def white_list_options
+      white_list = [:page]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
   end
 
 end

data/lib/readers/checkin_list_reader.rb

@@ -7,15 +7,20 @@ module TheCity
     # @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) 
-      page = options[:page] || 1
+      options[:page] ||= 1
       #@class_key = "checkin_list_#{page}"   
       @url_data_path = "/checkins"
-      @url_data_params = {:page => page}
+      @url_data_params = white_list_options(options)
       
       # The object to store and load the cache.
       @cacher = cacher unless cacher.nil?    
     end
 
+    def white_list_options
+      white_list = [:page, :include_checked_out]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/donation_export_list_reader.rb

@@ -7,14 +7,19 @@ module TheCity
     # @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) 
-      page = options[:page] || 1
+      options[:page] ||= 1
       #@class_key = "groups_#{group_id}_exports"   
       @url_data_path = "/donations/exports"
-      @url_data_params = {:page => page}
+      @url_data_params = white_list_options(options)
       
       # The object to store and load the cache.
       @cacher = cacher unless cacher.nil?    
     end
+
+    def white_list_options
+      white_list = [:page]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
     
   end