Merge pull request dekalee#13 from danielfh/unset-fields

Allow to unset fields

Author: nicolasThal

src/AutopilotContact.php

@@ -200,11 +200,6 @@ public function toRequest($prependKey = true)
 
         /** @var AutopilotField $field */
         foreach($this->fields as $field) {
-            //TODO: how do you "unset" fields with Autopilot? Their API doesn't say anything about it
-            if ($field->getValue() === null) {
-                continue;
-            }
-
             if (! $field->isReserved()) {
                 $result['custom'][$field->formatName()] = $field->getValue();
             } else {
@@ -246,4 +241,4 @@ function jsonSerialize()
     {
         return $this->toArray();
     }
-}
+}

src/AutopilotField.php

@@ -229,7 +229,7 @@ public function setValue($value)
         }
 
         // type of field is set in the constructor
-        if ($this->getType() !== $type) {
+        if (($this->getType() !== $type) && !is_null($value)) {
             throw AutopilotException::typeMismatch($this->getType(), $type);
         }
 

tests/unit/AutopilotContactCest.php

@@ -163,6 +163,55 @@ public function testContactToRequest(UnitTester $I)
         $I->assertEquals($expected['contact'], $contact->toRequest($prependKey = false));
     }
 
+    public function testContactFieldsCanBeCleared(UnitTester $I)
+    {
+        $I->wantTo('clear contact fields');
+
+        $values = [
+            'FirstName'               => null,
+            'LastName'                => null,
+            'custom_fields' => [
+                [
+                    'kind'      => 'Age',
+                    'value'     => null,
+                    'fieldType' => 'integer',
+                ],
+                [
+                    'kind'      => 'Birthday',
+                    'value'     => null,
+                    'fieldType' => 'date',
+                ],
+                [
+                    'kind'      => 'Category',
+                    'value'     => null,
+                    'fieldType' => 'string',
+                ],
+                [
+                    'kind'      => 'Completed Status',
+                    'value'     => null,
+                    'fieldType' => 'float',
+                ],
+            ],
+        ];
+
+        $contact = new AutopilotContact($values);
+
+        $expected = [
+            'contact' => [
+                'FirstName' => null,
+                'LastName'  => null,
+                'custom'    => [
+                    'integer--Age'             => null,
+                    'date--Birthday'           => null,
+                    'string--Category'         => null,
+                    'float--Completed--Status' => null,
+                ],
+            ],
+        ];
+        
+        $I->assertEquals($expected, $contact->toRequest());
+    }
+
     public function testContactMagicGettersAndSetters(UnitTester $I)
     {
         $I->wantTo('set and get values using magic methods');