Add tariff method

Author: mbardelmeijer

README.md

@@ -104,6 +104,7 @@ public function routeNotificationForCmsms()
 - `body('')`: Accepts a string value for the message body.
 - `originator('')`: Accepts a string value between 1 and 11 characters, used as the message sender name.
 - `reference('')`: Accepts a string value for your message reference. This information will be returned in a status report so you can match the message and it's status. Restrictions: 1 - 32 alphanumeric characters and reference will not work for demo accounts.
+- `tariff()`: Accepts a integer value for your message tariff. The unit is eurocent. Requires the `originator` to be set to a specific value. Contact CM for this value and to enable this feature for your contract.
 
 ## Changelog
 

src/CmsmsMessage.php

@@ -15,6 +15,9 @@ class CmsmsMessage
     /** @var string */
     protected $reference;
 
+    /** @var int */
+    protected $tariff;
+
     /**
      * @param string $body
      */
@@ -66,6 +69,22 @@ public function reference($reference)
         return $this;
     }
 
+    /**
+     * @param int $tariff Tariff in eurocent
+     * @return $this
+     * @throws InvalidMessage
+     */
+    public function tariff($tariff)
+    {
+        if (empty($tariff) || ! is_int($tariff)) {
+            throw InvalidMessage::invalidTariff($tariff);
+        }
+
+        $this->tariff = $tariff;
+
+        return $this;
+    }
+
     /**
      * @return array
      */
@@ -75,6 +94,7 @@ public function toXmlArray()
             'BODY' => $this->body,
             'FROM' => $this->originator,
             'REFERENCE' => $this->reference,
+            'TARIFF' => $this->tariff,
         ]);
     }
 

src/Exceptions/InvalidMessage.php

@@ -23,4 +23,13 @@ public static function invalidOriginator($originator)
     {
         return new static("The originator on the CMSMS message may only contain 1 - 11 characters. Was given '{$originator}'");
     }
+
+    /**
+     * @param int $tariff
+     * @return static
+     */
+    public static function invalidTariff($tariff)
+    {
+        return new static("The tarrif on the CMSMS message may only contain a nonzero integer. Was given '{$tariff}'");
+    }
 }

tests/CmsmsMessageTest.php

@@ -97,6 +97,30 @@ public function it_cannot_set_a_reference_that_contains_non_alpha_numeric_values
         (new CmsmsMessage)->reference('@#$*A*Sjks87');
     }
 
+    /** @test */
+    public function is_can_set_tariff()
+    {
+        $message = (new CmsmsMessage)->tariff(12);
+
+        $this->assertEquals(12, Arr::get($message->toXmlArray(), 'TARIFF'));
+    }
+
+    /** @test */
+    public function it_cannot_set_an_empty_tariff()
+    {
+        $this->setExpectedException(InvalidMessage::class);
+
+        (new CmsmsMessage)->tariff(0);
+    }
+
+    /** @test */
+    public function it_cannot_set_a_float_to_tariff()
+    {
+        $this->setExpectedException(InvalidMessage::class);
+
+        (new CmsmsMessage)->tariff(2.5);
+    }
+
     /** @test */
     public function it_xml_contains_only_filled_parameters()
     {