Jobs: add helper service to wait for a job to finish

Author: glaubinix

README.md

@@ -557,6 +557,14 @@ $job = $client->jobs()->show($jobId);
 ```
 Returns the job.
 
+##### Wait for a job to finish
+```php
+$numberOfMinutesToWait = 3;
+$jobHelper = new \PrivatePackagist\ApiClient\JobHelper($client);
+$job = $jobHelper->waitForJob($jobId, $numberOfMinutesToWait);
+```
+Returns the job.
+
 #### Magento legacy keys
 
 ##### List all legacy keys for a customer

src/Exception/JobErrorException.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace PrivatePackagist\ApiClient\Exception;
+
+class JobErrorException extends RuntimeException
+{
+    /** @var array */
+    private $job;
+
+    public function __construct(array $job)
+    {
+        $this->job = $job;
+
+        parent::__construct($job['message']);
+    }
+
+    /**
+     * @return array
+     */
+    public function getJob()
+    {
+        return $this->job;
+    }
+}

src/JobHelper.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace PrivatePackagist\ApiClient;
+
+use PrivatePackagist\ApiClient\Exception\JobErrorException;
+
+class JobHelper
+{
+    /** @var Client */
+    private $packagistClient;
+
+    public function __construct(Client $packagistClient)
+    {
+        $this->packagistClient = $packagistClient;
+    }
+
+    public function waitForJob($jobId, $maxWaitMinutes = 3)
+    {
+        $maxWaitTime = new \DateTimeImmutable(sprintf('+%s minutes', $maxWaitMinutes));
+        while ($maxWaitTime> new \DateTimeImmutable()) {
+            $job = $this->packagistClient->jobs()->show($jobId);
+
+            if ($job['status'] === 'success') {
+                return $job;
+            }
+
+            if ($job['status'] === 'error') {
+                throw new JobErrorException($job);
+            }
+
+            sleep(1);
+        }
+
+        throw new \Exception(sprintf('Job has not finish after %s minutes', $maxWaitMinutes));
+    }
+}