Storable resources

WyriHaximus · WyriHaximus · commit 0e9d4fe12dbc · 2017-07-10T19:10:40.000+02:00
diff --git a/composer.lock b/composer.lock
diff --git a/src/AsyncClient.php b/src/AsyncClient.php
@@ -6,7 +6,9 @@
 use ApiClients\Foundation\ClientInterface;
 use ApiClients\Foundation\Factory;
 use ApiClients\Foundation\Options;
+use ApiClients\Foundation\Resource\ResourceInterface;
 use React\EventLoop\LoopInterface;
+use React\Promise\CancellablePromiseInterface;
 use React\Promise\PromiseInterface;
 use Rx\Observable;
 use Rx\Scheduler;
@@ -71,6 +73,16 @@ public static function createFromClient(ClientInterface $client, RateLimitState
         return new self($client, $rateLimitState);
     }
 
+    public function hydrate(string $resource): CancellablePromiseInterface
+    {
+        return $this->client->hydrate($resource);
+    }
+
+    public function extract(ResourceInterface $resource): CancellablePromiseInterface
+    {
+        return $this->client->extract($resource);
+    }
+
     public function meta(): PromiseInterface
     {
         return $this->client->handle(new Command\MetaCommand());
diff --git a/src/AsyncClientInterface.php b/src/AsyncClientInterface.php
@@ -2,11 +2,29 @@
 
 namespace ApiClients\Client\Github;
 
+use ApiClients\Foundation\Resource\ResourceInterface;
+use React\Promise\CancellablePromiseInterface;
 use React\Promise\PromiseInterface;
 use Rx\Observable;
 
 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;
+
     public function meta(): PromiseInterface;
 
     public function user(string $user): PromiseInterface;
diff --git a/src/Client.php b/src/Client.php
@@ -5,6 +5,7 @@
 use ApiClients\Client\Github\Resource\UserInterface;
 use ApiClients\Foundation\Factory as FoundationClientFactory;
 use ApiClients\Foundation\Options;
+use ApiClients\Foundation\Resource\ResourceInterface;
 use React\EventLoop\Factory;
 use React\EventLoop\LoopInterface;
 use Rx\Scheduler;
@@ -20,7 +21,7 @@ final class Client implements ClientInterface
     /**
      * @var AsyncClient
      */
-    private $client;
+    private $asyncClient;
 
     /**
      * @param LoopInterface $loop
@@ -29,7 +30,7 @@ final class Client implements ClientInterface
     private function __construct(LoopInterface $loop, AsyncClient $client)
     {
         $this->loop = $loop;
-        $this->client = $client;
+        $this->asyncClient = $client;
     }
 
     /**
@@ -59,14 +60,30 @@ public static function create(
         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
+        );
+    }
+
     /**
      * @param  string        $user
      * @return UserInterface
      */
     public function user(string $user): UserInterface
     {
         return await(
-            $this->client->user($user),
+            $this->asyncClient->user($user),
             $this->loop
         );
     }
@@ -76,6 +93,6 @@ public function user(string $user): UserInterface
      */
     public function getRateLimitState(): RateLimitState
     {
-        return $this->client->getRateLimitState();
+        return $this->asyncClient->getRateLimitState();
     }
 }
diff --git a/src/ClientInterface.php b/src/ClientInterface.php
@@ -3,9 +3,26 @@
 namespace ApiClients\Client\Github;
 
 use ApiClients\Client\Github\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;
+
     public function user(string $user): UserInterface;
 
     public function getRateLimitState(): RateLimitState;
