Merge pull request #3 from ray-di/web-api-query

Support Web API
ray-di · Feb 15, 2021 · ef6c7a1 · ef6c7a1
2 parents 94488fc + c780607
commit ef6c7a1
Show file tree

Hide file tree

Showing 17 changed files with 276 additions and 19 deletions.
diff --git a/README.ja.md b/README.ja.md
@@ -227,7 +227,7 @@ $sqlQuery->exec('memo_add', ['memo' => 'run', 'created_at' => new DateTime()]);
 
 オブジェクトが渡されるとParameter Injectionと同様`toScalar()`または`__toString()`の値に変換されます。
 
-
+#
 ## プロファイラー
 
 メディアアクセスはロガーで記録されます。標準ではテストに使うメモリロガーがバインドされています。

diff --git a/composer.json b/composer.json
@@ -13,8 +13,9 @@
         "ext-json": "*",
         "ext-pdo": "*",
         "aura/sql": "^3.0",
-        "pagerfanta/pagerfanta": "^1.1",
         "doctrine/annotations": "^1.11",
+        "guzzlehttp/guzzle": "^7.2",
+        "pagerfanta/pagerfanta": "^1.1",
         "ray/aop": "^2.10",
         "ray/aura-sql-module": "^1.10",
         "ray/di": "2.x-dev"

diff --git a/demo/run.php b/demo/run.php
@@ -29,7 +29,7 @@ protected function configure()
             UserAddInterface::class,
             UserItemInterface::class
         ]);
-        $this->install(new MediaQueryModule($this->sqlDir, $queries));
+        $this->install(new MediaQueryModule($queries, $this->sqlDir));
         $this->install(new AuraSqlModule($this->dsn));
     }
 });

diff --git a/phpcs.xml b/phpcs.xml
@@ -49,6 +49,7 @@
         <exclude name="PSR12.Files.FileHeader.IncorrectOrder"/>
         <exclude name="PSR12.Files.FileHeader.SpacingAfterBlock"/>
         <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint"/>
+        <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.UselessAnnotation"/>
     </rule>
 
 

diff --git a/src/Annotation/WebQuery.php b/src/Annotation/WebQuery.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery\Annotation;
+
+use Attribute;
+use Doctrine\Common\Annotations\NamedArgumentConstructorAnnotation;
+
+/**
+ * @Annotation
+ * @Target("METHOD")
+ */
+#[Attribute(Attribute::TARGET_METHOD)]
+final class WebQuery implements NamedArgumentConstructorAnnotation
+{
+    /** @var string */
+    public $method;
+
+    /** @var string */
+    public $uri;
+
+    public function __construct(string $method, string $uri)
+    {
+        $this->method = $method;
+        $this->uri = $uri;
+    }
+}
diff --git a/src/MediaQueryInterceptor.php → src/DbQueryInterceptor.php b/src/MediaQueryInterceptor.php → src/DbQueryInterceptor.php
@@ -11,7 +11,7 @@
 
 use function substr;
 
