Migrating JobsAPI to use new HTTPlug.

Now returning a StreamInterface instead of a string for artifact files.

Author: moufmouf

lib/Gitlab/Api/AbstractApi.php

@@ -5,6 +5,7 @@
 use Http\Discovery\StreamFactoryDiscovery;
 use Http\Message\MultipartStream\MultipartStreamBuilder;
 use Http\Message\StreamFactory;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Abstract class for Api classes
@@ -52,18 +53,29 @@ public function configure()
     }
 
     /**
+     * Performs a GET query and returns the response as a PSR-7 response object.
+     *
      * @param string $path
      * @param array $parameters
      * @param array $requestHeaders
-     * @return mixed
+     * @return ResponseInterface
      */
-    protected function get($path, array $parameters = array(), $requestHeaders = array())
+    protected function getAsResponse($path, array $parameters = array(), $requestHeaders = array())
     {
         $path = $this->preparePath($path, $parameters);
 
-        $response = $this->client->getHttpClient()->get($path, $requestHeaders);
+        return $this->client->getHttpClient()->get($path, $requestHeaders);
+    }
 
-        return ResponseMediator::getContent($response);
+    /**
+     * @param string $path
+     * @param array $parameters
+     * @param array $requestHeaders
+     * @return mixed
+     */
+    protected function get($path, array $parameters = array(), $requestHeaders = array())
+    {
+        return ResponseMediator::getContent($this->getAsResponse($path, $parameters, $requestHeaders));
     }
 
     /**

lib/Gitlab/Api/Jobs.php

@@ -1,5 +1,7 @@
 <?php namespace Gitlab\Api;
 
+use Psr\Http\Message\StreamInterface;
+
 class Jobs extends AbstractApi
 {
     const SCOPE_CREATED = 'created';
@@ -49,24 +51,24 @@ public function show($project_id, $job_id)
     /**
      * @param int|string $project_id
      * @param int $job_id
-     * @return string
+     * @return StreamInterface
      */
     public function artifacts($project_id, $job_id)
     {
-        return $this->get("projects/".$this->encodePath($project_id)."/jobs/".$this->encodePath($job_id)."/artifacts");
+        return $this->getAsResponse("projects/".$this->encodePath($project_id)."/jobs/".$this->encodePath($job_id)."/artifacts")->getBody();
     }
 
     /**
      * @param int|string $project_id
      * @param string $ref_name
      * @param string $job_name
-     * @return string
+     * @return StreamInterface
      */
     public function artifactsByRefName($project_id, $ref_name, $job_name)
     {
-        return $this->get("projects/".$this->encodePath($project_id)."/jobs/artifacts/".$this->encodePath($ref_name)."/download", array(
+        return $this->getAsResponse("projects/".$this->encodePath($project_id)."/jobs/artifacts/".$this->encodePath($ref_name)."/download", array(
             'job' => $job_name
-        ));
+        ))->getBody();
     }
 
     /**

test/Gitlab/Tests/Api/JobsTest.php

@@ -1,8 +1,9 @@
 <?php namespace Gitlab\Tests\Api;
 
 use Gitlab\Api\Jobs;
+use GuzzleHttp\Psr7\Response;
 
-class JobsTest extends ApiTestCase
+class JobsTest extends TestCase
 {
     /**
      * @test
@@ -70,35 +71,35 @@ public function shouldGetJob()
      */
     public function shouldGetArtifacts()
     {
-        $expectedString = "some file content";
+        $returnedStream = new Response(200, [], 'foobar');
 
         $api = $this->getApiMock();
         $api->expects($this->once())
-            ->method('get')
+            ->method('getAsResponse')
             ->with('projects/1/jobs/3/artifacts')
-            ->will($this->returnValue($expectedString))
+            ->will($this->returnValue($returnedStream))
         ;
 
-        $this->assertEquals($expectedString, $api->artifacts(1, 3));
+        $this->assertEquals('foobar', $api->artifacts(1, 3)->getContents());
     }
 
     /**
      * @test
      */
     public function shouldGetArtifactsByRefName()
     {
-        $expectedString = "some file content";
+        $returnedStream = new Response(200, [], 'foobar');
 
         $api = $this->getApiMock();
         $api->expects($this->once())
-            ->method('get')
+            ->method('getAsResponse')
             ->with('projects/1/jobs/artifacts/master/download', array(
                 'job' => 'job_name'
             ))
-            ->will($this->returnValue($expectedString))
+            ->will($this->returnValue($returnedStream))
         ;
 
-        $this->assertEquals($expectedString, $api->artifactsByRefName(1, 'master', 'job_name'));
+        $this->assertEquals('foobar', $api->artifactsByRefName(1, 'master', 'job_name')->getContents());
     }
 
     /**

test/Gitlab/Tests/Api/TestCase.php

@@ -28,7 +28,7 @@ protected function getApiMock(array $methods = [])
         $client = Client::createWithHttpClient($httpClient);
 
         return $this->getMockBuilder($this->getApiClass())
-            ->setMethods(array_merge(array('get', 'post', 'postRaw', 'patch', 'delete', 'put', 'head'), $methods))
+            ->setMethods(array_merge(array('getAsResponse', 'get', 'post', 'postRaw', 'patch', 'delete', 'put', 'head'), $methods))
             ->setConstructorArgs(array($client))
             ->getMock();
     }