the-city-admin 0.5.2 → 0.6.0

data/lib/readers/donation_list_reader.rb

@@ -12,12 +12,17 @@ module TheCity
 
       #@class_key = "pledge_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
       @url_data_path = "/donations"
-      @url_data_params = options
+      @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, :fund_id, :state, :group_id, :user_id, :start_date, :end_date, :paginate, :page, :per_page]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/fund_list_reader.rb

@@ -12,12 +12,17 @@ module TheCity
 
       #@class_key = "pledge_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
       @url_data_path = "/funds"
-      @url_data_params = options
+      @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/group_address_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_addresses"   
       @url_data_path = "/groups/#{group_id}/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
 

data/lib/readers/group_checkin_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_checkins"   
       @url_data_path = "/groups/#{group_id}/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
 

data/lib/readers/group_event_attendance_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_event_attendances"   
       @url_data_path = "/groups/#{group_id}/event_attendances"
-      @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
 

data/lib/readers/group_export_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_exports"   
       @url_data_path = "/groups/#{group_id}/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
 

data/lib/readers/group_invitation_list_reader.rb

@@ -8,16 +8,21 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_invitations_#{page}"   
       @url_data_path = "/groups/#{group_id}/invitations"
-      @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/group_list_reader.rb

@@ -11,12 +11,17 @@ module TheCity
 
       #@class_key = "group_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
       @url_data_path = "/groups"
-      @url_data_params = options
+      @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, :search, :under_group_id, :group_types, :include_inactive, :include_addresses, :include_composition, :include_user_ids]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/group_role_list_reader.rb

@@ -8,16 +8,21 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_roles_#{page}"   
       @url_data_path = "/groups/#{group_id}/roles"
-      @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, :title, :include_inactive]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/group_tag_list_reader.rb

@@ -8,16 +8,21 @@ module TheCity
     #                :: group_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      group_id = options[:group_id]
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
       #@class_key = "groups_#{group_id}_tags_#{page}"   
       @url_data_path = "/groups/#{group_id}/tags"
-      @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/invitation_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: group_id is required
     # @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 = "invitations_#{page}"   
       @url_data_path = "/invitations"
-      @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, :filter]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/metric_list_reader.rb

@@ -7,16 +7,21 @@ 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 = "metric_list_#{page}"   
       @url_data_path = "/metrics"
-      @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/metric_measurement_list_reader.rb

@@ -4,18 +4,25 @@ module TheCity
 
     # Constructor.
     #
-    # @param page The page number to get.  Default is 1.
     # @param options A hash of options for requesting data from the server.
+    #                :: metric_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
-    def initialize(metric_id, page = 1, options = {}, cacher = nil) 
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+      metric_id = options.delete(:metric_id)
       #@class_key = "metric_#{metric_id}_measurement_list_#{page}"   
       @url_data_path = "/metrics/#{metric_id}/measurements"
-      @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/pledge_list_reader.rb

@@ -12,12 +12,17 @@ module TheCity
 
       #@class_key = "pledge_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
       @url_data_path = "/pledges"
-      @url_data_params = options
+      @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, :campus_id, :include_participation]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
 end

data/lib/readers/role_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 = "role_list_#{page}"   
       @url_data_path = "/roles"
-      @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, :under_group_id, :group_types, :titles]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
-end
+end

data/lib/readers/skill_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 = "skill_list_#{page}"   
       @url_data_path = "/skills"
-      @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/skilled_user_id_list_reader.rb

@@ -4,19 +4,25 @@ module TheCity
 
     # Constructor.
     #
-    # @param page The skill id to get the users for.
-    # @param page The page number to get.  Default is 1.
     # @param options A hash of options for requesting data from the server.
+    #                :: skill_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
-    def initialize(skill_id, page = 1, options = {}, cacher = nil) 
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+      skill_id = options.delete(:skill_id)
       #@class_key = "skilled_user_id_list_#{page}"   
       @url_data_path = "/skills/#{skill_id}/user_ids"
-      @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/skilled_user_list_reader.rb

@@ -4,19 +4,25 @@ module TheCity
 
     # Constructor.
     #
-    # @param page The skill id to get the users for.
-    # @param page The page number to get.  Default is 1.
     # @param options A hash of options for requesting data from the server.
+    #                :: skill_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
-    def initialize(skill_id, page = 1, options = {}, cacher = nil) 
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+      skill_id = options.delete(:skill_id)
       #@class_key = "skilled_user_list_#{page}"   
       @url_data_path = "/skills/#{skill_id}/users"
-      @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/tag_group_list_reader.rb

@@ -4,19 +4,24 @@ module TheCity
 
     # Constructor.
     #
-    # @param tag_id The tag id to get the groups for. 
-    # @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(tag_id, page = 1, options = {}, cacher = nil) 
+    def initialize(options = {}, cacher = nil) 
+      options[:page] ||= 1
+      tag_id = options.delete(:tag_id)
       #@class_key = "tag_#{tag_id}_group_list_#{page}"   
       @url_data_path = "/tags/#{tag_id}/groups"
-      @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/tag_list_reader.rb

@@ -7,16 +7,21 @@ 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 = "tag_list_#{page}"   
       @url_data_path = "/tags"
-      @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/terminology_list_reader.rb

@@ -7,16 +7,21 @@ 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 = "terminology_list_#{page}"   
       @url_data_path = "/terminology"
-      @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/user_address_list_reader.rb

@@ -8,15 +8,20 @@ module TheCity
     #                :: user_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      user_id = options[:user_id]
+      options[:page] ||= 1
+      user_id = options.delete(:user_id)
       #@class_key = "users_#{user_id}_addresses"   
       @url_data_path = "/users/#{user_id}/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
 

data/lib/readers/user_admin_privilege_list_reader.rb

@@ -8,16 +8,21 @@ module TheCity
     #                :: user_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      user_id = options[:user_id]    
+      options[:page] ||= 1
+      user_id = options.delete(:user_id)
       #@class_key = "users_#{user_id}_admin_privileges_#{page}"   
       @url_data_path = "/users/#{user_id}/admin_privileges"
-      @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/user_family_list_reader.rb

@@ -8,15 +8,21 @@ module TheCity
     #                :: user_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      user_id = options[:user_id]
+      options[:page] ||= 1
+      user_id = options.delete(:user_id)
       #@class_key = "users_#{user_id}_family"   
       @url_data_path = "/users/#{user_id}/family"
+      @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/user_invitation_list_reader.rb

@@ -8,16 +8,21 @@ module TheCity
     #                :: user_id is required
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
-      page = options[:page] || 1
-      user_id = options[:user_id]
+      options[:page] ||= 1
+      user_id = options.delete(:user_id)
       #@class_key = "users_#{user_id}_invitations_#{page}"   
       @url_data_path = "/users/#{user_id}/invitations"
-      @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/user_list_reader.rb

@@ -4,22 +4,24 @@ module TheCity
 
     # 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) 
-      page = options[:page] || 1
-      filter = options[:filter] 
+      options[:page] ||= 1
 
       #@class_key = "user_list_#{page}_#{filter.to_s.downcase.gsub(' ','')}"   
       @url_data_path = "/users"
-      @url_data_params = {:page => page}
-      @url_data_params.merge!({:filter => filter}) if filter
+      @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, :filter, :include_participation, :include_custom_fields, :include_barcodes, :include_addresses, :include_family]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
   end
 
-end
+end