Set feature flag to enable/disable sending SMS (#9)

If the flag is set to false, SMS details will be logged using LogAdapter.

Author: vigneshgurusamy

src/Adapters/Log/LogAdapter.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Linkstreet\LaravelSms\Adapters\Log;
+
+use Illuminate\Support\Facades\Log;
+use Linkstreet\LaravelSms\Contracts\AdapterInterface;
+use Linkstreet\LaravelSms\Contracts\ResponseInterface;
+use Linkstreet\LaravelSms\Model\Device;
+
+class LogAdapter implements AdapterInterface
+{
+    public function send(Device $device, string $message): ResponseInterface
+    {
+        Log::debug('SMS', [
+            'device' => $device->toArray(),
+            'message' => $message,
+        ]);
+
+        return new LogResponse($device, $message);
+    }
+}

src/Adapters/Log/LogResponse.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Linkstreet\LaravelSms\Adapters\Log;
+
+use Linkstreet\LaravelSms\Contracts\ResponseInterface;
+use Linkstreet\LaravelSms\Model\Device;
+
+class LogResponse implements ResponseInterface
+{
+    private Device $device;
+    private string $message;
+
+    public function __construct(Device $device, string $message)
+    {
+        $this->device = $device;
+        $this->message = $message;
+    }
+
+    public function getStatusCode(): int
+    {
+        return 200;
+    }
+
+    public function getResponse()
+    {
+        return (object)[
+            'device' => $this->device->toArray(),
+            'message' => $this->message,
+            'debug' => 'Mocked success response',
+        ];
+    }
+
+    public function getRaw()
+    {
+        return $this;
+    }
+
+    public function isSuccess(): bool
+    {
+        return true;
+    }
+
+    public function isFailure(): bool
+    {
+        return !$this->isSuccess();
+    }
+
+    public function getErrorCode()
+    {
+        return '';
+    }
+
+    public function getErrorMessage()
+    {
+        return '';
+    }
+
+    public function getReasonPhrase()
+    {
+        return '';
+    }
+}

src/Config/config.php

@@ -13,6 +13,7 @@
     | Supported adapter: twilio, kap
     |
     */
+    'enabled' => env('SMS_ENABLED', true),
 
     'default' => 'kap',
 

src/Model/Device.php

@@ -52,16 +52,16 @@ public function getCountryIso(): string
      * Get device number without plus sign
      * @return string
      */
-    public function getNumberWithoutPlusSign()
+    public function getNumberWithoutPlusSign(): string
     {
         return ltrim($this->getNumber(), '+');
     }
 
     /**
      * @return array
      */
-    public function toArray()
+    public function toArray(): array
     {
-        return array($this);
+        return get_object_vars($this);
     }
 }

src/SmsManager.php

@@ -3,6 +3,7 @@
 namespace Linkstreet\LaravelSms;
 
 use Linkstreet\LaravelSms\Adapters\Adapter;
+use Linkstreet\LaravelSms\Adapters\Log\LogAdapter;
 use Linkstreet\LaravelSms\Contracts\AdapterInterface;
 use Linkstreet\LaravelSms\Contracts\ResponseInterface;
 use Linkstreet\LaravelSms\Exceptions\AdapterException;
@@ -177,6 +178,10 @@ public function resolveConnection(Device $device): string
      */
     public function getAdapter(string $connection): AdapterInterface
     {
+        if (false == $this->config['enabled']) {
+            return new LogAdapter();
+        }
+
         $properties = $this->config['connections'][$connection];
 
         $class = Adapter::find($properties['adapter']);
@@ -191,7 +196,7 @@ public function toArray(): array
     {
         return [
             'connection' => $this->connection,
-            'device' => is_null($this->device) ?: $this->device->toArray(),
+            'device' => $this->device,
         ];
     }
 }

tests/SmsManagerTest.php

@@ -3,6 +3,7 @@
 namespace Linkstreet\LaravelSms\Tests;
 
 use Linkstreet\LaravelSms\Adapters\Adapter;
+use Linkstreet\LaravelSms\Adapters\Log\LogAdapter;
 use Linkstreet\LaravelSms\Exceptions\AdapterException;
 use Linkstreet\LaravelSms\Model\Device;
 use Linkstreet\LaravelSms\SmsManager;
@@ -52,7 +53,7 @@ public function setDevice()
         $device = new Device('+10123456789', 'US');
 
         $manager = new SmsManager($this->config);
-        $m_device = $manager->to($device)->toArray()['device'][0];
+        $m_device = $manager->to($device)->toArray()['device'];
 
         $this->assertSame($m_device->getNumber(), $device->getNumber());
         $this->assertSame($m_device->getCountryIso(), $device->getCountryIso());
@@ -83,12 +84,20 @@ public function returnsConnectionAdapter()
     {
         $manager = new SmsManager($this->config);
 
-        $manager->to(new Device('+10123456789', 'US'));
-
         $adapter = $manager->getAdapter($this->config['default']);
 
         $default_adapter = $this->config['connections'][$this->config['default']]['adapter'];
 
         $this->assertInstanceOf(Adapter::find($default_adapter), $adapter);
     }
+
+    /** @test */
+    public function returnsLogAdapter()
+    {
+        $manager = new SmsManager(array_merge($this->config, ['enabled' => false]));
+
+        $adapter = $manager->getAdapter($this->config['default']);
+
+        $this->assertInstanceOf(LogAdapter::class, $adapter);
+    }
 }