handle dots or forward slashes in graph column names

albertobraschi · Nov 20, 2008 · 2f42d0c · 2f42d0c
1 parent db7f4ed
commit 2f42d0c
Show file tree

Hide file tree

Showing 6 changed files with 160 additions and 12 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,5 @@
+v0.1.2. handle dots or forward slashes in graph column names
+
 v0.1.1. fixed bug due to change in google's graph csv
 
 v0.1.0. fixed bug due to change in google's graph csv; removed deprecated load_report method

diff --git a/lib/rugalytics.rb b/lib/rugalytics.rb
@@ -11,7 +11,7 @@
 
 # See README for usage documentation.
 module Rugalytics
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 
   FORMAT_PDF = '0' unless defined? FORMAT_PDF
   FORMAT_XML = '1' unless defined? FORMAT_XML

diff --git a/lib/rugalytics/profile.rb b/lib/rugalytics/profile.rb
@@ -3,7 +3,7 @@ class Profile < ::Google::Base
 
     class << self
       def find_all(account_id)
-        doc = Hpricot::XML get("https://www.google.com:443/analytics/settings/home?scid=#{account_id}")
+        doc = Hpricot get("https://www.google.com:443/analytics/settings/home?scid=#{account_id}")
         (doc/'select[@id=profile] option').inject([]) do |profiles, option|
           profile_id = option['value'].to_i
           profiles << Profile.new(:account_id => account_id, :profile_id => profile_id, :name => option.inner_html) if profile_id > 0
@@ -27,6 +27,21 @@ def initialize(attrs)
       @profile_id = attrs[:profile_id]  if attrs.has_key?(:profile_id)
     end
 
