SmartLoad::balance() - Code Metrics - Inspection of "Bump dependencies. Require php 7.1.0 or newer. A..." - jacques/php-smartcall-httpclient - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d53117...da6533 )

by Jacques

created 2019-01-28 14:16 UTC

SmartLoad::balance() A

↳ Parent: SmartLoad

Complexity

Conditions	3
Paths	5

Size

Total Lines

Duplication

Lines	26
Ratio	100 %

Code Coverage

Tests	11
CRAP Score	3.0327

Importance

Changes

Metric	Value
dl	26
loc	26
ccs	11
cts	13
cp	0.8462
rs	9.504
c	0
b	0
f	0
cc	3
nc	5
nop	1
crap	3.0327

<?php declare(strict_types=1);
/**
 * SmartCall Restful API (v3) HTTP Client.
 *
 * PLEASE NOTE: The interface is very fluid while the intial integration
 * is taking place.  It will be refactored in the near future.
 *
 * @author    Jacques Marneweck <[email protected]>
 * @copyright 2017-2019 Jacques Marneweck.  All rights strictly reserved.
 * @license   MIT
 */

namespace Jacques\Smartcall\HttpClient\Traits;

trait SmartLoad
{
    /**
     * Authenticate and retrieves the dealer balance in Rands.
     *
     * @param string $dealerMsisdn
     *
     * @throws Exception
     *
     * @return array
     */
    public function balance($dealerMsisdn)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/balance/%s',
                    $dealerMsisdn
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and request to cancel a previous recharge request. Will only
     * succeed if the recharge has not been successfully submitted to the network.
     *
     * @param string $dealerMsisdn
     * @param string $clientReference
     *
     * @throws Exception
     *
     * @return array
     */
    public function cancelRecharge($dealerMsisdn, $clientReference)

    {
        try {
            $response = $this->delete(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/recharges/%s/%s',
                    $dealerMsisdn,
                    $clientReference
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and request period based cashup reports.
     *
     * @param string $dealerMsisdn
     * @param string $start
     * @param string $end
     *
     * @throws Exception
     *
     * @return array
     */
    public function cashup($dealerMsisdn, $start, $end)

    {
        try {
            $response = $this->post(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '/webservice/smartload/cashup',
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                    'json'    => [
                        'smartloadId' => $dealerMsisdn,
                        'startDate'   => $start,
                        'endDate'     => $end,
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and request current day cashup report.
     *
     * @param string $dealerMsisdn
     *
     * @throws Exception
     *
     * @return array
     */
    public function cashupToday($dealerMsisdn)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/cashup/%s',
                    $dealerMsisdn
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and request to transfer funds from one Smartload account to another.
     *
     * @param string $fromDealerMsisdn
     * @param string $toDealerMsisdn
     * @param string $amount
     * @param string $sendSms
     *
     * @throws Exception
     *
     * @return array
     */
    public function fundstransfer($fromDealerMsisdn, $toDealerMsisdn, $amount, $sendSms)

    {
        try {
            $response = $this->post(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '/webservice/smartload/fundstransfer',
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                    'json' => [
                        'sourceSmartloadId'    => $fromDealerMsisdn,
                        'recipientSmartloadId' => $toDealerMsisdn,
                        'amount'               => $amount,
                        'sendSms'              => $sendSms,
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and retrieves a list of all available networks.
     *
     * @param int $networkId
     *
     * @throws Exception
     *
     * @return array
     */
    public function network($networkId)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/networks/%d',
                    $networkId
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and retrieves a list of all available networks.
     *
     * @throws Exception
     *
     * @return array
     */
    public function networks()

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '/webservice/smartload/networks',
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and recharge prevend request.
     *
     * @param string $dealerMsisdn
     * @param string $clientReference
     * @param string $smsRecipientMsisdn
     * @param string $deviceId
     * @param int    $productId
     * @param int    $amount
     * @param bool   $pinless
     * @param bool   $sendSms
     */
    public function prevend($dealerMsisdn, $clientReference, $smsRecipientMsisdn, $deviceId, $productId, $amount, $pinless, $sendSms)

    {
        try {
            $response = $this->post(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '/webservice/smartload/prevend',
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                    'json' => [
                        'smartloadId'        => $dealerMsisdn,
                        'clientReference'    => $clientReference,
                        'smsRecipientMsisdn' => $smsRecipientMsisdn,
                        'deviceId'           => $deviceId,
                        'productId'          => $productId,
                        'amount'             => $amount,
                        'pinless'            => $pinless,
                        'sendSms'            => $sendSms,
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and retrieves the product information for the specified product id.
     *
     * @param int $productId
     *
     * @throws Exception
     *
     * @return array
     */
    public function products($productId)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/products/%d',
                    $productId
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and recharge request.
     *
     * @param string $dealerMsisdn
     * @param string $clientReference
     * @param string $smsRecipientMsisdn
     * @param string $deviceId
     * @param int    $productId
     * @param int    $amount
     * @param bool   $pinless
     * @param bool   $sendSms
     */
    public function recharge($dealerMsisdn, $clientReference, $smsRecipientMsisdn, $deviceId, $productId, $amount, $pinless, $sendSms)

    {
        try {
            $response = $this->post(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                '/webservice/smartload/recharges',
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                    'json' => [
                        'smartloadId'        => $dealerMsisdn,
                        'clientReference'    => $clientReference,
                        'smsRecipientMsisdn' => $smsRecipientMsisdn,
                        'deviceId'           => $deviceId,
                        'productId'          => $productId,
                        'amount'             => $amount,
                        'pinless'            => $pinless,
                        'sendSms'            => $sendSms,
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and checks if the provided ID (MSISDN) is registered with Smartload.
     *
     * @param string $dealerMsisdn
     *
     * @throws Exception
     *
     * @return array
     */
    public function registered($dealerMsisdn)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/registered/%s',
                    $dealerMsisdn
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Authenticate and retrieves the details of the transaction that was performed
     * by the dealer using the Client reference number.
     *
     * @param string $dealerMsisdn
     * @param string $clientReference
     */
    public function transaction($dealerMsisdn, $clientReference)

    {
        try {
            $response = $this->get(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                sprintf(
                    '/webservice/smartload/recharges/%s/%s',
                    $dealerMsisdn,
                    $clientReference
                ),
                [
                    'headers' => [
                        'Authorization' => $this->bearerOrBasic(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                    ],
                ]
            );

            return [
                'status'    => 'ok',
                'http_code' => $response->getStatusCode(),
                'body'      => (string) $response->getBody(),
            ];
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            return $this->clientError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } catch (\GuzzleHttp\Exception\ServerException $e) {
            return $this->parseError($e);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }
}


1			<?php declare(strict_types=1);
2			/**
3			* SmartCall Restful API (v3) HTTP Client.
4			*
5			* PLEASE NOTE: The interface is very fluid while the intial integration
6			* is taking place. It will be refactored in the near future.
7			*
8			* @author Jacques Marneweck <[email protected]>
9			* @copyright 2017-2019 Jacques Marneweck. All rights strictly reserved.
10			* @license MIT
11			*/
12
13			namespace Jacques\Smartcall\HttpClient\Traits;
14
15			trait SmartLoad
16			{
17			/**
18			* Authenticate and retrieves the dealer balance in Rands.
19			*
20			* @param string $dealerMsisdn
21			*
22			* @throws Exception
23			*
24			* @return array
25			*/
26	4	View Code Duplication	public function balance($dealerMsisdn)
			0 ignored issues – show Duplication introduced 2018-02-18 18:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
27			{
28			try {
29	4		$response = $this->get(
			0 ignored issues – show Bug introduced 2018-02-25 11:26 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
30	4		sprintf(
31	4		'/webservice/smartload/balance/%s',
32	4		$dealerMsisdn
33			),
34			[
35			'headers' => [
36	4		'Authorization' => $this->bearerOrBasic(),
			0 ignored issues – show Bug introduced 2018-02-25 11:26 UTC by Report Bug Copy Issue Report It seems like `bearerOrBasic()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
37			],

jacques / php-smartcall-httpclient

Push — master ( d53117...da6533 )

SmartLoad::balance() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like