Convert SMS Gateways into D8 Plugins

First go at this. Tests not included. Also included a BC-shim to allow this patch to work with existing gateways.

Re-roll

The first version did not allow multiple instances of the same type of gateway plugin to be instantiated.

This iteration adds that, making it possible to create a generic gateway that only needs to be configured e.g. https://www.drupal.org/project/sms_simplegateway so only one plugin for multiple gateways.

Also introduced the possibility to enable and disable gateways. This is useful for more advanced use-cases where multiple gateways could be used. Selecting a disabled gateway as default in the UI automatically enables it.

Also fixed some of the test fails, cleaned up functions and moved them to the correct classes, renamed classes and services to more appropriate names.

Fixing the test fails. Corrected hook implementations and some renames.

Due to the size of this patch, I have split off the aspect of implementing sms messaging providers as services into a different issue and posted a patch there. Will follow through with that aspect and then continue with this when that issue lands. I have also created a meta issue (now called Plan issue) to help track such refactoring efforts #2509560: [Meta] Revamp SMS Framework in D8 - improve flexibility and scalability

#2509566: Convert sms_send() into a service is in so we can now continue work on this...

Edit: corrected wrong issue link.

Re-rolled.

Rerolled.

1. +++ b/modules/sms_track/sms_track.module
   @@ -60,17 +61,17 @@ function sms_track_sms_send(SmsMessageInterface $sms, array $options, $gateway)
   +function sms_track_sms_send_process($op, SmsMessageInterface $sms, array $options, GatewayInterface $gateway, $result) {
   

   Type-hint $result as array

2. +++ b/sms.module
   @@ -128,148 +129,78 @@ function sms_incoming($number, $message, array $options = array()) {
    function sms_gateways($op = 'gateways', $gateway = NULL) {
   ...
   +      foreach ($gateway_manager->getAvailableGateways() as $id => $gw) {
   ...
   +      $gw = $gateway_manager->getGateway($gateway);
   

   Might make more sense to name the function argument $gateway_id and then $gw can be correctly named $gateway

3. +++ b/sms.routing.yml
   @@ -62,3 +70,10 @@ sms.bootstrap_admin:
   +
   +sms.delivery_report:
   +  path: '/sms/deliveryreport/{gateway_id}'
   +  defaults:
   +    _controller: '\Drupal\sms\DeliveryReportController::acknowledgeDelivery'
   +  requirements:
   +    _access: 'TRUE'
   
   +++ b/src/Annotation/SmsGateway.php
   @@ -0,0 +1,39 @@
   diff --git a/src/DeliveryReportController.php b/src/DeliveryReportController.php
   
   diff --git a/src/DeliveryReportController.php b/src/DeliveryReportController.php
   new file mode 100644
   
   new file mode 100644
   index 0000000..fa54056
   
   index 0000000..fa54056
   --- /dev/null
   
   --- /dev/null
   +++ b/src/DeliveryReportController.php
   
   +++ b/src/DeliveryReportController.php
   +++ b/src/DeliveryReportController.php
   @@ -0,0 +1,69 @@
   
   @@ -0,0 +1,69 @@
   +<?php
   +
   +/**
   + * @file
   + * Contains \Drupal\sms\DeliveryReportController
   + */
   +
   +namespace Drupal\sms;
   +
   

   Delivery reports is strictly not in this scope. Would make the patch easier to review if this is removed to another issue...

4. +++ b/src/Provider/DefaultSmsProvider.php
   @@ -109,12 +119,12 @@ class DefaultSmsProvider implements SmsProviderInterface {
   +  protected function postProcess(SmsMessageInterface $sms, array $options, GatewayInterface $gateway, $result) {
   

   Type-hint $result as array

Fixed comments in #16.
#16.2: opened #2542790: Implement API for delivery reports for SMS Gateways
Also opened #2542784: Add unit tests for SMS Gateway and Gateway Manager to add unit tests for the new classes.

With those follow-ups I think this can go in.

1. +++ b/src/Gateway/GatewayManager.php
   @@ -0,0 +1,220 @@
   +        // @todo Throw exception here???
   +//        throw new \InvalidArgumentException(sprintf('Gateway %s configured without a plugin id.', $id));
   

   ??? Exception should be thrown. And a test should be added for this in the follow-up issue

2. +++ b/src/Plugin/Gateway/LogGateway.php
   @@ -0,0 +1,56 @@
   +   *
   +   * Log sms message to drupal watchdog().
   

   Comment should be in the body of the function. And logger is the new name now.

1. Some more clean up.
2. Reverted the array type-hinting, causing problems. Opened #2542866: Clarify the API for message results after sms_send() to take care of that.
3. Implemented default methods in GatewayBase

Fixed test fails. Made the implementation of HookGateway more robust and seamless with existing plugin architecture.

+++ b/src/Tests/SmsFrameworkWebTest.php
@@ -7,16 +7,32 @@
+  ¶

Remove extra space

Test base classes should be abstract.

Updated patch after #2556201: Update 8.x-1.x branch to match new config_object schema

Committed and pushed to 8.x-1.x