Merge branch 'hotfix/47-geocode-validation'

Close #52
Fixes #47

Author: weierophinney

CHANGELOG.md

@@ -26,6 +26,10 @@ All notable changes to this project will be documented in this file, in reverse
   submission of direct messages to the Twitter API. Payloads for DMs have been
   broken since the 3.0.0 release.
 
+- [#52](https://github.com/zendframework/ZendService_Twitter/pull/52) fixes
+  the `search/tweets` logic concerning geocode parameter validation, ensuring it
+  no longer raises an exception for a valid geocode parameter.
+
 ## 3.0.1 - 2017-08-17
 
 ### Added

src/Twitter.php

@@ -977,12 +977,12 @@ public function searchTweets(string $query, array $options = []) : Response
         foreach ($options as $key => $value) {
             switch (strtolower($key)) {
                 case 'geocode':
-                    if (! substr_count($value, ',') !== 2) {
+                    if (substr_count($value, ',') !== 2) {
                         throw new Exception\InvalidArgumentException(
                             '"geocode" must be of the format "latitude,longitude,radius"'
                         );
                     }
-                    list($latitude, $longitude, $radius) = explode(',', $value);
+                    list($latitude, $longitude, $radius) = explode(',', $value, 3);
                     $radius = trim($radius);
                     if (! preg_match('/^\d+(mi|km)$/', $radius)) {
                         throw new Exception\InvalidArgumentException(

test/TwitterTest.php

@@ -1233,4 +1233,64 @@ public function testFriendshipsLookupRaisesExceptionIfInvalidIdentifiersProvided
 
         $twitter->friendships->lookup($ids);
     }
+
+    public function validGeocodeOptions()
+    {
+        return [
+            'mile-radius' => ['53.3242381,-6.3857848,1mi'],
+            'km-radius'   => ['53.3242381,-6.3857848,1km'],
+        ];
+    }
+
+    /**
+     * @dataProvider validGeocodeOptions
+     * @param string $geocode
+     */
+    public function testSearchTweetsShouldNotInvalidateCorrectlyFormattedGeocodeOption($geocode)
+    {
+        $twitter = new Twitter\Twitter();
+
+        $options = [
+            'geocode' => $geocode,
+        ];
+
+        $twitter->setHttpClient($this->stubOAuthClient(
+            'search/tweets.json',
+            Http\Request::METHOD_GET,
+            'search.tweets.json',
+            array_merge($options, ['q' => 'foo'])
+        ));
+
+        $finalResponse = $twitter->search->tweets('foo', $options);
+        $this->assertInstanceOf(TwitterResponse::class, $finalResponse);
+    }
+
+    public function invalidGeocodeOptions()
+    {
+        return [
+            'too-few-commas'  => ['53.3242381,-6.3857848', 'latitude,longitude,radius'],
+            'too-many-commas' => ['53.3242381,-6.3857848,1mi,why', 'latitude,longitude,radius'],
+            'invalid-radius'  => ['53.3242381,-6.3857848,1', 'Radius segment'],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidGeocodeOptions
+     * @param string $geocode
+     * @param string $expectedMessage
+     */
+    public function testSearchTweetsShouldInvalidateIncorrectlyFormattedGeocodeOption(
+        $geocode,
+        $expectedMessage
+    ) {
+        $twitter = new Twitter\Twitter();
+
+        $options = [
+            'geocode' => $geocode,
+        ];
+
+        $this->expectException(Twitter\Exception\InvalidArgumentException::class);
+        $this->expectExceptionMessage($expectedMessage);
+        $twitter->search->tweets('foo', $options);
+    }
 }