module TheCity

  class MetricList < ApiList

    include Enumerable

    # 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 = options
      @options[:page] ||= 1
      @options[:reader] = TheCity::MetricListReader.new(@options) if @options[:reader].nil?
      @json_data = @options[: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