Merge pull request #34 from packagist/t/job-wait-helper

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

Author: naderman

README.md

@@ -554,6 +554,25 @@ $client->mirroredRepositories()->removePackages($mirroredRepositoryId);
 ##### Show a job
 ```php
 $job = $client->jobs()->show($jobId);
+```
+Returns the job.
+
+##### Wait for a job to finish
+This will periodically poll the job status until the job either finished or the maximum wait time was reached
+```php
+$numberOfSecondsToWait = 180;
+$jobHelper = new \PrivatePackagist\ApiClient\JobHelper($client);
+try {
+    $job = $jobHelper->waitForJob($jobId, $numberOfSecondsToWait);
+} catch (\PrivatePackagist\ApiClient\Exception\JobTimeoutException $e) {
+    // Job didn't finish within the specified time
+} catch (\PrivatePackagist\ApiClient\Exception\JobErrorException $e) {
+    // Job finished with an error. See the message for more information
+    echo $e->getMessage();
+}
+
+
+
 ```
 Returns the job.
 

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/Exception/JobTimeoutException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace PrivatePackagist\ApiClient\Exception;
+
+class JobTimeoutException extends RuntimeException
+{
+
+}

src/JobHelper.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace PrivatePackagist\ApiClient;
+
+use PrivatePackagist\ApiClient\Exception\JobErrorException;
+use PrivatePackagist\ApiClient\Exception\JobTimeoutException;
+
+class JobHelper
+{
+    /** @var Client */
+    private $packagistClient;
+
+    public function __construct(Client $packagistClient)
+    {
+        $this->packagistClient = $packagistClient;
+    }
+
+    /**
+     * @param string $jobId
+     * @param int $maxWaitSeconds
+     * @param int $waitInterval
+     * @return array
+     */
+    public function waitForJob($jobId, $maxWaitSeconds = 180, $waitInterval = 5)
+    {
+        $maxWaitTime = new \DateTimeImmutable(sprintf('+%s seconds', $maxWaitSeconds));
+        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($waitInterval);
+        }
+
+        throw new JobTimeoutException(sprintf('Job has not finish after %s seconds', $maxWaitSeconds));
+    }
+}