Configuration updates

Author: scaytrase

.gitignore

@@ -7,4 +7,4 @@ composer.lock
 target/
 vendor/
 bin/
-build/
+build/

LICENSE

@@ -336,4 +336,4 @@ This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
+Public License instead of this License.

README.md

@@ -1,11 +1,15 @@
-
 # scaytrase/symfony-sms-delivery-bundle
-[![Latest Stable Version](https://poser.pugx.org/scaytrase/symfony-sms-interface/v/stable.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface) [![Total Downloads](https://poser.pugx.org/scaytrase/symfony-sms-interface/downloads.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface) [![Latest Unstable Version](https://poser.pugx.org/scaytrase/symfony-sms-interface/v/unstable.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface) [![License](https://poser.pugx.org/scaytrase/symfony-sms-interface/license.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
+[![Latest Stable Version](https://poser.pugx.org/scaytrase/symfony-sms-interface/v/stable.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
+[![Total Downloads](https://poser.pugx.org/scaytrase/symfony-sms-interface/downloads.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
+[![Latest Unstable Version](https://poser.pugx.org/scaytrase/symfony-sms-interface/v/unstable.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
+[![License](https://poser.pugx.org/scaytrase/symfony-sms-interface/license.svg)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
 
 [![Monthly Downloads](https://poser.pugx.org/scaytrase/symfony-sms-interface/d/monthly.png)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
 [![Daily Downloads](https://poser.pugx.org/scaytrase/symfony-sms-interface/d/daily.png)](https://packagist.org/packages/scaytrase/symfony-sms-interface)
 
-This Symfony2 bundle provides basic service for sending short messages. This bundle does not provide you any finished implementation for communicating the SMS gateway. To use it you have use some transport implementation or implemenent a transport on your own. See [usage section](#Usage) for known implementations
+This Symfony bundle provides basic service for sending short messages. This bundle does not provide you any finished
+implementation for communicating the SMS gateway. To use it you have use some transport implementation or
+implement a transport on your own. See [usage section](#Usage) for known implementations
 
 ## Features
 
@@ -47,22 +51,50 @@ Below is the configuration example and their default values
 
 ```yaml
 sms_delivery:
+    spool: sms_delivery.spool.instant
     transport: sms_delivery.dummy_sender # @id of the transport service 
-    disable_delivery: false # disables actual delivery making every send return successful result. use profiler to get message details
-    delivery_recipient: null # when not null - sends every message to the specified recipient, ignoring actual recipient of the message.
+    disable_delivery: false # disable delivery overrides spool with disabled spool
+    delivery_recipient: null # delivery recipient overrides recipient when sending
 ```
 
 ## Usage
 
-To use this interface you must create a message class implementing  ``ShortMessageInterface`` and implement a transport that delivers your message to end point sms gateway. You can refer my [WebSMS](https://github.com/scaytrase/symfony-websms-bundle) gateway implementation as a reference.
+To use this interface you must create a message class implementing  ``ShortMessageInterface`` and create the implementation of the
+``TransportInterface`` that delivers your message to end point sms gateway.
+You can refer my [WebSMS](https://github.com/scaytrase/symfony-websms-bundle) gateway implementation as a reference.
  
  
 ### Example
 
-```php 
+```php
+class MyMessage implements ShortMessageInterface { /*...*/ }
+
+class SmsController extends Controller {
+
 public function sendSmsAction(){
-  $message = new YourMessage('5552368','Help!')
-  $result = $this->get('sms_delivery.sender')->send($message);
-  return new Response('Delivery '. $result ? 'successful' ; 'failed');
+  $message = new MyMessage('5552368','Help!')
+  $sender = $this->get('sms_delivery.sender');
+  $sender->spoolMessage($message);
+  $result = $sender->flush();
+  return new Response('Delivery '. $result ? 'successful' : 'failed');
 }
 ```
+
+
+### Standalone usage
+
+Despite of the fact that this library is designed as Symfony bundle it could be used as standalone library for sending
+short messages. You should just instantiate sender service on your own.
+
+```php
+
+    class MyProviderSmsTransport implements TransportInterface { /*...*/ }
+
+    class MyMessage implements ShortMessageInterface { /*...*/ }
+
+    $transport = new MyProviderSmsTransport();
+    $sender = new MessageDeliveryService($transport);
+    $sender->spoolMessage(new MyMessage('Message body'));
+    $sender->flush(); // Default InstantSpool does not actually needs flushing but you can use another spool instead
+
+```

src/ScayTrase/SmsDeliveryBundle/DependencyInjection/Compiler/SpoolCompilerPass.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: batanov.pavel
+ * Date: 21.07.2015
+ * Time: 16:26
+ */
+
+namespace ScayTrase\SmsDeliveryBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class SpoolCompilerPass implements CompilerPassInterface
+{
+
+    /**
+     * You can modify the container here before it is dumped to PHP code.
+     *
+     * @param ContainerBuilder $container
+     *
+     * @api
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition('sms_delivery.sender')) {
+            return;
+        }
+
+        $sender = $container->getDefinition('sms_delivery.sender');
+
+        if (
+            $container->hasParameter('sms_delivery.disable_delivery') &&
+            $container->getParameter('sms_delivery.disable_delivery') === true &&
+            $container->hasDefinition('sms_delivery.spool.disabled')
+        ) {
+            $sender->replaceArgument(1, $container->getDefinition('sms_delivery.spool.disabled'));
+        } else {
+            $spool = $container->getDefinition($container->getParameter('sms_delivery.spool'));
+            $sender->replaceArgument(1, $spool);
+        }
+    }
+}

src/ScayTrase/SmsDeliveryBundle/DependencyInjection/Compiler/TransportCompilerPass.php

@@ -10,6 +10,7 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 
 class TransportCompilerPass implements CompilerPassInterface
 {
@@ -23,14 +24,27 @@ class TransportCompilerPass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
-        $container->getDefinition('sms_delivery.sender')->replaceArgument(
-            0,
-            $container->getDefinition($container->getParameter('sms_delivery.transport'))
-        );
+        if (!$container->hasDefinition('sms_delivery.sender')) {
+            return;
+        }
 
-        $container->getDefinition('sms_delivery.sender')->replaceArgument(
-            1,
-            $container->getDefinition($container->getParameter('sms_delivery.spool'))
-        );
+        $sender = $container->getDefinition('sms_delivery.sender');
+
+        $transport = $container->getDefinition($container->getParameter('sms_delivery.transport'));
+        if (
+            $container->hasParameter('sms_delivery.delivery_recipient') &&
+            $container->getParameter('sms_delivery.delivery_recipient') !== null
+        ) {
+            $overrideTransport = new Definition('ScayTrase\SmsDeliveryBundle\Transport\OverrideRecipientTransport');
+            $overrideTransport->setArguments(
+                array(
+                    $transport,
+                    $container->getParameter('sms_delivery.delivery_recipient')
+                )
+            );
+            $sender->replaceArgument(0, $overrideTransport);
+        } else {
+            $sender->replaceArgument(0, $transport);
+        }
     }
 }

src/ScayTrase/SmsDeliveryBundle/Service/MessageDeliveryService.php

@@ -8,7 +8,6 @@
 
 namespace ScayTrase\SmsDeliveryBundle\Service;
 
-use ScayTrase\SmsDeliveryBundle\Spool\DisabledSpool;
 use ScayTrase\SmsDeliveryBundle\Spool\InstantSpool;
 use ScayTrase\SmsDeliveryBundle\Spool\Package;
 use ScayTrase\SmsDeliveryBundle\Spool\SpoolInterface;
@@ -23,10 +22,6 @@ class MessageDeliveryService
 {
     /** @var  TransportInterface */
     protected $transport;
-    /** @var  boolean */
-    private $deliveryDisabled;
-    /** @var  string */
-    private $recipientOverride;
     /** @var  Package[] */
     private $profile = array();
     /** @var SpoolInterface */
@@ -35,22 +30,13 @@ class MessageDeliveryService
     /**
      * @param TransportInterface $transport
      * @param SpoolInterface $spool
-     * @param bool $deliveryDisabled
-     * @param null|string $recipientOverride
      */
-    public function __construct(
-        TransportInterface $transport,
-        SpoolInterface $spool = null,
-        $deliveryDisabled = false,
-        $recipientOverride = null
-    )
+    public function __construct(TransportInterface $transport, SpoolInterface $spool = null)
     {
         $this->transport = $transport;
         $this->spool = $spool;
-        $this->deliveryDisabled = $deliveryDisabled;
-        $this->recipientOverride = $recipientOverride;
         if (!$this->spool) {
-            $this->spool = $this->deliveryDisabled ? new DisabledSpool() : new InstantSpool();
+            $this->spool = new InstantSpool();
         }
     }
 
@@ -60,10 +46,6 @@ public function __construct(
      */
     public function spoolMessage(ShortMessageInterface $message)
     {
-        if (($this->recipientOverride) !== null) {
-            $message->setRecipient($this->recipientOverride);
-        }
-
         $package = new Package($this->transport, $message);
         $this->profile[] = $package;
         return $this->spool->pushPackage($package);

src/ScayTrase/SmsDeliveryBundle/SmsDeliveryBundle.php

@@ -2,6 +2,7 @@
 
 namespace ScayTrase\SmsDeliveryBundle;
 
+use ScayTrase\SmsDeliveryBundle\DependencyInjection\Compiler\SpoolCompilerPass;
 use ScayTrase\SmsDeliveryBundle\DependencyInjection\Compiler\TransportCompilerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -22,6 +23,7 @@ public function build(ContainerBuilder $container)
     {
         parent::build($container);
         $container->addCompilerPass(new TransportCompilerPass());
+        $container->addCompilerPass(new SpoolCompilerPass());
     }
 
 }

src/ScayTrase/SmsDeliveryBundle/Spool/SpoolInterface.php

@@ -8,9 +8,6 @@
 
 namespace ScayTrase\SmsDeliveryBundle\Spool;
 
-use ScayTrase\SmsDeliveryBundle\Service\ShortMessageInterface;
-use ScayTrase\SmsDeliveryBundle\Transport\TransportInterface;
-
 interface SpoolInterface
 {
     /**

src/ScayTrase/SmsDeliveryBundle/Tests/BundleTest.php

@@ -0,0 +1,118 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: batanov.pavel
+ * Date: 13.08.2015
+ * Time: 8:37
+ */
+
+namespace ScayTrase\SmsDeliveryBundle\Tests;
+
+use ScayTrase\SmsDeliveryBundle\DataCollector\MessageDeliveryDataCollector;
+use ScayTrase\SmsDeliveryBundle\DependencyInjection\Compiler\SpoolCompilerPass;
+use ScayTrase\SmsDeliveryBundle\DependencyInjection\Compiler\TransportCompilerPass;
+use ScayTrase\SmsDeliveryBundle\DependencyInjection\SmsDeliveryExtension;
+use ScayTrase\SmsDeliveryBundle\Service\MessageDeliveryService;
+use ScayTrase\SmsDeliveryBundle\Service\ShortMessageInterface;
+use ScayTrase\SmsDeliveryBundle\Spool\DisabledSpool;
+use ScayTrase\SmsDeliveryBundle\Transport\DummyTransport;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class BundleTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @return array configurations array
+     */
+    public function configurationProvider()
+    {
+        return array(
+            'missing_configuration' => array(null),
+            'empty_configuration' => array(array()),
+            'disable_delivery_configuration' => array(array('disable_delivery' => true)),
+            'delivery_recipient_configuration' => array(array('delivery_recipient' => '1234567890')),
+            'full_configuration' => array(array('disable_delivery' => true, 'delivery_recipient' => '1234567890')),
+        );
+    }
+
+    /**
+     * @dataProvider configurationProvider
+     * @param $config
+     */
+    public function testBundleConfiguration($config)
+    {
+        $container = $this->buildContainer($config);
+
+        self::assertTrue($container->hasParameter('sms_delivery.spool'));
+        self::assertTrue($container->hasParameter('sms_delivery.transport'));
+        self::assertTrue($container->hasParameter('sms_delivery.disable_delivery'));
+        self::assertTrue($container->hasParameter('sms_delivery.delivery_recipient'));
+    }
+
+    /**
+     * @param array|null $config
+     * @return ContainerBuilder
+     */
+    private function buildContainer(array $config = null)
+    {
+        $extension = new SmsDeliveryExtension();
+        $container = new ContainerBuilder();
+        $container->addCompilerPass(new TransportCompilerPass());
+        $container->addCompilerPass(new SpoolCompilerPass());
+        $extension->load(array((array)$config), $container);
+        $container->compile();
+        return $container;
+    }
+
+    public function testBundleConfigurationValues()
+    {
+        $container = $this->buildContainer(array('disable_delivery' => true, 'delivery_recipient' => '1234567890'));
+
+        self::assertEquals(true, $container->getParameter('sms_delivery.disable_delivery'));
+        self::assertEquals('1234567890', $container->getParameter('sms_delivery.delivery_recipient'));
+    }
+
+    public function testDefaultRecipientDelivery()
+    {
+        $container = $this->buildContainer(array('delivery_recipient' => '1234567890'));
+
+        /** @var MessageDeliveryService|\PHPUnit_Framework_MockObject_MockObject $sender */
+        $sender = $container->get('sms_delivery.sender');
+
+        /** @var ShortMessageInterface|\PHPUnit_Framework_MockObject_MockObject $message */
+        $message = $this->getMock('ScayTrase\SmsDeliveryBundle\Service\ShortMessageInterface');
+        $message->expects(self::once())->method('setRecipient');
+
+        $sender->spoolMessage($message);
+    }
+
+    public function testPublicService()
+    {
+        $container = $this->buildContainer();
+
+        /** @var ShortMessageInterface|\PHPUnit_Framework_MockObject_MockObject $message */
+        $message = $this->getMock('ScayTrase\SmsDeliveryBundle\Service\ShortMessageInterface');
+
+        /** @var MessageDeliveryService $sender */
+        $sender = $container->get('sms_delivery.sender');
+
+        self::assertFalse($sender->spoolMessage($message));
+    }
+
+    public function testDataCollector()
+    {
+        $transport = new DummyTransport();
+
+        /** @var MessageDeliveryService $sender */
+        $sender = new MessageDeliveryService($transport, new DisabledSpool);
+        $collector = new MessageDeliveryDataCollector($sender);
+
+        /** @var ShortMessageInterface|\PHPUnit_Framework_MockObject_MockObject $message */
+        $message = $this->getMock('ScayTrase\SmsDeliveryBundle\Service\ShortMessageInterface');
+
+        self::assertTrue($sender->spoolMessage($message));
+        $collector->collect(new Request(), new Response());
+        self::assertEquals(1, count($collector->getData()));
+    }
+}