rugalytics 0.0.1

data/spec/lib/rugalytics/account_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Rugalytics::Account do
+
+  describe "being initialized" do
+    it "should accept :name as key" do
+      a = Rugalytics::Account.new(:name => 'test')
+      a.name.should == 'test'
+    end
+
+    it "should accept :account_id as key" do
+      a = Rugalytics::Account.new(:account_id => '12341234')
+      a.account_id.should == '12341234'
+    end
+  end
+
+  it "should be able to find all accounts for user" do
+    html = fixture('analytics_account_find_all.html')
+    Rugalytics::Account.should_receive(:get).and_return(html)
+    accounts = Rugalytics::Account.find_all
+    accounts.collect(&:name).should == %w[your_site.com webgroup.nd.edu]
+    accounts.collect(&:account_id).should == %w[1254221 344381].map(&:to_i)
+  end
+
+  it "should be able to find profiles for an account" do
+    html = fixture('analytics_profile_find_all.html')
+    Rugalytics::Profile.should_receive(:get).and_return(html)
+    accounts = Rugalytics::Account.new(:name => 'your_site.com', :account_id => '1254221').profiles
+    accounts.collect(&:name).should == ["blog.your_site.com"]
+  end
+
+  it "should print kind of pretty" do
+    account = Rugalytics::Account.new(:name => 'your_site.com', :account_id => '1254221')
+    account.to_s.should == "your_site.com (1254221)"
+  end
+
+  before do
+    @account = mock('account', :name=>'your_site.com', :account_id=>1254221)
+  end
+
+  describe "finding an account by its name" do
+    it 'should find all and return the match' do
+      Rugalytics::Account.should_receive(:find_all).and_return [@account]
+      Rugalytics::Account.find(@account.name).should == @account
+    end
+
+    it 'should return nil if there is no match' do
+      Rugalytics::Account.should_receive(:find_all).and_return [@account]
+      Rugalytics::Account.find('no_match').should be_nil
+    end
+  end
+
+  describe "finding an account by its account_id" do
+    it 'should find all and return the match' do
+      Rugalytics::Account.should_receive(:find_all).and_return [@account]
+      Rugalytics::Account.find(@account.account_id).should == @account
+    end
+
+    it 'should return nil if there is no match' do
+      Rugalytics::Account.should_receive(:find_all).and_return [@account]
+      Rugalytics::Account.find(111).should be_nil
+    end
+  end
+
+  describe "finding a profile by its profile_id" do
+
+    it 'should return the match' do
+      profile_id = 12341234
+      profile = mock('profile', :profile_id => profile_id)
+      account = Rugalytics::Account.new({})
+      account.should_receive(:profiles).and_return [profile]
+      account.find_profile(profile_id).should == profile
+    end
+  end
+
+  describe "finding a profile by its profile_id" do
+    it 'should return the match' do
+      profile_id = 12341234
+      name = 'blog.your_site.com'
+      profile = mock('profile', :profile_id => profile_id, :name => name)
+      account = Rugalytics::Account.new({})
+      account.should_receive(:profiles).and_return [profile]
+      account.find_profile(name).should == profile
+    end
+  end
+end

data/spec/lib/rugalytics/graph_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Rugalytics::Graph do
+
+  describe 'when creating' do
+
+    before :all do
+      @period = '1 May 2008 - 3 May 2008'
+      @name = 'Page Views'
+      @points = [5360, 3330, 4330]
+    end
+
+    it "should create fields for attributes and values" do
+      graph = Rugalytics::Graph.new @name, @period, @points
+
+      graph.from.should == Date.parse('2008-05-01')
+      graph.to.should == Date.parse('2008-05-03')
+
+      graph.points.should == @points
+    end
+
+  end
+
+  describe 'when counting total of points' do
+    it 'should sum points in graph' do
+      graph = Rugalytics::Graph.new '','',[5360, 3330, 4330]
+      graph.sum_of_points.should == 5360 + 3330 + 4330
+    end
+  end
+
+  describe 'when counting total of points' do
+    it 'should sum points in graph' do
+      graph = Rugalytics::Graph.new '','',[5360, 3330, 4330]
+      from = Date.parse('1 May 2003')
+      mid = Date.parse('2 May 2003')
+      to = Date.parse('3 May 2003')
+      graph.stub!(:from).and_return from
+      graph.stub!(:to).and_return to
+      graph.points_by_day.should == [[from,5360],[mid,3330],[to,4330]]
+    end
+  end
+
+end

