Throw exception on error [BC]

Author: danmichaelo

src/InvalidResponseException.php renamed to src/Exceptions/InvalidResponseException.php

@@ -1,4 +1,4 @@
-<?php namespace Scriptotek\Sru;
+<?php namespace Scriptotek\Sru\Exceptions;
 
 class InvalidResponseException extends \Exception
 {

src/Exceptions/SruErrorException.php

@@ -0,0 +1,15 @@
+<?php namespace Scriptotek\Sru\Exceptions;
+
+class SruErrorException extends \Exception
+{
+	public $uri;
+
+    /**
+     * @param string $message
+     */
+    public function __construct($message, $uri)
+    {
+        parent::__construct($message);
+        $this->uri = $uri;
+    }
+}

src/Providers/SruServiceProvider.php

@@ -36,7 +36,7 @@ public function register()
         $app['sru-client'] = $app->share(function ($app) {
             return new SruClient($app['config']->get('sru.endpoint'), $app['config']->get('sru'));
         });
-        $app->alias('sru-client', 'Scriptotek\Sru\Client');
+        $app->alias('sru-client', SruClient::class);
     }
 
     /**

src/Records.php

@@ -52,18 +52,6 @@ public function __construct($cql, Client $client, $count = 10, $extraParams = ar
         $this->fetchMore();
     }
 
-    /**
-     * Return error message from last reponse, if any
-     *
-     * @return string|null
-     */
-    public function __get($prop)
-    {
-        if ($prop == 'error') {
-            return $this->lastResponse->error;
-        }
-    }
-
     /**
      * Return the number of records
      *
@@ -88,7 +76,7 @@ private function fetchMore()
         $this->data = $this->lastResponse->records;
 
         if (count($this->data) != 0 && $this->data[0]->position != $this->position) {
-            throw new InvalidResponseException('Wrong index of first record in result set. '
+            throw new Exceptions\InvalidResponseException('Wrong index of first record in result set. '
                 . 'Expected: ' .$this->position . ', got: ' . $this->data[0]->position
             );
         }

src/Response.php

@@ -101,9 +101,6 @@ class Response implements ResponseInterface
     /** @var Client Reference to SRU client object */
     protected $client;
 
-    /** @var string Error message */
-    public $error;
-
     /** @var string SRU protocol version */
     public $version;
 
@@ -146,7 +143,7 @@ public function __construct($text, &$client = null)
             if (!empty($details)) {
                 $msg .= ' (' . $details . ')';
             }
-            $this->error = $msg;
+            throw new Exceptions\SruErrorException($msg, $uri);
         }
     }
 

tests/ExplainResponseTest.php

@@ -102,7 +102,6 @@ public function testNormalResponse()
 			  </sru:record>
 			</sru:explainResponse>');
 
-        $this->assertNull($res->error);
         $this->assertEquals('1.2', $res->version);
         $this->assertEquals('sru.bibsys.no', $res->host);
         $this->assertEquals(80, $res->port);

tests/RecordsTest.php

@@ -14,10 +14,8 @@ public function testIterating()
 
         $client = new Client($uri);
         $records = new Records($cql, $client, 10, array(), $http);
-        $this->assertNull($records->error);
         $this->assertEquals(8, $records->numberOfRecords());
         $records->rewind();
-        $this->assertNull($records->error);
 
         $this->assertEquals(1, $records->key());
         $this->assertTrue($records->valid());
@@ -37,7 +35,7 @@ public function testIterating()
     }
 
     /**
-     * @expectedException Scriptotek\Sru\InvalidResponseException
+     * @expectedException Scriptotek\Sru\Exceptions\InvalidResponseException
      */
     public function testRepeatSameResponse()
     {

tests/SearchRetrieveResponseTest.php

@@ -34,7 +34,6 @@ public function testSingleRecordResult()
             </srw:extraResponseData>
           </srw:searchRetrieveResponse>');
 
-        $this->assertNull($res->error);
         $this->assertEquals('1.1', $res->version);
         $this->assertEquals(1, $res->numberOfRecords);
         $this->assertNull($res->nextRecordPosition);
@@ -83,7 +82,6 @@ public function testMultipleRecordsResult()
             </srw:extraResponseData>
           </srw:searchRetrieveResponse>');
 
-        $this->assertNull($res->error);
         $this->assertEquals('1.1', $res->version);
         $this->assertEquals(303, $res->numberOfRecords);
         $this->assertEquals(3, $res->nextRecordPosition);
@@ -95,6 +93,10 @@ public function testMultipleRecordsResult()
         $this->assertEquals('Record 1', $res->records[0]->data);
     }
 
+    /**
+     * @expectedException         Scriptotek\Sru\Exceptions\SruErrorException
+     * @expectedExceptionMessage  Unknown schema for retrieval (Invalid parameter: 'marcxml' for service: 'biblio')
+     */
     public function testErrorWithDetails()
     {
         $res = new SearchRetrieveResponse('<srw:searchRetrieveResponse xmlns:srw="http://www.loc.gov/zing/srw/">
@@ -107,10 +109,12 @@ public function testErrorWithDetails()
             </diagnostic>
           </srw:diagnostics>
         </srw:searchRetrieveResponse>');
-
-        $this->assertEquals('Unknown schema for retrieval (Invalid parameter: \'marcxml\' for service: \'biblio\')', $res->error);
     }
 
+    /**
+     * @expectedException         Scriptotek\Sru\Exceptions\SruErrorException
+     * @expectedExceptionMessage  General system error
+     */
     public function testErrorWithoutDetails()
     {
         $res = new SearchRetrieveResponse('<srw:searchRetrieveResponse xmlns:srw="http://www.loc.gov/zing/srw/">
@@ -122,10 +126,12 @@ public function testErrorWithoutDetails()
             </diagnostic>
           </srw:diagnostics>
         </srw:searchRetrieveResponse>');
-        $this->assertEquals('General system error', Response::$errorMessages['info:srw/diagnostic/1/1']);
-        $this->assertEquals('General system error', $res->error);
     }
 
+    /**
+     * @expectedException         Scriptotek\Sru\Exceptions\SruErrorException
+     * @expectedExceptionMessage  Too many boolean operators, the maximum is 10. Please try a less complex query. (10)
+     */
     public function testErrorWithCustomMessage()
     {
         $res = new SearchRetrieveResponse('<srw:searchRetrieveResponse xmlns:srw="http://www.loc.gov/zing/srw/">
@@ -139,6 +145,5 @@ public function testErrorWithCustomMessage()
             </diagnostic>
           </srw:diagnostics>
         </srw:searchRetrieveResponse>');
-        $this->assertEquals('Too many boolean operators, the maximum is 10. Please try a less complex query. (10)', $res->error);
     }
 }