rugalytics 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.5. report names are now methods that can be called on profile, load_report is deprecated
+
 v0.0.4. fix for HTML and URL changes at Google Analytics site
 
 v0.0.3. get some rails integration going on, with config/rugalytics.yml

data/README

@@ -18,6 +18,24 @@ Should be up at rubyforge, so to install:
  sudo gem install rugalytics
 
 
+== Changes in v0.0.5
+
+The load_report method has been deprecated, instead call the report name as
+a method, for example:
+
+ # Instead of this
+ report = profile.load_report('Pageviews', :from => '2007-01-01')
+
+ # Do this
+ report = profile.pageviews_report(:from => '2007-01-01')
+
+ # Instead of this
+ report = profile.load_report('TrafficSources')
+
+ # Do this
+ report = profile.traffic_sources_report
+
+
 == Authenticate
 
 Login with your Google Analytics user name and password:
@@ -55,7 +73,7 @@ Obtaining page views:
 
 The +pageviews+ method is doing this under the hood:
 
- report = profile.load_report('Pageviews', :from=>'2007-01-01', :to=>'2007-01-02')
+ report = profile.pageviews_report(:from=>'2007-01-01', :to=>'2007-01-02')
 
  report.page_views_total
  => 24980
@@ -77,7 +95,7 @@ the Export tab, and then mousing over the CSV option.
 
 Let's load the TrafficSources report:
 
- report = profile.load_report 'TrafficSources'
+ report = profile.traffic_sources_report
 
  report.report_name
  => "Traffic Sources Overview"
@@ -96,17 +114,17 @@ Let's load the TrafficSources report:
 
 Let's try another report, VisitorsOverview:
 
- report = profile.load_report 'VisitorsOverview'
+ report = profile.visitors_overview_report
 
  report.browser_items[1]
- => #<Rugalytics::Item @percentage_visits="0.18", @visits="3140", @browser="Firefox">
+ => # Rugalytics::Item @percentage_visits="0.18", @visits="3140", @browser="Firefox"
 
  report.connection_speed_items[3]
- => #<Rugalytics::Item @connection_speed="Dialup", @percentage_visits="0.06340057402849197", @visits="1100">
+ => # Rugalytics::Item @connection_speed="Dialup", @percentage_visits="0.06340057402849197", @visits="1100"
 
 Let's now grab 100 lines of the Networks report:
 
- report = profile.load_report 'Networks', :rows=>100
+ report = profile.networks_report :rows=>100
 
  report.items.size
  => 100
@@ -121,13 +139,13 @@ To use from Rails, make a config file rails_root/config/rugalytics.yml
 with the following contents:
 
  ---
- account: <account_name>
- profile: <profile_name>
- username: <user_name>
- password: <pass_w>
+ account: [account_name]
+ profile: [profile_name]
+ username: [user_name]
+ password: [pass_w]
 
 Remember to tell your source control system to ignore this file! If you're
-using git, this means adding config/rugalytics.yml to you .gitignore
+using git, this means adding config/rugalytics.yml to your .gitignore
 file.
 
  vi .gitignore
@@ -137,7 +155,7 @@ You can now use Rugalytics from within Rails, and login will be done
 automatically, e.g.:
 
  profile = Rugalytics.default_profile
- report = profile.load_report('TopContent', :from=>(Date.today - 7) )
+ report = profile.top_content_report(:from=>(Date.today - 7) )
  top_items_over_week = report.items.sort_by{|i| i.unique_page_views.to_i}.reverse
 
 

data/README.rdoc

@@ -18,6 +18,24 @@ Should be up at rubyforge, so to install:
  sudo gem install rugalytics
 
 
