Add analyze unit tests

Author: Alex Belenky

src/CommentsClient.php

@@ -1,6 +1,7 @@
 <?php namespace PerspectiveApi;
 
 use GuzzleHttp\Client;
+use GuzzleHttp\Exception\ClientException;
 
 class CommentsClient {
     const API_URL = 'https://commentanalyzer.googleapis.com/v1alpha1';
@@ -19,8 +20,20 @@ public function __construct(string $token) {
         $this->token = $token;
     }
 
-    public function analyze(array $fields): CommentsResponse {
-        return $this->request('analyze', []);
+    public function analyze(): CommentsResponse {
+        $data   = [];
+        $fields = [
+            'comment', 'languages', 'requestedAttributes', 'context', 'spanAnnotations', 'doNotStore', 'clientToken',
+            'sessionId'
+        ];
+
+        foreach ($fields AS $field) {
+            if (isset($this->{$field})) {
+                $data[$field] = $this->{$field};
+            }
+        }
+
+        return $this->request('analyze', $data);
     }
 
     public function suggestScore() {
@@ -68,21 +81,21 @@ public function communityId() {
     }
 
     protected function request(string $method, array $data): CommentsResponse {
-        $fields = 'attributeScores,detectedLanguages,languages';
         $client = new Client(['defaults' => [
             'headers'  => ['content-type' => 'application/json', 'Accept' => 'application/json'],
         ]]);
-        $response = $client->post(self::API_URL."/comments:{$method}?key={$this->token}&fields=".$fields, [
-            'json' => [
-                'comment' => $this->comment,
-                'languages' => $this->languages,
-                'requestedAttributes' => $this->requestedAttributes,
-                'context'   => $this->context,
-                'spanAnnotations' => $this->spanAnnotations,
-                'doNotStore'    => $this->doNotStore,
-                'clientToken'   => $this->clientToken,
-                'sessionId' => $this->sessionId
-            ]]);
+
+        try {
+            $response = $client->post(self::API_URL."/comments:{$method}?key={$this->token}", ['json' => $data]);
+        } catch (ClientException $e) {
+            $error = json_decode($e->getResponse()->getBody(), true);
+
+            if (isset($error['error'])) {
+                throw new CommentsException($error['error']['message'], $error['error']['code']);
+            } else {
+                throw $e;
+            }
+        }
 
         $result = json_decode($response->getBody(), true);
 

src/CommentsException.php

@@ -1,5 +1,5 @@
 <?php namespace PerspectiveApi;
 
-class CommentsException {
+use Exception;
 
-}
+class CommentsException extends Exception {}

tests/CommentsClientAnalyzeTest.php

@@ -1,10 +1,12 @@
 <?php namespace PerspectiveApi\Test;
 
 use PerspectiveApi\CommentsClient;
+use PerspectiveApi\CommentsException;
 use PerspectiveApi\CommentsResponse;
 use PHPUnit\Framework\TestCase;
 
 class CommentsClientAnalyzeTest extends TestCase {
+    /** @var CommentsResponse */
     protected static $response;
 
     public static function setUpBeforeClass(): void {
@@ -15,18 +17,42 @@ public static function setUpBeforeClass(): void {
         $commentsClient->requestedAttributes(['TOXICITY' => ['scoreType' => 'PROBABILITY', 'scoreThreshold' => 0]]);
         $commentsClient->spanAnnotations(true);
         $commentsClient->doNotStore(true);
-        $commentsClient->clientToken('some token');
+        $commentsClient->clientToken('some-token');
         $commentsClient->sessionId('ses1');
 
-        self::$response = $commentsClient->analyze(['attributeScores', 'detectedLanguages', 'languages']);
+        self::$response = $commentsClient->analyze();
     }
 
     public function testHasCommentsResponseInstance() {
         $this->assertInstanceOf(CommentsResponse::class, self::$response);
     }
 
-    public function testAnalyzeResponse(): void {
-        $this->assertIsArray(self::$response->attributeScores());
-        $this->assertIsArray(self::$response->languages());
+    public function testAttributeScores(): void {
+        $attributeScores = self::$response->attributeScores();
+
+        $this->assertIsArray($attributeScores);
+        $this->arrayHasKey('TOXICITY');
+        $this->assertGreaterThan(0.9, $attributeScores['TOXICITY']['summaryScore']['value']);
+    }
+
+    public function testLanguages() {
+        $languages = self::$response->languages();
+
+        $this->assertIsArray($languages);
+        $this->assertContains('en', $languages);
+    }
+
+    public function testClientToken() {
+        $clientToken = self::$response->clientToken();
+
+        $this->assertEquals('some-token', $clientToken);
+    }
+
+    public function testCommentsException() {
+        $this->expectException(CommentsException::class);
+        $this->expectExceptionMessage('The request is missing a valid API key.');
+
+        $commentsClient = new CommentsClient('');
+        $commentsClient->analyze();
     }
 }