Skip to content

Commit caa519c

Browse files
lauren12292lauren12292
committed
Merge branch 'develop'
2 parents 8186c9e + 2a376ff commit caa519c

File tree

5 files changed

+22
-80
lines changed

5 files changed

+22
-80
lines changed

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ script:
1313
notifications:
1414
slack:
1515
rooms:
16-
# - secure: 4FRaTAAiYyeUvgw2RhmblgbNiJO4wmd34OBgWcwURjP9oVmFfSwR9r1LNCdUGxrPOghexSY2DjXIuvIrfTfi/xYbhHb3Kw7PEAyB8IuBMlKtY4NSFou62S2VhYpxyg58T+C7P2zi0eDnDE06pwTCoGPaimxMZQY91yQ0yPYDPVXbwe5SjEgamzlwGBxlS/0A6w1iCPHg27/iO2hXtdW3oLS2I0F/Q8Q95RBkX9hpg6yqHlTV7jRbSqvQ9OFBqk/tXMHQvhoPDGgCgQDuykJuaAYx7g9d0YL0eEYYOh9B/TJ/kNOwdRFBu5kuQ2/nFS5Z0S3Y3UIhdYjUmm9gSMnwIbYnrW22EqDJLoT9Zi3Gv7Prg/8/fSkWsof7BJTMSuXUqO1AxDGKIxFv9uSF1daZoY+AC1ooU1xDu1nNvWVYPlkwEdDxxmHpFkGT3ESTZYccPovQl8Z5K0I1BBAVdJKDzm07lE6VHbxkKcvK6gG0TN3uLxnSlQtjkfJ+aVMq1kxeVsB9lEsKs9oezsKzzbftMm525aXPg+OAv+31CUFWxvT/p4ps8Q+AV6aZpoPHkpK8VryyNirUeZ/m4m4ebDHhD9vcN+JqE9gzshT+0U3g19SvLiUMQtbuZ2BUvrq2hh2LEGs03AFZaNg9AEUVA1PQRhV5NILyoS/lbiBYJPT39Sg=
16+
- secure: 4FRaTAAiYyeUvgw2RhmblgbNiJO4wmd34OBgWcwURjP9oVmFfSwR9r1LNCdUGxrPOghexSY2DjXIuvIrfTfi/xYbhHb3Kw7PEAyB8IuBMlKtY4NSFou62S2VhYpxyg58T+C7P2zi0eDnDE06pwTCoGPaimxMZQY91yQ0yPYDPVXbwe5SjEgamzlwGBxlS/0A6w1iCPHg27/iO2hXtdW3oLS2I0F/Q8Q95RBkX9hpg6yqHlTV7jRbSqvQ9OFBqk/tXMHQvhoPDGgCgQDuykJuaAYx7g9d0YL0eEYYOh9B/TJ/kNOwdRFBu5kuQ2/nFS5Z0S3Y3UIhdYjUmm9gSMnwIbYnrW22EqDJLoT9Zi3Gv7Prg/8/fSkWsof7BJTMSuXUqO1AxDGKIxFv9uSF1daZoY+AC1ooU1xDu1nNvWVYPlkwEdDxxmHpFkGT3ESTZYccPovQl8Z5K0I1BBAVdJKDzm07lE6VHbxkKcvK6gG0TN3uLxnSlQtjkfJ+aVMq1kxeVsB9lEsKs9oezsKzzbftMm525aXPg+OAv+31CUFWxvT/p4ps8Q+AV6aZpoPHkpK8VryyNirUeZ/m4m4ebDHhD9vcN+JqE9gzshT+0U3g19SvLiUMQtbuZ2BUvrq2hh2LEGs03AFZaNg9AEUVA1PQRhV5NILyoS/lbiBYJPT39Sg=
1717
# - secure: D4VxkkZlj7uaaFbqEBITkJCusVeii436N8X6GijuosUSaee9lqGYUF5ZS9lV6VGMKs719IfSJsCc2v/N4nc9Y/8AKgXd7AWHUwaRR+MC6rLwv9xqH8ZlkTPUKHUXkUQe1f9042PcMxzYa9r0+uKniM9l915Yx0PLaawJrWe3ZVig/uBhn5FueLhtUACzLJcjNcri/BKEgmP2+EgUsupUhujd0MsQd8xN5YIIv6VM5oD0XWXZCnBqHoZK+Qq7LfwDnTmUk7juqTOAjefF6v8IJTDELvSdK9QW7f9x7h0ICabIrI+Gl4IbNLJYEnELBi+X7da2YJUTgUoQrlBB4z+T8KybD8myqV/pJc1n0xrk84g1MtYQ3ahZn7eD3DTjIvK+ML8qAAGwxibF8VsV+GSoo5FcB6e3vV+glHODlwszstVs11PpL1grurVdoa5HPhUbm1jtQixOwO7h8GgGpwO20PuMLfyOfTjfoMcJ3ISjGNHRmUwcCH9avcaHqMLPLHht0z+8inVlDZeTcN+Wi8tk1YXwuQYUkTW46iFmoZNGdygRjTu43h9hCqdG7vcoKrR8oDbMT8X/sfs+z/UaBbuYBr9dT8rrdKJoa9115PaYpCs529DLrw1iGmzr5CkAXDElc1y2F352nwVS+dX7/OIQz1/dbT1ozWQ9Blx6ez5XN84=
1818
# - secure: g/eOC2QCn7oUW234u/P1kmh9OASO9t5g6iC+DflNdnedHnpw8IEG9CsLAnNynOY0KvC/2/Q6BAIFpT/qO8BPdaC2eQnd9LDurOXExxvjKZgTujhqgzijJGzVPSL8//hafj0Ec2+iJZFo/DYMPqUpYDsiKxX53+SMz9/GN/PKVKsI7bzuaOm04xXktU0A76pVfaG0N/qFSVHI64SShACoUXRpTzyUbmksRgzk7FB162R+TH1soPsR3vPh8c2SSWC9msrDc4iljcBhSFTdjL68z+srjDPYMSoOcFXXFNP+dmL+Q0veL/E4e40e7CWIU1O3grOcEcCkaSoZVSpGduNnCst8h6MpgauPtrgwHk4zGMoSl+L6al+nFo/3h2dXeebrQ0tY/hRfZi4Q8xwqG9083TBqi71fTpoFZ7sNtrY4Kdtl5Oa2CFUo7lVn1JB9qQwSa0eai3Whv0RyRqqQe77aDUj0dfD2R3Q61rX5OF/f++W0XtNwHQubzmj8HD/cFneShIQsbl9KgYXoR6HiXcbBiNdmmZjSrzkPYh7vlsujYrz6Cg2msKybWJ/FfOz0tS1cjlCtiCMOTExN6tEF8YCp9l+s+5RLe61pgFPy4Snr9pEjuTS5DYliTyZMY2ZZC1clBQtgE8E2qCG1QSzqnqqiGxj2K4zmLPpB4y1XpW8e3yk=
1919
on_success: always

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "rosette/api",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"description": "Rosette API PHP client SDK",
55
"license": "Apache",
66
"keywords": [

‎source/rosette/api/Api.php‎

Lines changed: 7 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,6 @@ class Api
6868
*/
6969
private $headers;
7070

71-
/**
72-
* True if the version has already been checked. Saves round trips.
73-
*
74-
* @var bool
75-
*/
76-
private $version_checked;
77-
7871
/**
7972
* Endpoint for the operation.
8073
*
@@ -126,12 +119,13 @@ public function __construct($user_key, $service_url = 'https://api.rosette.com/
126119
"Content-Type: application/json",
127120
"Accept: application/json",
128121
"Accept-Encoding: gzip",
129-
"User-Agent: RosetteAPIPHP/" . self::$binding_version, );
122+
"User-Agent: RosetteAPIPHP/" . self::$binding_version,
123+
"X-RosetteAPI-Binding: php",
124+
"X-RosetteAPI-Binding-Version: " . self::$binding_version );
130125

131126
$this->setServiceUrl($service_url);
132127
$this->setDebug(false);
133128
$this->setTimeout(300);
134-
$this->version_checked = false;
135129
$this->subUrl = null;
136130
$this->max_retries = 5;
137131
$this->ms_between_retries = 500000;
@@ -286,7 +280,6 @@ private function replaceHeaderItem($old_header_item, $new_header_item)
286280
*/
287281
private function callEndpoint($parameters, $subUrl)
288282
{
289-
$this->checkVersion($this->service_url);
290283
$this->subUrl = $subUrl;
291284
$resultObject = '';
292285

@@ -322,44 +315,6 @@ private function callEndpoint($parameters, $subUrl)
322315
return $resultObject;
323316
}
324317

325-
/**
326-
* Checks the server version against the api (or provided )version.
327-
*
328-
* @param $url
329-
* @param $versionToCheck
330-
*
331-
* @return bool
332-
*
333-
* @throws RosetteException
334-
*/
335-
private function checkVersion($url, $versionToCheck = null)
336-
{
337-
if (!$this->version_checked) {
338-
if (!$versionToCheck) {
339-
$versionToCheck = self::$binding_version;
340-
}
341-
$resultObject = $this->postHttp($url . "info?clientVersion=$versionToCheck", $this->headers, null);
342-
343-
// should not get called due to makeRequest checks, but just in case, we want to
344-
// avoid an incompatible version error when it's something else.
345-
if ($this->getResponseCode() !== 200) {
346-
throw new RosetteException( $resultObject['message'], $this->getResponseCode());
347-
}
348-
349-
if (array_key_exists('versionChecked', $resultObject) && $resultObject['versionChecked'] === true) {
350-
$this->version_checked = true;
351-
} else {
352-
throw new RosetteException(
353-
'The server version is not compatible with binding version ' . strval($versionToCheck),
354-
RosetteException::$INCOMPATIBLE_VERSION
355-
);
356-
}
357-
}
358-
359-
return $this->version_checked;
360-
}
361-
362-
363318
/**
364319
* function makeRequest.
365320
*
@@ -380,7 +335,7 @@ private function makeRequest($url, $headers, $data, $method)
380335
$request = $this->mock_request != null ? $this->mock_request : new RosetteRequest();
381336
for ($retries = 0; $retries < $this->max_retries; $retries++) {
382337
if ($request->makeRequest($url, $headers, $data, $method) === false) {
383-
throw new RosetteException($request->getResponseError);
338+
throw new RosetteException($request->getResponseError);
384339
} else {
385340
$this->setResponseCode($request->getResponseCode());
386341
if ($this->getResponseCode() === 429) {
@@ -540,15 +495,15 @@ public function morphology($params, $facet = null)
540495
* Calls the entities endpoint.
541496
*
542497
* @param $params
543-
* @param $linked
498+
* @param $resolve_entities
544499
*
545500
* @return mixed
546501
*
547502
* @throws RosetteException
548503
*/
549-
public function entities($params, $linked = false)
504+
public function entities($params, $resolve_entities = false)
550505
{
551-
return $linked ? $this->callEndpoint($params, 'entities/linked') : $this->callEndpoint($params, 'entities');
506+
return $resolve_entities ? $this->callEndpoint($params, 'entities/linked') : $this->callEndpoint($params, 'entities');
552507
}
553508

554509
/**

‎source/rosette/api/RosetteRequest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public function getResponse()
198198
$response = [ 'headers' => $this->headersToArray() ];
199199
$responseBody = $this->getResponseBody();
200200
if (empty($responseBody)) {
201-
$response = array_merge($response, [ 'body' => 'empty' ]);
201+
$response = array_merge($response, [ 'body' => 'empty' ]);
202202
} else {
203203
$response = array_merge($response, json_decode($this->getResponseBody(), true));
204204
}

‎spec/rosette/api/ApiSpec.php‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public function it_calls_the_language_endpoint($params, $request)
7676
$request->beADoubleOf('rosette\api\RosetteRequest');
7777
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
7878
$request->getResponseCode()->willReturn(200);
79-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
79+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
8080

8181
$this->setMockRequest($request);
8282
$this->language($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -90,7 +90,7 @@ public function it_calls_the_sentences_endpoint($params, $request)
9090
$request->beADoubleOf('rosette\api\RosetteRequest');
9191
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
9292
$request->getResponseCode()->willReturn(200);
93-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
93+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
9494

9595
$this->setMockRequest($request);
9696
$this->sentences($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -104,7 +104,7 @@ public function it_calls_the_tokens_endpoint($params, $request)
104104
$request->beADoubleOf('rosette\api\RosetteRequest');
105105
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
106106
$request->getResponseCode()->willReturn(200);
107-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
107+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
108108

109109
$this->setMockRequest($request);
110110
$this->tokens($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -118,7 +118,7 @@ public function it_calls_the_morphology_endpoint($params, $request)
118118
$request->beADoubleOf('rosette\api\RosetteRequest');
119119
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
120120
$request->getResponseCode()->willReturn(200);
121-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
121+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
122122

123123
$this->setMockRequest($request);
124124
$this->morphology($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -140,7 +140,7 @@ public function it_calls_the_entities_endpoint($params, $request)
140140
$request->beADoubleOf('rosette\api\RosetteRequest');
141141
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
142142
$request->getResponseCode()->willReturn(200);
143-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
143+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
144144

145145
$this->setMockRequest($request);
146146
$this->entities($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -154,7 +154,7 @@ public function it_calls_the_entities_linked_endpoint($params, $request)
154154
$request->beADoubleOf('rosette\api\RosetteRequest');
155155
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
156156
$request->getResponseCode()->willReturn(200);
157-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
157+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
158158

159159
$this->setMockRequest($request);
160160
$linked = true;
@@ -169,7 +169,7 @@ public function it_calls_the_categories_endpoint($params, $request)
169169
$request->beADoubleOf('rosette\api\RosetteRequest');
170170
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
171171
$request->getResponseCode()->willReturn(200);
172-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
172+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
173173

174174
$this->setMockRequest($request);
175175
$this->categories($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -183,7 +183,7 @@ public function it_calls_the_sentiment_endpoint($params, $request)
183183
$request->beADoubleOf('rosette\api\RosetteRequest');
184184
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
185185
$request->getResponseCode()->willReturn(200);
186-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
186+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
187187

188188
$this->setMockRequest($request);
189189
$this->sentiment($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -197,7 +197,7 @@ public function it_calls_using_multipart($params, $request)
197197
$request->beADoubleOf('rosette\api\RosetteRequest');
198198
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
199199
$request->getResponseCode()->willReturn(200);
200-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
200+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
201201

202202
$this->setMockRequest($request);
203203
$this->sentiment($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -210,7 +210,7 @@ public function it_calls_the_name_translation_endpoint($params, $request)
210210
$request->beADoubleOf('rosette\api\RosetteRequest');
211211
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
212212
$request->getResponseCode()->willReturn(200);
213-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
213+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
214214

215215
$this->setMockRequest($request);
216216
$this->nameTranslation($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -223,7 +223,7 @@ public function it_calls_the_name_similarity_endpoint($params, $request)
223223
$request->beADoubleOf('rosette\api\RosetteRequest');
224224
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
225225
$request->getResponseCode()->willReturn(200);
226-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
226+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
227227

228228
$this->setMockRequest($request);
229229
$this->nameSimilarity($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -237,7 +237,7 @@ public function it_calls_the_relationships_endpoint($params, $request)
237237
$request->beADoubleOf('rosette\api\RosetteRequest');
238238
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
239239
$request->getResponseCode()->willReturn(200);
240-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => true ]);
240+
$request->getResponse()->willReturn([ 'name' => 'Rosette API']);
241241

242242
$this->setMockRequest($request);
243243
$this->relationships($params)->shouldHaveKeyWithValue('name', 'Rosette API');
@@ -257,17 +257,4 @@ public function it_fails_with_non_200_response($params, $request)
257257
$this->shouldThrow('rosette\api\RosetteException')->duringRelationships($params);
258258
}
259259

260-
public function it_fails_check_version($params, $request)
261-
{
262-
$params->beADoubleOf('\rosette\api\RelationshipsParameters');
263-
$params->contentUri = 'http://some.dummysite.com';
264-
265-
$request->beADoubleOf('rosette\api\RosetteRequest');
266-
$request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
267-
$request->getResponseCode()->willReturn(200);
268-
$request->getResponse()->willReturn([ 'name' => 'Rosette API', 'versionChecked' => false ]);
269-
270-
$this->setMockRequest($request);
271-
$this->shouldThrow('rosette\api\RosetteException')->duringRelationships($params);
272-
}
273260
}

0 commit comments

Comments
 (0)