data/spec/lib/rugalytics/item_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Rugalytics::Item, 'when creating' do
+
+  before :all do
+    @url = 'theyworkforyou.co.nz'
+    @attributes = 'URL,Page Views,Unique Page Views,Time on Page,Bounce Rate,% Exit,$ Index'
+    @values = '/,189,157,54.94957983193277,0.4862385392189026,0.37037035822868347,0.0'
+  end
+
+  it "it should create fields for attributes and values" do
+    item = Rugalytics::Item.new @attributes.split(','), @values.split(','), @url
+
+    item.url.should == 'http://theyworkforyou.co.nz/'
+    item.page_views.should == '189'
+    item.unique_page_views.should == '157'
+    item.time_on_page.should == '54.94957983193277'
+    item.bounce_rate.should == '0.4862385392189026'
+    item.percentage_exit.should == '0.37037035822868347'
+    item.dollar_index.should == '0.0'
+  end
+
+end

data/spec/lib/rugalytics/profile_spec.rb

@@ -0,0 +1,104 @@
+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'
+    end
+
+    it "should accept :account_id as key" do
+      a = Rugalytics::Profile.new(:account_id => '12341234', :profile_id => '12341234')
+      a.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'
+    end
+
+  end
+
+  describe "finding by account id and profile id" do
+    it 'should find account and find profile' do
+      account_id = 1254221
+      profile_id = 12341234
+      account = mock('account')
+      profile = mock('profile')
+
+      Rugalytics::Account.should_receive(:find).with(1254221).and_return account
+      account.should_receive(:find_profile).with(profile_id).and_return profile
+      Rugalytics::Profile.find(account_id, profile_id).should == profile
+    end
+  end
+
+  describe 'finding pageviews' do
+    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
+    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
+      end
+    end
+  end
+
+  describe 'finding visits' do
+    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
+    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
+      end
+    end
+  end
+
+  it "should be able to find all profiles for an account" do
+    html = fixture('analytics_profile_find_all.html')
+    Rugalytics::Profile.should_receive(:get).and_return(html)
+    accounts = Rugalytics::Profile.find_all('1254221')
+    accounts.collect(&:name).should ==  ["blog.your_site.com"]
+  end
+
+  describe "finding by account name and profile name" do
+    it 'should find account and find profile' do
+      account_name = 'your_site.com'
+      profile_name = 'blog.your_site.com'
+      account = mock('account')
+      profile = mock('profile')
+
+      Rugalytics::Account.should_receive(:find).with(account_name).and_return account
+      account.should_receive(:find_profile).with(profile_name).and_return profile
+      Rugalytics::Profile.find(account_name, profile_name).should == profile
+    end
+  end
+
+  describe "finding a profile by passing single name when account and profile name are the same" do
+    it 'should find account and find profile' do
+      name = 'your_site.com'
+      account = mock('account')
+      profile = mock('profile')
+
+      Rugalytics::Account.should_receive(:find).with(name).and_return account
+      account.should_receive(:find_profile).with(name).and_return profile
+      Rugalytics::Profile.find(name).should == profile
+    end
+  end
+end

data/spec/lib/rugalytics/report_spec.rb

