the-city-admin 0.1.4 → 0.1.5

data/lib/api/user_process_answer.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class UserProcessAnswer < ApiObject
+
+    tc_attr_accessor :question_id,
+                     :question,
+                     :required,
+                     :answered_at,
+                     :answer
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the note.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+
+  end
+
+end
+
+

data/lib/api/user_process_answer_list.rb

@@ -0,0 +1,64 @@
+module TheCity
+
+  class UserProcessAnswerList
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    #   :user_id - The ID of the user to load the answers for the process. (required)
+    #   :process_id - The ID of the user's process to load the answers for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   UserProcessAnswerList.new({:user_id => 12345, :process_id => 23456})
+    #
+    #   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
+
+      @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
+
+
+    # Get the specified processes.
+    #
+    # @param index The index of the process to get.
+    #
+    # @return [UserProcesses]
+    def [](index)
+      UserProcessAnswer.new( @json_data['answers'][index] ) if @json_data['answers'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['answers'].each{ |process| yield( UserProcessAnswer.new(process) )}
+    end
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['answers'].empty?
+    end
+
+  end
+
+end

data/lib/readers/address_list_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
-      @class_key = "address_list_#{page}"   
+      #@class_key = "address_list_#{page}"   
       @url_data_path = "/addresses"
       @url_data_params = {:page => page}
       

data/lib/readers/address_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param options (optional) Options for including more information.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(address_id, options = {}, cacher = nil)
-      @class_key = "address_#{address_id}"   
+      #@class_key = "address_#{address_id}"   
       @url_data_path = "/addresses/#{address_id}"
       
       # The object to store and load the cache.

data/lib/readers/api_reader.rb

@@ -11,14 +11,14 @@ module TheCity
     #
     # @return the data loaded in a JSON object.
     def load_feed
-      if !@cacher.nil? and !@cacher.is_cache_expired?( @class_key )
-        data = @cacher.get_data( @class_key )
-      else
+      # if !@cacher.nil? and !@cacher.is_cache_expired?( @class_key )
+      #   data = @cacher.get_data( @class_key )
+      # else
         @url_data_params ||= {}
         response = TheCity::admin_request(:get, @url_data_path, @url_data_params) 
         data = JSON.parse(response.body)    
         @cacher.save_data(@class_key, data) unless @cacher.nil?  
-      end   
+      #end   
 
       return data
     end

data/lib/readers/checkin_list_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
-      @class_key = "checkin_list_#{page}"   
+      #@class_key = "checkin_list_#{page}"   
       @url_data_path = "/checkins"
       @url_data_params = {:page => page}
       

data/lib/readers/checkin_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param options (optional) Options for including more information.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(checkin_id, options = {}, cacher = nil)
-      @class_key = "checkin_#{tag_id}"   
+      #@class_key = "checkin_#{tag_id}"   
       @url_data_path = "/checkins/#{tag_id}"
       
       # The object to store and load the cache.

data/lib/readers/family_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @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}"   
+     # @class_key = "family_#{id}"   
       @url_data_path = "/families/#{id}"
       @url_data_params = {}
       

data/lib/readers/group_address_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_addresses"   
+      #@class_key = "groups_#{group_id}_addresses"   
       @url_data_path = "/groups/#{group_id}/addresses"
       @url_data_params = {:page => page}
       

data/lib/readers/group_checkin_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_checkins"   
+      #@class_key = "groups_#{group_id}_checkins"   
       @url_data_path = "/groups/#{group_id}/checkins"
       @url_data_params = {:page => page}
       

data/lib/readers/group_event_attendance_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_event_attendances"   
+      #@class_key = "groups_#{group_id}_event_attendances"   
       @url_data_path = "/groups/#{group_id}/event_attendances"
       @url_data_params = {:page => page}
       

data/lib/readers/group_export_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_exports"   
+      #@class_key = "groups_#{group_id}_exports"   
       @url_data_path = "/groups/#{group_id}/exports"
       @url_data_params = {:page => page}
       

data/lib/readers/group_invitation_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_invitations_#{page}"   
+      #@class_key = "groups_#{group_id}_invitations_#{page}"   
       @url_data_path = "/groups/#{group_id}/invitations"
       @url_data_params = {:page => page}
       

data/lib/readers/group_list_reader.rb

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

data/lib/readers/group_reader.rb

@@ -7,7 +7,7 @@ module TheCity
     # <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}"   
+      #@class_key = "groups_#{group_id}"   
       @url_data_path = "/groups/#{group_id}"
       
       # The object to store and load the cache.

data/lib/readers/group_role_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_roles_#{page}"   
+      #@class_key = "groups_#{group_id}_roles_#{page}"   
       @url_data_path = "/groups/#{group_id}/roles"
       @url_data_params = {:page => page}
       

