rugalytics 0.0.8 → 0.0.9

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.9. allowed setting of :url and :page_title options for drilldown and content reports; merged masolino's changes
+
 v0.0.8. moved i18n date parse method to Rugalytics module
 
 v0.0.7. consolidated on US English spelling of pageviews for method names

data/README

@@ -96,7 +96,7 @@ Let's load the TrafficSources report:
 
  report = profile.traffic_sources_report
 
- report.report_name
+ report.name
  => "Traffic Sources Overview"
 
  report.start_date
@@ -132,6 +132,42 @@ Let's now grab 100 lines of the Networks report:
  => "telecom xtra"
 
 
+== Report by URL
+
+You can get a content drilldown report:
+
+ report = profile.content_drilldown_report(:url => "/projects/abc/")
+ report.name
+ => "Content Drilldown,/projects/abc/"
+
+ report.items.first
+ => # Rugalytics::Item @bounce_rate="0.85", @unique_pageviews="155",
+          @percentage_exit="0.776536312849162", @time_on_page="165.75",
+          @pageviews="179", @path="/reports/", @dollar_index="0.0",
+          @url="http://your_site.com/projects/abc/reports/"
+
+Pageviews by URL:
+
+ report = profile.top_content_detail_report(:url => "/projects/abc")
+ report.name
+ => "Content Detail:,/projects/abc"
+
+ report.pageviews_total
+ => 179
+
+Pageviews by page title:
+
+ report = profile.content_by_title_detail_report(:page_title => "Project ABC | Company XYZ")
+ report.name
+ => "Content by Title Detail:,Project ABC | Company XYZ"
+
+ report.items.first
+ => # Rugalytics::Item @bounce_rate="0.85", @unique_pageviews="1550",
+          @percentage_exit="0.776536312849162", @time_on_page="165.75",
+          @pageviews="179", @path="/projects/abc", @dollar_index="0.0",
+          @url="http://your_site.com/projects/abc"
+
+
 ==Use in Rails
 
 To use from Rails, make a config file rails_root/config/rugalytics.yml

data/README.rdoc

@@ -96,7 +96,7 @@ Let's load the TrafficSources report:
 
  report = profile.traffic_sources_report
 
- report.report_name
+ report.name
  => "Traffic Sources Overview"
 
  report.start_date
@@ -132,6 +132,42 @@ Let's now grab 100 lines of the Networks report:
  => "telecom xtra"
 
 
+== Report by URL
+
+You can get a content drilldown report:
+
+ report = profile.content_drilldown_report(:url => "/projects/abc/")
+ report.name
+ => "Content Drilldown,/projects/abc/"
+
+ report.items.first
+ => # Rugalytics::Item @bounce_rate="0.85", @unique_pageviews="155",
+          @percentage_exit="0.776536312849162", @time_on_page="165.75",
+          @pageviews="179", @path="/reports/", @dollar_index="0.0",
+          @url="http://your_site.com/projects/abc/reports/"
+
+Pageviews by URL:
+
+ report = profile.top_content_detail_report(:url => "/projects/abc")
+ report.name
+ => "Content Detail:,/projects/abc"
+
+ report.pageviews_total
+ => 179
+
+Pageviews by page title:
+
+ report = profile.content_by_title_detail_report(:page_title => "Project ABC | Company XYZ")
+ report.name
+ => "Content by Title Detail:,Project ABC | Company XYZ"
+
+ report.items.first
+ => # Rugalytics::Item @bounce_rate="0.85", @unique_pageviews="1550",
+          @percentage_exit="0.776536312849162", @time_on_page="165.75",
+          @pageviews="179", @path="/projects/abc", @dollar_index="0.0",
+          @url="http://your_site.com/projects/abc"
+
+
 ==Use in Rails
 
 To use from Rails, make a config file rails_root/config/rugalytics.yml

data/lib/rugalytics/item.rb

@@ -15,6 +15,7 @@ module Rugalytics
 
       if respond_to?(:url)
         self.path = url
+        # todo: For drilldown report, URLs need to be cumulatively created e.g. /health/ -> http://theyworkforyou.co.nz/portfolios/health/
         self.url = "http://#{base_url}#{url}"
       end
     end

data/lib/rugalytics/profile.rb

@@ -46,20 +46,12 @@ module Rugalytics
     end
 
     def get_report_csv(options={})