@@ -0,0 +1,153 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Rugalytics::Report do
+
+  describe "creating report from csv" do
+
+    describe "when setting report attributes" do
+      before :all do
+        csv = %Q|# ----------------------------------------
+theyworkforyou.co.nz
+Top Content,
+26 May 2008,31 May 2008
+# ----------------------------------------|
+        @report = Rugalytics::Report.new(csv)
+      end
+
+      it "should set base url from second line of text" do
+        @report.base_url.should == 'theyworkforyou.co.nz'
+      end
+
+      it "should set report name from third line of text" do
+        @report.report_name.should == 'Top Content'
+      end
+
+      it "should set start date from fourth line of text" do
+        @report.start_date.should == '26 May 2008'
+      end
+
+      it "should set end date from fourth line of text" do
+        @report.end_date.should == '31 May 2008'
+      end
+    end
+
+    describe "when creating items from 'Table'" do
+      before :all do
+        @base_url = %Q|theyworkforyou.co.nz|
+        @attributes = %Q|URL,Page Views,Unique Page Views,Time on Page,Bounce Rate,% Exit,$ Index|
+        @values1 = %Q|/,189,157,54.94957983193277,0.4862385392189026,0.37037035822868347,0.0|
+        @values2 = %Q|/bills,60,38,54.17307692307692,0.0,0.13333334028720856,0.0|
+        @csv = %Q|# ----------------------------------------
+#{@base_url}
+Top Content,
+26 May 2008,31 May 2008
+# ----------------------------------------
+# ----------------------------------------
+# Table
+# ----------------------------------------
+#{@attributes}
+#{@values1}
+#{@values2}
+# --------------------------------------------------------------------------------
+|
+      end
+
+      it 'should create item for each data row in "Table"' do
+        item1 = mock('item1')
+        item2 = mock('item2')
+        Rugalytics::Item.should_receive(:new).with(@attributes.split(','), @values1.split(','), @base_url).and_return item1
+        Rugalytics::Item.should_receive(:new).with(@attributes.split(','), @values2.split(','), @base_url).and_return item2
+
+        report = Rugalytics::Report.new(@csv)
+        report.items.should == [item1, item2]
+      end
+    end
+
+    describe "when creating items from '.*MiniTableTable'" do
+      before :all do
+        @base_url = %Q|theyworkforyou.co.nz|
+        @browser_attributes = %Q|Browser,Visits,% visits|
+        @browser_values = %Q|Firefox,1529,0.17185568809509277|
+        @connection_speed_attributes = %Q|Connection Speed,Visits,% visits|
+        @connection_speed_values = %Q|Unknown,3987,0.4481285810470581|
+        @csv = %Q|# ----------------------------------------
+#{@base_url}
+Visitors Overview,
+3 May 2008,2 June 2008
+# ----------------------------------------
+# ----------------------------------------
+# BrowserMiniTable
+# ----------------------------------------
+#{@browser_attributes}
+#{@browser_values}
+
+# ----------------------------------------
+# ConnectionSpeedMiniTable
+# ----------------------------------------
+#{@connection_speed_attributes}
+#{@connection_speed_values}
+# --------------------------------------------------------------------------------|
+      end
+      it 'should create item for each data row in "XxxMiniTable"' do
+        browser_item = mock('browser_item')
+        connection_item = mock('item')
+        Rugalytics::Item.should_receive(:new).with(@browser_attributes.split(','), @browser_values.split(','), @base_url).and_return browser_item
+        Rugalytics::Item.should_receive(:new).with(@connection_speed_attributes.split(','), @connection_speed_values.split(','), @base_url).and_return connection_item
+
+        report = Rugalytics::Report.new(@csv)
+        report.browser_items.should == [browser_item]
+        report.connection_speed_items.should == [connection_item]
+        report.attribute_names.should == ['browser_items', 'connection_speed_items']
+      end
+    end
+
+    describe "when creating graph points from 'Graph'" do
+      before :all do
+        @period = %Q|1 May 2008 - 31 May 2008|
+        @name = %Q|Page Views|
+        @csv = %Q|# ----------------------------------------
+theyworkforyou.co.nz
+Top Content,
+26 May 2008,31 May 2008
+# ----------------------------------------
+
+# ----------------------------------------
+# Graph
+# ----------------------------------------
+#{@period}
+#{@name}
+"5,360"
+433|
+      end
+
+      it 'should create graph with data under "Graph"' do
+        graph = mock('graph')
+        Rugalytics::Graph.should_receive(:new).with(@name, @period, [5360, 433]).and_return graph
+
+        report = Rugalytics::Report.new(@csv)
+        report.page_views_graph.should == graph
+        report.attribute_names.should == ['page_views_graph']
+      end
+    end
+  end
+
+  describe 'when retrieving total using method not defined on class' do
+    it 'should return total from graph named in method name' do
+      report = Rugalytics::Report.new
+      report.should_receive(:respond_to?).with(:page_views_graph).and_return true
+      report.should_receive(:page_views_graph).and_return mock('graph', :sum_of_points=>100)
+      report.method_missing(:page_views_total).should == 100
+    end
+  end
+
+  describe 'when retrieving list by day using method not defined on class' do
+    it 'should return by day list from graph named in method name' do
+      report = Rugalytics::Report.new
+      report.should_receive(:respond_to?).with(:page_views_graph).and_return true
+      points_by_day = mock('points_by_day')
+      report.should_receive(:page_views_graph).and_return mock('graph', :points_by_day=>points_by_day)
+      report.method_missing(:page_views_by_day).should == points_by_day
+    end
+  end
+
+end

