the-city-admin 0.1.0

data/lib/readers/family_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class FamilyReader < ApiReader
+
+    # Constructor.
+    #
+    # @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)
+      id = options[:id] || options[:external_id]
+      @class_key = "family_#{id}"   
+      @url_data_path = "/families/#{id}"
+      @url_data_params = {}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/group_address_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupAddressListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_addresses"   
+      @url_data_path = "/groups/#{group_id}/addresses"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/group_checkin_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupCheckinListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_checkins"   
+      @url_data_path = "/groups/#{group_id}/checkins"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/group_event_attendance_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupEventAttendanceListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_event_attendances"   
+      @url_data_path = "/groups/#{group_id}/event_attendances"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/group_export_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupExportListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_exports"   
+      @url_data_path = "/groups/#{group_id}/exports"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/group_invitation_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class GroupInvitationListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_invitations_#{page}"   
+      @url_data_path = "/groups/#{group_id}/invitations"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/group_list_reader.rb

@@ -0,0 +1,25 @@
+module TheCity
+
+  class GroupListReader < 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) 
+      page = options[:page] || 1
+      filter = options[:filter] 
+
+      @class_key = "group_list_#{page}_#{filter.to_s.downcase.gsub(' ','')}"  
+      @url_data_path = "/groups"
+      @url_data_params = {:page => page}
+      @url_data_params.merge!({:filter => filter}) if filter
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/group_reader.rb

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

data/lib/readers/group_role_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class GroupRoleListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_roles_#{page}"   
+      @url_data_path = "/groups/#{group_id}/roles"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/group_tag_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class GroupTagListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: 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]
+      @class_key = "groups_#{group_id}_tags_#{page}"   
+      @url_data_path = "/groups/#{group_id}/tags"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/metric_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class MetricListReader < ApiReader
+
+    # Constructor.
+    #
+    # @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
+
+      @class_key = "metric_list_#{page}"   
+      @url_data_path = "/metrics"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/metric_measurement_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class MetricMeasurementListReader < 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(metric_id, page = 1, options = {}, cacher = nil) 
+      @class_key = "metric_#{metric_id}_measurement_list_#{page}"   
+      @url_data_path = "/metrics/#{metric_id}/measurements"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/metric_measurement_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class MetricMeasurementReader < ApiReader
+
+    # Constructor.
+    #
+    # <b>metric_id</b> The ID of the metric that the measurement belongs to.
+    # <b>measurement_id</b> The ID of the measurement to load.
+    # <b>CacheAdapter cacher</b> (optional) The cacher to be used to cache data.
+    def initialize(metric_id, measurement_id, cacher = nil)
+      @class_key = "metrics_#{metric_id}_measurements_#{measurement_id}"   
+      @url_data_path = "/metrics/#{metric_id}/measurements/#{measurement_id}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/readers/metric_reader.rb

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

data/lib/readers/role_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class RoleListReader < ApiReader
+
+    # Constructor.
+    #
+    # @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 
+      @class_key = "role_list_#{page}"   
+      @url_data_path = "/roles"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/skill_list_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class SkillListReader < ApiReader
+
+    # Constructor.
+    #
+    # @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
+      @class_key = "skill_list_#{page}"   
+      @url_data_path = "/skills"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/skilled_user_id_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class SkilledUserIdListReader < ApiReader
+
+    # 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.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(skill_id, page = 1, options = {}, cacher = nil) 
+      @class_key = "skilled_user_id_list_#{page}"   
+      @url_data_path = "/skills/#{skill_id}/user_ids"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/skilled_user_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class SkilledUserListReader < ApiReader
+
+    # 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.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(skill_id, page = 1, options = {}, cacher = nil) 
+      @class_key = "skilled_user_list_#{page}"   
+      @url_data_path = "/skills/#{skill_id}/users"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/tag_group_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class TagGroupListReader < ApiReader
+
+    # 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) 
+      @class_key = "tag_#{tag_id}_group_list_#{page}"   
+      @url_data_path = "/tags/#{tag_id}/groups"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end