Client::prepareRequest() - Code Metrics - Inspection of "small fixes to request build methods" - fazland/skebby-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 02addd...f1621a )

by Alessandro

created 2016-10-21 13:30 UTC

Client::prepareRequest() C

↳ Parent: Client

Complexity

Conditions	7
Paths	64

Size

Total Lines	35
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	26
CRAP Score	7.0024

Importance

Changes

Metric	Value
dl	0
loc	35
ccs	26
cts	27
cp	0.963
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	26
nc	64
nop	1
crap	7.0024

<?php

namespace Fazland\SkebbyRestClient\Client;

use Fazland\SkebbyRestClient\DataStructure\Response;
use Fazland\SkebbyRestClient\DataStructure\Sms;
use Fazland\SkebbyRestClient\Exception\NoRecipientsSpecifiedException;
use Fazland\SkebbyRestClient\Constant\Charsets;
use Fazland\SkebbyRestClient\Constant\EncodingSchemas;
use Fazland\SkebbyRestClient\Constant\Endpoints;
use Fazland\SkebbyRestClient\Constant\Recipients;
use Fazland\SkebbyRestClient\Constant\SendMethods;
use Fazland\SkebbyRestClient\Constant\ValidityPeriods;
use libphonenumber\NumberParseException;
use libphonenumber\PhoneNumberFormat;
use libphonenumber\PhoneNumberUtil;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * @author Massimiliano Braglia <[email protected]>
 */
class Client
{
    /**
     * @var array
     */
    private $config;

    /**
     * @param array $options
     */
    public function __construct(array $options)
    {
        $resolver = new OptionsResolver();

        $this->configureOptions($resolver);
        $this->config = $resolver->resolve($options);
    }

    /**
     * Send an SMS
     *
     * @param Sms $sms
     *
     * @return Response[]
     *
     * @throws NoRecipientsSpecifiedException
     */
    public function send(Sms $sms)
    {
        if (! $sms->hasRecipients()) {
            throw new NoRecipientsSpecifiedException();
        }

        $messages = [];

        $recipients = $sms->getRecipients();
        foreach (array_chunk($recipients, Recipients::MAX) as $chunk) {
            $message = clone $sms;
            $message
                ->setRecipients($chunk)
                ->clearRecipientVariables()
            ;

            foreach ($chunk as $recipient) {
                if (! isset($sms->getRecipientVariables()[$recipient])) {
                    continue;
                }

                foreach ($sms->getRecipientVariables()[$recipient] as $variable => $value) {
                    $message->addRecipientVariable($recipient, $variable, $value);
                }
            }

            $messages[] = $message;
        }

        $responses = [];
        foreach ($messages as $message) {
            $request = $this->prepareRequest($message);

            $responses[] = $this->executeRequest($request);
        }

        return $responses;
    }

    /**
     * Configure default options for client.
     *
     * It takes required options username, password, sender and method.
     * validity_period MUST be a \DateInterval object if set
     * delivery_start MUST be a \DateTime object if set
     *
     * @param OptionsResolver $resolver
     */
    private function configureOptions(OptionsResolver $resolver)
    {
        $resolver
            ->setRequired([
                'username',
                'password',
                'sender',
                'method',
            ])
            ->setDefaults([
                'delivery_start' => null,
                'charset' => Charsets::UTF8,
                'validity_period' => \DateInterval::createFromDateString('2800 minutes'),
                'encoding_schema' => EncodingSchemas::NORMAL,
                'endpoint_uri' => Endpoints::REST_HTTPS
            ])
            ->setAllowedTypes('username', 'string')
            ->setAllowedTypes('password', 'string')
            ->setAllowedTypes('sender', 'string')
            ->setAllowedTypes('method', 'string')
            ->setAllowedTypes('delivery_start', ['null', 'DateTime'])
            ->setAllowedTypes('validity_period', ['null', 'DateInterval'])
            ->setAllowedTypes('encoding_schema', 'string')
            ->setAllowedTypes('charset', 'string')
            ->setAllowedTypes('endpoint_uri', 'string')
            ->setAllowedValues('method', [
                SendMethods::CLASSIC,
                SendMethods::CLASSIC_PLUS,
                SendMethods::BASIC,
                SendMethods::TEST_CLASSIC,
                SendMethods::TEST_CLASSIC_PLUS,
                SendMethods::TEST_BASIC,
            ])
            ->setAllowedValues('validity_period', function (\DateInterval $value) {
                return $value->i >= ValidityPeriods::MIN && $value->i <= ValidityPeriods::MAX;
            })
            ->setAllowedValues('encoding_schema', [
                EncodingSchemas::NORMAL,
                EncodingSchemas::UCS2,
            ])
            ->setAllowedValues('charset', [
                Charsets::ISO_8859_1,
                Charsets::UTF8,
            ])
        ;
    }

    /**
     * @param Sms $sms
     *
     * @return array
     */
    private function prepareRequest(Sms $sms)
    {
        $sender_string = null;
        $sender_number = null;
        try {
            $sender_number = $this->normalizePhoneNumber($this->config['sender']);
        } catch (NumberParseException $e) {
            $sender_string = substr($this->config['sender'], 0, 11);
        }

        $deliveryStart = $sms->getDeliveryStart() ?: $this->config['delivery_start'];
        $validityPeriod = $sms->getValidityPeriod() ?: $this->config['validity_period'];

        $request = [
            'username' => $this->config['username'],
            'password' => $this->config['password'],
            'method' => $this->config['method'],
            'sender_number' => $sender_number,
            'sender_string' => $sender_string,
            'recipients' => $this->prepareRecipients($sms),
            'text' => str_replace(' ', '+', $sms->getText()),
            'user_reference' => $sms->getUserReference(),
            'delivery_start' => $deliveryStart ? urlencode($deliveryStart->format(\DateTime::RFC2822)) : null,
            'validity_period' => $validityPeriod ? $validityPeriod->i : null,
            'encoding_scheme' => $this->config['encoding_schema'],
            'charset' => urlencode($this->config['charset']),
        ];

        $serializedRequest = [];
        foreach ($request as $key => $value) {
            $serializedRequest[] = "$key=$value";
        }

        return implode('&', $serializedRequest);
    }

    /**
     * @param Sms $sms
     *
     * @return string
     */
    private function prepareRecipients(Sms $sms)
    {
        $recipients = $sms->getRecipients();

        if (! $sms->hasRecipientVariables()) {
            $recipients = array_map([$this, 'normalizePhoneNumber'], $recipients);
            return json_encode($recipients);
        }

        $recipientVariables = $sms->getRecipientVariables();

        return json_encode(array_map(function ($recipient) use ($recipientVariables) {
            $targetVariables = [];
            if (isset($recipientVariables[$recipient])) {
                $targetVariables = $recipientVariables[$recipient];
            }

            return array_merge(['recipient' => $this->normalizePhoneNumber($recipient)], $targetVariables);
        }, $recipients));
    }

    /**
     * @param string $phoneNumber
     *
     * @return string
     *
     * @throws NumberParseException
     */
    private function normalizePhoneNumber($phoneNumber)
    {
        $utils = PhoneNumberUtil::getInstance();
        $parsed = $utils->parse(preg_replace('/^00/', '+', $phoneNumber), null);

        $phoneNumber = $utils->format($parsed, PhoneNumberFormat::E164);

        return substr($phoneNumber, 1);
    }

    /**
     * @param string $request
     *
     * @return Response
     */
    private function executeRequest($request)
    {
        $curl = curl_init();

        curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_TIMEOUT, 60);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
        curl_setopt($curl, CURLOPT_URL, $this->config['endpoint_uri']);

        $response = curl_exec($curl);

        curl_close($curl);

        return new Response($response);
    }
}


1		<?php
2
3		namespace Fazland\SkebbyRestClient\Client;
4
5		use Fazland\SkebbyRestClient\DataStructure\Response;
6		use Fazland\SkebbyRestClient\DataStructure\Sms;
7		use Fazland\SkebbyRestClient\Exception\NoRecipientsSpecifiedException;
8		use Fazland\SkebbyRestClient\Constant\Charsets;
9		use Fazland\SkebbyRestClient\Constant\EncodingSchemas;
10		use Fazland\SkebbyRestClient\Constant\Endpoints;
11		use Fazland\SkebbyRestClient\Constant\Recipients;
12		use Fazland\SkebbyRestClient\Constant\SendMethods;
13		use Fazland\SkebbyRestClient\Constant\ValidityPeriods;
14		use libphonenumber\NumberParseException;
15		use libphonenumber\PhoneNumberFormat;
16		use libphonenumber\PhoneNumberUtil;
17		use Symfony\Component\OptionsResolver\OptionsResolver;
18
19		/**
20		* @author Massimiliano Braglia <[email protected]>
21		*/
22		class Client
23		{
24		/**
25		* @var array
26		*/
27		private $config;
28
29		/**
30		* @param array $options
31		*/
32	7	public function __construct(array $options)
33		{
34	7	$resolver = new OptionsResolver();
35
36	7	$this->configureOptions($resolver);
37	7	$this->config = $resolver->resolve($options);
38	7	}
39
40		/**
41		* Send an SMS
42		*
43		* @param Sms $sms
44		*
45	7	* @return Response[]
46		*
47	7	* @throws NoRecipientsSpecifiedException
48		*/
49	7	public function send(Sms $sms)
50	7	{
51	1	if (! $sms->hasRecipients()) {
52	1	throw new NoRecipientsSpecifiedException();
53		}
54	1
55	1	$messages = [];
56
57		$recipients = $sms->getRecipients();
58	1	foreach (array_chunk($recipients, Recipients::MAX) as $chunk) {
59	1	$message = clone $sms;
60	1	$message
61		->setRecipients($chunk)
62		->clearRecipientVariables()
63	1	;
64	1
65	1	foreach ($chunk as $recipient) {
66	1	if (! isset($sms->getRecipientVariables()[$recipient])) {
67		continue;
68	1	}
69	1
70	1	foreach ($sms->getRecipientVariables()[$recipient] as $variable => $value) {
71	6	$message->addRecipientVariable($recipient, $variable, $value);
72		}
73		}
74	7
75	7	$messages[] = $message;
76	7	}
77
78	6	$responses = [];
79	4	foreach ($messages as $message) {
80		$request = $this->prepareRequest($message);
81	4
82		$responses[] = $this->executeRequest($request);
83		}
84
85		return $responses;
86		}
87	7
88		/**
89		* Configure default options for client.
90	7	*
91	7	* It takes required options username, password, sender and method.
92	7	* validity_period MUST be a \DateInterval object if set
93	7	* delivery_start MUST be a \DateTime object if set
94	7	*
95	7	* @param OptionsResolver $resolver
96	7	*/
97	7	private function configureOptions(OptionsResolver $resolver)
98	7	{
99	7	$resolver
100	7	->setRequired([
101	7	'username',
102	7	'password',
103	7	'sender',
104	7	'method',
105	7	])
106	7	->setDefaults([
107	7	'delivery_start' => null,
108	7	'charset' => Charsets::UTF8,
109	7	'validity_period' => \DateInterval::createFromDateString('2800 minutes'),
110	7	'encoding_schema' => EncodingSchemas::NORMAL,
111	7	'endpoint_uri' => Endpoints::REST_HTTPS
112	7	])
113	7	->setAllowedTypes('username', 'string')
114	7	->setAllowedTypes('password', 'string')
115	7	->setAllowedTypes('sender', 'string')
116	7	->setAllowedTypes('method', 'string')
117	7	->setAllowedTypes('delivery_start', ['null', 'DateTime'])
118	7	->setAllowedTypes('validity_period', ['null', 'DateInterval'])
119	7	->setAllowedTypes('encoding_schema', 'string')
120		->setAllowedTypes('charset', 'string')
121	7	->setAllowedTypes('endpoint_uri', 'string')
122	7	->setAllowedValues('method', [
123	7	SendMethods::CLASSIC,
124	7	SendMethods::CLASSIC_PLUS,
125	7	SendMethods::BASIC,
126	7	SendMethods::TEST_CLASSIC,
127	7	SendMethods::TEST_CLASSIC_PLUS,
128	7	SendMethods::TEST_BASIC,
129	7	])
130	7	->setAllowedValues('validity_period', function (\DateInterval $value) {
131	7	return $value->i >= ValidityPeriods::MIN && $value->i <= ValidityPeriods::MAX;
132	7	})
133	7	->setAllowedValues('encoding_schema', [
134	7	EncodingSchemas::NORMAL,
135		EncodingSchemas::UCS2,
136	7	])
137		->setAllowedValues('charset', [
138	7	Charsets::ISO_8859_1,
139		Charsets::UTF8,
140		])
141		;
142		}
143
144		/**
145		* @param Sms $sms
146		*
147	7	* @return array
148		*/
149	7	private function prepareRequest(Sms $sms)
150	1	{
151		$sender_string = null;
152		$sender_number = null;
153	6	try {
154	6	$sender_number = $this->normalizePhoneNumber($this->config['sender']);
155		} catch (NumberParseException $e) {
156	6	$sender_string = substr($this->config['sender'], 0, 11);
157	6	}
158
159		$deliveryStart = $sms->getDeliveryStart() ?: $this->config['delivery_start'];
160		$validityPeriod = $sms->getValidityPeriod() ?: $this->config['validity_period'];
161	6
162	6	$request = [
163	1	'username' => $this->config['username'],
164	1	'password' => $this->config['password'],
165		'method' => $this->config['method'],
166	6	'sender_number' => $sender_number,
167	6	'sender_string' => $sender_string,
168	1	'recipients' => $this->prepareRecipients($sms),
169	1	'text' => str_replace(' ', '+', $sms->getText()),
170		'user_reference' => $sms->getUserReference(),
171		'delivery_start' => $deliveryStart ? urlencode($deliveryStart->format(\DateTime::RFC2822)) : null,
172	6	'validity_period' => $validityPeriod ? $validityPeriod->i : null,
173	6	'encoding_scheme' => $this->config['encoding_schema'],
174	6	'charset' => urlencode($this->config['charset']),
175	6	];
176	6
177	6	$serializedRequest = [];
178	6	foreach ($request as $key => $value) {
179	6	$serializedRequest[] = "$key=$value";
180	6	}
181	6
182	6	return implode('&', $serializedRequest);
183	6	}
184	6
185		/**
186	6	* @param Sms $sms
187	6	*
188	6	* @return string
189	6	*/
190		private function prepareRecipients(Sms $sms)
191	6	{
192		$recipients = $sms->getRecipients();
193
194		if (! $sms->hasRecipientVariables()) {
195		$recipients = array_map([$this, 'normalizePhoneNumber'], $recipients);
196		return json_encode($recipients);
197		}
198
199	6	$recipientVariables = $sms->getRecipientVariables();
200
201	6	return json_encode(array_map(function ($recipient) use ($recipientVariables) {
202		$targetVariables = [];
203	6	if (isset($recipientVariables[$recipient])) {
204	3	$targetVariables = $recipientVariables[$recipient];
205	3	}
206
207		return array_merge(['recipient' => $this->normalizePhoneNumber($recipient)], $targetVariables);
208	3	}, $recipients));
209		}
210	3
211	3	/**
212	3	* @param string $phoneNumber
213	3	*
214	3	* @return string
215		*
216	3	* @throws NumberParseException
217	3	*/
218		private function normalizePhoneNumber($phoneNumber)
219		{
220		$utils = PhoneNumberUtil::getInstance();
221		$parsed = $utils->parse(preg_replace('/^00/', '+', $phoneNumber), null);
222
223		$phoneNumber = $utils->format($parsed, PhoneNumberFormat::E164);
224
225		return substr($phoneNumber, 1);
226		}
227	6
228		/**
229	6	* @param string $request
230	6	*
231		* @return Response
232	6	*/
233		private function executeRequest($request)
234	6	{
235		$curl = curl_init();
236
237		curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
238		curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
239		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
240		curl_setopt($curl, CURLOPT_POST, 1);
241		curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
242	6	curl_setopt($curl, CURLOPT_URL, $this->config['endpoint_uri']);
243
244	6	$response = curl_exec($curl);
245
246	6	curl_close($curl);
247	6
248	6	return new Response($response);
249	6	}
250		}
251

fazland / skebby-rest-client

Push — master ( 02addd...f1621a )

Client::prepareRequest() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like