Merge pull request #96 from twirphp/example-refactor

Refactor example to stay closer to the quickstart guide
twirphp · Nov 9, 2021 · 617f960 · 617f960
2 parents 4ff52ca + 88f00d4
commit 617f960
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 14 deletions.
diff --git a/composer.json b/composer.json
@@ -37,8 +37,9 @@
     "autoload-dev": {
         "psr-4": {
             "Tests\\Twirp\\": "lib/tests/",
-            "": ["clientcompat/generated/", "example/generated/", "example/src/"],
-            "Tests\\Twitch\\Twirp\\Example\\": "example/tests/"
+            "": ["clientcompat/generated/", "example/generated/"],
+            "Twirp\\Example\\": "example/src/",
+            "Tests\\Twirp\\Example\\": "example/tests/"
         }
     },
     "config": {

diff --git a/example/README.md b/example/README.md
@@ -2,6 +2,18 @@
 
 ## Usage
 
+In the repository root run the following:
+
+```shell
+make generate
+```
+
+Then enter the example directory:
+
+```shell
+cd example
+```
+
 Launch the server:
 
 ```shell

diff --git a/example/server.php b/example/server.php
@@ -4,13 +4,14 @@
 
 $request = \GuzzleHttp\Psr7\ServerRequest::fromGlobals();
 
-$handler = new \Twitch\Twirp\Example\HaberdasherServer(new \Twirphp\Example\Haberdasher());
+$handler = new \Twitch\Twirp\Example\HaberdasherServer(new \Twirp\Example\Haberdasher());
 
 $response = $handler->handle($request);
 
 if (!headers_sent()) {
     // status
     header(sprintf('HTTP/%s %s %s', $response->getProtocolVersion(), $response->getStatusCode(), $response->getReasonPhrase()), true, $response->getStatusCode());
+
     // headers
     foreach ($response->getHeaders() as $header => $values) {
         foreach ($values as $value) {

diff --git a/example/service.proto b/example/service.proto
@@ -1,7 +1,7 @@
 syntax = "proto3";
 
 package twitch.twirp.example;
-option go_package = "example";
+option go_package = "/example";
 
 // A Hat is a piece of headwear made by a Haberdasher.
 message Hat {

diff --git a/example/src/Twirphp/Example/Haberdasher.php → example/src/Haberdasher.php b/example/src/Twirphp/Example/Haberdasher.php → example/src/Haberdasher.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Twirphp\Example;
+namespace Twirp\Example;
 
 use Twitch\Twirp\Example\Hat;
 use Twitch\Twirp\Example\Size;

diff --git a/example/tests/HaberdasherFunctionalTest.php b/example/tests/HaberdasherFunctionalTest.php
@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use GuzzleHttp\Psr7\HttpFactory;
 use Twirp\Error;
+use Twirp\Example\Haberdasher;
 use Twirp\Router;
-use Twirphp\Example\Haberdasher;
 use Twitch\Twirp\Example\HaberdasherClient;
 use Twitch\Twirp\Example\HaberdasherServer;
 use Twitch\Twirp\Example\Size;

diff --git a/example/tests/HaberdasherJsonClientTest.php b/example/tests/HaberdasherJsonClientTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;

diff --git a/example/tests/HaberdasherServerTest.php b/example/tests/HaberdasherServerTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use GuzzleHttp\Psr7\ServerRequest;
 use Prophecy\Argument;

diff --git a/example/tests/Psr15HttpClient.php b/example/tests/Psr15HttpClient.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
@@ -36,8 +36,7 @@ public function sendRequest(RequestInterface $request): ResponseInterface
         )
             ->withRequestTarget($request->getRequestTarget())
             ->withProtocolVersion($request->getProtocolVersion())
-            ->withBody($request->getBody())
-        ;
+            ->withBody($request->getBody());
 
         foreach ($request->getHeaders() as $name => $value) {
             $serverRequest = $serverRequest->withHeader($name, $value);

diff --git a/example/tests/ServerHooksErrorStub.php b/example/tests/ServerHooksErrorStub.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use Twirp\BaseServerHooks;
 

diff --git a/example/tests/TwirpErrorTest.php b/example/tests/TwirpErrorTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Tests\Twitch\Twirp\Example;
+namespace Tests\Twirp\Example;
 
 use Twirp\ErrorCode;
 use Twitch\Twirp\Example\TwirpError;