Use Base URIs via Browser

clue · clue · commit a879b63e32bc · 2015-09-04T21:01:08.000+02:00
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ listing from the given ViewVC URL:
 ```php
 $loop = React\EventLoop\Factory::create();
 $browser = new Clue\React\Buzz\Browser($loop);
-$client = new Client('http://example.com/viewvc/', $browser);
+$client = new Client($browser->withBase('http://example.com/viewvc/'));
 
 $client->fetchDirectory('/')->then(function ($files) {
     echo 'Files: ' . implode(', ', $files) . PHP_EOL;
@@ -34,9 +34,12 @@ in order to handle async requests:
 $loop = React\EventLoop\Factory::create();
 $browser = new Clue\React\Buzz\Browser($loop);
 
-$client = new Client($url, $browser);
+$client = new Client($browser->withBase('http://example.com/viewvc/'));
 ```
 
+The `Client` API uses relative URIs to reference files and directories in your
+ViewVC installation, so make sure to apply the base URI as depicted above.
+
 If you need custom DNS or proxy settings, you can explicitly pass a
 custom [`Browser`](https://github.com/clue/php-buzz-react#browser) instance.
 
@@ -95,7 +98,7 @@ use Clue\React\Block;
 $loop = React\EventLoop\Factory::create();
 $browser = new Clue\React\Buzz\Browser($loop);
 
-$client = new Client($url /* change me */, $browser);
+$client = new Client($browser->withBase($uri /* change me */));
 $promise = $client->fetchFile($path /* change me */);
 
 try {
diff --git a/examples/directory.php b/examples/directory.php
@@ -26,12 +26,12 @@
 
 $browser = new Browser($loop, $sender);
 
-$client = new Client($url, $browser);
+$client = new Client($browser->withBase($url));
 
 if (substr($path, -1) === '/') {
-    $client->fetchDirectory($path, $revision)->then('var_dump', 'printf');
+    $client->fetchDirectory($path, $revision)->then('print_r', 'printf');
 } else {
-    $client->fetchFile($path, $revision)->then('printf', 'printf');
+    $client->fetchFile($path, $revision)->then('print_r', 'printf');
 }
 
 $loop->run();
diff --git a/src/Client.php b/src/Client.php
@@ -14,10 +14,9 @@
 
 class Client
 {
-    private $url;
     private $brower;
 
-    public function __construct($url, Browser $browser, Parser $parser = null, Loader $loader = null)
+    public function __construct(Browser $browser, Parser $parser = null, Loader $loader = null)
     {
         if ($parser === null) {
             $parser = new Parser();
@@ -31,7 +30,6 @@ public function __construct($url, Browser $browser, Parser $parser = null, Loade
 //             'follow_redirects' => false
 //         ));
 
-        $this->url = rtrim($url, '/') . '/';
         $this->browser = $browser;
         $this->parser = $parser;
         $this->loader = $loader;
@@ -135,7 +133,7 @@ private function fetchXml($url)
 
     private function fetch($url)
     {
-        return $this->browser->get($this->url . ltrim($url, '/'))->then(
+        return $this->browser->get(ltrim($url, '/'))->then(
             function (Response $response) {
                 return (string)$response->getBody();
             },
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -7,15 +7,14 @@
 
 class ClientTest extends TestCase
 {
-    private $url;
     private $browser;
     private $client;
 
     public function setUp()
     {
-        $this->url = 'http://viewvc.example.org';
-        $this->browser = $this->getMockBuilder('Clue\React\Buzz\Browser')->disableOriginalConstructor()->getMock();
-        $this->client = new Client($this->url, $this->browser);
+        // test case does not take base URI into account
+        $this->browser = $this->getMockBuilder('Clue\React\Buzz\Browser')->disableOriginalConstructor()->setMethods(array('get'))->getMock();
+        $this->client = new Client($this->browser);
     }
 
     public function testInvalidDirectory()
@@ -33,7 +32,7 @@ public function testInvalidFile()
     public function testFetchFile()
     {
         $response = new Response('HTTP/1.0', 200, 'OK', array(), new Body('# hello'));
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co'))->will($this->returnValue(Promise\resolve($response)));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co'))->will($this->returnValue(Promise\resolve($response)));
 
         $promise = $this->client->fetchFile('README.md');
 
@@ -42,17 +41,16 @@ public function testFetchFile()
 
     public function testFetchFileExcessiveSlashesAreIgnored()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co'))->will($this->returnValue(Promise\reject()));
 
-        $client = new Client($this->url . '/', $this->browser);
-        $promise = $client->fetchFile('/README.md');
+        $promise = $this->client->fetchFile('/README.md');
 
         $this->expectPromiseReject($promise);
     }
 
     public function testFetchFileRevision()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co&pathrev=1.0'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co&pathrev=1.0'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchFile('/README.md', '1.0');
 
@@ -61,7 +59,7 @@ public function testFetchFileRevision()
 
     public function testFetchDirectoryRevision()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?pathrev=1.0'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?pathrev=1.0'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchDirectory('/directory/', '1.0');
 
@@ -70,7 +68,7 @@ public function testFetchDirectoryRevision()
 
     public function testFetchDirectoryAttic()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?hideattic=0'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?hideattic=0'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchDirectory('/directory/', null, true);
 
@@ -79,7 +77,7 @@ public function testFetchDirectoryAttic()
 
     public function testFetchDirectoryRevisionAttic()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?pathrev=1.1&hideattic=0'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?pathrev=1.1&hideattic=0'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchDirectory('/directory/', '1.1', true);
 
@@ -88,7 +86,7 @@ public function testFetchDirectoryRevisionAttic()
 
     public function testFetchLogRevision()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=log&pathrev=1.0'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=log&pathrev=1.0'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchLog('/README.md', '1.0');
 
@@ -97,7 +95,7 @@ public function testFetchLogRevision()
 
     public function testFetchPatch()
     {
-        $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=patch&r1=1.0&r2=1.1'))->will($this->returnValue(Promise\reject()));
+        $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=patch&r1=1.0&r2=1.1'))->will($this->returnValue(Promise\reject()));
 
         $promise = $this->client->fetchPatch('/README.md', '1.0', '1.1');
 
diff --git a/tests/FunctionalApacheClientTest.php b/tests/FunctionalApacheClientTest.php
@@ -17,7 +17,7 @@ public function setUp()
         $this->loop = LoopFactory::create();
         $browser = new Browser($this->loop);
 
-        $this->viewvc = new Client($url, $browser);
+        $this->viewvc = new Client($browser->withBase($url));
     }
 
     public function testFetchDirectory()
diff --git a/tests/FunctionalGentooClientTest.php b/tests/FunctionalGentooClientTest.php
@@ -36,7 +36,7 @@ public function setUp()
             $this->markTestSkipped('Unable to reach Gentoo ViewVC');
         }
 
-        $this->viewvc = new Client($url, $browser);
+        $this->viewvc = new Client($browser->withBase($url));
     }
 
     public function testFetchDirectoryAttic()

Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,14 @@`
`7`	`7`
`8`	`8`	`class ClientTest extends TestCase`
`9`	`9`	`{`
`10`		`- private $url;`
`11`	`10`	`private $browser;`
`12`	`11`	`private $client;`
`13`	`12`
`14`	`13`	`public function setUp()`
`15`	`14`	`{`
`16`		`- $this->url = 'http://viewvc.example.org';`
`17`		`- $this->browser = $this->getMockBuilder('Clue\React\Buzz\Browser')->disableOriginalConstructor()->getMock();`
`18`		`- $this->client = new Client($this->url, $this->browser);`
	`15`	`+ // test case does not take base URI into account`
	`16`	`+ $this->browser = $this->getMockBuilder('Clue\React\Buzz\Browser')->disableOriginalConstructor()->setMethods(array('get'))->getMock();`
	`17`	`+ $this->client = new Client($this->browser);`
`19`	`18`	`}`
`20`	`19`
`21`	`20`	`public function testInvalidDirectory()`
`@@ -33,7 +32,7 @@ public function testInvalidFile()`
`33`	`32`	`public function testFetchFile()`
`34`	`33`	`{`
`35`	`34`	`$response = new Response('HTTP/1.0', 200, 'OK', array(), new Body('# hello'));`
`36`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co'))->will($this->returnValue(Promise\resolve($response)));`
	`35`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co'))->will($this->returnValue(Promise\resolve($response)));`
`37`	`36`
`38`	`37`	`$promise = $this->client->fetchFile('README.md');`
`39`	`38`
`@@ -42,17 +41,16 @@ public function testFetchFile()`
`42`	`41`
`43`	`42`	`public function testFetchFileExcessiveSlashesAreIgnored()`
`44`	`43`	`{`
`45`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co'))->will($this->returnValue(Promise\reject()));`
	`44`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co'))->will($this->returnValue(Promise\reject()));`
`46`	`45`
`47`		`- $client = new Client($this->url . '/', $this->browser);`
`48`		`- $promise = $client->fetchFile('/README.md');`
	`46`	`+ $promise = $this->client->fetchFile('/README.md');`
`49`	`47`
`50`	`48`	`$this->expectPromiseReject($promise);`
`51`	`49`	`}`
`52`	`50`
`53`	`51`	`public function testFetchFileRevision()`
`54`	`52`	`{`
`55`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=co&pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
	`53`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=co&pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
`56`	`54`
`57`	`55`	`$promise = $this->client->fetchFile('/README.md', '1.0');`
`58`	`56`
`@@ -61,7 +59,7 @@ public function testFetchFileRevision()`
`61`	`59`
`62`	`60`	`public function testFetchDirectoryRevision()`
`63`	`61`	`{`
`64`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
	`62`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
`65`	`63`
`66`	`64`	`$promise = $this->client->fetchDirectory('/directory/', '1.0');`
`67`	`65`
`@@ -70,7 +68,7 @@ public function testFetchDirectoryRevision()`
`70`	`68`
`71`	`69`	`public function testFetchDirectoryAttic()`
`72`	`70`	`{`
`73`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?hideattic=0'))->will($this->returnValue(Promise\reject()));`
	`71`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?hideattic=0'))->will($this->returnValue(Promise\reject()));`
`74`	`72`
`75`	`73`	`$promise = $this->client->fetchDirectory('/directory/', null, true);`
`76`	`74`
`@@ -79,7 +77,7 @@ public function testFetchDirectoryAttic()`
`79`	`77`
`80`	`78`	`public function testFetchDirectoryRevisionAttic()`
`81`	`79`	`{`
`82`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/directory/?pathrev=1.1&hideattic=0'))->will($this->returnValue(Promise\reject()));`
	`80`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('directory/?pathrev=1.1&hideattic=0'))->will($this->returnValue(Promise\reject()));`
`83`	`81`
`84`	`82`	`$promise = $this->client->fetchDirectory('/directory/', '1.1', true);`
`85`	`83`
`@@ -88,7 +86,7 @@ public function testFetchDirectoryRevisionAttic()`
`88`	`86`
`89`	`87`	`public function testFetchLogRevision()`
`90`	`88`	`{`
`91`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=log&pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
	`89`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=log&pathrev=1.0'))->will($this->returnValue(Promise\reject()));`
`92`	`90`
`93`	`91`	`$promise = $this->client->fetchLog('/README.md', '1.0');`
`94`	`92`
`@@ -97,7 +95,7 @@ public function testFetchLogRevision()`
`97`	`95`
`98`	`96`	`public function testFetchPatch()`
`99`	`97`	`{`
`100`		`- $this->browser->expects($this->once())->method('get')->with($this->equalTo('http://viewvc.example.org/README.md?view=patch&r1=1.0&r2=1.1'))->will($this->returnValue(Promise\reject()));`
	`98`	`+ $this->browser->expects($this->once())->method('get')->with($this->equalTo('README.md?view=patch&r1=1.0&r2=1.1'))->will($this->returnValue(Promise\reject()));`
`101`	`99`
`102`	`100`	`$promise = $this->client->fetchPatch('/README.md', '1.0', '1.1');`
`103`	`101`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public function setUp()`
`17`	`17`	`$this->loop = LoopFactory::create();`
`18`	`18`	`$browser = new Browser($this->loop);`
`19`	`19`
`20`		`- $this->viewvc = new Client($url, $browser);`
	`20`	`+ $this->viewvc = new Client($browser->withBase($url));`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`public function testFetchDirectory()`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function setUp()`
`36`	`36`	`$this->markTestSkipped('Unable to reach Gentoo ViewVC');`
`37`	`37`	`}`
`38`	`38`
`39`		`- $this->viewvc = new Client($url, $browser);`
	`39`	`+ $this->viewvc = new Client($browser->withBase($url));`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public function testFetchDirectoryAttic()`