Merge pull request #40 from bufferapp/support/total_value_metrics

Add a method for page insights with total_value metrics

Author: dinostheo

Facebook/Facebook.php

@@ -138,6 +138,36 @@ public function getPageInsightsAudienceData($pageId, $metric, $breakdown)
         return $data;
     }
 
+    /*
+     * Get page insights for total value metrics, for a given date range
+     */
+    public function getPageInsightsForTotalValueMetrics($pageId, $metrics, $period, $since, $until)
+    {
+        $params = [
+            "metric" => join(",", $metrics),
+            "metric_type" => "total_value",
+            "period" => $period,
+            "since" => $since,
+            "until" => $until,
+        ];
+
+        $data = [];
+        $response = $this->sendRequest("GET", "/{$pageId}/insights", $params);
+
+        if (!empty($response)) {
+            $decodedBody = $response->getDecodedBody();
+
+            if (!empty($decodedBody) && is_array($decodedBody)) {
+                $responseData = $decodedBody["data"];
+                foreach ($responseData as $metric) {
+                    $data[$metric["name"]] = $metric["total_value"]["value"];
+                }
+            }
+        }
+
+        return $data;
+    }
+
     /*
      * Get Instagram Graph node metadata
      */

tests/FacebookTest.php

@@ -429,9 +429,9 @@ public function testGetPageInsightsAudienceDataEmptyResponse()
 
         $facebook = new Facebook();
         $responseMock = m::mock('\Facebook\FacebookResponse')
-        ->shouldReceive('getDecodedBody')
-        ->once()
-        ->andReturn($decodedAudienceData)
+            ->shouldReceive('getDecodedBody')
+            ->once()
+            ->andReturn($decodedAudienceData)
             ->getMock();
         $facebookMock = m::mock('\Facebook\Facebook');
         $facebookMock->shouldReceive('sendRequest')->once()->andReturn($responseMock);
@@ -1806,4 +1806,109 @@ public function testGetInstagramStoryInsightsWithMetricType()
             'views' => 500
         ]);
     }
+
+    public function testGetPageInsightsForTotalValueMetrics()
+    {
+        $decodedResponseData = [
+            'data' => [
+                [
+                    'name' => 'page_impressions',
+                    'period' => 'day',
+                    'total_value' => [
+                        'value' => 500
+                    ]
+                ],
+                [
+                    'name' => 'page_engaged_users',
+                    'period' => 'day',
+                    'total_value' => [
+                        'value' => 100
+                    ]
+                ]
+            ]
+        ];
+
+        $facebook = new Facebook();
+        $responseMock = m::mock('\Facebook\FacebookResponse')
+            ->shouldReceive('getDecodedBody')
+            ->once()
+            ->andReturn($decodedResponseData)
+            ->getMock();
+        $facebookMock = m::mock('\Facebook\Facebook');
+
+        $metrics = ['page_impressions', 'page_engaged_users'];
+        $period = 'day';
+        $since = '1493826552';
+        $until = '1496418552';
+        $params = [
+            'metric' => join(',', $metrics),
+            'metric_type' => 'total_value',
+            'period' => $period,
+            'since' => $since,
+            'until' => $until,
+        ];
+
+        $facebookMock->shouldReceive('sendRequest')
+            ->once()
+            ->with('GET', '/' . self::FB_PAGE_ID . '/insights', $params)
+            ->andReturn($responseMock);
+        $facebook->setFacebookLibrary($facebookMock);
+
+        $response = $facebook->getPageInsightsForTotalValueMetrics(
+            self::FB_PAGE_ID,
+            $metrics,
+            $period,
+            $since,
+            $until
+        );
+
+        $this->assertEquals(500, $response['page_impressions']);
+        $this->assertEquals(100, $response['page_engaged_users']);
+    }
+
+    public function testGetPageInsightsForTotalValueMetricsEmptyResponse()
+    {
+        $facebook = new Facebook();
+        $responseMock = m::mock('\Facebook\FacebookResponse')
+            ->shouldReceive('getDecodedBody')
+            ->once()
+            ->andReturn(['data' => []])
+            ->getMock();
+        $facebookMock = m::mock('\Facebook\Facebook');
+        $facebookMock->shouldReceive('sendRequest')->once()->andReturn($responseMock);
+        $facebook->setFacebookLibrary($facebookMock);
+
+        $response = $facebook->getPageInsightsForTotalValueMetrics(
+            self::FB_PAGE_ID,
+            ['page_impressions'],
+            'day',
+            '1493826552',
+            '1496418552'
+        );
+
+        $this->assertEquals([], $response);
+    }
+
+    public function testGetPageInsightsForTotalValueMetricsNullResponse()
+    {
+        $facebook = new Facebook();
+        $responseMock = m::mock('\Facebook\FacebookResponse')
+            ->shouldReceive('getDecodedBody')
+            ->once()
+            ->andReturn(null)
+            ->getMock();
+        $facebookMock = m::mock('\Facebook\Facebook');
+        $facebookMock->shouldReceive('sendRequest')->once()->andReturn($responseMock);
+        $facebook->setFacebookLibrary($facebookMock);
+
+        $response = $facebook->getPageInsightsForTotalValueMetrics(
+            self::FB_PAGE_ID,
+            ['page_impressions'],
+            'day',
+            '1493826552',
+            '1496418552'
+        );
+
+        $this->assertEquals([], $response);
+    }
 }