Azine\MailgunWebhooksBundle\Services\HetrixtoolsService\AzineMailgunHetrixtoolsService

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

58.62%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	checkIpAddressInBlacklist()	0	9	1
A	executeCheck()	0	21	2
A	prepareBlacklistIpCheckUrl()	0	17	4

<?php

namespace Azine\MailgunWebhooksBundle\Services\HetrixtoolsService;

/**
 * AzineMailgunHetrixtoolsService
 *
 * This service is a wrapper for using Hetrixtools blacklist check functionality https://hetrixtools.com/.
 */
class AzineMailgunHetrixtoolsService
{
    /**
     * @var string
     */
    private $apiKey;

    /**
     * @var string
     */
    private $blacklistIpCheckUrl;

    /**
     * AzineMailgunHetrixtoolsService constructor.
     *
     * @param string $apiKey
     * @param string $url
     */
    public function __construct($apiKey, $url)
    {
        $this->apiKey = $apiKey;
        $this->blacklistIpCheckUrl = $url;
    }

    /**
     * @param string $ip
     * @return HetrixtoolsServiceResponse $response
     */
    public function checkIpAddressInBlacklist($ip)
    {
        $url = $this->prepareBlacklistIpCheckUrl($ip);

        $jsonResponse = $this->executeCheck($url);
        $hetrixtoolsServiceResponse = HetrixtoolsServiceResponse::fromJson($jsonResponse);

        return $hetrixtoolsServiceResponse;
    }

    /**
     * sends a get request to the given url
     *
     * @param  string $url
     * @return string $response| null
     */
    protected function executeCheck($url)
    {
        $ch = curl_init($url);

        curl_setopt($ch, CURLOPT_HEADER, true);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        $server_output = curl_exec($ch);
        $info = curl_getinfo($ch);
        $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
        curl_close($ch);

        if($info['http_code'] != 200){

            return null;
        }

        $response = substr($server_output, $header_size);

        return $response;
    }

    /**
     * @param string $ip
     * @throws \InvalidArgumentException
     * @return string $url
     */
    private function prepareBlacklistIpCheckUrl($ip)
    {
        if ($ip == null || !filter_var($ip, FILTER_VALIDATE_IP)) {

            throw new \InvalidArgumentException('Given Ip address is invalid');
        }

        if($this->apiKey == null){

            throw new \InvalidArgumentException('Api key for Hetrixtools blacklist check service is not set');
        }

        $url = str_replace('<API_TOKEN>', $this->apiKey, $this->blacklistIpCheckUrl);
        $url = str_replace('<IP_ADDRESS>', $ip, $url);

        return $url;
    }
}