Merge pull request #3 from scaytrase/feature/transports

Spooling and special transports

fix #1

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
+
+```

composer.json

@@ -17,7 +17,8 @@
     "symfony/config": "~2.3"
   },
   "require-dev": {
-    "phpunit/phpunit": "~4.6@stable"
+    "phpunit/phpunit": "~4.6@stable",
+    "symfony/framework-bundle": "~2.3"
   },
   "autoload": {
     "psr-0": {

src/ScayTrase/SmsDeliveryBundle/Command/FlushCommand.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: batanov.pavel
+ * Date: 11.08.2015
+ * Time: 14:59
+ */
+
+namespace ScayTrase\SmsDeliveryBundle\Command;
+
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class FlushCommand extends ContainerAwareCommand
+{
+    /**
+     * Configures the current command.
+     */
+    protected function configure()
+    {
+        $this->setName('scaytrase:sms_delivery:flush');
+        $this->setDescription('Flush the delivery service message spool');
+    }
+
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $sender = $this->getContainer()->get('sms_delivery.sender');
+
+        $sender->flush();
+    }
+
+}

src/ScayTrase/SmsDeliveryBundle/DataCollector/MessageDeliveryDataCollector.php

@@ -9,6 +9,7 @@
 namespace ScayTrase\SmsDeliveryBundle\DataCollector;
 
 use ScayTrase\SmsDeliveryBundle\Service\MessageDeliveryService;
+use ScayTrase\SmsDeliveryBundle\Spool\Package;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
@@ -53,6 +54,7 @@ public function getName()
         return 'sms_delivery.data_collector';
     }
 
+    /** @return Package[] */
     public function getData()
     {
         return $this->data;

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,9 +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;
+        }
+
+        $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/DependencyInjection/Configuration.php

@@ -24,11 +24,13 @@ public function getConfigTreeBuilder()
 
         $disable_delivery = (new BooleanNodeDefinition('disable_delivery'));
         $delivery_recipient = (new ScalarNodeDefinition('delivery_recipient'));
-        $sender = (new ScalarNodeDefinition('transport'));
+        $transport = (new ScalarNodeDefinition('transport'));
+        $spool = (new ScalarNodeDefinition('spool'));
 
         $rootNode
             ->children()
-                ->append($sender->defaultValue('sms_delivery.dummy_sender')->info('Sender transport service'))
+                ->append($spool->defaultValue('sms_delivery.spool.instant')->info('Sender message spool'))
+                ->append($transport->defaultValue('sms_delivery.transport.dummy')->info('Sender transport service'))
                 ->append($disable_delivery->defaultFalse()->info('Disables actual delivery for testing purposes'))
                 ->append($delivery_recipient->defaultNull()->info('Recipient for messages for testing purposes'))
             ->end();

src/ScayTrase/SmsDeliveryBundle/EventListener/MemorySpoolListener.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: batanov.pavel
+ * Date: 12.08.2015
+ * Time: 10:31
+ */
+
+namespace ScayTrase\SmsDeliveryBundle\EventListener;
+
+use Psr\Log\LoggerInterface;
+use ScayTrase\SmsDeliveryBundle\Service\MessageDeliveryService;
+use ScayTrase\SmsDeliveryBundle\Spool\MemorySpool;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+class MemorySpoolListener implements EventSubscriberInterface
+{
+    /** @var MessageDeliveryService */
+    private $sender;
+    /** @var LoggerInterface */
+    private $logger;
+
+    /**
+     * Constructor.
+     *
+     * @param MessageDeliveryService $sender
+     * @param LoggerInterface $logger A LoggerInterface instance
+     */
+    public function __construct(MessageDeliveryService $sender, LoggerInterface $logger = null)
+    {
+        $this->sender = $sender;
+        $this->logger = $logger;
+    }
+
+    /** {@inheritdoc} */
+    public static function getSubscribedEvents()
+    {
+        $listeners = array(KernelEvents::TERMINATE => 'onTerminate');
+
+        if (class_exists('Symfony\Component\Console\ConsoleEvents')) {
+            $listeners[ConsoleEvents::TERMINATE] = 'onTerminate';
+        }
+
+        return $listeners;
+    }
+
+    public function onTerminate()
+    {
+        $spool = $this->sender->getSpool();
+
+        if ($spool instanceof MemorySpool) {
+            try {
+                $spool->flush();
+            } catch (\Exception $exception) {
+                if (null !== $this->logger) {
+                    $this->logger->error(sprintf('Exception occurred while flushing message queue: %s',
+                        $exception->getMessage()));
+                }
+            }
+        }
+    }
+}

src/ScayTrase/SmsDeliveryBundle/Resources/config/services.yml

@@ -1,22 +1,39 @@
 parameters:
-    sms_delivery.transport: sms_delivery.dummy_sender
+    sms_delivery.transport: sms_delivery.transport.dummy
     sms_delivery.disable_delivery: false
     sms_delivery.delivery_recipient: null
+    sms_delivery.spool: sms_delviery.spool.instant
 
 services:
-    sms_delivery.dummy_sender:
+    sms_delivery.spool.instant:
+        class: ScayTrase\SmsDeliveryBundle\Spool\InstantSpool
+
+    sms_delivery.spool.disabled:
+        class: ScayTrase\SmsDeliveryBundle\Spool\DisabledSpool
+
+    sms_delivery.spool.memory:
+        class: ScayTrase\SmsDeliveryBundle\Spool\MemorySpool
+
+    sms_delivery.transport.dummy:
         class: ScayTrase\SmsDeliveryBundle\Transport\DummyTransport
 
     sms_delivery.sender:
         class: ScayTrase\SmsDeliveryBundle\Service\MessageDeliveryService
         arguments:
         - %sms_delivery.transport%
+        - %sms_delivery.spool%
         - %sms_delivery.disable_delivery%
         - %sms_delivery.delivery_recipient%
 
-    data_collector.sms_delivery.data_collector:
+    sms_delivery.data_collector:
         class: ScayTrase\SmsDeliveryBundle\DataCollector\MessageDeliveryDataCollector
         arguments:
         - @sms_delivery.sender
         tags:
             - { name: data_collector, template: "SmsDeliveryBundle:DataCollector:data_collector", id: "sms_delivery.data_collector" }
+
+    sms_delivery.event_listener.memory_spool_listener:
+        class: ScayTrase\SmsDeliveryBundle\EventListener\MemorySpoolListener
+        arguments: [ @sms_delivery.sender, @?logger ]
+        tags:
+        - { name: kernel.event_subscriber }

src/ScayTrase/SmsDeliveryBundle/Resources/views/DataCollector/data_collector.html.twig

@@ -80,22 +80,22 @@
                 <th scope="col">#</th>
                 <th scope="col">Delivery Status</th>
                 <th scope="col">Delivery Reason</th>
-                <th scope="col">Delivery Transport</th>
+                {#<th scope="col">Delivery Transport</th>#}
                 <th scope="col">Message Recipient</th>
                 <th scope="col">Message Body</th>
-                <th scope="col">Message Class</th>
+                {#<th scope="col">Message Class</th>#}
             </tr>
             </thead>
             <tbody>
-            {% for key,record in collector.data %}
+            {% for key,package in collector.data %}
                 <tr>
                     <td>{{ key }}</td>
-                    <td>{{ record.status }}</td>
-                    <td>{{ record.reason }}</td>
-                    <td>{{ record.transport }}</td>
-                    <td>{{ record.message.recipient }}</td>
-                    <td>{{ record.message.body }}</td>
-                    <td>{{ record.message_class }}</td>
+                    <td>{{ package.status }}</td>
+                    <td>{{ package.reason }}</td>
+                    {#<td>{{ package.record.transport }}</td>#}
+                    <td>{{ package.record.message.recipient }}</td>
+                    <td>{{ package.message.body }}</td>
+                    {#<td>{{ package.message_class }}</td>#}
                 </tr>
             {% endfor %}
             </tbody>