Client::__construct() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/recca0..." - recca0120/every8d - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( c58257...69da59 )

by recca

created 2018-01-20 18:08 UTC

Client::__construct() A

↳ Parent: Client

Complexity

Conditions	3
Paths	4

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	6
cts	6
cp	1
rs	9.4285
cc	3
eloc	5
nc	4
nop	4
crap	3

<?php

namespace Recca0120\Every8d;

use Carbon\Carbon;
use DomainException;
use Http\Client\HttpClient;
use Http\Message\MessageFactory;
use Http\Discovery\HttpClientDiscovery;
use Http\Discovery\MessageFactoryDiscovery;

class Client
{
    /**
     * $apiEndpoint.
     *
     * @var string
     */
    public $apiEndpoint = 'http://api.every8d.com/API21/HTTP';

    /**
     * $credit.
     *
     * @var float
     */
    public $credit = null;

    /**
     * $userId.
     *
     * @var string
     */
    protected $userId;

    /**
     * $password.
     *
     * @var string
     */
    protected $password;

    /**
     * $httpClient.
     *
     * @var \Http\Client\HttpClient
     */
    protected $httpClient;

    /**
     * $messageFactory.
     *
     * @var \Http\Message\MessageFactory
     */
    protected $messageFactory;

    /**
     * __construct.
     *
     * @param string $userId
     * @param string $password
     * @param \Http\Client\HttpClient $httpClient
     * @param \Http\Message\MessageFactory $messageFactory
     */
    public function __construct($userId, $password, HttpClient $httpClient = null, MessageFactory $messageFactory = null)
    {
        $this->userId = $userId;
        $this->password = $password;
        $this->httpClient = $httpClient ?: HttpClientDiscovery::find();
        $this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
    }

    /**
     * https.
     *
     * @return $this
     */
    public function https()
    {
        $this->apiEndpoint = 'https://oms.every8d.com/API21/HTTP/';

        return $this;
    }

    /**
     * send.
     *
     * @param array $params
     * @return string
     */
    public function send($params)
    {
        $response = $this->doRequest('sendSMS.ashx', array_filter(array_merge([
            'UID' => $this->userId,
            'PWD' => $this->password,
            'SB' => null,
            'MSG' => null,
            'DEST' => null,
            'ST' => null,
            'RETRYTIME' => null,
        ], $this->remapParams($params))));

        if ($this->isValidResponse($response) === false) {
            throw new DomainException($response, 500);
        }

        return $this->parseResponse($response);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * sendMMS.
     *
     * @param array $params
     * @return string
     */
    public function sendMMS($params)
    {
        $response = $this->https()->doRequest('snedMMS.ashx', array_filter(array_merge([
            'UID' => $this->userId,
            'PWD' => $this->password,
            'SB' => null,
            'MSG' => null,
            'DEST' => null,
            'ST' => null,
            'RETRYTIME' => null,
            'ATTACHMENT' => null,
            'TYPE' => null,
        ], $this->remapParams($params))));

        if ($this->isValidResponse($response) === false) {
            throw new DomainException($response, 500);
        }

        return $this->parseResponse($response);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * credit.
     *
     * @return float
     */
    public function credit()
    {
        if (is_null($this->credit) === false) {
            return $this->credit;
        }

        $response = $this->doRequest('getCredit.ashx', [
            'UID' => $this->userId,
            'PWD' => $this->password,
        ]);

        if ($this->isValidResponse($response) === false) {
            throw new DomainException($response, 500);
        }

        return $this->setCredit($response)->credit;
    }

    /**
     * setCredit.
     *
     * @param string $credit
     */
    protected function setCredit($credit)
    {
        $this->credit = (float) $credit;

        return $this;
    }

    /**
     * isValidResponse.
     *
     * @param string $response
     *
     * @return bool
     */
    protected function isValidResponse($response)
    {
        return substr($response, 0, 1) !== '-';
    }

    /**
     * doRequest.
     *
     * @param string $uri
     * @param array $params
     *
     * @return string
     */
    protected function doRequest($uri, $params)
    {
        $request = $this->messageFactory->createRequest(
            'POST',
            rtrim($this->apiEndpoint, '/').'/'.$uri,
            ['Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'],
            http_build_query($params)
        );
        $response = $this->httpClient->sendRequest($request);

        return $response->getBody()->getContents();
    }

    /**
     * remapParams.
     *
     * @param array $params
     * @return array
     */
    protected function remapParams($params)
    {
        if (empty($params['subject']) === false) {
            $params['SB'] = $params['subject'];
            unset($params['subject']);
        }

        if (empty($params['to']) === false) {

            $params['DEST'] = $params['to'];
            unset($params['to']);
        }

        if (empty($params['text']) === false) {

            $params['MSG'] = $params['text'];
            unset($params['text']);
        }

        if (empty($params['sendTime']) === false) {
            $params['ST'] = empty($params['sendTime']) === false ? Carbon::parse($params['sendTime'])->format('YmdHis') : null;
            unset($params['sendTime']);
        }

        if (empty($params['attachment']) === false) {

            $params['ATTACHMENT'] = $params['attachment'];
            unset($params['attachment']);
        }

        if (empty($params['type']) === false) {

            $params['TYPE'] = $params['type'];
            unset($params['type']);
        }

        return $params;
    }

    /**
     * parseResponse.
     *
     * @param array $response
     * @return array
     */
    protected function parseResponse($response)
    {
        list($credit, $sended, $cost, $unsend, $batchId) = explode(',', $response);

        return [
            'credit' => $this->setCredit($credit)->credit,
            'sended' => (int) $sended,
            'cost' => (float) $cost,
            'unsend' => (int) $unsend,
            'batchId' => $batchId,
        ];
    }
}


1			<?php
2
3			namespace Recca0120\Every8d;
4
5			use Carbon\Carbon;
6			use DomainException;
7			use Http\Client\HttpClient;
8			use Http\Message\MessageFactory;
9			use Http\Discovery\HttpClientDiscovery;
10			use Http\Discovery\MessageFactoryDiscovery;
11
12			class Client
13			{
14			/**
15			* $apiEndpoint.
16			*
17			* @var string
18			*/
19			public $apiEndpoint = 'http://api.every8d.com/API21/HTTP';
20
21			/**
22			* $credit.
23			*
24			* @var float
25			*/
26			public $credit = null;
27
28			/**
29			* $userId.
30			*
31			* @var string
32			*/
33			protected $userId;
34
35			/**
36			* $password.
37			*
38			* @var string
39			*/
40			protected $password;
41
42			/**
43			* $httpClient.
44			*
45			* @var \Http\Client\HttpClient
46			*/
47			protected $httpClient;
48
49			/**
50			* $messageFactory.
51			*
52			* @var \Http\Message\MessageFactory
53			*/
54			protected $messageFactory;
55
56			/**
57			* __construct.
58			*
59			* @param string $userId
60			* @param string $password
61			* @param \Http\Client\HttpClient $httpClient
62			* @param \Http\Message\MessageFactory $messageFactory
63			*/
64	5		public function __construct($userId, $password, HttpClient $httpClient = null, MessageFactory $messageFactory = null)
65			{
66	5		$this->userId = $userId;
67	5		$this->password = $password;
68	5		$this->httpClient = $httpClient ?: HttpClientDiscovery::find();
69	5		$this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
70	5		}
71
72			/**
73			* https.
74			*
75			* @return $this
76			*/
77	2		public function https()
78			{
79	2		$this->apiEndpoint = 'https://oms.every8d.com/API21/HTTP/';
80
81	2		return $this;
82			}
83
84			/**
85			* send.
86			*
87			* @param array $params
88			* @return string
89			*/
90	2		public function send($params)
91			{
92	2		$response = $this->doRequest('sendSMS.ashx', array_filter(array_merge([
93	2		'UID' => $this->userId,
94	2		'PWD' => $this->password,
95	2		'SB' => null,
96	2		'MSG' => null,
97	2		'DEST' => null,
98	2		'ST' => null,
99	2		'RETRYTIME' => null,
100	2		], $this->remapParams($params))));
101
102	2		if ($this->isValidResponse($response) === false) {
103	1		throw new DomainException($response, 500);
104			}
105
106	1		return $this->parseResponse($response);
			0 ignored issues – show Documentation introduced 2018-01-20 16:29 UTC by Report Bug Copy Issue Report `$response` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
107			}
108
109			/**
110			* sendMMS.
111			*
112			* @param array $params
113			* @return string
114			*/
115	1		public function sendMMS($params)
116			{
117	1		$response = $this->https()->doRequest('snedMMS.ashx', array_filter(array_merge([
118	1		'UID' => $this->userId,
119	1		'PWD' => $this->password,
120	1		'SB' => null,
121	1		'MSG' => null,
122	1		'DEST' => null,
123	1		'ST' => null,
124	1		'RETRYTIME' => null,
125	1		'ATTACHMENT' => null,
126	1		'TYPE' => null,
127	1		], $this->remapParams($params))));
128
129	1		if ($this->isValidResponse($response) === false) {
130			throw new DomainException($response, 500);
131			}
132
133	1		return $this->parseResponse($response);
			0 ignored issues – show Documentation introduced 2018-01-20 16:29 UTC by Report Bug Copy Issue Report `$response` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
134			}
135
136			/**
137			* credit.
138			*
139			* @return float
140			*/
141	4		public function credit()
142			{
143	4		if (is_null($this->credit) === false) {
144	2		return $this->credit;
145			}
146
147	2		$response = $this->doRequest('getCredit.ashx', [
148	2		'UID' => $this->userId,
149	2		'PWD' => $this->password,
150	2		]);
151
152	2		if ($this->isValidResponse($response) === false) {
153	1		throw new DomainException($response, 500);
154			}
155
156	1		return $this->setCredit($response)->credit;
157			}
158
159			/**
160			* setCredit.
161			*
162			* @param string $credit
163			*/
164	3		protected function setCredit($credit)
165			{
166	3		$this->credit = (float) $credit;
167
168	3		return $this;
169			}
170
171			/**
172			* isValidResponse.
173			*
174			* @param string $response
175			*
176			* @return bool
177			*/
178	5		protected function isValidResponse($response)
179			{
180	5		return substr($response, 0, 1) !== '-';
181			}
182
183			/**
184			* doRequest.
185			*
186			* @param string $uri
187			* @param array $params
188			*
189			* @return string
190			*/
191	5		protected function doRequest($uri, $params)
192			{
193	5		$request = $this->messageFactory->createRequest(
194	5		'POST',
195	5		rtrim($this->apiEndpoint, '/').'/'.$uri,
196	5		['Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'],
197	5		http_build_query($params)
198	5		);
199	5		$response = $this->httpClient->sendRequest($request);
200
201	5		return $response->getBody()->getContents();
202			}
203
204			/**
205			* remapParams.
206			*
207			* @param array $params
208			* @return array
209			*/
210	3		protected function remapParams($params)
211			{
212	3		if (empty($params['subject']) === false) {
213			$params['SB'] = $params['subject'];
214			unset($params['subject']);
215			}
216
217	3	View Code Duplication	if (empty($params['to']) === false) {
			0 ignored issues – show Duplication introduced 2018-01-19 04:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
218	3		$params['DEST'] = $params['to'];
219	3		unset($params['to']);
220	3		}
221
222	3	View Code Duplication	if (empty($params['text']) === false) {
			0 ignored issues – show Duplication introduced 2018-01-19 04:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
223	3		$params['MSG'] = $params['text'];
224	3		unset($params['text']);
225	3		}
226
227	3		if (empty($params['sendTime']) === false) {
228	2		$params['ST'] = empty($params['sendTime']) === false ? Carbon::parse($params['sendTime'])->format('YmdHis') : null;
229	2		unset($params['sendTime']);
230	2		}
231
232	3	View Code Duplication	if (empty($params['attachment']) === false) {
			0 ignored issues – show Duplication introduced 2018-01-20 16:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
233	1		$params['ATTACHMENT'] = $params['attachment'];
234	1		unset($params['attachment']);
235	1		}
236
237	3	View Code Duplication	if (empty($params['type']) === false) {
			0 ignored issues – show Duplication introduced 2018-01-20 16:29 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
238	1		$params['TYPE'] = $params['type'];
239	1		unset($params['type']);
240	1		}
241
242	3		return $params;
243			}
244
245			/**
246			* parseResponse.
247			*
248			* @param array $response
249			* @return array
250			*/
251	2		protected function parseResponse($response)
252			{
253	2		list($credit, $sended, $cost, $unsend, $batchId) = explode(',', $response);
254
255			return [
256	2		'credit' => $this->setCredit($credit)->credit,
257	2		'sended' => (int) $sended,
258	2		'cost' => (float) $cost,
259	2		'unsend' => (int) $unsend,
260	2		'batchId' => $batchId,
261	2		];
262			}
263			}
264

recca0120 / every8d

Push — master ( c58257...69da59 )

Client::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like