+    def top_report_names
+      unless @report_names
+        html = Profile.get("https://www.google.com/analytics/reporting/?scid=#{profile_id}")
+        # reports = html.scan(/rpt=([A-Za-z]+)("|&)/)
+        reports = html.scan(/changeReport\(&(#39|quot);([a-z_]+)&(#39|quot);/)
+        non_reports = ['goal_intro_report', 'add_segment_report', 'custom_reports_overview_report', 'manage_emails_report', 'manage_segments_report']
+        names = reports.collect do |name|
+          name = name[1].sub(/^maps$/,'geo_map').sub(/^sources$/,'traffic_sources').sub(/^visitors$/,'visitors_overview')
+          "#{name}_report"
+        end
+        @report_names = names.uniq.sort - non_reports
+      end
+      @report_names
+    end
+
     def method_missing symbol, *args
       if name = symbol.to_s[/^(.+)_report$/, 1]
         options = args && args.size == 1 ? args[0] : {}
@@ -79,6 +94,11 @@ def set_default_options(options)
         :gdfmt   => 'nth_day',
         :view    => 0
       })
+      if options[:report] == 'GeoMap'
+        options.delete(:tab)
+        options.delete(:gdfmt)
+        options.delete(:rows)
+      end
       options[:from] = ensure_datetime_in_google_format(options[:from])
       options[:to]   = ensure_datetime_in_google_format(options[:to])
       options
@@ -123,9 +143,17 @@ def to_s
     private
 
       def create_report(name, options={})
-        report = Rugalytics::Report.new get_report_csv(options.merge({:report=>name}))
-        puts report.attribute_names
-        report
+        options = options.merge({:report=>name})
+        csv = get_report_csv(options)
+        begin
+          report = Rugalytics::Report.new csv
+          puts report.attribute_names
+          report
+        rescue Exception => e
+          puts convert_options_to_uri_params(options).inspect
+          puts csv
+          raise e
+        end
       end
   end
 end
diff --git a/lib/rugalytics/report.rb b/lib/rugalytics/report.rb
@@ -67,6 +67,7 @@ def handle_graphs lines
           index = index.next
         end
 
+        name = name.gsub('/','_per_').gsub('.','')
         graph = Graph.new name, points, start_date, end_date
         morph("#{name.sub(/page views/i,'pageviews')} graph", graph)
       end

diff --git a/spec/lib/rugalytics/profile_spec.rb b/spec/lib/rugalytics/profile_spec.rb
@@ -31,6 +31,101 @@
     end
   end
 
+  describe 'finding report names' do
+    before do
+      @profile = Profile.new :profile_id=>123
+    end
+
+    it 'should return list of reports linked from main profile page' do
+      report = {}
+      report[0] = 'os_browsers'
+      report[1] = 'colors'
+      report[2] = 'dashboard'
+      report[3] = 'visits'
+      report[4] = 'unique_visitors'
+      report[5] = 'pageviews'
+      report[6] = 'average_pageviews'
+      report[7] = 'time_on_site'
+      report[8] = 'bounce_rate'
+      report[9] = 'visitor_types'
+      report[10] = 'languages'
+      report[11] = 'networks'
+      report[12] = 'user_defined'
+      report[13] = 'browsers'
+      report[14] = 'platforms'
+      report[15] = 'maps'
+      report[16] = 'sources'
+      report[17] = 'visitors'
+      html = %Q|<html><head><title>Visitors Overview - Google Analytics</title></head>
+<body dir="ltr" class="report_body">
+<a href="#" onclick="return VisualizationModule.changeReport(&#39;add_segment&#39;);">Create a new advanced segment</a>
+<a href="#" id="f_managesegment_format" onclick="return VisualizationModule.changeReport(&#39;manage_segments&#39;);">Manage your advanced segments</a>
+<b> Your report has been added.<a href="dashboard?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;#{report[2]}&#39;)">View Dashboard</a>
+<a href="visits?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[3]}&quot;);"> Visits </a>
+<a href="unique_visitors?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[4]}&quot;);"> Absolute Unique Visitors </a>
+<a href="pageviews?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[5]}&quot;);"> Pageviews </a>
+<a href="average_pageviews?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[6]}&quot;);"> Average Pageviews </a>
+<a href="time_on_site?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[7]}&quot;);"> Time on Site </a>
+<a href="bounce_rate?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&quot;#{report[8]}&quot;);"> Bounce Rate </a>
+<a href="visitor_types?id=321&amp;pdr=20081020-20081119&amp;cmp=average&amp;view=1" onclick="return VisualizationModule.changeReport(&quot;#{report[9]}&quot;, &quot;view\x3d1&quot;);"> New Visits</a>
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[10]}&quot;)">languages</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[11]}&quot;)">network locations</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[12]}&quot;)">user defined</a>
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[13]}&quot;, &quot;view=1&quot;)">browsers</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[14]}&quot;, &quot;view=1&quot;)">operating systems</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[0]}&quot;, &quot;view=1&quot;)">browser and operating systems</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[1]}&quot;, &quot;view=1&quot;)">screen colors</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;resolutions&quot;, &quot;view=1&quot;)">screen resolutions</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;java&quot;, &quot;view=1&quot;, &quot;view=1&quot;)">java support</a>,
+<a href="#" onclick="VisualizationModule.changeReport(&quot;flash&quot;, &quot;view=1&quot;, &quot;view=1&quot;)">Flash</a>
+<a href="#" onclick="VisualizationModule.changeReport(&quot;#{report[15]}&quot;)">Map Overlay</a>
+<a href="browsers?id=321&amp;pdr=20081020-20081119&amp;cmp=average&amp;view=1" onclick="return VisualizationModule.changeReport(&quot;browsers&quot;, &quot;view\x3d1&quot;);"> view full report</a>
+<a href="speeds?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return Vis            <a href="dashboard?dashboard=1&amp;id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;dashboard&#39;)" class="" id="dashboard_nav_item">
+<a href="visitors?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;#{report[17]}&#39;)" class="current" id="visitors_nav_item">
+<a href="visitors?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;visitors&#39;)" class="current">
+<a href="benchmark?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReportAndComparison(&#39;benchmark&#39;, &#39;benchmark&#39;)" class="">
+<a href="maps?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;#{report[15]}&#39;)" class="">
+<a href="visitor_types?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;visitor_types&#39;, &#39;view=1&#39;)" class="">
+<a href="languages?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;languages&#39;)" class="">
+<a href="visits?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;visits&#39;)" class="">
+<a href="unique_visitors?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;unique_visitors&#39;)" class="">
+<a href="pageviews?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;pageviews&#39;)" class="">
+<a href="average_pageviews?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;average_pageviews&#39;)" class="">
+<a href="time_on_site?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;time_on_site&#39;)" class="">
+<a href="bounce_rate?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;bounce_rate&#39;)" class="">
+<a href="loyalty?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;loyalty&#39;)" class="">
+<a href="recency?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;recency&#39;)" class="">
+<a href="length_of_visit?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;length_of_visit&#39;)" class="">
+<a href="depth_of_visit?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;depth_of_visit&#39;)" class="">
+<a href="browsers?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;browsers&#39;, &#39;view=1&#39;)" class="">
+<a href="platforms?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;platforms&#39;, &#39;view=1&#39;)" class="">
+<a href="os_browsers?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;os_browsers&#39;, &#39;view=1&#39;)" class="">
+<a href="colors?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;colors&#39;, &#39;view=1&#39;)" class="">
+<a href="resolutions?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;resolutions&#39;, &#39;view=1&#39;)" class="">
+<a href="flash?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;flash&#39;, &#39;view=1&#39;)" class="">
+<a href="java?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;java&#39;, &#39;view=1&#39;)" class="">
+<a href="networks?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;networks&#39;)" class="">
+<a href="hostnames?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;hostnames&#39;)" class="">
+<a href="speeds?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;speeds&#39;)" class="">
+<a href="user_defined?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;user_defined&#39;)" class="">
+<a href="sources?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;#{report[16]}&#39;)" class="" id="traffic_sources_nav_item">
+<a href="content?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;content&#39;)" class="" id="content_nav_item">
+<a href="goal_intro?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;goal_intro&#39;)" class="" id="goals_nav_item">
+<a href="custom_reports_overview?id=321&amp;pdr=20081020-20081119&amp;cmp=average" onclick="return VisualizationModule.changeReport(&#39;custom_reports_overview&#39;)" class="custom_reporting_section" id="custom_report_nav_item">
+<a href="#" onclick="return VisualizationModule.changeReport(&quot;manage_segments&quot;);">Advanced Segments</a>&nbsp;<b class="beta_label small">Beta</b>
+<a href="#" onclick="return VisualizationModule.changeReport(&quot;manage_emails&quot;);">Email</a>
+</body></html>|
+      Profile.should_receive(:get).with("https://www.google.com/analytics/reporting/?scid=#{@profile.profile_id}").and_return html
+      reports = @profile.top_report_names
+      puts reports
+      report.each do |k,name|
+        report_name = "#{name.sub(/^maps$/,'geo_map').sub(/^sources$/,'traffic_sources').sub(/^visitors$/,'visitors_overview')}_report"
+        reports.should include(report_name)
+      end
+    end
+
+  end
+
   describe 'finding pageviews' do
     before do
       @profile = Profile.new :profile_id=>123
