readme, smal tweaks

README.md

@@ -0,0 +1,11 @@
+pinentry
+========
+
+This package allows PHP command line applications to prompt
+users for a passphrase / pin using the gpgtools `pinentry` program.
+
+https://www.gnupg.org/related_software/pinentry/index.html
+
+The PinRequest class allows passphrase requests to be parameterized 
+(messages, titles, button text), or to request a confirmation password
+also.

examples/getpid.php

@@ -0,0 +1,7 @@
+<?php
+require "vendor/autoload.php";
+use BitWasp\PinEntry\PinEntry;
+
+$pinEntry = new PinEntry("/usr/bin/pinentry");
+$pin = $pinEntry->getInfo("pid");
+echo "got pin {$pin}\n";

examples/getversion.php

@@ -0,0 +1,8 @@
+<?php
+require "vendor/autoload.php";
+use BitWasp\PinEntry\PinEntry;
+use BitWasp\PinEntry\PinRequest;
+
+$pinEntry = new PinEntry("/usr/bin/pinentry");
+$pin = $pinEntry->getInfo("version");
+echo "got pin {$pin}\n";

src/Command.php

@@ -19,23 +19,4 @@ class Command
     const SETTIMEOUT = 'SETTIMEOUT';
     const SETQUALITYBAR = 'SETQUALITYBAR';
     const SETQUALITYBAR_TT = 'SETQUALITYBAR_TT';
-
-    private $cmd;
-    private $param;
-
-    public function __construct(string $command, $param)
-    {
-        $this->cmd = $command;
-        $this->param = $param;
-    }
-
-    public function getCommand(): string
-    {
-        return $this->cmd;
-    }
-
-    public function getParam()
-    {
-        return $this->param;
-    }
 }

src/PinEntry.php

@@ -18,9 +18,8 @@ public function __construct(
         ProcessInterface $process
     ) {
         $msg = $process->waitFor("OK");
-
         if ($msg !== "OK Pleased to meet you\n") {
-            throw new PinEntryException("Unexpected start of pinnetry protocol");
+            throw new PinEntryException("First message from pinentry did not match expected value");
         }
         $this->process = $process;
     }
@@ -32,7 +31,7 @@ public function getInfo(string $type): string
         return $msg;
     }
 
-    public function getPin(Request $request): string
+    public function getPin(PinRequest $request): string
     {
         foreach ($request->getCommands() as $command => $param) {
             $this->process->send("{$command} {$param}\n");

src/Request.php → src/PinRequest.php

@@ -4,7 +4,7 @@
 
 namespace BitWasp\PinEntry;
 
-class Request
+class PinRequest
 {
     /**
      * @var string[]|int[]

test/unit/RequestTest.php

@@ -4,19 +4,19 @@
 
 namespace BitWasp\Test\PinEntry;
 
-use BitWasp\PinEntry\Request;
+use BitWasp\PinEntry\PinRequest;
 
 class RequestTest extends TestCase
 {
     /**
-     * @var Request
+     * @var PinRequest
      */
     private $request;
 
     public function setUp()
     {
         parent::setUp(); // TODO: Change the autogenerated stub
-        $this->request = new Request();
+        $this->request = new PinRequest();
     }
 
     public function testSetDesc()