Merge pull request #16 from portier/feat/state

Fix implementation of `state`

Author: stephank

README.md

@@ -50,15 +50,15 @@ $app->post('/auth', function($req, $res) use ($portier) {
 });
 
 $app->post('/verify', function($req, $res) use ($portier) {
-    $result = $portier->verify($req->getParsedBody()['id_token']);
+    $email = $portier->verify($req->getParsedBody()['id_token']);
 
     $res = $res
         ->withStatus(200)
         ->withHeader('Content-Type', 'text/html; charset=utf-8');
 
     $res->getBody()->write(
 <<<EOF
-        <p>Verified email address {$result->email}!</p>
+        <p>Verified email address ${email}!</p>
 EOF
     );
 

client-tester.php

@@ -33,8 +33,8 @@
             break;
         case 'verify':
             try {
-                $result = $client->verify($cmd[1]);
-                echo "ok\t{$result->email}\t{$result->state}\n";
+                $email = $client->verify($cmd[1]);
+                echo "ok\t{$email}\n";
             } catch (Throwable $err) {
                 $msg = implode('  ', explode("\n", $err->getMessage()));
                 echo "err\t{$msg}\n";

src/Client.php

@@ -97,7 +97,7 @@ public static function normalize(string $email): string
      * Start authentication of an email address.
      *
      * @param string $email email address to authenticate
-     * @param string $state state to carry along, will be returned in `verify`
+     * @param string $state arbitrary state that is returned to the redirect URL via the `state` query parmmeter
      *
      * @return string URL to redirect the browser to
      */
@@ -129,8 +129,10 @@ public function authenticate(string $email, string $state = null): string
      * Verify a token received on our `redirect_uri`.
      *
      * @param string $token the received `id_token` parameter value
+     *
+     * @return string the verified email address
      */
-    public function verify(string $token): VerifyResult
+    public function verify(string $token): string
     {
         assert(!empty($token));
         assert(!empty($this->broker));
@@ -213,7 +215,7 @@ public function verify(string $token): VerifyResult
         }
 
         // Return the normalized email.
-        return new VerifyResult($email, $state);
+        return $email;
     }
 
     /**