Contents

module Gattica
  
  # Encapsulates the data returned by the GA API
  class DataSet
    include Convertible
    
    attr_reader :total_results, :start_index, :items_per_page, :start_date,
                :end_date, :points, :xml
      
    def initialize(xml)
      @xml = xml.to_s
      @total_results = xml.at('openSearch:totalResults').inner_html.to_i
      @start_index = xml.at('openSearch:startIndex').inner_html.to_i
      @items_per_page = xml.at('openSearch:itemsPerPage').inner_html.to_i
      @start_date = Date.parse(xml.at('dxp:startDate').inner_html)
      @end_date = Date.parse(xml.at('dxp:endDate').inner_html)
      @points = xml.search(:entry).collect { |entry| DataPoint.new(entry) }
    end

    # Returns a string formatted as a CSV containing just the data points.
    #
    # == Parameters:
    # +format=:long+::    Adds id, updated, title to output columns
    def to_csv(format=:long)
      output = ''
      columns = []
      case format
        when :long
          ["id", "updated", "title"].each { |c| columns << c }
      end
      unless @points.empty?   # if there was at least one result
        @points.first.dimensions.map {|d| d.key}.each { |c| columns << c }
        @points.first.metrics.map {|m| m.key}.each { |c| columns << c }
      end
      output = CSV.generate_line(columns) + "\n"
      @points.each do |point|
        output += point.to_csv(format) + "\n"
      end
    end

    def to_yaml
      { 'total_results' => @total_results,
        'start_index' => @start_index,
        'items_per_page' => @items_per_page,
        'start_date' => @start_date,
        'end_date' => @end_date,
        'points' => @points }.to_yaml
    end

  end
  
end

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
songphi-gattica-0.5.3	lib/gattica/data_set.rb
betapond-gattica-0.5.2	lib/gattica/data_set.rb
betapond-gattica-0.5.1	lib/gattica/data_set.rb