Merge pull request #372 from recurly/aaron-suarez/add-details-tag

Add details to error messages to make them more helpful

Tests/Recurly/Client_Test.php

@@ -40,4 +40,19 @@ public function testGatweayError() {
     }
     catch (Recurly_ConnectionError $e) {}
   }
+
+  // Test that the <details> tag from a 400 response is appended to the message
+  public function testBadRequestError() {
+    $this->client->addResponse('POST', '/purchases', 'client/bad-request-400.xml');
+
+    try {
+      $purchase = new Recurly_Purchase();
+      $purchase->address = 'something unacceptable';
+
+      $collection = Recurly_Purchase::invoice($purchase, $this->client);
+    }
+    catch(Recurly_Error $e) {
+      $this->assertEquals($e->getMessage(), "The provided XML was invalid. Details: Unacceptable tags <address>");
+    }
+  }
 }

Tests/fixtures/client/bad-request-400.xml

@@ -0,0 +1,9 @@
+HTTP/1.1 400 Bad Request
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<error>
+<symbol>invalid_xml</symbol>
+<description>The provided XML was invalid.</description>
+<details>Unacceptable tags &lt;address&gt;</details>
+</error>

lib/recurly/errors.php

@@ -72,13 +72,16 @@ class Recurly_FieldError
   var $field;
   var $symbol;
   var $description;
+  var $details;
 
   public function __toString() {
     if (!empty($this->field) && ($this->__readableField() != 'base')) {
-      return $this->__readableField() . ' ' . $this->description;
+      $details = $this->details ? ' Details: ' . $this->details : '';
+      return $this->__readableField() . ' ' . $this->description . $details;
     }
     else {
-      return $this->description;
+      $details = $this->details ? ' Details: ' . $this->details : '';
+      return $this->description . $details;
     }
   }
 

lib/recurly/response.php

@@ -57,7 +57,7 @@ public function assertValidResponse()
       case 0:
         throw new Recurly_ConnectionError('An error occurred while connecting to Recurly.');
       case 400:
-        $message = (is_null($error) ? 'Bad API Request' : $error->description);
+        $message = (is_null($error) ? 'Bad API Request' : (string) $error);
         throw new Recurly_Error($message, 0, null, $recurlyCode);
       case 401:
         throw new Recurly_UnauthorizedError('Your API Key is not authorized to connect to Recurly.');
@@ -117,6 +117,9 @@ private static function parseErrorNode($node)
         case 'description':
           $error->description = $node->nodeValue;
           break;
+        case 'details':
+          $error->details = $node->nodeValue;
+          break;
       }
       $node = $node->nextSibling;
     }