Add multipart option

Author: mbardelmeijer

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `CMSMS` will be documented in this file
 
+## [0.0.3] - 2016-09-12
+#### Added
+- Added `multipart` method for `CmsmsMessage`.
+
 ## [0.0.2] - 2016-09-04
 #### Added
 - Added `tariff` method for `CmsmsMessage`.

README.md

@@ -105,6 +105,7 @@ public function routeNotificationForCmsms()
 - `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.
+- `multipart($minimum, $maximum)`: Accepts a 0 to 8 integer range which allows multipart messages. See the [documentation from CM](https://dashboard.onlinesmsgateway.com/docs#send-a-message-multipart) for more information.
 
 ## Changelog
 

src/CmsmsMessage.php

@@ -18,6 +18,12 @@ class CmsmsMessage
     /** @var int */
     protected $tariff;
 
+    /** @var int */
+    protected $minimumNumberOfMessageParts;
+
+    /** @var int */
+    protected $maximumNumberOfMessageParts;
+
     /**
      * @param string $body
      */
@@ -85,6 +91,24 @@ public function tariff($tariff)
         return $this;
     }
 
+    /**
+     * @param int $minimum
+     * @param int $maximum
+     * @return $this
+     * @throws InvalidMessage
+     */
+    public function multipart($minimum, $maximum)
+    {
+        if (! is_int($minimum) || ! is_int($maximum) || $maximum > 8 || $minimum >= $maximum) {
+            throw InvalidMessage::invalidMessageParts($minimum, $maximum);
+        }
+
+        $this->minimumNumberOfMessageParts = $minimum;
+        $this->maximumNumberOfMessageParts = $maximum;
+
+        return $this;
+    }
+
     /**
      * @return array
      */
@@ -95,6 +119,8 @@ public function toXmlArray()
             'FROM' => $this->originator,
             'REFERENCE' => $this->reference,
             'TARIFF' => $this->tariff,
+            'MINIMUMNUMBEROFMESSAGEPARTS' => $this->minimumNumberOfMessageParts,
+            'MAXIMUMNUMBEROFMESSAGEPARTS' => $this->maximumNumberOfMessageParts,
         ]);
     }
 

src/Exceptions/InvalidMessage.php

@@ -32,4 +32,14 @@ public static function invalidTariff($tariff)
     {
         return new static("The tarrif on the CMSMS message may only contain a nonzero integer. Was given '{$tariff}'");
     }
+
+    /**
+     * @param int $minimum
+     * @param int $maximum
+     * @return static
+     */
+    public static function invalidMessageParts($minimum, $maximum)
+    {
+        return new static("The number of message parts on the CMSMS message may only contain a integer range from 0 to 8. Was given a minimum of '{$minimum}' and maximum of '{$maximum}'");
+    }
 }

tests/CmsmsMessageTest.php

@@ -98,7 +98,7 @@ public function it_cannot_set_a_reference_that_contains_non_alpha_numeric_values
     }
 
     /** @test */
-    public function is_can_set_tariff()
+    public function it_can_set_tariff()
     {
         $message = (new CmsmsMessage)->tariff(12);
 
@@ -121,6 +121,39 @@ public function it_cannot_set_a_float_to_tariff()
         (new CmsmsMessage)->tariff(2.5);
     }
 
+    /** @test */
+    public function it_can_set_multipart()
+    {
+        $message = (new CmsmsMessage)->multipart(1, 4);
+
+        $this->assertEquals(1, Arr::get($message->toXmlArray(), 'MINIMUMNUMBEROFMESSAGEPARTS'));
+        $this->assertEquals(4, Arr::get($message->toXmlArray(), 'MAXIMUMNUMBEROFMESSAGEPARTS'));
+    }
+
+    /** @test */
+    public function it_cannot_set_a_float_to_multipart()
+    {
+        $this->setExpectedException(InvalidMessage::class);
+
+        (new CmsmsMessage)->multipart(1.3, 4.8);
+    }
+
+    /** @test */
+    public function it_cannot_have_more_than_8_parts()
+    {
+        $this->setExpectedException(InvalidMessage::class);
+
+        (new CmsmsMessage)->multipart(1, 9);
+    }
+
+    /** @test */
+    public function it_cannot_have_a_higher_minimum_than_maximum_for_multipart()
+    {
+        $this->setExpectedException(InvalidMessage::class);
+
+        (new CmsmsMessage)->multipart(4, 3);
+    }
+
     /** @test */
     public function it_xml_contains_only_filled_parameters()
     {