-class MediaQueryInterceptor implements MethodInterceptor
+class DbQueryInterceptor implements MethodInterceptor
 {
     /** @var SqlQueryInterface */
     private $sqlQuery;

diff --git a/src/Exception/WebApiRequestException.php b/src/Exception/WebApiRequestException.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery\Exception;
+
+use RuntimeException;
+
+class WebApiRequestException extends RuntimeException
+{
+}
diff --git a/src/MediaQueryLogger.php b/src/MediaQueryLogger.php
@@ -24,7 +24,7 @@ public function start(): void
      */
     public function log(string $queryId, array $values): void
     {
-        $this->logs[] = sprintf('query:%s(%s)', $queryId, json_encode($values));
+        $this->logs[] = sprintf('query: %s(%s)', $queryId, json_encode($values));
     }
 
     public function __toString(): string

diff --git a/src/MediaQueryModule.php b/src/MediaQueryModule.php
@@ -6,10 +6,13 @@
 
 use DateTimeImmutable;
 use DateTimeInterface;
+use GuzzleHttp\Client;
+use GuzzleHttp\ClientInterface;
 use Ray\Di\AbstractModule;
 use Ray\Di\Scope;
 use Ray\MediaQuery\Annotation\DbQuery;
 use Ray\MediaQuery\Annotation\SqlDir;
+use Ray\MediaQuery\Annotation\WebQuery;
 
 class MediaQueryModule extends AbstractModule
 {
@@ -19,29 +22,50 @@ class MediaQueryModule extends AbstractModule
     /** @var list<class-string> */
     private $mediaQueries;
 
-    public function __construct(string $sqlDir, Queries $mediaQueries, ?AbstractModule $module = null)
+    /** @var array<string, string> */
+    private array $domainBindings;
+
+    /**
+     * @param Queries               $mediaQueries
+     * @param string                $sqlDir
+     * @param array<string, string> $domainBindings
+     * @param AbstractModule|null   $module
+     */
+    public function __construct(Queries $mediaQueries, string $sqlDir, array $domainBindings = [], ?AbstractModule $module = null)
     {
         $this->mediaQueries = $mediaQueries->classes;
         $this->sqlDir = $sqlDir;
+        $this->domainBindings = $domainBindings;
         parent::__construct($module);
     }
 
     protected function configure(): void
     {
-        $this->bind(SqlQueryInterface::class)->to(SqlQuery::class);
         $this->bind(MediaQueryLoggerInterface::class)->to(MediaQueryLogger::class)->in(Scope::SINGLETON);
         $this->bind(ParamInjectorInterface::class)->to(ParamInjector::class);
         $this->bind(ParamConverterInterface::class)->to(ParamConverter::class);
         $this->bind(DateTimeInterface::class)->to(DateTimeImmutable::class);
+        // Bind media query interface
+        foreach ($this->mediaQueries as $mediaQuery) {
+            $this->bind($mediaQuery)->toNull();
+        }
+
+        // DbQuery
+        $this->bind(SqlQueryInterface::class)->to(SqlQuery::class);
         $this->bindInterceptor(
             $this->matcher->any(),
             $this->matcher->annotatedWith(DbQuery::class),
-            [MediaQueryInterceptor::class]
+            [DbQueryInterceptor::class]
         );
         $this->bind()->annotatedWith(SqlDir::class)->toInstance($this->sqlDir);
-        // Bind media query interface
-        foreach ($this->mediaQueries as $mediaQuery) {
-            $this->bind($mediaQuery)->toNull();
-        }
+        // Web Query
+        $this->bindInterceptor(
+            $this->matcher->any(),
+            $this->matcher->annotatedWith(WebQuery::class),
+            [WebQueryInterceptor::class]
+        );
+        $this->bind(ClientInterface::class)->to(Client::class);
+        $this->bind(WebApiQueryInterface::class)->to(WebApiQuery::class);
+        $this->bind()->annotatedWith('web_api_query_domain')->toInstance($this->domainBindings);
     }
 }
diff --git a/src/WebApiQuery.php b/src/WebApiQuery.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery;
+
+use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Exception\GuzzleException;
+use Ray\Di\Di\Named;
+use Ray\MediaQuery\Exception\WebApiRequestException;
+
+use function json_decode;
+use function uri_template;
+
+final class WebApiQuery implements WebApiQueryInterface
+{
+    /** @var ClientInterface */
+    private $client;
+
+    /** @var MediaQueryLoggerInterface  */
+    private $logger;
+
+    /** @var array<string, string>  */
+    private $domainBindings;
+
+    /**
+     * @param array<string, string> $domainBindings
+     *
+     * @Named("'domainBindings=web_api_query_domain")
+     */
+    #[Named('domainBindings=web_api_query_domain')]
+    public function __construct(ClientInterface $client, MediaQueryLoggerInterface $logger, array $domainBindings)
+    {
+        $this->client = $client;
+        $this->logger = $logger;
+        $this->domainBindings = $domainBindings;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function request(string $method, string $uri, array $query): array
+    {
+        try {
+            $this->logger->start();
+            $boundUri = uri_template($uri, $this->domainBindings + $query);
+            $response = $this->client->request($method, $boundUri, $query);
+            $json = $response->getBody()->getContents();
+            /** @var array<string, mixed> $body */
+            $body = json_decode($json, true);
+            $this->logger->log($boundUri, $query);
+
+            return $body;
+        } catch (GuzzleException $e) {
+            throw new WebApiRequestException($e->getMessage(), (int) $e->getCode(), $e);
+        }
+    }
+}
diff --git a/src/WebApiQueryInterface.php b/src/WebApiQueryInterface.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery;
+
+interface WebApiQueryInterface
+{
+    /**
+     * @param array<string, string> $query
+     *
+     * @return array<string, mixed>
+     */
+    public function request(string $method, string $uri, array $query): array;
+}
diff --git a/src/WebQueryInterceptor.php b/src/WebQueryInterceptor.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery;
+
+use Ray\Aop\MethodInterceptor;
+use Ray\Aop\MethodInvocation;
+use Ray\MediaQuery\Annotation\WebQuery;
+
+class WebQueryInterceptor implements MethodInterceptor
+{
+    /** @var WebApiQueryInterface */
+    private $webApiQuery;
+
+    /** @var ParamInjectorInterface  */
+    private $paramInjector;
+
+    public function __construct(WebApiQueryInterface $webApiQuery, ParamInjectorInterface $paramInjector)
+    {
+        $this->webApiQuery = $webApiQuery;
+        $this->paramInjector = $paramInjector;
+    }
+
+    /**
+     * @return Pages|array<mixed>
+     */
+    public function invoke(MethodInvocation $invocation)
+    {
+        $method = $invocation->getMethod();
+        /** @var WebQuery $webQuery */
+        $webQuery = $method->getAnnotation(WebQuery::class);
+        /** @var array<string, string> $values */
+        $values = $this->paramInjector->getArgumentes($invocation);
+
+        return $this->webApiQuery->request($webQuery->method, $webQuery->uri, $values);
+    }
+}
diff --git a/tests/Fake/WebApi/FooItemInterface.php b/tests/Fake/WebApi/FooItemInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\MediaQuery\WebApi;
+
+use Ray\MediaQuery\Annotation\WebQuery;
+
+interface FooItemInterface
+{
+    #[WebQuery(method: 'GET', uri: 'https://{domain}/anything/{id}')]
+    public function __invoke(string $id): array;
+}
diff --git a/tests/MediaQueryModuleTest.php b/tests/MediaQueryModuleTest.php
@@ -44,7 +44,7 @@ protected function setUp(): void
             PromiseListInterface::class,
         ]);
         $sqlDir = dirname(__DIR__) . '/tests/sql';
