From 2c8eaacec79169f141105a42facdd04cf48e1087 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Mon, 10 Aug 2015 21:33:50 +0200 Subject: [PATCH 1/2] Merge headers of ocs results --- lib/private/api.php | 18 ++++++----- lib/private/ocs/result.php | 3 +- tests/lib/api.php | 62 ++++++++++++++++++++------------------ 3 files changed, 46 insertions(+), 37 deletions(-) diff --git a/lib/private/api.php b/lib/private/api.php index 3c599de25a..fde2020bcf 100644 --- a/lib/private/api.php +++ b/lib/private/api.php @@ -201,7 +201,8 @@ class OC_API { $picked = reset($shipped['failed']); $code = $picked['response']->getStatusCode(); $meta = $picked['response']->getMeta(); - $response = new OC_OCS_Result($data, $code, $meta['message']); + $headers = $picked['response']->getHeaders(); + $response = new OC_OCS_Result($data, $code, $meta['message'], $headers); return $response; } elseif(!empty($shipped['succeeded'])) { $responses = array_merge($shipped['succeeded'], $thirdparty['succeeded']); @@ -214,13 +215,16 @@ class OC_API { $picked = reset($thirdparty['failed']); $code = $picked['response']->getStatusCode(); $meta = $picked['response']->getMeta(); - $response = new OC_OCS_Result($data, $code, $meta['message']); + $headers = $picked['response']->getHeaders(); + $response = new OC_OCS_Result($data, $code, $meta['message'], $headers); return $response; } else { $responses = $thirdparty['succeeded']; } // Merge the successful responses - $data = array(); + $data = []; + $codes = []; + $header = []; foreach($responses as $response) { if($response['shipped']) { @@ -228,8 +232,9 @@ class OC_API { } else { $data = array_merge_recursive($data, $response['response']->getData()); } - $codes[] = array('code' => $response['response']->getStatusCode(), - 'meta' => $response['response']->getMeta()); + $header = array_merge_recursive($header, $response['response']->getHeaders()); + $codes[] = ['code' => $response['response']->getStatusCode(), + 'meta' => $response['response']->getMeta()]; } // Use any non 100 status codes @@ -243,8 +248,7 @@ class OC_API { } } - $result = new OC_OCS_Result($data, $statusCode, $statusMessage); - return $result; + return new OC_OCS_Result($data, $statusCode, $statusMessage, $header); } /** diff --git a/lib/private/ocs/result.php b/lib/private/ocs/result.php index 42b6166b82..78c0b3bdd6 100644 --- a/lib/private/ocs/result.php +++ b/lib/private/ocs/result.php @@ -51,7 +51,7 @@ class OC_OCS_Result{ * @param int $code * @param null|string $message */ - public function __construct($data=null, $code=100, $message=null) { + public function __construct($data = null, $code = 100, $message = null, $headers = []) { if ($data === null) { $this->data = array(); } elseif (!is_array($data)) { @@ -61,6 +61,7 @@ class OC_OCS_Result{ } $this->statusCode = $code; $this->message = $message; + $this->headers = $headers; } /** diff --git a/tests/lib/api.php b/tests/lib/api.php index 3b925a6396..6a8fcfcd05 100644 --- a/tests/lib/api.php +++ b/tests/lib/api.php @@ -14,11 +14,13 @@ class Test_API extends \Test\TestCase { * @param string $message */ function buildResponse($shipped, $data, $code, $message=null) { - return array( + $resp = new OC_OCS_Result($data, $code, $message); + $resp->addHeader('KEY', 'VALUE'); + return [ 'shipped' => $shipped, - 'response' => new OC_OCS_Result($data, $code, $message), + 'response' => $resp, 'app' => $this->getUniqueID('testapp_'), - ); + ]; } // Validate details of the result @@ -35,11 +37,11 @@ class Test_API extends \Test\TestCase { } function dataProviderTestOneResult() { - return array( - array(100, true), - array(101, false), - array(997, false), - ); + return [ + [100, true], + [101, false], + [997, false], + ]; } /** @@ -50,47 +52,47 @@ class Test_API extends \Test\TestCase { */ public function testOneResult($statusCode, $succeeded) { // Setup some data arrays - $data1 = array( - 'users' => array( - 'tom' => array( + $data1 = [ + 'users' => [ + 'tom' => [ 'key' => 'value', - ), - 'frank' => array( + ], + 'frank' => [ 'key' => 'value', - ), - )); + ], + ]]; // Test merging one success result $response = $this->buildResponse(true, $data1, $statusCode); - $result = OC_API::mergeResponses(array($response)); + $result = OC_API::mergeResponses([$response]); $this->assertEquals($response['response'], $result); $this->checkResult($result, $succeeded); } function dataProviderTestMergeResponses() { - return array( + return [ // Two shipped success results - array(true, 100, true, 100, true), + [true, 100, true, 100, true], // Two shipped results, one success and one failure - array(true, 100, true, 998, false), + [true, 100, true, 998, false], // Two shipped results, both failure - array(true, 997, true, 998, false), + [true, 997, true, 998, false], // Two third party success results - array(false, 100, false, 100, true), + [false, 100, false, 100, true], // Two third party results, one success and one failure - array(false, 100, false, 998, false), + [false, 100, false, 998, false], // Two third party results, both failure - array(false, 997, false, 998, false), + [false, 997, false, 998, false], // One of each, both success - array(false, 100, true, 100, true), - array(true, 100, false, 100, true), + [false, 100, true, 100, true], + [true, 100, false, 100, true], // One of each, both failure - array(false, 997, true, 998, false), + [false, 997, true, 998, false], // One of each, shipped success - array(false, 997, true, 100, true), + [false, 997, true, 100, true], // One of each, third party success - array(false, 100, true, 998, false), - ); + [false, 100, true, 998, false], + ]; } /** * @dataProvider dataProviderTestMergeResponses @@ -131,9 +133,11 @@ class Test_API extends \Test\TestCase { $this->checkResult($result, $succeeded); $resultData = $result->getData(); $resultMeta = $result->getMeta(); + $resultHeaders = $result->getHeaders(); $resultStatusCode = $result->getStatusCode(); $this->assertArrayHasKey('jan', $resultData['users']); + $this->assertArrayHasKey('KEY', $resultHeaders); // check if the returned status message matches the selected status code if ($resultStatusCode === 997) { From e589226f58698dec4fdb95a555bd9c15e96faba5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Thu, 13 Aug 2015 10:39:52 +0200 Subject: [PATCH 2/2] fix PHPDoc --- lib/private/ocs/result.php | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/private/ocs/result.php b/lib/private/ocs/result.php index 78c0b3bdd6..e8ef253ee6 100644 --- a/lib/private/ocs/result.php +++ b/lib/private/ocs/result.php @@ -50,6 +50,7 @@ class OC_OCS_Result{ * @param mixed $data the data to return * @param int $code * @param null|string $message + * @param array $headers */ public function __construct($data = null, $code = 100, $message = null, $headers = []) { if ($data === null) {