@@ -102,9 +197,10 @@
     before do
       @profile = Profile.new :profile_id=>123
     end
-    def self.it_should_default option, value
+    def self.it_should_default option, value, report=nil
+      options = report ? %Q|{:report=>"#{report}"}| : '{}'
       eval %Q|it 'should set :#{option} to #{value}' do
-                @profile.set_default_options({})[:#{option}].should == #{value}
+                @profile.set_default_options(#{options})[:#{option}].should == #{value}
               end|
     end
     it_should_default :report, '"Dashboard"'
@@ -114,6 +210,11 @@ def self.it_should_default option, value
     it_should_default :compute, '"average"'
     it_should_default :gdfmt, '"nth_day"'
     it_should_default :view, '0'
+
+    it_should_default :tab, 'nil', 'GeoMap'
+    it_should_default :rows, 'nil', 'GeoMap'
+    it_should_default :gdfmt, 'nil', 'GeoMap'
+
     it 'should default :from to a month ago, and :to to today' do
       @month_ago = mock('month_ago')
       @today = mock('today')

diff --git a/spec/lib/rugalytics/report_spec.rb b/spec/lib/rugalytics/report_spec.rb
@@ -165,9 +165,9 @@
     end
 
     describe "when creating graph points from 'Graph'" do
-      def graph_correct expected_start, expected_end
+      def graph_correct expected_start, expected_end, column_name='Page Views', graph_name=:pageviews_graph
         @start_end_dates = "#{@start},#{@end}"
-        @name = %Q|Page Views|
+        @name = column_name
         @column_names = "Day,#{@name}"
         @csv = ['# ----------------------------------------',
                 'your_site.com',
@@ -184,11 +184,11 @@ def graph_correct expected_start, expected_end
                 '# ----------------------------------------']
         graph = mock('graph')
 
-        Graph.should_receive(:new).with(@name, [5360, 575], expected_start, expected_end).and_return graph
+        Graph.should_receive(:new).with(@name.sub('/','_per_').sub('.',''), [5360, 575], expected_start, expected_end).and_return graph
 
         report = Report.new(@csv.join("\n"))
-        report.pageviews_graph.should == graph
-        report.attribute_names.should == ['pageviews_graph']
+        report.send(graph_name).should == graph
+        report.attribute_names.should == [graph_name.to_s]
       end
 
       describe 'with source date format "Month Day, Year"' do
@@ -206,6 +206,22 @@ def graph_correct expected_start, expected_end
           graph_correct Date.parse(@start), Date.parse(@end)
         end
       end
+
+      describe "with forward slash in column name" do
+        it 'should create graph with forward slash replaced by _per_ in column name' do
+          @start = %Q|28 August 2008|
+          @end = %Q|29 August 2008|
+          graph_correct Date.parse(@start), Date.parse(@end), 'Pages/Visit', :pages_per_visit_graph
+        end
+      end
+
+      describe "with dot in column name" do
+        it 'should create graph with dot removed in column name' do
+          @start = %Q|28 August 2008|
+          @end = %Q|29 August 2008|
+          graph_correct Date.parse(@start), Date.parse(@end), 'Avg. Time on Site', :avg_time_on_site_graph
+        end
+      end
     end
   end