Merge pull request #9390 from piwik/9046

Add possibility to specify a limit for visits in Live.getVisitorProfile

plugins/Live/.gitignore

+tests/System/processed/*xml
\ No newline at end of file

plugins/Live/API.php

@@ -198,12 +198,19 @@ class API extends \Piwik\Plugin\API
      * @param int $idSite Site ID
      * @param bool|false|string $visitorId The ID of the visitor whose profile to retrieve.
      * @param bool|false|string $segment
+     * @param bool|false|int $limitVisits
      * @return array
      */
-    public function getVisitorProfile($idSite, $visitorId = false, $segment = false)
+    public function getVisitorProfile($idSite, $visitorId = false, $segment = false, $limitVisits = false)
     {
         Piwik::checkUserHasViewAccess($idSite);
 
+        if ($limitVisits === false) {
+            $limitVisits = VisitorProfile::VISITOR_PROFILE_MAX_VISITS_TO_SHOW;
+        } else {
+            $limitVisits = (int) $limitVisits;
+        }
+
         if ($visitorId === false) {
             $visitorId = $this->getMostRecentVisitorId($idSite, $segment);
         }
@@ -220,7 +227,7 @@ class API extends \Piwik\Plugin\API
         }
 
         $profile = new VisitorProfile($idSite);
-        $result = $profile->makeVisitorProfile($visits, $visitorId, $segment);
+        $result = $profile->makeVisitorProfile($visits, $visitorId, $segment, $limitVisits);
 
         /**
          * Triggered in the Live.getVisitorProfile API method. Plugins can use this event

plugins/Live/VisitorProfile.php

@@ -38,10 +38,11 @@ class VisitorProfile
      * @param $visits
      * @param $visitorId
      * @param $segment
+     * @param $numLastVisits
      * @return array
      * @throws Exception
      */
-    public function makeVisitorProfile(DataTable $visits, $visitorId, $segment)
+    public function makeVisitorProfile(DataTable $visits, $visitorId, $segment, $numLastVisits)
     {
         $this->initVisitorProfile();
 
@@ -75,7 +76,7 @@ class VisitorProfile
         $this->handleAdjacentVisitorIds($visits, $visitorId, $segment);
 
         // use N most recent visits for last_visits
-        $visits->deleteRowsOffset(self::VISITOR_PROFILE_MAX_VISITS_TO_SHOW);
+        $visits->deleteRowsOffset($numLastVisits);
 
         $this->profile['lastVisits'] = $visits;
 

plugins/Live/tests/Fixtures/ManyVisitsOfSameVisitor.php

+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link    http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+namespace Piwik\Plugins\Live\tests\Fixtures;
+
+use Piwik\Date;
+use Piwik\Tests\Framework\Fixture;
+
+/**
+ * Generates many visits for the same visitor
+ */
+class ManyVisitsOfSameVisitor extends Fixture
+{
+    public $dateTime = '2010-02-01 11:22:33';
+    public $idSite = 1;
+
+    public function setUp()
+    {
+        if (!self::siteCreated($idSite = 1)) {
+            self::createWebsite($this->dateTime);
+        }
+
+        $this->trackVisits();
+    }
+
+    public function tearDown()
+    {
+        // empty
+    }
+
+    private function trackVisits()
+    {
+        $t = self::getTracker($this->idSite, $this->dateTime, $defaultInit = true);
+        $t->setTokenAuth(self::getTokenAuth());
+        $t->enableBulkTracking();
+
+        for ($numVisits = 0; $numVisits <= 30; $numVisits++) {
+            $t->setForceNewVisit();
+            $t->setUrl('http://example.org/my/dir/page' . ($numVisits % 4));
+
+            $visitDateTime = Date::factory($this->dateTime)->addDay($numVisits)->getDatetime();
+            $t->setForceVisitDateTime($visitDateTime);
+
+            self::assertTrue($t->doTrackPageView('incredible title ' . ($numVisits % 3)));
+        }
+
+        self::checkBulkTrackingResponse($t->doBulkTrack());
+    }
+}
\ No newline at end of file

plugins/Live/tests/System/APITest.php → plugins/Live/tests/System/ApiCounterTest.php

@@ -18,10 +18,11 @@ use Piwik\Tests\Framework\TestCase\SystemTestCase;
 
 /**
  * @group Live
- * @group APITest
+ * @group ApiTest
+ * @group Api
  * @group Plugins
  */
-class APITest extends SystemTestCase
+class ApiCounterTest extends SystemTestCase
 {
     /**
      * @var API

plugins/Live/tests/System/ApiTest.php

+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Plugins\Live\tests\System;
+
+use Piwik\Plugins\Live\tests\Fixtures\ManyVisitsOfSameVisitor;
+use Piwik\Tests\Framework\TestCase\SystemTestCase;
+
+/**
+ * @group Live
+ * @group ApiTest
+ * @group Api
+ * @group Plugins
+ */
+class ApiTest extends SystemTestCase
+{
+    /**
+     * @var ManyVisitsOfSameVisitor
+     */
+    public static $fixture = null; // initialized below class definition
+
+    /**
+     * @dataProvider getApiForTesting
+     */
+    public function testApi($api, $params)
+    {
+        $this->runApiTests($api, $params);
+    }
+
+    public function getApiForTesting()
+    {
+        $api = array(
+            'Live.getVisitorProfile',
+        );
+
+        $apiToTest   = array();
+        $apiToTest[] = array($api,
+            array(
+                'idSite'     => 1,
+                'date'       => self::$fixture->dateTime,
+                'periods'    => array('day'),
+                'testSuffix' => ''
+            )
+        );
+        $apiToTest[] = array($api,
+            array(
+                'idSite'     => 1,
+                'date'       => self::$fixture->dateTime,
+                'periods'    => array('day'),
+                'otherRequestParameters' => array('limitVisits' => 20),
+                'testSuffix' => 'higherLimit'
+            )
+        );
+
+        return $apiToTest;
+    }
+
+    public static function getOutputPrefix()
+    {
+        return '';
+    }
+
+    public static function getPathToTestDirectory()
+    {
+        return dirname(__FILE__);
+    }
+
+}
+
+ApiTest::$fixture = new ManyVisitsOfSameVisitor();
\ No newline at end of file