Add suggestScore method

Author: Alex Belenky

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+/.idea
+/tests/.env

README.md

@@ -0,0 +1,64 @@
+# PHP Perspective Comment Analyzer API
+
+![Minimal PHP version](https://img.shields.io/packagist/php-v/stajor/perspectiveapi.svg)
+
+PHP library for Perspective Comment Analyzer API.
+
+## Installation
+
+Via Composer:
+
+```bash
+composer require stajor/perspectiveapi
+```
+    
+## Usage
+
+#### Scoring comments: AnalyzeComment
+
+```php
+<?php
+
+$commentsClient = new PerspectiveApi\CommentsClient('PERSPECTIVE-API-TOKEN');
+$commentsClient->comment(['text' => 'What kind of idiot name is foo? Sorry, I like your name.']);
+$commentsClient->languages(['en']);
+$commentsClient->context(['entries' => ['text' => 'off-topic', 'type' => 'PLAIN_TEXT']]);
+$commentsClient->requestedAttributes(['TOXICITY' => ['scoreType' => 'PROBABILITY', 'scoreThreshold' => 0]]);
+
+// Analyze and get response
+$response = $commentsClient->analyze();
+
+// Print scores
+print_r($response->attributeScores());
+```
+
+#### Sending feedback: SuggestCommentScore
+```php
+<?php
+
+$commentsClient = new PerspectiveApi\CommentsClient('PERSPECTIVE-API-TOKEN');
+$commentsClient->comment(['text' => 'What kind of idiot name is foo? Sorry, I like your name.']);
+$commentsClient->languages(['en']);
+$commentsClient->context(['entries' => ['text' => 'off-topic', 'type' => 'PLAIN_TEXT']]);
+$commentsClient->clientToken('some-token');
+$commentsClient->communityId('unit-test');
+$commentsClient->attributeScores(['TOXICITY' => [
+    'summaryScore' => ['value' => 0.83785176, 'type' => 'PROBABILITY'],
+    'spanScores' => [['begin' => 0, 'end' => 32, 'score' => ['value' => 0.9208521, 'type' => 'PROBABILITY']]]]
+]);
+
+// Suggest Score and get response
+$response = $commentsClient->suggestScore();
+
+// Print scores
+print_r($response->attributeScores());
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Stajor/perspectiveapi. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

src/CommentsClient.php

@@ -29,29 +29,24 @@ public function __construct(string $token) {
      * @throws CommentsException
      */
     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);
+        return $this->request('analyze', $fields);
     }
 
     /**
-     *
+     * Sending feedback: SuggestCommentScore
      *
      * @return CommentsResponse
      * @throws CommentsException
      */
     public function suggestScore(): CommentsResponse {
-        //TODO
+        $fields = ['comment', 'context', 'attributeScores', 'languages', 'communityId', 'clientToken'];
+
+        return $this->request('suggestscore', $fields);
     }
 
     /**
@@ -161,15 +156,22 @@ public function communityId(string $communityId) {
      * Send request to API
      *
      * @param string $method
-     * @param array $data
+     * @param array $fields
      * @return CommentsResponse
      * @throws CommentsException
      */
-    protected function request(string $method, array $data): CommentsResponse {
+    protected function request(string $method, array $fields): CommentsResponse {
+        $data   = [];
         $client = new Client(['defaults' => [
             'headers'  => ['content-type' => 'application/json', 'Accept' => 'application/json'],
         ]]);
 
+        foreach ($fields AS $field) {
+            if (isset($this->{$field})) {
+                $data[$field] = $this->{$field};
+            }
+        }
+
         try {
             $response = $client->post(self::API_URL."/comments:{$method}?key={$this->token}", ['json' => $data]);
         } catch (ClientException $e) {

src/CommentsResponse.php

@@ -18,4 +18,8 @@ public function languages(): ?array {
     public function clientToken(): ?string {
         return $this->response['clientToken'] ?? null;
     }
+
+    public function detectedLanguages(): ?array {
+        return $this->response['detectedLanguages'] ?? null;
+    }
 }

tests/CommentsClientAnalyzeTest.php

@@ -11,7 +11,7 @@ class CommentsClientAnalyzeTest extends TestCase {
 
     public static function setUpBeforeClass(): void {
         $commentsClient = new CommentsClient(getenv('PERSPECTIVE_API_TOKEN'));
-        $commentsClient->comment(['text' => 'You are an idiot', 'type' => 'PLAIN_TEXT']);
+        $commentsClient->comment(['text' => 'What kind of idiot name is foo? Sorry, I like your name.']);
         $commentsClient->languages(['en']);
         $commentsClient->context(['entries' => ['text' => 'off-topic', 'type' => 'PLAIN_TEXT']]);
         $commentsClient->requestedAttributes(['TOXICITY' => ['scoreType' => 'PROBABILITY', 'scoreThreshold' => 0]]);
@@ -32,7 +32,7 @@ public function testAttributeScores(): void {
 
         $this->assertIsArray($attributeScores);
         $this->arrayHasKey('TOXICITY');
-        $this->assertGreaterThan(0.9, $attributeScores['TOXICITY']['summaryScore']['value']);
+        $this->assertGreaterThan(0.8, $attributeScores['TOXICITY']['summaryScore']['value']);
     }
 
     public function testLanguages() {

tests/CommentsClientSuggestScoreTest.php

@@ -0,0 +1,47 @@
+<?php namespace PerspectiveApi\Test;
+
+use PerspectiveApi\CommentsClient;
+use PerspectiveApi\CommentsException;
+use PerspectiveApi\CommentsResponse;
+use PHPUnit\Framework\TestCase;
+
+class CommentsClientSuggestScoreTest extends TestCase {
+    /** @var CommentsResponse */
+    protected static $response;
+
+    public static function setUpBeforeClass(): void {
+        $commentsClient = new CommentsClient(getenv('PERSPECTIVE_API_TOKEN'));
+        $commentsClient->comment(['text' => 'What kind of idiot name is foo? Sorry, I like your name.']);
+        $commentsClient->languages(['en']);
+        $commentsClient->context(['entries' => ['text' => 'off-topic', 'type' => 'PLAIN_TEXT']]);
+        $commentsClient->clientToken('some-token');
+        $commentsClient->communityId('unit-test');
+        $commentsClient->attributeScores(['TOXICITY' => [
+            'summaryScore' => ['value' => 0.83785176, 'type' => 'PROBABILITY'],
+            'spanScores' => [['begin' => 0, 'end' => 32, 'score' => ['value' => 0.9208521, 'type' => 'PROBABILITY']]]]
+        ]);
+
+        self::$response = $commentsClient->suggestScore();
+    }
+
+    public function testLanguages() {
+        $detectedLanguages = self::$response->detectedLanguages();
+
+        $this->assertIsArray($detectedLanguages);
+        $this->assertContains('en', $detectedLanguages);
+    }
+
+    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->suggestScore();
+    }
+}