Merge pull request #14 from chadicus/develop

Better handling of extra felds

Author: chadicus

src/NetAcuity.php

@@ -144,9 +144,19 @@ private function _parseResponse($response, array $fields)
         Util::throwIfNotType(['string' => $response], true);
         Util::throwIfNotType(['string' => $fields], true);
 
+        $numberOfExpectedFields = count($fields);
+
         $responseData = explode(';', $response);
-        Util::ensure(count($fields), count($responseData));
+        $numberOfResponseFields = count($responseData);
+        //Netacuity has a history of adding fields without notice
+        //Ensure that there are at least numberOfFields values returned.
+        Util::ensure(
+            true,
+            $numberOfResponseFields >= $numberOfExpectedFields,
+            '\\UnexpectedValueException',
+            ["Net acuity returned less than {$numberOfExpectedFields} fields"]
+        );
 
-        return array_combine($fields, $responseData);
+        return array_combine($fields, array_slice($responseData, 0, $numberOfExpectedFields));
     }
 }

tests/NetAcuityTest.php

@@ -5,6 +5,8 @@
 
 /**
  * @coversDefaultClass \DominionEnterprises\NetAcuity\NetAcuity
+ * @covers ::__construct
+ * @covers ::<private>
  */
 final class NetAcuityTest extends PHPUnit_Framework_TestCase
 {
@@ -25,11 +27,7 @@ public function createNonIntApiId()
      * Verify that geo lookup works.
      *
      * @test
-     * @covers ::__construct
      * @covers ::getGeo
-     * @covers ::_buildQuery
-     * @covers ::_query
-     * @covers ::_parseResponse
      */
     public function getGeo()
     {
@@ -74,7 +72,6 @@ public function getGeo()
      * Verify that ip address must be a string.
      *
      * @test
-     * @covers ::__construct
      * @covers ::getGeo
      * @expectedException InvalidArgumentException
      */
@@ -84,4 +81,68 @@ public function getGeoNonStringIp()
         $client = new NetAcuity($socket, 1);
         $client->getGeo(1);
     }
+
+    /**
+     * @test
+     * @covers ::getGeo
+     * @expectedException \UnexpectedValueException
+     * @expectedExceptionMessage Net acuity returned less than 22 fields
+     */
+    public function getGeoNotEnoughFields()
+    {
+        $socket = $this->getMockBuilder('\Socket\Raw\Socket')->disableOriginalConstructor()->setMethods(['write', 'read'])->getMock();
+        $socket->expects($this->once())->method('write')->with("4;1;1.2.3.4\r\n")->will($this->returnValue(13));
+        $socket->expects($this->once())->method('read')->with(1024)->will(
+            $this->returnValue('xxxxUSA;something;reserved;broadband;2;123.456;789.101;12345;112;1314;1516;1;US;1;123;2;3;4;5;6;7')
+        );
+
+        $client = new NetAcuity($socket, 1);
+        $client->getGeo('1.2.3.4');
+    }
+
+    /**
+     *
+     * @test
+     * @covers ::getGeo
+     */
+    public function getGeoWithExtraField()
+    {
+        $socket = $this->getMockBuilder('\Socket\Raw\Socket')->disableOriginalConstructor()->setMethods(['write', 'read'])->getMock();
+        $socket->expects($this->once())->method('write')->with("4;1;1.2.3.4\r\n")->will($this->returnValue(13));
+        $socket->expects($this->once())->method('read')->with(1024)->will(
+            $this->returnValue(
+                'xxxxUSA;something;reserved;broadband;2;123.456;789.101;12345;112;1314;1516;1;US;1;123;2;3;4;5;6;7;UTC;extra dataxxx'
+            )
+        );
+
+        $client = new NetAcuity($socket, 1);
+
+        $this->assertSame(
+            [
+                'country' => 'USA',
+                'region' => 'something',
+                'city' => 'reserved',
+                'conn-speed' => 'broadband',
+                'metro-code' => '2',
+                'latitude' => '123.456',
+                'longitude' => '789.101',
+                'zip-code' => '12345',
+                'country-code' => '112',
+                'region-code' => '1314',
+                'city-code' => '1516',
+                'continent-code' => '1',
+                'two-letter-country' => 'US',
+                'internal-code' => '1',
+                'area-code' => '123',
+                'country-conf' => '2',
+                'region-conf' => '3',
+                'city-conf' => '4',
+                'postal-conf' => '5',
+                'gmt-offset' => '6',
+                'in-dist' => '7',
+                'timezone-name' => 'UTC',
+            ],
+            $client->getGeo('1.2.3.4')
+        );
+    }
 }