the-city-admin 0.1.0

data/lib/api/group_list.rb

@@ -0,0 +1,74 @@
+module TheCity
+
+  class GroupList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #   :search -  (optional) A group name to search on.
+    #
+    #
+    # Examples:
+    #   UserList.new
+    #
+    #   UserList.new({:page => 2})
+    #    
+    def initialize(options = {}) 
+      options[:page] ||= 1
+      reader = options[:reader] || TheCity::GroupListReader.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
+    
+    
+    # All the groups in the list.
+    #
+    # @return array of group names.
+    def all_names
+      @json_data['groups'].collect { |group| group['name'] }
+    end
+    alias :names :all_names
+    
+    
+    # Get the specified group.
+    #
+    # @param index The index of the group to get.
+    #
+    # @return [Group]
+    def [](index)
+      Group.new( @json_data['groups'][index] ) if @json_data['groups'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['groups'].each{ |group| yield( Group.new(group) )}
+    end    
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['groups'].empty?
+    end    
+  
+  end
+  
+end

data/lib/api/group_role.rb

@@ -0,0 +1,27 @@
+module TheCity
+
+  class GroupRole < ApiObject
+
+    tc_attr_accessor :active, 
+                     :created_at, 
+                     :id, 
+                     :last_engaged, 
+                     :title, 
+                     :user_api_url, 
+                     :user_id, 
+                     :user_name, 
+                     :user_type
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group role.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/group_role_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class GroupRoleList 
+
+    include Enumerable    
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :group_id - The ID of the group to load the roles for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   GroupRoleList.new({:group_id => 12345})
+    #
+    #   GroupRoleList.new({:group_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::GroupRoleListReader.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 group role.
+    #
+    # @param index The index of the group role to get.
+    #
+    # @return [GroupRole]
+    def [](index)
+      GroupRole.new( @json_data['roles'][index] ) if @json_data['roles'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['roles'].each{ |role| yield( GroupRole.new(role) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['roles'].empty?
+    end
+
+  end
+  
+end

data/lib/api/group_tag.rb

@@ -0,0 +1,20 @@
+module TheCity
+
+  class GroupTag < ApiObject
+
+    tc_attr_accessor :name,
+                     :tag_id
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the group tag.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+
+

data/lib/api/group_tag_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class GroupTagList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :group_id - The ID of the group to load the roles for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   GroupTagList.new({:group_id => 12345})
+    #
+    #   GroupTagList.new({:group_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::GroupTagListReader.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 group tag.
+    #
+    # @param index The index of the group tag to get.
+    #
+    # @return [GroupTag]
+    def [](index)
+      GroupTag.new( @json_data['tags'][index] ) if @json_data['tags'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['tags'].each{ |tag| yield( GroupTag.new(tag) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['tags'].empty?
+    end
+
+  end
+  
+end

data/lib/api/metric.rb

@@ -0,0 +1,50 @@
+module TheCity
+
+  class Metric < ApiObject
+    tc_attr_accessor :id,
+                     :name,
+                     :description,
+                     :category,
+                     :subcategory,
+                     :is_percent         
+
+
+    # Loads the metric by the specified ID.
+    #
+    # @param metric_id The ID of the user to load.
+    #
+    # Returns a new {Metric} object.
+    def self.load_by_id(metric_id)
+      metric_reader = MetricReader.new(metric_id)
+      self.new(metric_reader.load_feed)
+    end       
+
+
+    # Constructor.
+    #
+    # @param json_data (optional) The object that has the data.
+    # @param options (optional) Options for including more information.
+    def initialize(json_data = nil, options = {}) 
+      @writer_object = MetricWriter
+      initialize_from_json_object(json_data) unless json_data.nil?   
+
+      @measurement_list = nil
+    end
+
+
+    # Address information.
+    #
+    # @return [UserAddressList]
+    def measurements
+      return @measurement_list unless @measurement_list.nil?  
+      return nil unless self.id
+
+      reader = MetricMeasurementListReader.new(self.id)    
+      @measurement_list = MetricMeasurementList.new(reader)
+      return @measurement_list
+    end
+  end
+
+end
+
+

data/lib/api/metric_list.rb

@@ -0,0 +1,72 @@
+module TheCity
+
+  class MetricList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of filters for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :filter -  (optional) The filters are below and only one can be specified.
+    #     ::created_in_the_last_N_PERIOD - A string specifying the period of time to look back for users created. 
+    #                                      N_PERIOD is in days, weeks, months or years.
+    #     ::contact_updated_in_the_last_N_PERIOD - A string specifying the period of time to look back for users created.
+    #                                              N_PERIOD is in days, weeks, months or years.
+    #     ::with_external_id_1 - The external ID to reference.
+    #     ::with_external_id_2 - The external ID to reference.
+    #     ::with_external_id_3 - The external ID to reference.
+    #     ::without_external_id_1 - The external ID to reference.
+    #     ::without_external_id_2 - The external ID to reference.
+    #     ::without_external_id_3 - The external ID to reference.
+    #
+    #
+    # Examples:
+    #   MetricList.new({:filter => :created_in_the_last_7_days})
+    #
+    #   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
+
+      @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 metric.
+    #
+    # @param index The index of the user to get.
+    #
+    # @return [Metric]
+    def [](index)  
+      Metric.new( @json_data['metrics'][index] ) if @json_data['metrics'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['metrics'].each{ |metric| yield( Metric.new(metric) )}
+    end    
+  
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['metrics'].empty?
+    end
+
+  end
+  
+end

data/lib/api/metric_measurement.rb

@@ -0,0 +1,29 @@
+module TheCity
+
+  class MetricMeasurement < ApiObject
+
+    tc_attr_accessor :id, 
+                     :created_at, 
+                     :value
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the role.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+
+    # Save this object.
+    #
+    # @return True on success, otherwise false.
+    def save
+      writer = MetricMeasurementWriter.new(self.to_attributes) 
+      writer.save_feed
+    end
+    
+  end
+
+end
+
+

data/lib/api/metric_measurement_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class MetricMeasurementList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   MetricMeasurementList.new({:group_id => 12345})
+    #
+    #   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
+
+      @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 user role.
+    #
+    # @param index The index of the user role to get.
+    #
+    # @return [UserRole]
+    def [](index)
+      MetricMeasurement.new( @json_data['measurements'][index] ) if @json_data['measurements'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['measurements'].each{ |measurement| yield( MatricMeasurement.new(measurement) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['measurements'].empty?
+    end
+
+  end
+  
+end