-      options.reverse_merge!({
-        :report  => 'Dashboard',
-        :from    => Time.now.utc - 7.days,
-        :to      => Time.now.utc,
-        :tab     => 0,
-        :format  => FORMAT_CSV,
-        :rows    => 50,
-        :compute => 'average',
-        :gdfmt   => 'nth_day',
-        :view    => 0
-      })
-      options[:from] = ensure_datetime_in_google_format(options[:from])
-      options[:to]   = ensure_datetime_in_google_format(options[:to])
+      options = set_default_options(options)
+      params = convert_options_to_uri_params(options)
+      self.class.get("https://google.com/analytics/reporting/export", :query_hash => params)
+    end
 
+    def convert_options_to_uri_params(options)
       params = {
         :pdr  => "#{options[:from]}-#{options[:to]}",
         :rpt  => "#{options[:report]}Report",
@@ -69,13 +61,48 @@ module Rugalytics
         :tab  => options[:tab],
         :trows=> options[:rows],
         :gdfmt=> options[:gdfmt],
-        :id   => profile_id,
+        :id   => profile_id
       }
-      puts params.inspect
-      # https://www.google.com/analytics/reporting/export?fmt=2&id=1712313&pdr=20080701-20080731&cmp=average&&rpt=PageviewsReport
-      self.class.get("https://google.com/analytics/reporting/export", :query_hash => params)
+      params[:d1] = options[:url] if options[:url]
+      params[:d1] = options[:page_title] if options[:page_title]
+      params
+    end
+
+    def a_month_ago
+      Time.now.utc.last_month
     end
 
+    def today
+      Time.now.utc
+    end
+
+    def set_default_options(options)
+      options.reverse_merge!({
+        :report  => 'Dashboard',
+        :from    => a_month_ago,
+        :to      => today,
+        :tab     => 0,
+        :format  => FORMAT_CSV,
+        :rows    => 50,
+        :compute => 'average',
+        :gdfmt   => 'nth_day',
+        :view    => 0
+      })
+      options[:from] = ensure_datetime_in_google_format(options[:from])
+      options[:to]   = ensure_datetime_in_google_format(options[:to])
+      options
+    end
+
+    # Extract Page Views from Content Drilldown Report URLs.
+    # Use with :url => "/projects/68263/" to options hash
+    #
+    # def drilldown(options={})
+      # content_drilldown_report(options).pageviews_total
+    # end
+    #
+    # instead do
+    # profile.content_drilldown_report(:url => '/projects/68263/').pageviews_total
+
     def pageviews(options={})
       pageviews_report(options).pageviews_total
     end

data/lib/rugalytics/report.rb

@@ -4,7 +4,7 @@ module Rugalytics
 
     include MorphLessMethodMissing
 
-    attr_reader :base_url, :report_name, :start_date, :end_date
+    attr_reader :base_url, :start_date, :end_date, :name
 
     def initialize csv=''
       return if csv.empty?
@@ -36,11 +36,18 @@ module Rugalytics
       end
     end
 
+    def report_name
+      ActiveSupport::Deprecation.warn "Report#report_name has been deprecated, use Report#name instead"
+      name
+    end
+
     private
 
     def set_attributes lines
       @base_url = lines[1]
-      @report_name = lines[2].chomp(',')
+      names = lines[2].split(',')
+      @base_url = "#{@base_url}#{names[1].chomp('/')}" if names.size > 1 && names[1][/^\/.+$/]
+      @name = lines[2].chomp(',')
       dates = lines[3].include?('","') ? lines[3].split('","') : lines[3].split(',')
       @start_date = Rugalytics.i18n_date_parse(dates[0])
       @end_date = Rugalytics.i18n_date_parse(dates[1])
@@ -73,7 +80,7 @@ module Rugalytics
     def handle_tables lines
       index = 5
       while index < lines.size
