Merge pull request #13 from php-api-clients/storable-resources

Storable resources

Author: WyriHaximus

composer.lock

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+use ApiClients\Client\Travis\AsyncClient;
+use ApiClients\Client\Travis\Resource\RepositoryInterface;
+use React\EventLoop\Factory;
+use function ApiClients\Foundation\resource_pretty_print;
+
+require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
+
+$loop   = Factory::create();
+$client = AsyncClient::create($loop);
+
+$repos = [
+    'WyriHaximus/php-travis-client',
+];
+
+if (count($argv) > 1) {
+    unset($argv[0]);
+    foreach ($argv as $repo) {
+        $repos[] = $repo;
+    }
+}
+
+foreach ($repos as $repo) {
+    $client->repository($repo)->then(function (RepositoryInterface $repo) use ($client) {
+        resource_pretty_print($repo);
+
+        return $client->extract($repo);
+    })->then(function (string $json) use ($client) {
+        echo $json, PHP_EOL;
+
+        return $client->hydrate($json);
+    })->then(function (RepositoryInterface $repo) {
+        resource_pretty_print($repo);
+
+        return $repo->refresh();
+    })->done(function (RepositoryInterface $repo) {
+        resource_pretty_print($repo);
+    }, function ($e) {
+        echo (string)$e;
+    });
+}
+
+$loop->run();

examples/repository-extract-hydrate-refresh-async.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+use ApiClients\Client\Travis\Client;
+use function ApiClients\Foundation\resource_pretty_print;
+
+require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
+
+$client = Client::create();
+
+$repos = [
+    'WyriHaximus/php-travis-client',
+];
+
+if (count($argv) > 1) {
+    unset($argv[0]);
+    foreach ($argv as $repo) {
+        $repos[] = $repo;
+    }
+}
+
+foreach ($repos as $repo) {
+    $repo = $client->repository($repo);
+    resource_pretty_print($repo);
+
+    $json = $client->extract($repo);
+    echo $json, PHP_EOL;
+
+    $repo = $client->hydrate($json);
+    resource_pretty_print($repo);
+
+    $repo = $repo->refresh();
+    resource_pretty_print($repo);
+}

examples/repository-extract-hydrate-refresh.php

@@ -6,6 +6,7 @@
 use ApiClients\Client\Travis\Resource\HookInterface;
 use ApiClients\Foundation\ClientInterface;
 use ApiClients\Foundation\Factory;
+use ApiClients\Foundation\Resource\ResourceInterface;
 use React\EventLoop\LoopInterface;
 use React\Promise\CancellablePromiseInterface;
 use React\Promise\PromiseInterface;
@@ -55,6 +56,16 @@ public static function create(
         return new self($client);
     }
 
+    public function hydrate(string $resource): CancellablePromiseInterface
+    {
+        return $this->client->hydrate($resource);
+    }
+
+    public function extract(ResourceInterface $resource): CancellablePromiseInterface
+    {
+        return $this->client->extract($resource);
+    }
+
     /**
      * Create an AsyncClient from a ApiClients\Foundation\ClientInterface.
      * Be sure to pass in a client with the options from ApiSettings and the Async namespace suffix.

src/AsyncClient.php

@@ -2,6 +2,7 @@
 
 namespace ApiClients\Client\Travis;
 
+use ApiClients\Foundation\Resource\ResourceInterface;
 use React\Promise\CancellablePromiseInterface;
 use React\Promise\PromiseInterface;
 use Rx\Observable;
@@ -10,6 +11,22 @@
 
 interface AsyncClientInterface
 {
+    /**
+     * Take a string create by the extract method and hydrate it back to a resource.
+     *
+     * @param string $resource
+     * @return CancellablePromiseInterface
+     */
+    public function hydrate(string $resource): CancellablePromiseInterface;
+
+    /**
+     * Extract a resource into a string for storage.
+     *
+     * @param ResourceInterface $resource
+     * @return CancellablePromiseInterface
+     */
+    public function extract(ResourceInterface $resource): CancellablePromiseInterface;
+
     /**
      * Fetch the given repository.
      * This will resolve a Resource\Async\Repository object.

src/AsyncClientInterface.php

@@ -7,6 +7,7 @@
 use ApiClients\Client\Travis\Resource\SSHKeyInterface;
 use ApiClients\Client\Travis\Resource\UserInterface;
 use ApiClients\Foundation\Factory;
+use ApiClients\Foundation\Resource\ResourceInterface;
 use React\EventLoop\Factory as LoopFactory;
 use React\EventLoop\LoopInterface;
 use Rx\React\Promise;
@@ -67,6 +68,22 @@ public static function createFromClient(LoopInterface $loop, AsyncClientInterfac
         return new self($loop, $asyncClient);
     }
 
+    public function hydrate(string $resource): ResourceInterface
+    {
+        return await(
+            $this->asyncClient->hydrate($resource),
+            $this->loop
+        );
+    }
+
+    public function extract(ResourceInterface $resource): string
+    {
+        return await(
+            $this->asyncClient->extract($resource),
+            $this->loop
+        );
+    }
+
     /**
      * {@inheritdoc}
      */

src/Client.php

@@ -6,9 +6,26 @@
 use ApiClients\Client\Travis\Resource\RepositoryInterface;
 use ApiClients\Client\Travis\Resource\SSHKeyInterface;
 use ApiClients\Client\Travis\Resource\UserInterface;
+use ApiClients\Foundation\Resource\ResourceInterface;
 
 interface ClientInterface
 {
+    /**
+     * Take a string create by the extract method and hydrate it back to a resource.
+     *
+     * @param string $resource
+     * @return ResourceInterface
+     */
+    public function hydrate(string $resource): ResourceInterface;
+
+    /**
+     * Extract a resource into a string for storage.
+     *
+     * @param ResourceInterface $resource
+     * @return string
+     */
+    public function extract(ResourceInterface $resource): string;
+
     /**
      * Fetch the given repository.
      * This will return a Resource\Async\Repository object.