data/spec/lib/rugalytics_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Rugalytics do
+
+  describe "finding a profile by its account name and profile name" do
+    it 'should return the match' do
+      account_name = 'your_site.com'
+      profile_name = 'blog.your_site.com'
+      profile = mock('profile')
+      Rugalytics::Profile.should_receive(:find).with(account_name, profile_name).and_return profile
+      Rugalytics::find_profile(account_name, profile_name).should == profile
+    end
+  end
+
+  describe "finding a profile by its account_id and profile_id" do
+    it 'should return the match' do
+      account_id = 1254221
+      profile_id = 12341234
+      profile = mock('profile')
+      Rugalytics::Profile.should_receive(:find).with(account_id, profile_id).and_return profile
+      Rugalytics::find_profile(account_id, profile_id).should == profile
+    end
+  end
+
+  describe "finding a profile by passing single name when account and profile name are the same" do
+    it 'should return the match' do
+      name = 'your_site.com'
+      profile = mock('profile')
+      Rugalytics::Profile.should_receive(:find).with(name, nil).and_return profile
+      Rugalytics::find_profile(name).should == profile
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--color
+--format
+progress
+--loadby
+mtime
+--reverse
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/rugalytics'
+
+def fixture(filename)
+  open("#{File.dirname(__FILE__)}/fixtures/#{filename}").read
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: rugalytics
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob McKinnon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: googlebase
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: morph
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+    version: 
+description: Rugalytics is a Ruby API for Google Analytics.
+email: 
+- rob ~@nospam@~ rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- lib/rugalytics/account.rb
+- lib/rugalytics/analytics.rb
+- lib/rugalytics/connection.rb
+- lib/rugalytics/graph.rb
+- lib/rugalytics/item.rb
+- lib/rugalytics/profile.rb
+- lib/rugalytics/report.rb
+- lib/rugalytics.rb
+- LICENSE
+- Manifest
+- README
+- README.rdoc
+- spec/fixtures/analytics_account_find_all.html
+- spec/fixtures/analytics_profile_find_all.html
+- spec/fixtures/dashboard_report_webgroup.xml
+- spec/lib/rugalytics/account_spec.rb
+- spec/lib/rugalytics/graph_spec.rb
+- spec/lib/rugalytics/item_spec.rb
+- spec/lib/rugalytics/profile_spec.rb
+- spec/lib/rugalytics/report_spec.rb
+- spec/lib/rugalytics_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- rugalytics.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rugalytics
+- --main
+- README
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rugalytics
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Rugalytics is a Ruby API for Google Analytics.
+test_files: []
+