Merge pull request #15 from packbackbooks/service-connector-fix

DATAINF-97 Change how POST requests are made to fix double-encoded JSON

Author: EricTendian

src/Interfaces/ILtiServiceConnector.php

@@ -6,5 +6,5 @@ interface ILtiServiceConnector
 {
     public function getAccessToken(array $scopes);
 
-    public function makeServiceRequest(array $scopes, $method, $url, $body = null, $contentType = 'application/json', $accept = 'application/json');
+    public function makeServiceRequest(array $scopes, string $method, string $url, string $body = null, $contentType = 'application/json', $accept = 'application/json');
 }

src/LtiServiceConnector.php

@@ -75,7 +75,7 @@ public function getAccessToken(array $scopes)
         return $tokenData['access_token'];
     }
 
-    public function makeServiceRequest(array $scopes, $method, $url, $body = null, $contentType = 'application/json', $accept = 'application/json')
+    public function makeServiceRequest(array $scopes, string $method, string $url, string $body = null, $contentType = 'application/json', $accept = 'application/json')
     {
         $headers = [
             'Authorization' => 'Bearer '.$this->getAccessToken($scopes),
@@ -87,7 +87,7 @@ public function makeServiceRequest(array $scopes, $method, $url, $body = null, $
                 $headers = array_merge($headers, ['Content-Type' => $contentType]);
                 $response = $this->client->request($method, $url, [
                     'headers' => $headers,
-                    'json' => $body,
+                    'body' => $body,
                 ]);
                 break;
             default:
@@ -98,10 +98,13 @@ public function makeServiceRequest(array $scopes, $method, $url, $body = null, $
         }
 
         $respHeaders = $response->getHeaders();
+        array_walk($respHeaders, function (&$value) {
+            $value = $value[0];
+        });
         $respBody = $response->getBody();
 
         return [
-            'headers' => array_filter(explode("\r\n", $respHeaders)),
+            'headers' => $respHeaders,
             'body' => json_decode($respBody, true),
         ];
     }

tests/LtiServiceConnectorTest.php

@@ -13,6 +13,31 @@
 
 class LtiServiceConnectorTest extends TestCase
 {
+    /**
+     * @var Mockery\MockInterface
+     */
+    private $registration;
+    /**
+     * @var Mockery\MockInterface
+     */
+    private $cache;
+    /**
+     * @var Mockery\MockInterface
+     */
+    private $client;
+    /**
+     * @var Mockery\MockInterface
+     */
+    private $response;
+    /**
+     * @var string
+     */
+    private $token;
+    /**
+     * @var LtiServiceConnector
+     */
+    private $connector;
+
     public function setUp(): void
     {
         $this->registration = Mockery::mock(ILtiRegistration::class);
@@ -69,30 +94,33 @@ public function testItMakesPostServiceRequest()
         $scopes = ['scopeKey'];
         $method = 'post';
         $url = 'https://example.com';
-        $body = ['post' => 'body'];
+        $body = json_encode(['post' => 'body']);
         $requestHeaders = [
             'Authorization' => 'Bearer '.$this->token,
             'Accept' => 'application/json',
             'Content-Type' => 'application/json',
         ];
         $responseHeaders = [
-            'Content-Type: application/json',
-            'Accept: application/json',
+            'Content-Type' => ['application/json'],
+            'Server' => ['nginx'],
         ];
         $responseBody = ['some' => 'response'];
         $expected = [
-            'headers' => $responseHeaders,
+            'headers' => [
+                'Content-Type' => 'application/json',
+                'Server' => 'nginx',
+            ],
             'body' => $responseBody,
         ];
 
         $this->mockCacheHasAccessToken();
         $this->client->shouldReceive('request')
             ->with($method, $url, [
                 'headers' => $requestHeaders,
-                'json' => $body,
+                'body' => $body,
             ])->once()->andReturn($this->response);
         $this->response->shouldReceive('getHeaders')
-            ->once()->andReturn(implode("\r\n", $responseHeaders));
+            ->once()->andReturn($responseHeaders);
         $this->response->shouldReceive('getBody')
             ->once()->andReturn(json_encode($responseBody));
 
@@ -111,12 +139,15 @@ public function testItMakesDefaultServiceRequest()
             'Accept' => 'application/json',
         ];
         $responseHeaders = [
-            'Content-Type: application/json',
-            'Accept: application/json',
+            'Content-Type' => ['application/json'],
+            'Server' => ['nginx'],
         ];
         $responseBody = ['some' => 'response'];
         $expected = [
-            'headers' => $responseHeaders,
+            'headers' => [
+                'Content-Type' => 'application/json',
+                'Server' => 'nginx',
+            ],
             'body' => $responseBody,
         ];
 
@@ -126,7 +157,7 @@ public function testItMakesDefaultServiceRequest()
                 'headers' => $requestHeaders,
             ])->once()->andReturn($this->response);
         $this->response->shouldReceive('getHeaders')
-            ->once()->andReturn(implode("\r\n", $responseHeaders));
+            ->once()->andReturn($responseHeaders);
         $this->response->shouldReceive('getBody')
             ->once()->andReturn(json_encode($responseBody));