+== Changes in v0.0.5
+
+The load_report method has been deprecated, instead call the report name as
+a method, for example:
+
+ # Instead of this
+ report = profile.load_report('Pageviews', :from => '2007-01-01')
+
+ # Do this
+ report = profile.pageviews_report(:from => '2007-01-01')
+
+ # Instead of this
+ report = profile.load_report('TrafficSources')
+
+ # Do this
+ report = profile.traffic_sources_report
+
+
 == Authenticate
 
 Login with your Google Analytics user name and password:
@@ -55,7 +73,7 @@ Obtaining page views:
 
 The +pageviews+ method is doing this under the hood:
 
- report = profile.load_report('Pageviews', :from=>'2007-01-01', :to=>'2007-01-02')
+ report = profile.pageviews_report(:from=>'2007-01-01', :to=>'2007-01-02')
 
  report.page_views_total
  => 24980
@@ -77,7 +95,7 @@ the Export tab, and then mousing over the CSV option.
 
 Let's load the TrafficSources report:
 
- report = profile.load_report 'TrafficSources'
+ report = profile.traffic_sources_report
 
  report.report_name
  => "Traffic Sources Overview"
@@ -96,17 +114,17 @@ Let's load the TrafficSources report:
 
 Let's try another report, VisitorsOverview:
 
- report = profile.load_report 'VisitorsOverview'
+ report = profile.visitors_overview_report
 
  report.browser_items[1]
- => #<Rugalytics::Item @percentage_visits="0.18", @visits="3140", @browser="Firefox">
+ => # Rugalytics::Item @percentage_visits="0.18", @visits="3140", @browser="Firefox"
 
  report.connection_speed_items[3]
- => #<Rugalytics::Item @connection_speed="Dialup", @percentage_visits="0.06340057402849197", @visits="1100">
+ => # Rugalytics::Item @connection_speed="Dialup", @percentage_visits="0.06340057402849197", @visits="1100"
 
 Let's now grab 100 lines of the Networks report:
 
- report = profile.load_report 'Networks', :rows=>100
+ report = profile.networks_report :rows=>100
 
  report.items.size
  => 100
@@ -121,13 +139,13 @@ To use from Rails, make a config file rails_root/config/rugalytics.yml
 with the following contents:
 
  ---
- account: <account_name>
- profile: <profile_name>
- username: <user_name>
- password: <pass_w>
+ account: [account_name]
+ profile: [profile_name]
+ username: [user_name]
+ password: [pass_w]
 
 Remember to tell your source control system to ignore this file! If you're
-using git, this means adding config/rugalytics.yml to you .gitignore
+using git, this means adding config/rugalytics.yml to your .gitignore
 file.
 
  vi .gitignore
@@ -137,7 +155,7 @@ You can now use Rugalytics from within Rails, and login will be done
 automatically, e.g.:
 
  profile = Rugalytics.default_profile
- report = profile.load_report('TopContent', :from=>(Date.today - 7) )
+ report = profile.top_content_report(:from=>(Date.today - 7) )
  top_items_over_week = report.items.sort_by{|i| i.unique_page_views.to_i}.reverse
 
 

data/Rakefile

@@ -20,4 +20,9 @@ end
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/rugalytics.rb"
+end
+
+desc "Run all examples with RCov"
+task :rcov do
+  sh '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby -Ilib -S rcov --text-report  -o "coverage" -x "Library" spec/lib/**/*'
 end

data/lib/rugalytics/profile.rb

@@ -27,13 +27,25 @@ module Rugalytics
       @profile_id = attrs[:profile_id]  if attrs.has_key?(:profile_id)
     end
 
+    def method_missing symbol, *args
+      if name = symbol.to_s[/^(.+)_report$/, 1]
+        options = args && args.size == 1 ? args[0] : {}
+        create_report(name.camelize, options)
+      else
+        super
+      end
+    end
+
     def load_report(name, options={})
