Reporting now uses v3 api

Author: mrm

Atomx/Resources/Report.php

@@ -9,90 +9,20 @@
 class Report extends AtomxClient {
     private $returnStream = false;
 
-    // Run report
-    public function run($json)
+    public function run($json, $timeout = 600)
     {
-        return $this->postUrl('report', compact('json'));
-    }
-
-    public function status($reportId)
-    {
-        return $this->getUrl('report/' . $reportId, ['status' => true]);
-    }
-
-    public static function getReportId($report)
-    {
-        if (isset($report['report']['id'])) {
-            return $report['report']['id'];
-        }
-
-        return false;
-    }
-
-    public static function isReady($report)
-    {
-        if (isset($report['report']['is_ready'])) {
-            return $report['report']['is_ready'];
-        }
-
-        return false;
-    }
-
-    public static function numberOfRows($report)
-    {
-        if (isset($report['report']['lines']))
-            return $report['report']['lines'];
-
-        return false;
-    }
-
-    public static function getColumns($report)
-    {
-        if (!is_null($report) && isset($report['query'])) {
-            $sumsOrMetrics = (isset($report['query']['sums']) ? $report['query']['sums'] : $report['query']['metrics']);
-
-            return array_merge($report['query']['groups'], $sumsOrMetrics);
-        }
-
-        return false;
-    }
-
-    public function download($report)
-    {
-        $reportId = $report['report']['id'];
-
         $this->returnStream = true;
 
-        $stream = $this->getUrl('report/' . $reportId, [], [
-//            'timeout'         => 0,
-//            'connect_timeout' => 0
+        $stream = $this->postUrl('report?download', compact('json'), [
+            'timeout'         => $timeout,
+            'connect_timeout' => 20
         ]);
 
         $this->returnStream = false;
 
         return new ReportStreamer($stream);
     }
 
-    public function runAndDownload($json, $timeout = 120, $returnReportId = false)
-    {
-        $reportData = $this->run($json);
-
-        $secondsWaiting = 0;
-
-        while (!Report::isReady($this->status(Report::getReportId($reportData)))) {
-            sleep(1);
-
-            if (++$secondsWaiting >= $timeout) {
-                return false;
-            }
-        }
-
-        if ($returnReportId)
-            return [$this->download($reportData), Report::getReportId($reportData)];
-        else
-            return $this->download($reportData);
-    }
-
     protected function handleResponse(Response $response)
     {
         if ($response->getStatusCode() == 200) {

tests/ReportTest.php

@@ -10,128 +10,18 @@ public function testCreateAndDownloadReport()
         $to = date('Y-m-d 00:00:00', time());
 
         $report = new Report(new AtomxAccountStore());
-        $options = array(
-            'scope'    => 'advertiser',
-            'groups'   => ['campaign_id', 'domain_id', 'day_timestamp'],
-            'sums'     => ['impressions', 'clicks', 'conversions', 'campaign_cost'],
+        $options = [
+            'scope'    => 'network_buy',
+            'groups'   => ['day', 'campaign_id', 'creative_id', 'country_id'],
+            'metrics'  => ['impressions', 'clicks', 'conversions', 'campaign_cost', 'advertiser_network_profit'],
             'where'    => [['advertiser_network_id', '==', '1']],
             'from'     => $from,
             'to'       => $to,
             'timezone' => 'UTC'
-        );
+        ];
 
-        //$report = $report->run($options);
+        $report = $report->run($options);
 
-        //var_export($report);
-    }
-
-    public function testReportIsDone()
-    {
-        $report = new Report(new AtomxAccountStore());
-        $rData = $report->status(Report::getReportId($this->getReportData()));
-
-        var_dump($rData);
-
-        $this->assertEquals(true, Report::isReady($rData));
-    }
-
-    public function testDownloadReport()
-    {
-        $report = new Report(new AtomxAccountStore());
-        $rData = $this->getReportData();
-
-        $streamer = $report->download($rData);
-
-        var_dump(Report::numberOfRows($rData));
-        var_dump(Report::getColumns($rData));
-
-        var_dump($streamer->readLine());
-
-        $imps = 0;
-        $revenue = 0;
-
-        while (($row = $streamer->readLine()) !== false) {
-            $imps += $row[3];
-            $revenue += $row[6];
-        }
-
-        var_dump($imps, $revenue);
-    }
-
-    public function testRunAndDownloadReport()
-    {
-        $from = date('Y-m-d 00:00:00', time() - 24 * 60 * 60);
-        $to = date('Y-m-d 00:00:00', time());
-
-        $report = new Report(new AtomxAccountStore());
-        $options = array(
-            'scope'    => 'advertiser',
-            'groups'   => ['campaign_id', 'domain_id', 'day_timestamp'],
-            'sums'     => ['impressions', 'clicks', 'conversions', 'campaign_cost'],
-            'where'    => [['advertiser_network_id', '==', '1']],
-            'from'     => $from,
-            'to'       => $to,
-            'timezone' => 'UTC'
-        );
-
-        $streamer = $report->runAndDownload($options);
-
-        $this->assertNotEquals(false, $streamer);
-
-        var_dump($streamer->readLine());
-    }
-
-    /**
-     * @return array
-     */
-    private function getReportData()
-    {
-        // TODO: Mock the response
-        $rData = [
-                'success' => true,
-                'timestamp' => '2015-09-23T15:30:38.563796',
-                'report' =>
-                    [
-                        'link' => '/v1/report/89130c7cd76c7637195224529bbae9c7',
-                        'duration' => NULL,
-                        'started' => 1443022238,
-                        'lines' => 0,
-                        'error' => NULL,
-                        'finished' => NULL,
-                        'fast' => true,
-                        'is_ready' => true,
-                        'id' => '89130c7cd76c7637195224529bbae9c7',
-                    ],
-                'query' =>
-                    [
-                        'from' => '2015-09-22 00:00:00',
-                        'timezone' => 'UTC',
-                        'sums' =>
-                            array (
-                                0 => 'impressions',
-                                1 => 'clicks',
-                                2 => 'conversions',
-                                3 => 'campaign_cost',
-                            ),
-                        'groups' =>
-                            array (
-                                0 => 'campaign_id',
-                                1 => 'domain_id',
-                                2 => 'day_timestamp',
-                            ),
-                        'to' => '2015-09-23 00:00:00',
-                        'where' =>
-                            array (
-                                0 =>
-                                    array (
-                                        0 => 'advertiser_network_id',
-                                        1 => '==',
-                                        2 => '1',
-                                    ),
-                            ),
-                        'scope' => 'advertiser'
-                    ]
-            ];
-        return $rData;
+        $this->assertEquals(['day', 'campaign_id', 'creative_id', 'country_id','impressions', 'clicks', 'conversions', 'campaign_cost', 'advertiser_network_profit'], $report->readLine());
     }
 }