-        while (lines[index][/^# .*Table/].nil? || lines[index].strip.size == 0)
+        while (lines[index][/^# .*Table/].nil? || lines[index].blank?)
           index = index.next
           return if index == lines.size
         end

data/lib/rugalytics.rb

@@ -11,7 +11,7 @@ require 'yaml'
 
 # See README for usage documentation.
 module Rugalytics
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 
   FORMAT_PDF = '0' unless defined? FORMAT_PDF
   FORMAT_XML = '1' unless defined? FORMAT_XML

data/rugalytics.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Rugalytics-0.0.8
+# Gem::Specification for Rugalytics-0.0.9
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: rugalytics
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Rob McKinnon
 autorequire: 
 bindir: bin
 
-date: 2008-08-06 00:00:00 +01:00
+date: 2008-08-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

data/rugalytics.yml.example

@@ -1,5 +1,5 @@
---- 
-account: <account_name>
-profile: <profile_name>
-username: <user_name>
-password: <pass_w>
+---
+account: account_name
+profile: profile_name
+username: user_name
+password: pass_w

data/spec/lib/rugalytics/profile_spec.rb

@@ -98,6 +98,65 @@ describe Profile do
     end
   end
 
+  describe 'when asked to set default options when no options specified' do
+    before do
+      @profile = Profile.new :profile_id=>123
+    end
+    def self.it_should_default option, value
+      eval %Q|it 'should set :#{option} to #{value}' do
+                @profile.set_default_options({})[:#{option}].should == #{value}
+              end|
+    end
+    it_should_default :report, '"Dashboard"'
+    it_should_default :tab, '0'
+    it_should_default :format, 'Rugalytics::FORMAT_CSV'
+    it_should_default :rows, '50'
+    it_should_default :compute, '"average"'
+    it_should_default :gdfmt, '"nth_day"'
+    it_should_default :view, '0'
+    it 'should default :from to a month ago, and :to to today' do
+      @month_ago = mock('month_ago')
+      @today = mock('today')
+      @profile.should_receive(:a_month_ago).and_return @month_ago
+      @profile.should_receive(:today).and_return @today
+      @profile.should_receive(:ensure_datetime_in_google_format).with(@month_ago).and_return @month_ago
+      @profile.should_receive(:ensure_datetime_in_google_format).with(@today).and_return @today
+      options = @profile.set_default_options({})
+      options[:from].should == @month_ago
+      options[:to].should == @today
+    end
+  end
+
+  describe 'when asked to convert option keys to uri parameter keys' do
+    before do
+      @profile = Profile.new :profile_id=>123
+    end
+    def self.it_should_convert option_key, param_key, value_addition=''
+      eval %Q|it 'should convert :#{option_key} to :#{param_key}' do
+                params = @profile.convert_options_to_uri_params({:#{option_key} => 'value'})
+                params[:#{param_key}].should == 'value#{value_addition}'
+              end|
+    end
+    it_should_convert :report,  :rpt, 'Report'
+    it_should_convert :compute, :cmp
+    it_should_convert :format,  :fmt
+    it_should_convert :view,    :view
+    it_should_convert :rows,    :trows
+    it_should_convert :gdfmt,   :gdfmt
+    it_should_convert :url,     :d1
+    it_should_convert :page_title,:d1
+
+    it 'should convert from and to dates into the period param' do
+      from = '20080801'
+      to = '20080808'
+      params = @profile.convert_options_to_uri_params :from=>from, :to=>to
+      params[:pdr].should == "#{from}-#{to}"
+    end
+    it 'should set param id to be the profile id' do
+      @profile.convert_options_to_uri_params({})[:id].should == 123
+    end
+  end
+
   it "should be able to find all profiles for an account" do
     html = fixture('analytics_profile_find_all.html')
     Profile.should_receive(:get).and_return(html)

data/spec/lib/rugalytics/report_spec.rb

@@ -21,6 +21,7 @@ describe Report do
 
       it "should set report name from third line of text" do
         @report.report_name.should == 'Top Content'
+        @report.name.should == 'Top Content'
       end
 
       it "should set start date from fourth line of text" do
@@ -30,6 +31,41 @@ describe Report do
       it "should set end date from fourth line of text" do
         @report.end_date.should == Date.parse('31 May 2008')
       end
+
+      describe "for a Content Drilldown report and a path is in report name" do
+        before :all do
+          csv = ['# ----------------------------------------',
+                  'your_site.com',
+                  'Content Drilldown,/portfolios/health/',
+                  '26 May 2008,31 May 2008',
+                  '# ----------------------------------------']
+          @report = Report.new(csv.join("\n"))
+        end
+        it 'should append path at end of base_url' do
+          @report.base_url.should == 'your_site.com/portfolios/health'
+        end
+        it 'should set report name including path' do
+          @report.report_name.should == 'Content Drilldown,/portfolios/health/'
+          @report.name.should == 'Content Drilldown,/portfolios/health/'
+        end
+      end
+
+      describe "for a Top Content by title report and page title is in report name" do
+        before :all do
+          csv = ['# ----------------------------------------',
+                  'your_site.com',
+                  'Content by Title Detail:,Project ABC | Company XZY',
+                  '26 May 2008,31 May 2008',
+                  '# ----------------------------------------']
+          @report = Report.new(csv.join("\n"))
+        end
+        it 'should not append title to end of base_url' do
+          @report.base_url.should == 'your_site.com'
+        end
+        it 'should set report name including page title' do
+          @report.name.should == 'Content by Title Detail:,Project ABC | Company XZY'
+        end
+      end
     end
 
     describe "when setting report dates" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rugalytics
 version: !ruby/object:Gem::Version 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Rob McKinnon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-06 00:00:00 +01:00
+date: 2008-08-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency