make refactoring code

Author: ogolub

README.md

@@ -21,9 +21,18 @@ or add
 
 to the require section of your `composer.json` file.
 
+Subsequently, run
+
+```
+./yii migrate/up --migrationPath=@vendor/avator/yii2-turbosms/migrations
+```
+
 ## Basic setup
 
-You should have registered account at http://turbosms.ua/
+You should:
+* registered account at http://turbosms.ua/
+* add sender in page https://turbosms.ua/sign/add.html
+* create login and password for soap api in page https://turbosms.ua/route.html
 
 ### Configuration
 
@@ -32,22 +41,22 @@ Add the following in your config:
 ```php
 <?php
 ...
-    'components'=>array(
+    'components' => [
         'turbosms' => [
             'class' => 'avator\turbosms\Turbosms',
             'sender' => 'your_sender',
             'login' => 'your_login',
             'password' => 'your_password',
         ],
         ...
-    ),
+    ],
 ...
 ```
 If you want test sms in debug mode change config:
 ```php
 <?php
 ...
-    'components'=>array(
+    'components' => [
         'turbosms' => [
             'class' => 'avator\turbosms\Turbosms',
             'sender' => 'your_sender',
@@ -56,7 +65,7 @@ If you want test sms in debug mode change config:
             'debug' => true,
         ],
         ...
-    ),
+    ],
 ...
 ```
 in debug mode sms not send only add to db table.
@@ -70,6 +79,12 @@ Once the extension is installed, simply use it in your code by  :
  <?php Yii::$app->turbosms->send('test', '+380XXXXXXXXX'); ?>
  ```
 
+TODO
+-----
+* Translate message
+* Down migration
+* Save log to file
+
 ## License
 
 **yii2-turbosms** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.

Turbosms.php

@@ -12,17 +12,20 @@
  *
  * @author AVATOR (Oleksii Golub) <sclub2018@yandex.ua>
  * @since 1.0
- *
  */
 class Turbosms extends Component
 {
 
     /**
+     * Soap login
+     *
      * @var string
      */
     public $login;
 
     /**
+     * Soap password
+     *
      * @var string
      */
     public $password;
@@ -33,58 +36,87 @@ class Turbosms extends Component
     public $sender;
 
     /**
+     * Debug mode
+     *
      * @var bool
      */
     public $debug = false;
 
+    /**
+     * @var SoapClient
+     */
     protected $client;
 
     /**
+     * Wsdl url
+     *
      * @var string
      */
     protected $wsdl = 'http://turbosms.in.ua/api/wsdl.html';
 
+    /**
+     * Debug suffix message
+     *
+     * @var string
+     */
+    public $debugSuffixMessage = ' (тестовый режим)';
+
+    /**
+     * Success message
+     *
+     * @var string
+     */
+    public $successMessage = 'Сообщения успешно отправлено';
+
+    /**
+     * Error message
+     *
+     * @var string
+     */
+    public $errorMessage = 'Сообщения не отправлено (ошибка: "%error%")';
+
+    /**
+     * Save to db log
+     *
+     * @var bool
+     */
+    public $saveToDb = true;
+
+    /**
+     * @var int
+     */
+    protected $sendStatus = 1;
+
     /**
      * Send sms
      *
-     * @param $text
+     * @param string $text
      * @param $phones
      *
      * @throws InvalidConfigException
      */
-    public function send($text, $phones) {
-
-        if (!$this->debug || !$this->client) {
-            $this->connect();
-        }
-
+    public function send($text, $phones)
+    {
         if (!is_array($phones)) {
             $phones = [$phones];
         }
         foreach ($phones as $phone) {
-
-            $message = 'Сообщения успешно отправлено';
-            if (!$this->debug) {
-                $result = $this->client->SendSMS([
-                    'sender' => $this->sender,
-                    'destination' => $phone,
-                    'text' => $text
-                ]);
-
-                if ($result->SendSMSResult->ResultArray[0] != 'Сообщения успешно отправлены') {
-                    $message = 'Сообщения не отправлено (ошибка: "' . $result->SendSMSResult->ResultArray[0] . '")';
-                }
+            if (!$phone) {
+                continue;
             }
-
+            $message = $this->sendMessage($text, $phone);
             $this->saveToDb($text, $phone, $message);
         }
     }
 
     /**
+     * Connetc to Turbosms by Soap
+     *
      * @return SoapClient
      * @throws InvalidConfigException
      */
-    protected function connect() {
+    protected function connect()
+    {
 
         if ($this->client) {
             return $this->client;
@@ -113,36 +145,95 @@ protected function connect() {
     /**
      * Save sms to db
      *
-     * @param $text
-     * @param $phone
-     * @param $message
+     * @param string $text
+     * @param string $phone
+     * @param string $message
+     *
+     * @return bool
      */
-    public function saveToDb($text, $phone, $message) {
+    public function saveToDb($text, $phone, $message)
+    {
+        if (!$this->saveToDb) {
+            return false;
+        }
+
         $model = new TurboSmsSent();
         $model->text = $text;
         $model->phone = $phone;
-        $model->status = $message . ($this->debug ? ' (тестовый режим)' : '');
+        $model->message = $message . ($this->debug ? $this->debugSuffixMessage : '');
+        $model->status = $this->sendStatus;
         $model->save();
+
+        return true;
     }
 
     /**
      * Get balance
      *
      * @return int
      */
-    public function getBalance() {
-        $result = $this->client->GetCreditBalance();
-        return intval($result->GetCreditBalanceResult);
+    public function getBalance()
+    {
+        return $this->debug ? 0 : intval($this->getClient()->GetCreditBalance()->GetCreditBalanceResult);
     }
 
     /**
+     * Get message status
+     *
      * @param $messageId
      *
-     * @return mixed
+     * @return string
      */
-    public function getMessageStatus($messageId) {
-        $result = $this->client->GetMessageStatus(['MessageId' => $messageId]);
+    public function getMessageStatus($messageId)
+    {
+        if ($this->debug || !$messageId) {
+            return'';
+        }
+        $result = $this->getClient()->GetMessageStatus(['MessageId' => $messageId]);
         return $result->GetMessageStatusResult;
     }
 
+    /**
+     * Get Soap client
+     *
+     * @return SoapClient
+     * @throws InvalidConfigException
+     */
+    protected function getClient()
+    {
+        if (!$this->client) {
+            return $this->connect();
+        }
+        return $this->client;
+    }
+
+    /**
+     * @param $text
+     * @param $phone
+     * @return string
+     */
+    protected function sendMessage($text, $phone)
+    {
+        $message = $this->successMessage;
+        // set default status
+        $this->sendStatus = 1;
+        if ($this->debug) {
+            return $message;
+        }
+
+        $result = $this->getClient()->SendSMS([
+            'sender' => $this->sender,
+            'destination' => $phone,
+            'text' => $text
+        ]);
+
+        if (empty($result->SendSMSResult->ResultArray[0]) ||
+            $result->SendSMSResult->ResultArray[0] != 'Сообщения успешно отправлены') {
+            $this->sendStatus = 0;
+            $message = preg_replace('/%error%/i', $result->SendSMSResult->ResultArray, $this->errorMessage);
+        }
+
+        return $message;
+    }
+
 }

migrations/m160117_203749_rename_and_create_field.php

@@ -0,0 +1,32 @@
+<?php
+
+use yii\db\Schema;
+use yii\db\Migration;
+
+class m160117_203749_rename_and_create_field extends Migration
+{
+    public function up()
+    {
+        $this->renameColumn('{{%turbo_sms_sent}}', 'status', 'message');
+        $this->addColumn('{{%turbo_sms_sent}}', 'status', Schema::TYPE_SMALLINT);
+
+    }
+
+    public function down()
+    {
+        echo "m160117_203749_rename_and_create_field cannot be reverted.\n";
+
+        return false;
+    }
+
+    /*
+    // Use safeUp/safeDown to run migration code within a transaction
+    public function safeUp()
+    {
+    }
+
+    public function safeDown()
+    {
+    }
+    */
+}

models/TurboSmsSent.php

@@ -11,10 +11,14 @@
  * @property string $date_sent
  * @property string $text
  * @property string $phone
+ * @property string $message
  * @property string $status
  */
 class TurboSmsSent extends \yii\db\ActiveRecord
 {
+    const STATUS_SUCCESS = 1;
+    const STATUS_ERROR = 0;
+
     /**
      * @inheritdoc
      */
@@ -31,7 +35,8 @@ public function rules()
         return [
             [['date_sent'], 'safe'],
             [['text'], 'string'],
-            [['phone', 'status'], 'string', 'max' => 255]
+            [['phone', 'message'], 'string', 'max' => 255],
+            [['phone', 'status'], 'integer']
         ];
     }
 
@@ -45,6 +50,7 @@ public function attributeLabels()
             'date_sent' => Yii::t('app', 'Date Sent'),
             'text' => Yii::t('app', 'Text'),
             'phone' => Yii::t('app', 'Phone'),
+            'message' => Yii::t('app', 'Message'),
             'status' => Yii::t('app', 'Status'),
         ];
     }