Surfnet\StepupGateway\ApiBundle\Sms\SpryngService

Complexity

Total Complexity

5

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	send()	0	18	4
A	__construct()	0	5	1

<?php

/**
 * Copyright 2021 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupGateway\ApiBundle\Sms;

use Psr\Log\LoggerInterface;
use Spryng\SpryngRestApi\Objects\Message;
use Spryng\SpryngRestApi\Resources\MessageClient;
use Spryng\SpryngRestApi\Spryng;
use Surfnet\StepupGateway\ApiBundle\Dto\SmsMessage;

class SpryngService implements SmsAdapterInterface

Missing doc comment for class SpryngService

{
    /**

Missing short description in doc comment

     * @var LoggerInterface
     */
    private $logger;

Private member variable "logger" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var MessageClient
     */
    private $client;

Private member variable "client" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string
     */
    private $route = null;

Private member variable "route" must be prefixed with an underscore

    public function __construct(string $apiKey, ?string $route, LoggerInterface $logger)

Missing doc comment for function __construct()

    {
        $this->client = new MessageClient(new Spryng($apiKey));
        $this->route = $route;
        $this->logger = $logger;
    }

    public function send(SmsMessage $message): SmsMessageResultInterface

Missing doc comment for function send()

    {
        $this->logger->notice('Using Spryng to send an SMS');

        $spryngMessage = new Message();
        $spryngMessage->setBody($message->body);
        $spryngMessage->setRecipients([$message->recipient]);
        $spryngMessage->setOriginator($message->originator);

        if (!is_null($this->route)) {

The condition is_null($this->route) is always false.

            $spryngMessage->setRoute($this->route);
        }

        $response = $this->client->create($spryngMessage);
        if (is_null($response) || !$response->wasSuccessful()) {
            $this->logger->warning('Sending OTP per SMS failed.');
        }
        return new SpryngMessageResult($response);
    }
}