Fix #3 - Add support for fcmOptions

Author: williamdes

src/Message/Options.php

@@ -69,6 +69,13 @@ class Options implements Arrayable
      */
     protected $directBootOk = false;
 
+    /**
+     * @internal
+     *
+     * @var string|null
+     */
+    protected $analyticsLabel = null;
+
     /**
      * Options constructor.
      *
@@ -85,6 +92,7 @@ public function __construct(OptionsBuilder $builder)
         $this->restrictedPackageName = $builder->getRestrictedPackageName();
         $this->isDryRun = $builder->isDryRun();
         $this->directBootOk = $builder->isDirectBootOk();
+        $this->analyticsLabel = $builder->getFcmOptionsAnalyticsLabel();
     }
 
     /**
@@ -99,6 +107,9 @@ public function toArray()
         $delayWhileIdle = $this->delayWhileIdle ? true : null;
         $dryRun = $this->isDryRun ? true : null;
         $directBootOk = $this->directBootOk ? true : null;
+        $fcmOptions = $this->analyticsLabel !== null ? [
+            'analytics_label' => $this->analyticsLabel
+        ] : null;
 
         $options = [
             'collapse_key' => $this->collapseKey,
@@ -110,6 +121,7 @@ public function toArray()
             'restricted_package_name' => $this->restrictedPackageName,
             'dry_run' => $dryRun,
             'direct_boot_ok' => $directBootOk,
+            'fcm_options' => $fcmOptions,
         ];
 
         return array_filter($options);

src/Message/OptionsBuilder.php

@@ -74,6 +74,13 @@ class OptionsBuilder
      */
     protected $directBootOk;
 
+    /**
+     * @internal
+     *
+     * @var string|null
+     */
+    protected $analyticsLabel = null;
+
     /**
      * This parameter identifies a group of messages
      * A maximum of 4 different collapse keys is allowed at any given time.
@@ -226,6 +233,22 @@ public function setDryRun($isDryRun)
         return $this;
     }
 
+    /**
+     * This parameter sets the Analytics label
+     *
+     * @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions
+     *
+     * @param string $analyticsLabel
+     *
+     * @return \LaravelFCM\Message\OptionsBuilder
+     */
+    public function setFcmOptionsAnalyticsLabel($analyticsLabel)
+    {
+        $this->analyticsLabel = $analyticsLabel;
+
+        return $this;
+    }
+
     /**
      * Get the collapseKey.
      *
@@ -246,6 +269,18 @@ public function getPriority()
         return $this->priority;
     }
 
+    /**
+     * Get the Analytics label
+     *
+     * @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidFcmOptions
+     *
+     * @return null|string
+     */
+    public function getFcmOptionsAnalyticsLabel()
+    {
+        return $this->analyticsLabel;
+    }
+
     /**
      * is content available.
      *

tests/MessageTest.php

@@ -80,7 +80,47 @@ public function testBuildOptionsDirectBootOk()
         $this->assertJsonStringEqualsJsonString($targetFull, $json);
     }
 
-    public function testItConstructAValidJson_with_data()
+    public function testBuildOptionsFcmOptionsAnalyticsLabel()
+    {
+        $targetPartial = '{
+					"direct_boot_ok": true,
+					"content_available":true
+				}';
+
+        $targetFull = '{
+					"collapse_key":"collapseKey",
+					"content_available":true,
+					"priority":"high",
+					"delay_while_idle":true,
+					"time_to_live":200,
+					"fcm_options": {
+            "analytics_label": "UA-xxxxxxx"
+          },
+					"dry_run": true,
+					"direct_boot_ok": true
+				}';
+
+        $optionBuilder = new OptionsBuilder();
+
+        $optionBuilder->setDirectBootOk(true);
+        $optionBuilder->setContentAvailable(true);
+
+        $json = json_encode($optionBuilder->build()->toArray());
+        $this->assertJsonStringEqualsJsonString($targetPartial, $json);
+        $this->assertNull($optionBuilder->getFcmOptionsAnalyticsLabel());
+        $optionBuilder->setPriority(OptionsPriorities::high)
+            ->setCollapseKey('collapseKey')
+            ->setDelayWhileIdle(true)
+            ->setDryRun(true)
+            ->setFcmOptionsAnalyticsLabel('UA-xxxxxxx')
+            ->setTimeToLive(200);
+
+        $this->assertSame('UA-xxxxxxx', $optionBuilder->getFcmOptionsAnalyticsLabel());
+        $json = json_encode($optionBuilder->build()->toArray());
+        $this->assertJsonStringEqualsJsonString($targetFull, $json);
+    }
+
+    public function testItConstructAValidJsonWithData()
     {
         $targetAdd = '{
 				"first_data":"first",