autometal-piwik 0.6.2 → 1.0.0

data/spec/files/VisitorInterest.getNumberOfVisitsPerVisitDuration.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>
+	<row>
+		<label>0-10s</label>
+		<nb_visits>735</nb_visits>
+	</row>
+	<row>
+		<label>11-30s</label>
+		<nb_visits>32</nb_visits>
+	</row>
+	<row>
+		<label>31-60s</label>
+		<nb_visits>34</nb_visits>
+	</row>
+	<row>
+		<label>1-2 min</label>
+		<nb_visits>37</nb_visits>
+	</row>
+	<row>
+		<label>2-4 min</label>
+		<nb_visits>36</nb_visits>
+	</row>
+	<row>
+		<label>4-7 min</label>
+		<nb_visits>33</nb_visits>
+	</row>
+	<row>
+		<label>7-10 min</label>
+		<nb_visits>12</nb_visits>
+	</row>
+	<row>
+		<label>10-15 min</label>
+		<nb_visits>17</nb_visits>
+	</row>
+	<row>
+		<label>15-30 min</label>
+		<nb_visits>40</nb_visits>
+	</row>
+	<row>
+		<label>30+ min</label>
+		<nb_visits>19</nb_visits>
+	</row>
+</result>

data/spec/files/VisitsSummary.get.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>
+	<nb_uniq_visitors>914</nb_uniq_visitors>
+	<nb_visits>995</nb_visits>
+	<nb_actions>2161</nb_actions>
+	<nb_visits_converted>44</nb_visits_converted>
+	<bounce_count>704</bounce_count>
+	<sum_visit_length>143952</sum_visit_length>
+	<max_actions>47</max_actions>
+	<bounce_rate>71%</bounce_rate>
+	<nb_actions_per_visit>2.2</nb_actions_per_visit>
+	<avg_time_on_site>145</avg_time_on_site>
+</result>

data/spec/files/VisitsSummary.getActions.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>55</result>

data/spec/files/VisitsSummary.getBounceCount.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>51</result>

data/spec/files/VisitsSummary.getMaxActions.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>66</result>

data/spec/files/VisitsSummary.getSumVisitsLength.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>143952</result>

data/spec/files/VisitsSummary.getSumVisitsLengthPretty.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>1 days 15 hours</result>

data/spec/files/VisitsSummary.getUniqueVisitors.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>100</result>

data/spec/files/VisitsSummary.getVisits.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>200</result>

data/spec/files/VisitsSummary.getVisitsConverted.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<result>0</result>

data/spec/files/failure.xml

@@ -0,0 +1,3 @@
+<result>
+<error message="Mocked error message"/>
+</result>

data/spec/files/success.xml

@@ -0,0 +1,3 @@
+<result>
+<success message="ok"/>
+</result>

data/spec/goals_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+describe 'Piwik::Goals' do
+  before {
+    stub_api_calls
+  }
+  
+  # TODO: Specify required params
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::Goals }
+  
+  assert_data_integrity(:get, :size => 4)
+  assert_data_integrity(:get_goals, :size => 3)
+  assert_data_integrity(:get_visits_until_conversion, :size => 13)
+end

data/spec/image_graph_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+describe 'Piwik::ImageGraph' do
+  before {
+    stub_api_calls
+  }
+  
+  # TODO: Specify required params
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday', :apiModule => 'UserCountry', :apiAction => 'getCountry'} }
+  subject { Piwik::ImageGraph }
+  
+  assert_value_integrity(:get) # for array responses
+end

data/spec/languages_manager_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe 'Piwik::LanguagesManager' do
+  before {
+    stub_api_calls
+  }
+  
+  let(:params) { { :languageCode => 'en' } }
+  subject { Piwik::LanguagesManager }
+  
+  assert_data_integrity(:get_available_language_names, :size => 46)
+  assert_data_integrity(:get_available_languages, :size => 46)
+  assert_value_integrity(:is_language_available, :value => 1)
+end

data/spec/live_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe 'Piwik::Live' do
+  before {
+    stub_api_calls
+  }
+  
+  # TODO: Specify required params
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::Live }
+  
+  assert_data_integrity(:get_counters, :size => 3)
+  assert_data_integrity(:get_last_visits_details, :size => 8)
+end

data/spec/mobile_messaging_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+describe 'Piwik::MobileMessaging' do
+  before {
+    stub_api_calls
+  }
+  
+  subject { Piwik::MobileMessaging }
+  
+  xit { "nothing to see here - yet" }
+end

data/spec/multi_sites_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe 'Piwik::MultiSites' do
+  before {
+    stub_api_calls
+  }
+  
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::MultiSites }
+  
+  assert_data_integrity(:get_one, :size => 8)
+end

data/spec/pdf_reports_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+describe 'Piwik::PdfReports' do
+  before {
+    stub_api_calls
+  }
+  
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::PdfReports }
+  
+  assert_data_integrity(:getReports)
+end

data/spec/provider_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+describe 'Piwik::Provider' do
+  before {
+    stub_api_calls
+  }
+  
+  # TODO: Specify required params
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::Provider }
+  
+  assert_data_integrity(:get_provider, :size => 10)
+end