data/lib/readers/group_tag_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       group_id = options[:group_id]
-      @class_key = "groups_#{group_id}_tags_#{page}"   
+      #@class_key = "groups_#{group_id}_tags_#{page}"   
       @url_data_path = "/groups/#{group_id}/tags"
       @url_data_params = {:page => page}
       

data/lib/readers/metric_list_reader.rb

@@ -9,7 +9,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
 
-      @class_key = "metric_list_#{page}"   
+      #@class_key = "metric_list_#{page}"   
       @url_data_path = "/metrics"
       @url_data_params = {:page => page}
       

data/lib/readers/metric_measurement_list_reader.rb

@@ -8,7 +8,7 @@ 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(metric_id, page = 1, options = {}, cacher = nil) 
-      @class_key = "metric_#{metric_id}_measurement_list_#{page}"   
+      #@class_key = "metric_#{metric_id}_measurement_list_#{page}"   
       @url_data_path = "/metrics/#{metric_id}/measurements"
       @url_data_params = {:page => page}
       

data/lib/readers/metric_measurement_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # <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}"   
+      #@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.

data/lib/readers/metric_reader.rb

@@ -7,7 +7,7 @@ module TheCity
     # <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}"   
+      #@class_key = "metrics_#{metric_id}"   
       @url_data_path = "/metrics/#{metric_id}"
       
       # The object to store and load the cache.

data/lib/readers/pledge_list_reader.rb

@@ -0,0 +1,23 @@
+module TheCity
+
+  class PledgeListReader < 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 = "/pledges"
+      @url_data_params = options
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/lib/readers/pledge_reader.rb

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

data/lib/readers/role_list_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @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}"   
+      #@class_key = "role_list_#{page}"   
       @url_data_path = "/roles"
       @url_data_params = {:page => page}
       

data/lib/readers/skill_list_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @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}"   
+      #@class_key = "skill_list_#{page}"   
       @url_data_path = "/skills"
       @url_data_params = {:page => page}
       

data/lib/readers/skilled_user_id_list_reader.rb

@@ -9,7 +9,7 @@ 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(skill_id, page = 1, options = {}, cacher = nil) 
-      @class_key = "skilled_user_id_list_#{page}"   
+      #@class_key = "skilled_user_id_list_#{page}"   
       @url_data_path = "/skills/#{skill_id}/user_ids"
       @url_data_params = {:page => page}
       

data/lib/readers/skilled_user_list_reader.rb

@@ -9,7 +9,7 @@ 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(skill_id, page = 1, options = {}, cacher = nil) 
-      @class_key = "skilled_user_list_#{page}"   
+      #@class_key = "skilled_user_list_#{page}"   
       @url_data_path = "/skills/#{skill_id}/users"
       @url_data_params = {:page => page}
       

data/lib/readers/tag_group_list_reader.rb

@@ -9,7 +9,7 @@ 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(tag_id, page = 1, options = {}, cacher = nil) 
-      @class_key = "tag_#{tag_id}_group_list_#{page}"   
+      #@class_key = "tag_#{tag_id}_group_list_#{page}"   
       @url_data_path = "/tags/#{tag_id}/groups"
       @url_data_params = {:page => page}
       

data/lib/readers/tag_list_reader.rb

@@ -9,7 +9,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
 
-      @class_key = "tag_list_#{page}"   
+      #@class_key = "tag_list_#{page}"   
       @url_data_path = "/tags"
       @url_data_params = {:page => page}
       

data/lib/readers/tag_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param options (optional) Options for including more information.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(tag_id, options = {}, cacher = nil)
-      @class_key = "tags_#{tag_id}"   
+      #@class_key = "tags_#{tag_id}"   
       @url_data_path = "/tags/#{tag_id}"
       
       # The object to store and load the cache.

data/lib/readers/terminology_list_reader.rb

@@ -9,7 +9,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
 
-      @class_key = "terminology_list_#{page}"   
+      #@class_key = "terminology_list_#{page}"   
       @url_data_path = "/terminology"
       @url_data_params = {:page => page}
       

data/lib/readers/terminology_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param options (optional) Options for including more information.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(term, options = {}, cacher = nil)
-      @class_key = "terminology_#{term}"   
+      #@class_key = "terminology_#{term}"   
       @url_data_path = "/terminology/#{term}"
       
       # The object to store and load the cache.

data/lib/readers/user_address_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_addresses"   
+      #@class_key = "users_#{user_id}_addresses"   
       @url_data_path = "/users/#{user_id}/addresses"
       @url_data_params = {:page => page}