Merge pull request #4 from tylercd100/clickatell

Clickatell Support
tylercd100 · May 1, 2017 · 66d2592 · 66d2592
2 parents 5c10856 + 6838578
commit 66d2592
Show file tree

Hide file tree

Showing 10 changed files with 238 additions and 24 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 build
 composer.lock
 vendor
-run.php
+run.php
+ubuntu-xenial-16.04-cloudimg-console.log
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 All notable changes to `Monolog SMS` will be documented in this file.
 
+### 1.3.0
+- Added support for Clickatell
+
 ### 1.2.0
 - Added character limit
 

diff --git a/README.md b/README.md
@@ -10,8 +10,9 @@
 A Monolog Handler for SMS messaging services
 
 Currently supported
-- [Plivo](https://www.plivo.com/)
 - [Twilio](https://www.twilio.com/)
+- [Clickatell](https://www.clickatell.com/)
+- [Plivo](https://www.plivo.com/)
 
 ## Installation
 
@@ -26,7 +27,7 @@ For Plivo:
 use Tylercd100\Monolog\Handler\PlivoHandler;
 
 $handler = new PlivoHandler($token,$auth_id,$fromPhoneNumber,$toPhoneNumber);
-$logger  = new Monolog\Logger('plivo.example');
+$logger  = new Monolog\Logger('channel.name');
 $logger->pushHandler($handler);
 $logger->addCritical("Foo Bar!");
 ```
@@ -36,7 +37,17 @@ For Twilio:
 use Tylercd100\Monolog\Handler\TwilioHandler;
 
 $handler = new TwilioHandler($secret,$sid,$fromPhoneNumber,$toPhoneNumber);
-$logger  = new Monolog\Logger('plivo.example');
+$logger  = new Monolog\Logger('channel.name');
 $logger->pushHandler($handler);
 $logger->addCritical("Foo Bar!");
 ```
+
+For Clickatell:
+```php
+use Tylercd100\Monolog\Handler\ClickatellHandler;
+
+$handler = new ClickatellHandler($authToken,$fromPhoneNumber (/*Optional*/),$toPhoneNumber (/*String|Array*/));
+$logger  = new Monolog\Logger('channel.name');
+$logger->pushHandler($handler);
+$logger->addCritical("Foo Bar!");
+```
diff --git a/composer.json b/composer.json
@@ -1,12 +1,13 @@
 {
     "name": "tylercd100/monolog-sms",
-    "description": "A Monolog Handler for SMS messaging services such as Plivo and Twilio.",
+    "description": "A Monolog Handler for SMS messaging services such as Twilio, Clickatell and Plivo.",
     "keywords": [
+        "clickatell",
+        "composer",
+        "handler",
         "monolog",
         "plivo",
         "twilio",
-        "handler",
-        "composer",
         "tylercd100"
     ],
     "homepage": "https://github.com/tylercd100/monolog-sms",

diff --git a/src/Formatter/SMSFormatter.php b/src/Formatter/SMSFormatter.php
@@ -22,4 +22,4 @@ public function __construct($format = null, $allowInlineLineBreaks = false, $ign
         $dateFormat = null;
         parent::__construct($format, $dateFormat, $allowInlineLineBreaks, $ignoreEmptyContextAndExtra);
     }
-}
+}
diff --git a/src/Handler/ClickatellHandler.php b/src/Handler/ClickatellHandler.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Tylercd100\Monolog\Handler;
+
+use Exception;
+use Monolog\Logger;
+
+/**
+* Clickatell - Monolog Handler
+* @url https://www.clickatell.com/developers/api-documentation/rest-api-request-parameters
+*/
+class ClickatellHandler extends SMSHandler
+{
+    /**
+     * API version 1
+     */
+    const API_V1 = '2010-04-01';
+
+    /**
+     * @param string $secret     Twilio API Secret Token
+     * @param string $fromNumber The phone number that will be shown as the sender ID
+     * @param string $toNumber   The phone number to which the message will be sent
+     * @param int    $level      The minimum logging level at which this handler will be triggered
+     * @param bool   $bubble     Whether the messages that are handled can bubble up the stack or not
+     * @param bool   $useSSL     Whether to connect via SSL.
+     * @param string $host       The Twilio server hostname.
+     * @param string $version    The Twilio API version (default ClickatellHandler::API_V1)
+     * @param int    $limit      The character limit
+     */
+    public function __construct($secret, $fromNumber, $toNumber, $level = Logger::CRITICAL, $bubble = true, $useSSL = true, $host = 'platform.clickatell.com', $version = self::API_V1, $limit = 160)
+    {
+        if ($version !== self::API_V1) {
+            throw new Exception("API Version \'{$version}\' is not supported!");
+        }
+        parent::__construct($secret, null, $fromNumber, $toNumber, $level, $bubble, $useSSL, $host, $version, $limit);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  array  $record
+     * @return string
+     */
+    protected function buildContent($record)
+    {
+        if (strlen($record['formatted']) > $this->limit) {
+            $record['formatted'] = substr($record['formatted'], 0, $this->limit);
+        }
+
+        $dataArray = [
+            'content' => $record['formatted'],
+            'to' => (!is_array($this->toNumber)? [$this->toNumber] : $this->toNumber)
+        ];
+
+        ($this->fromNumber)? $dataArray['from'] = $this->fromNumber : false;
+
+        return json_encode($dataArray);
+    }
+
+    /**
+     * Builds the URL for the API call
+     *
+     * @return string
+     */
+    protected function buildRequestUrl()
+    {
+        return "POST /messages HTTP/1.1\r\n";
+    }
+}
diff --git a/src/Handler/PlivoHandler.php b/src/Handler/PlivoHandler.php
@@ -26,11 +26,11 @@ class PlivoHandler extends SMSHandler
      * @param bool   $useSSL     Whether to connect via SSL.
      * @param string $host       The Plivo server hostname.
      * @param string $version    The Plivo API version (default PlivoHandler::API_V1)
-     * @param string $limit      The character limit
+     * @param int    $limit      The character limit
      */
     public function __construct($authToken, $authId, $fromNumber, $toNumber, $level = Logger::CRITICAL, $bubble = true, $useSSL = true, $host = 'api.plivo.com', $version = self::API_V1, $limit = 160)
     {
-        if($version !== self::API_V1){
+        if ($version !== self::API_V1) {
             throw new Exception('API Version \'{$version}\' is not supported!');
         }
         parent::__construct($authToken, $authId, $fromNumber, $toNumber, $level, $bubble, $useSSL, $host, $version, $limit);
@@ -43,7 +43,7 @@ public function __construct($authToken, $authId, $fromNumber, $toNumber, $level
      */
     protected function buildContent($record)
     {
-        if(strlen($record['formatted']) > $this->limit){
+        if (strlen($record['formatted']) > $this->limit) {
             $record['formatted'] = substr($record['formatted'], 0, $this->limit);
         }
 
@@ -57,7 +57,7 @@ protected function buildContent($record)
 
     /**
      * Builds the URL for the API call
-     * 
+     *
      * @return string
      */
     protected function buildRequestUrl()

diff --git a/src/Handler/SMSHandler.php b/src/Handler/SMSHandler.php
@@ -40,6 +40,11 @@ abstract class SMSHandler extends SocketHandler
      */
     protected $version;
 
+    /**
+     * @var integer
+     */
+    protected $limit;
+
     /**
      * @param string $authToken  Plivo API Auth Token
      * @param string $authId     Plivo API Auth ID
@@ -50,12 +55,11 @@ abstract class SMSHandler extends SocketHandler
      * @param bool   $useSSL     Whether to connect via SSL.
      * @param string $host       The Plivo server hostname.
      * @param string $version    The Plivo API version (default PlivoHandler::API_V1)
-     * @param string $limit      The character limit
+     * @param int    $limit      The character limit
      */
     public function __construct($authToken, $authId, $fromNumber, $toNumber, $level = Logger::CRITICAL, $bubble = true, $useSSL = true, $host = 'api.plivo.com', $version = null, $limit = 160)
     {
-
-        if(empty($version)){
+        if (empty($version)) {
             throw new Exception('API Version is empty');
         }
 
@@ -69,7 +73,6 @@ public function __construct($authToken, $authId, $fromNumber, $toNumber, $level
         $this->host       = $host;
         $this->version    = $version;
         $this->limit      = $limit;
-
     }
 
     /**
@@ -94,7 +97,7 @@ abstract protected function buildContent($record);
 
     /**
      * Builds the URL for the API call
-     * 
+     *
      * @return string
      */
     abstract protected function buildRequestUrl();
@@ -107,12 +110,16 @@ abstract protected function buildRequestUrl();
      */
     private function buildHeader($content)
     {
-        $auth = base64_encode($this->authId.":".$this->authToken);
+        $auth = $this->authToken;
+
+        if ($this->authId) {
+            $auth = "Basic " . base64_encode($this->authId.":".$this->authToken);
+        }
 
         $header = $this->buildRequestUrl();
 
         $header .= "Host: {$this->host}\r\n";
-        $header .= "Authorization: Basic ".$auth."\r\n";;
+        $header .= "Authorization: ".$auth."\r\n";
         $header .= "Content-Type: application/json\r\n";
         $header .= "Content-Length: " . strlen($content) . "\r\n";
         $header .= "\r\n";
@@ -139,4 +146,4 @@ protected function getDefaultFormatter()
     {
         return new SMSFormatter();
     }
-}
+}
diff --git a/src/Handler/TwilioHandler.php b/src/Handler/TwilioHandler.php
@@ -26,11 +26,11 @@ class TwilioHandler extends SMSHandler
      * @param bool   $useSSL     Whether to connect via SSL.
      * @param string $host       The Twilio server hostname.
      * @param string $version    The Twilio API version (default TwilioHandler::API_V1)
-     * @param string $limit      The character limit
+     * @param int    $limit      The character limit
      */
     public function __construct($secret, $sid, $fromNumber, $toNumber, $level = Logger::CRITICAL, $bubble = true, $useSSL = true, $host = 'api.twilio.com', $version = self::API_V1, $limit = 160)
     {
-        if($version !== self::API_V1){
+        if ($version !== self::API_V1) {
             throw new Exception('API Version \'{$version}\' is not supported!');
         }
         parent::__construct($secret, $sid, $fromNumber, $toNumber, $level, $bubble, $useSSL, $host, $version, $limit);
@@ -44,7 +44,7 @@ public function __construct($secret, $sid, $fromNumber, $toNumber, $level = Logg
      */
     protected function buildContent($record)
     {
-        if(strlen($record['formatted']) > $this->limit){
+        if (strlen($record['formatted']) > $this->limit) {
             $record['formatted'] = substr($record['formatted'], 0, $this->limit);
         }
 
@@ -58,7 +58,7 @@ protected function buildContent($record)
 
     /**
      * Builds the URL for the API call
-     * 
+     *
      * @return string
      */
     protected function buildRequestUrl()
-Original file line number
+Diff line change
@@ Expand Up @@
             $dateFormat = null;
             parent::__construct($format, $dateFormat, $allowInlineLineBreaks, $ignoreEmptyContextAndExtra);
         }
-    }
+    }