data/spec/referers_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+describe 'Piwik::Referers' do
+  before {
+    stub_api_calls
+  }
+  
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::Referers }
+  
+  describe "#get_keywords" do
+    assert_data_integrity(:get_keywords, :size => 10)
+  end
+  
+  describe "#get_campaigns" do
+    it { subject.get_campaigns(params).size.should eq(0) }
+    it { subject.get_campaigns(params).empty?.should eq(true) }
+  end
+  
+  describe "#get_referer_type" do
+    assert_data_integrity(:get_referer_type, :size => 3)
+  end
+  
+  describe "#get_number_of_distinct_keywords" do
+    assert_value_integrity(:get_number_of_distinct_keywords, :value => 207)
+  end
+  
+  describe "#get_number_of_distinct_search_engines" do
+    assert_value_integrity(:get_number_of_distinct_search_engines, :value => 7)
+  end
+  
+  describe "#get_number_of_distinct_websites" do
+    assert_value_integrity(:get_number_of_distinct_websites, :value => 27)
+  end
+  
+  describe "#get_search_engines" do
+    assert_data_integrity(:get_search_engines, :size => 7)
+  end
+  
+  describe "#get_socials" do
+    it { subject.get_socials(params).size.should eq(0) }
+  end
+  
+  describe "#get_urls_for_social" do
+    it { subject.get_urls_for_social(params).size.should eq(0) }
+  end
+end

data/spec/seo_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+describe 'Piwik::SEO' do
+  before {
+    stub_api_calls
+  }
+  
+  let(:params) { {:url => 'http://site.test'} }
+  subject { Piwik::SEO }
+  
+  describe "#get_rank" do
+    assert_data_integrity(:get_rank, :size => 5)
+    it { subject.get_rank(params).data.first['label'].should eq('Google PageRank') }
+    it { subject.get_rank(params).data.first['rank'].should eq('7') }
+  end
+end

data/spec/site_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+describe 'Piwik::Site' do
+  before do
+    stub_api_calls
+  end
+  
+  subject { build(:site) }
+  its(:main_url) { should eq('http://test.local') }
+  its(:name) { should eq('Test Site') }
+  its(:config) { should eq({:piwik_url => PIWIK_URL, :auth_token => PIWIK_TOKEN}) }
+  
+  it { 
+    subject.save.should eq(true)
+    subject.name = 'Karate Site'
+    subject.update.should eq(true)
+    subject.destroy.should eq(true)
+  }
+  
+  describe 'with wrong id' do
+    before {Piwik::SitesManager.stub(:call).with('SitesManager.getSiteFromId',{:idSite => 666}, /.*/, /.*/).and_return('<result>0</result>')}
+    
+    xit { expect {Piwik::Site.load(666)}.to raise_error(Piwik::UnknownSite) }
+  end
+  
+  it { subject.seo_info.first['rank'].to_i.should eq(7) }
+  
+  describe '#annotations' do
+    subject { build(:site).annotations }
+    
+    it { subject.all.size.should eq(2) }
+    it { subject.update(1,{:pattern => 2}).should_not raise_error(Piwik::ApiError) }
+    it { subject.delete(1).should_not raise_error(Piwik::ApiError) }
+    it { subject.add(:name => 'test', :note => 'meah', :starred => 1).size.should eq(6) }
+    it { subject.count_for_dates.should_not raise_error(Piwik::ApiError) }
+    
+  end
+  
+  describe '#visits' do
+    subject { build(:site).visits }
+    
+    it { subject.summary.should be_a(Piwik::VisitsSummary) }
+    it { subject.count.should eq(200) }
+    it { subject.actions.should eq(55) }
+    it { subject.uniques.should eq(100) }
+    it { subject.bounces.should eq(51) }
+    it { subject.converted.should eq(0) }
+    it { subject.max_actions.should eq(66) }
+    it { subject.length.should eq(143952) }
+    it { subject.pretty_length.should eq("1 days 15 hours") }
+  end
+  
+  describe '#actions' do
+    subject { build(:site).actions }
+    
+    it { subject.summary.should be_a(Piwik::Actions) }
+    it { subject.urls.size.should eq(7) }
+    it { subject.entry_urls.size.should eq(5) }
+    it { subject.exit_urls.size.should eq(5) }
+    it { subject.downloads.size.should eq(2) }
+    it { subject.outlinks.size.should eq(11) }
+    it { subject.outlink('http://mysite.com').exit_nb_visits.should eq(5) }
+  end
+  
+  describe '#referers' do
+    subject { build(:site).referers }
+    
+    it { subject.websites.size.should eq(27) }
+    it { subject.websites_count.should eq(27) }
+    it { subject.keywords.size.should eq(10) }
+    it { subject.keywords_for_title('A page title').size.should eq(1) }
+    it { subject.keywords_for_url('http://mysite.com/page.html').size.should eq(5) }
+    it { subject.keywords_count.should eq(207) }
+    it { subject.search_engines.size.should eq(7) }
+    it { subject.search_engines_count.should eq(7) }
+    it { subject.socials.size.should eq(0) }
+  end
+  
+  describe '#goals' do
+    subject { build(:site).goals }
+    
+    it { subject.all.size.should eq(3) }
+    it { subject.load(1).nb_conversions.should eq(82) }
+    it { subject.update(1,{:pattern => 2}).should_not raise_error(Piwik::ApiError) }
+    it { subject.delete(1).should_not raise_error(Piwik::ApiError) }
+    it { subject.add(:name => 'test', 'matchAttribute' => '/', :pattern => '/', :patternType => 1).should_not raise_error(Piwik::ApiError) }
+  end
+  
+  describe '#transitions' do
+    subject { build(:site).transitions }
+    
+    it { subject.for_action('name','type').should be_a(Piwik::Transitions::TransitionsForAction) }
+    it { subject.for_title('My page title').should be_a(Piwik::Transitions::TransitionsForPageTitle) }
+    it { subject.for_url('http://mysite.com').should be_a(Piwik::Transitions::TransitionsForPageUrl) }
+    it { subject.translations.size.should eq(32) }
+  end
+  
+  describe "that exists" do
+    before { 
+      @site = build(:site) 
+      @site.save
+    }
+    it { expect {Piwik::Site.load(@site.id)}.to_not raise_error }
+  end
+end

data/spec/sites_manager_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+describe 'Piwik::SitesManager' do
+  before {
+    stub_api_calls
+  }
+  
+  # TODO: Specify required params
+  let(:params) { {:idSite => 1, :period => 'day', :date => 'yesterday'} }
+  subject { Piwik::SitesManager }
+
+  describe "#get" do
+    it { subject.get(params).should be_a(Piwik::Site) }
+  end
+  
+  describe "#get_sites_with_admin_access" do
+    assert_data_integrity(:get_sites_with_admin_access, :size => 4)
+  end
+  
+  describe "#get_all_sites" do
+    assert_data_integrity(:get_all_sites, :size => 4)
+  end
+  
+  describe "#get_unique_site_timezones" do
+    assert_value_integrity(:get_unique_site_timezones)
+  end
+  
+  describe "#get_javascript_tag" do
+    assert_value_integrity(:get_javascript_tag)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,76 @@
+require 'piwik'
+
+RSpec.configure do |config|
+  Dir[File.join(File.dirname(__FILE__),'spec','support''**','*.rb')].each {|f| require f}
+  config.mock_with :rspec
+  config.order = "random"
+end
+
+def stub_rails_env &block
+  Object.const_set("RAILS_ROOT", File.join(File.dirname(__FILE__),"files"))
+  yield
+  Object.const_set("RAILS_ROOT",nil)
+end
+
+def success_response
+  File.join(File.dirname(__FILE__),'files',"success.xml")
+end
+
+def failure_response
+  File.join(File.dirname(__FILE__),'files',"failure.xml")
+end
+
+def stub_api_calls
+  # Stubbing the main API call method. Methods without a specific stub
+  # will always return a success response
+  Piwik::Base.stub(:call) do |method,params,piwik_url,auth_token|
+    resp_file = File.join(File.dirname(__FILE__),'files',"#{method}.xml")
+    xml = if File.exists?(resp_file)
+      File.read resp_file
+    else
+      File.read File.join(success_response)
+    end
+    if xml.is_a?(String) && xml.force_encoding('BINARY').is_binary_data?
+      xml.force_encoding('BINARY')
+    elsif xml =~ /error message=/
+      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      raise Piwik::ApiError, result['error']['message'] if result['error']
+    else
+      xml
+    end
+  end
+end
+
+def assert_data_integrity method, options = {}
+  it { puts subject.inspect } if options[:debug]
+  it { subject.send(method,params).should_not raise_error(NoMethodError) }
+  enum_class = defined?(Enumerator) ? 'Enumerator' : 'Enumerable::Enumerator'
+  it { subject.send(method,params).each.should be_a(enum_class.constantize) }
+  it { subject.send(method,params).empty?.should eq(false) }
+  if options[:size].present?
+    it { subject.send(method,params).size.should eq(options[:size]) }
+  end
+end
+
+def assert_value_integrity method, options = {}
+  it { puts subject.inspect } if options[:debug]
+  it { subject.send(method,params).should_not raise_error(NoMethodError) }
+  it { subject.send(method,params).empty?.should eq(false) }
+  if options[:value].present?
+    it { subject.send(method,params).value.should eq(options[:value]) }
+  end
+end
+
+def build(object, attrs = {})
+  case object
+  when :user
+    def_attrs = { :login => "test_user", :password => "changeme", :email => "user@test.local", :user_alias => "Test User" }
+    Piwik::User.new(def_attrs.merge(attrs))
+  when :site
+    def_attrs = { :idsite => 1, :main_url => "http://test.local", :name => "Test Site" }
+    Piwik::Site.new(def_attrs.merge(attrs))
+  end
+end
+
+PIWIK_URL = 'http://piwik.local'
+PIWIK_TOKEN = '90871c8584ddf2265f54553a305b6ae1'