Added three new fields to the Metadata struct: IANATimeZone (string), IANAUTCOffset (float32), and IANADST (bool). These three new fields are accessible via setting a new feature flag "iana-timezone" (#79)

* Added three new fields to the Metadata struct: IANATimeZone (string), IANAUTCOffset (float32), and IANADST (bool). These three new fields are accessible via setting a new feature flag "iana-timezone"

* follow naming conventions

* comments

Author: JacobMcKenzieSmarty

src/ClientBuilder.php

@@ -235,6 +235,13 @@ public function withFeatureComponentAnalysis() {
         return $this->withCustomCommaSeparatedQuery("features", "component-analysis");
     }
 
+    /**
+     * withFeatureIanaTimeZone turns on the IANA timezone feature for the request.
+     */
+    public function withFeatureIanaTimeZone() {
+        return $this->withCustomCommaSeparatedQuery("features", "iana-timezone");
+    }
+
     public function buildUSAutocompleteProApiClient() {
         $this->ensureURLPrefixNotNull(self::US_AUTOCOMPLETE_PRO_API_URL);
         return new USAutoCompleteProApiClient($this->buildSender(), $this->serializer);

src/US_Street/Metadata.php

@@ -26,6 +26,9 @@ public function __construct($obj) {
         $this->timeZone = ArrayUtil::getField($obj, 'time_zone');
         $this->utcOffset = ArrayUtil::getField($obj, 'utc_offset');
         $this->obeysDst = ArrayUtil::getField($obj, 'dst');
+        $this->ianaTimeZone = ArrayUtil::getField($obj, 'iana_time_zone');
+        $this->ianaUtcOffset = ArrayUtil::getField($obj, 'iana_utc_offset');
+        $this->ianaObeysDst = ArrayUtil::getField($obj, 'iana_dst');
         $this->isEwsMatch = ArrayUtil::getField($obj, 'ews_match');
     }
 
@@ -45,6 +48,9 @@ public function __construct($obj) {
         $timeZone,
         $utcOffset,
         $obeysDst,
+        $ianaTimeZone,
+        $ianaUtcOffset,
+        $ianaObeysDst,
         $isEwsMatch;
 
     //region [ Getters ]
@@ -113,6 +119,18 @@ public function obeysDst() {
         return $this->obeysDst;
     }
 
+    public function getIanaTimeZone() {
+        return $this->ianaTimeZone;
+    }
+
+    public function getIanaUtcOffset() {
+        return $this->ianaUtcOffset;
+    }
+
+    public function obeysIanaDst() {
+        return $this->ianaObeysDst;
+    }
+
     public function isEwsMatch() {
         return $this->isEwsMatch;
     }

tests/ClientBuilderTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace SmartyStreets\PhpSdk\Tests;
+
+require_once(dirname(dirname(__FILE__)) . '/src/ClientBuilder.php');
+
+use SmartyStreets\PhpSdk\ClientBuilder;
+use PHPUnit\Framework\TestCase;
+
+class ClientBuilderTest extends TestCase {
+
+    public function testWithFeatureIANATimeZone() {
+        $builder = new ClientBuilder();
+        $builder->withFeatureIanaTimeZone();
+
+        $this->assertEquals('iana-timezone', $this->getCustomQuery($builder)['features']);
+    }
+
+    public function testWithFeatureIANATimeZoneAndComponentAnalysis_ShouldAppend() {
+        $builder = new ClientBuilder();
+        $builder->withFeatureComponentAnalysis();
+        $builder->withFeatureIanaTimeZone();
+
+        $this->assertEquals('component-analysis,iana-timezone', $this->getCustomQuery($builder)['features']);
+    }
+
+    private function getCustomQuery(ClientBuilder $builder) {
+        $reflection = new \ReflectionClass($builder);
+        $property = $reflection->getProperty('customQuery');
+        $property->setAccessible(true);
+        return $property->getValue($builder);
+    }
+}

tests/US_Street/CandidateTest.php

@@ -58,6 +58,9 @@ public function setUp() : void {
                 'time_zone' => '39',
                 'utc_offset' => 40.0,
                 'dst' => true,
+                'iana_time_zone' => 'America/Denver',
+                'iana_utc_offset' => -7.0,
+                'iana_dst' => true,
                 'ews_match' => true
             ),
             'analysis' => array(
@@ -144,6 +147,9 @@ public function testAllFieldsFilledCorrectly() {
         $this->assertEquals('39', $metadata->getTimeZone());
         $this->assertEquals(40.0, $metadata->getUtcOffset());
         $this->assertEquals(true, $metadata->obeysDst());
+        $this->assertEquals('America/Denver', $metadata->getIanaTimeZone());
+        $this->assertEquals(-7.0, $metadata->getIanaUtcOffset());
+        $this->assertEquals(true, $metadata->obeysIanaDst());
         $this->assertEquals(true, $metadata->isEwsMatch());
 
         $analysis = $candidate->getAnalysis();