Adjust return types

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.phpunit.result.cache
 build
 composer.lock
 vendor

src/BigHugeThesaurusClient.php

@@ -73,10 +73,10 @@ public function __construct(string $key)
     /**
      * Sets the client to be used for querying the API endpoints
      *
-     * @param Client $client
+     * @param Client|null $client
      * @return $this
      */
-    public function setHttpClient(Client $client = null)
+    public function setHttpClient(Client $client = null): BigHugeThesaurusClient
     {
         if ($client === null) {
             $client = new Client([
@@ -113,11 +113,10 @@ public function getBaseUri()
      * @param string $word
      * @return ThesaurusResponse
      * @throws NotFoundException
-     * @throws RemoteException
      * @throws GuzzleException
      * @see    https://words.bighugelabs.com/api.php
      */
-    public function lookup(string $word)
+    public function lookup(string $word): ThesaurusResponse
     {
         try {
             if (!$this->getHttpClient()) {
@@ -149,7 +148,6 @@ public function lookup(string $word)
      *
      * @param  string $word
      * @throws NotFoundException
-     * @throws RemoteException
      * @throws GuzzleException
      * @return array
      */
@@ -165,7 +163,6 @@ public function synonymsOf(string $word): array
      *
      * @param  string $word
      * @throws NotFoundException
-     * @throws RemoteException
      * @throws GuzzleException
      * @return array
      */
@@ -181,7 +178,6 @@ public function antonymsOf(string $word): array
      *
      * @param  string $word
      * @throws NotFoundException
-     * @throws RemoteException
      * @throws GuzzleException
      * @return array
      */
@@ -197,7 +193,6 @@ public function similarTermsOf(string $word): array
      *
      * @param  string $word
      * @throws NotFoundException
-     * @throws RemoteException
      * @throws GuzzleException
      * @return array
      */
@@ -211,20 +206,20 @@ public function relatedTermsOf(string $word): array
     /**
      * Get the raw response
      *
-     * @return ThesaurusResponse
+     * @return string
      */
-    public function getRawResponse()
+    public function getRawResponse(): string
     {
         return $this->rawResponse;
     }
 
     /**
      * Parse the response into a ThesaurusResponse
      *
-     * @param  string $response
+     * @param string $response
      * @return ThesaurusResponse
      */
-    protected function parseResponse($response)
+    protected function parseResponse(string $response): ThesaurusResponse
     {
         $parsed = json_decode($response, true);
 

src/ThesaurusResponse.php

@@ -233,7 +233,7 @@ public function toArray(): array
      *
      * @return string
      */
-    public function toJson()
+    public function toJson(): string
     {
         return json_encode($this->response);
     }

tests/BigHugeThesaurusClientTest.php

@@ -137,13 +137,16 @@ public function itShouldProvideTheThesaurusResponseIfTheLookupSucceeds()
     /** @test */
     public function itShouldReturnTheRawResponseFromTheClient()
     {
-        $this->mockHandler->append(new Response(200, [], file_get_contents(__DIR__ . '/fixtures/love.json')));
+        $response = file_get_contents(__DIR__ . '/fixtures/love.json');
+
+        $this->mockHandler->append(new Response(200, [], $response));
 
         $apiClient = $this->createClient('123');
 
         $apiClient->lookup('love');
 
         $this->assertIsString($apiClient->getRawResponse());
+        $this->assertEquals($response, $apiClient->getRawResponse());
     }
 
     /** @test */