-        $module = new MediaQueryModule($sqlDir, $mediaQueries, new AuraSqlModule('sqlite::memory:'));
+        $module = new MediaQueryModule($mediaQueries, $sqlDir, [], new AuraSqlModule('sqlite::memory:'));
         $this->injector = new Injector($module);
         $pdo = $this->injector->getInstance(ExtendedPdoInterface::class);
         assert($pdo instanceof ExtendedPdoInterface);
@@ -63,14 +63,14 @@ public function testInsertItem(): void
         assert($todoAdd instanceof TodoAddInterface);
         $todoAdd('1', 'run');
         $log = (string) $this->logger;
-        $this->assertStringContainsString('query:todo_add', $log);
+        $this->assertStringContainsString('query: todo_add', $log);
         $todoItem = $this->injector->getInstance(TodoItemInterface::class);
 
         assert($todoItem instanceof TodoItemInterface);
         $item = $todoItem('1');
         $this->assertSame(['id' => '1', 'title' => 'run'], $item);
         $log = (string) $this->logger;
-        $this->assertStringContainsString('query:todo_item', $log);
+        $this->assertStringContainsString('query: todo_item', $log);
     }
 
     public function testSelectItem(): void
@@ -80,7 +80,7 @@ public function testSelectItem(): void
         $item = $todoItem('1');
         $this->assertSame(['id' => '1', 'title' => 'run'], $item);
         $log = (string) $this->logger;
-        $this->assertStringContainsString('query:todo_item', $log);
+        $this->assertStringContainsString('query: todo_item', $log);
     }
 
     public function testSelectList(): void
@@ -91,7 +91,7 @@ public function testSelectList(): void
         $row = ['id' => '1', 'title' => 'run', 'time' => '1970-01-01 00:00:00'];
         $this->assertSame([$row], $list);
         $log = (string) $this->logger;
-        $this->assertStringContainsString('query:promise_list([])', $log);
+        $this->assertStringContainsString('query: promise_list([])', $log);
     }
 
     public function testSelectPager(): void
@@ -103,7 +103,7 @@ public function testSelectPager(): void
         $page = $list[1];
         $this->assertSame([['id' => '1', 'title' => 'run']], $page->data);
         $log = (string) $this->logger;
-        $this->assertStringContainsString('query:todo_list', $log);
+        $this->assertStringContainsString('query: todo_list', $log);
     }
 
     public function testPramInjection(): void

diff --git a/tests/SqlQueryTest.php b/tests/SqlQueryTest.php
@@ -55,7 +55,7 @@ public function testNewInstance(): void
     public function testExec(): void
     {
         $this->sqlQuery->exec('todo_add', $this->insertData);
-        $this->assertStringContainsString('query:todo_add({"id":"1","title":"run"})', (string) $this->log);
+        $this->assertStringContainsString('query: todo_add({"id":"1","title":"run"})', (string) $this->log);
     }
 
     /**