-      report = Rugalytics::Report.new report(options.merge({:report=>name}))
-      puts report.attribute_names
-      report
+      if options=={}
+        ActiveSupport::Deprecation.warn "Profile#load_report('#{name}') has been deprecated, use Profile##{name.tableize}_report instead"
+      else
+        ActiveSupport::Deprecation.warn "Profile#load_report('#{name}',options) has been deprecated, use Profile##{name.tableize}_report(options) instead"
+      end
+      create_report(name, options={})
     end
 
-    def report(options={})
+    def get_report_csv(options={})
       options.reverse_merge!({
         :report  => 'Dashboard',
         :from    => Time.now.utc - 7.days,
@@ -65,19 +77,19 @@ module Rugalytics
     end
 
     def pageviews(options={})
-      load_report('Pageviews',options).page_views_total
+      pageviews_report(options).page_views_total
     end
 
     def pageviews_by_day(options={})
-      load_report('Pageviews',options).page_views_by_day
+      pageviews_report(options).page_views_by_day
     end
 
     def visits(options={})
-      load_report('Visits',options).visits_total
+      visits_report(options).visits_total
     end
 
     def visits_by_day(options={})
-      load_report('Visits',options).visits_by_day
+      visits_report(options).visits_by_day
     end
 
     # takes a Date, Time or String
@@ -91,26 +103,11 @@ module Rugalytics
     end
 
     private
-      def get_item_summary_by_message(options={})
-        raise ArgumentError unless options.has_key?(:message)
-        message = options.delete(:message).to_s.capitalize
-        response = report(options.merge({:report => 'Dashboard'}))
-        doc = Hpricot::XML(response)
-        pageviews = (doc/:ItemSummary).detect { |summary| summary.at('Message').inner_html == message }
-        pageviews && pageviews.at('SummaryValue') ? pageviews.at('SummaryValue').inner_html.gsub(/\D/, '').to_i : 0
-      end
 
-      def get_serie_by_label(options={})
-        raise ArgumentError unless options.has_key?(:label)
-        label = options.delete(:label).to_s.capitalize
-        response = report(options.merge({:report => 'Dashboard'}))
-        doc = Hpricot::XML(response)
-        serie = (doc/:Serie).detect { |serie| serie.at('Label').inner_html == label }
-        if serie
-          (serie/:Point).inject([]) { |collection, point| collection << [Date.parse(point.at('Label').inner_html), point.at('Value').inner_html.to_i] }
-        else
-          []
-        end
+      def create_report(name, options={})
+        report = Rugalytics::Report.new get_report_csv(options.merge({:report=>name}))
+        puts report.attribute_names
+        report
       end
   end
 end

data/lib/rugalytics.rb

@@ -11,7 +11,7 @@ require 'yaml'
 
 # See README for usage documentation.
 module Rugalytics
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
   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.4
+# Gem::Specification for Rugalytics-0.0.5
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: rugalytics
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Rob McKinnon
 autorequire: 
 bindir: bin
 
-date: 2008-08-01 00:00:00 +01:00
+date: 2008-08-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

data/spec/lib/rugalytics/profile_spec.rb

@@ -3,22 +3,18 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb'
 describe Rugalytics::Profile do
 
   describe "being initialized" do
-
     it "should accept :name as key" do
-      a = Rugalytics::Profile.new(:name => 'test', :profile_id => '12341234')
-      a.name.should == 'test'
+      profile = Rugalytics::Profile.new(:name => 'test', :profile_id => '12341234')
+      profile.name.should == 'test'
     end
-
     it "should accept :account_id as key" do
-      a = Rugalytics::Profile.new(:account_id => '12341234', :profile_id => '12341234')
-      a.account_id.should == '12341234'
+      profile = Rugalytics::Profile.new(:account_id => '12341234', :profile_id => '12341234')
+      profile.account_id.should == '12341234'
     end
-
     it "should accept :profile_id as key" do
-      a = Rugalytics::Profile.new(:profile_id => '12341234')
-      a.profile_id.should == '12341234'
+      profile = Rugalytics::Profile.new(:profile_id => '12341234')
+      profile.profile_id.should == '12341234'
     end
-
   end
 
   describe "finding by account id and profile id" do
@@ -35,37 +31,68 @@ describe Rugalytics::Profile do
   end
 
   describe 'finding pageviews' do
+    before do
+      @profile = Rugalytics::Profile.new :profile_id=>123
+      @report = mock('report',:page_views_total=>100)
+    end
     it 'should return total from loaded "Pageviews" report' do
-      profile = Rugalytics::Profile.new :profile_id=>123
-      profile.should_receive(:load_report).with('Pageviews',{}).and_return mock('report',:page_views_total=>100)
-      profile.pageviews.should == 100
+      @profile.should_receive(:pageviews_report).with({}).and_return @report
+      @profile.pageviews.should == @report.page_views_total
     end
     describe 'when from and to dates are specified' do
       it 'should return total from "Pageviews" report for given dates' do
-        profile = Rugalytics::Profile.new :profile_id=>123
-        from = '2008-05-01'
-        to = '2008-05-03'
-        options = {:from=>from, :to=>to}
-        profile.should_receive(:load_report).with('Pageviews', options).and_return mock('report',:page_views_total=>100)
-        profile.pageviews(options).should == 100
+        options = {:from=>'2008-05-01', :to=>'2008-05-03'}
+        @profile.should_receive(:pageviews_report).with(options).and_return @report
+        @profile.pageviews(options).should == @report.page_views_total
       end
     end
   end
 
   describe 'finding visits' do
+    before do
+      @profile = Rugalytics::Profile.new :profile_id=>123
+      @report = mock('report', :visits_total=>100)
+    end
     it 'should return total from loaded "Visits" report' do
-      profile = Rugalytics::Profile.new :profile_id=>123
-      profile.should_receive(:load_report).with('Visits',{}).and_return mock('report',:visits_total=>100)
-      profile.visits.should == 100
+      @profile.should_receive(:visits_report).with({}).and_return @report
+      @profile.visits.should == @report.visits_total
     end
     describe 'when from and to dates are specified' do
       it 'should return total from "Visits" report for given dates' do
-        profile = Rugalytics::Profile.new :profile_id=>123
-        from = '2008-05-01'
-        to = '2008-05-03'
-        options = {:from=>from, :to=>to}
-        profile.should_receive(:load_report).with('Visits', options).and_return mock('report',:visits_total=>100)
-        profile.visits(options).should == 100
+        options = {:from=>'2008-05-01', :to=>'2008-05-03'}
+        @profile.should_receive(:visits_report).with(options).and_return @report
+        @profile.visits(options).should == @report.visits_total
+      end
+    end
+  end
+
+  describe 'finding report when called with method ending in _report' do
+    before do
+      @profile = Rugalytics::Profile.new :profile_id=>123
+      @report = mock('report', :visits_total=>100)
+    end
+    it 'should find report using create_report method' do
+      @profile.should_receive(:create_report).with('Visits',{}).and_return @report
+      @profile.visits_report.should == @report
+    end
+    it 'should find instantiate report with report csv' do
+      csv = 'csv'
+      @profile.should_receive(:get_report_csv).with({:report=>'Visits'}).and_return csv
+      @report.stub!(:attribute_names).and_return ''
+      Rugalytics::Report.should_receive(:new).with(csv).and_return @report
+      @profile.visits_report.should == @report
+    end
+    describe 'when report name is two words' do
+      it 'should find report using create_report method' do
+        @profile.should_receive(:create_report).with('VisitorsOverview',{}).and_return @report
+        @profile.visitors_overview_report.should == @report
+      end
+    end
+    describe 'when dates are given' do
+      it 'should find report using create_report method passing date options' do
+        options = {:from=>'2008-05-01', :to=>'2008-05-03'}
+        @profile.should_receive(:create_report).with('Visits', options).and_return @report
+        @profile.visits_report(options).should == @report
       end
     end
   end

metadata

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