Add service client

Author: usox

.gitignore

@@ -0,0 +1,3 @@
+vendor
+composer.lock
+.phpunit.result.cache

.travis.yml

@@ -0,0 +1,11 @@
+language: php
+
+php:
+  - 7.3
+  - nightly
+
+matrix:
+  allow_failures:
+  - php: nightly
+
+before_script: composer install

README.md

@@ -1 +1,24 @@
-# ipintel
+# IpIntel
+
+Small library to query the fraud ip detection service of https://getipintel.net/
+
+# Requirements
+
+- php 7.3
+- curl
+- an email address
+
+# Installation
+
+`composer require usox/ipintel`
+
+# Usage
+
+```php
+    $client = new \Usox\InIntel(
+        new \Curl\Curl(),
+        'your_email@addr.ess
+    );
+
+    $result = $client->validate('127.0.0.1');
+```

composer.json

@@ -0,0 +1,29 @@
+{
+  "name": "usox/ipintel",
+  "description": "Client for https://getipintel.net/",
+  "type": "library",
+  "autoload": {
+    "psr-4": {
+      "Usox\\IpIntel\\": ["src/IpIntel/", "tests/IpIntel/"]
+    }
+  },
+  "require": {
+    "ext-curl": "*",
+    "php": ">=7.3",
+    "php-curl-class/php-curl-class": "^8.6"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^8.4",
+    "mockery/mockery": "^1.2"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Daniel Jakob",
+      "email": "github@usox.org"
+    }
+  ],
+  "scripts": {
+    "test": "phpunit"
+  }
+}

example/retrieve.php

@@ -0,0 +1,15 @@
+<?php
+
+use Curl\Curl;
+use Usox\IpIntel\IpIntel;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+$ip = '127.0.0.1';
+
+$client = new IpIntel(
+    new Curl(),
+    'YOUR_EMAIL@ADDRESS.HERE'
+);
+
+var_dump($client->validate($ip));

phpunit.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+	 bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="TestSuite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <listeners>
+        <listener class="\Mockery\Adapter\Phpunit\TestListener"/>
+    </listeners>
+</phpunit>

src/IpIntel/Exception/IpIntelException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\IpIntel\Exception;
+
+abstract class IpIntelException extends \Exception
+{
+
+}

src/IpIntel/Exception/ServiceException.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\IpIntel\Exception;
+
+final class ServiceException extends IpIntelException
+{
+
+}

src/IpIntel/IpIntel.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\IpIntel;
+
+use Curl\Curl;
+
+final class IpIntel implements IpIntelInterface
+{
+    /**
+     * @var Curl
+     */
+    private $curl;
+
+    /**
+     * @var string Service Url
+     */
+    private $serviceUrl;
+
+    /**
+     * @var int The connection timeout in seconds
+     */
+    private $timeout;
+
+    /**
+     * @var string Contact mail address
+     */
+    private $contactEmailAddress;
+
+    /**
+     * @var string|null Custom flag to append to the url
+     */
+    private $customFlag;
+
+    public function __construct(
+        Curl $curl,
+        string $contactEmailAddress,
+        ?string $customFlag = null,
+        int $timeout = 5,
+        string $serviceUrl = 'https://check.getipintel.net'
+    ) {
+        $this->curl = $curl;
+        $this->contactEmailAddress = $contactEmailAddress;
+        $this->customFlag = $customFlag;
+        $this->timeout = $timeout;
+        $this->serviceUrl = $serviceUrl;
+    }
+
+    public function validate(string $ip, float $fraudProbability = 0.95): bool
+    {
+        $data = [
+            'ip' => $ip,
+            'contact' => $this->contactEmailAddress
+        ];
+
+        if ($this->customFlag !== null) {
+            $data['flags'] = $this->customFlag;
+        }
+
+        $this->curl->setTimeout($this->timeout);
+
+        $response = $this->curl->get(
+            sprintf(
+                '%s/check.php',
+                $this->serviceUrl
+            ),
+            $data
+        );
+
+        if ($response < 0 || strcmp($response, "") == 0) {
+            throw new Exception\ServiceException();
+        }
+
+        return (float) $response < $fraudProbability;
+    }
+}

src/IpIntel/IpIntelInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Usox\IpIntel;
+
+interface IpIntelInterface
+{
+
+    /**
+     * @throws Exception\ServiceException
+     */
+    public function validate(string $ip, float $fraudProbability = 0.95): bool;
+}

tests/IpIntel/IpIntelTest.php

@@ -0,0 +1,111 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Usox\IpIntel;
+
+use Curl\Curl;
+use Mockery;
+use Mockery\Adapter\Phpunit\MockeryTestCase;
+use Mockery\MockInterface;
+use Usox\IpIntel\Exception\ServiceException;
+
+class IpIntelTest extends MockeryTestCase
+{
+    /**
+     * @var null|MockInterface|Curl
+     */
+    private $curl;
+
+    /**
+     * @var null|IpIntel
+     */
+    private $ipIntel;
+
+    private $contactEmailAddress = 'foo@bar.baz';
+
+    public function setUp(): void
+    {
+        $this->curl = Mockery::mock(Curl::class);
+
+        $this->ipIntel = new IpIntel(
+            $this->curl,
+            $this->contactEmailAddress
+        );
+    }
+
+    public function testValidateReturnsFalseIfAbovePropability(): void
+    {
+        $ip = '666.42.33.21';
+
+        $this->curl->shouldReceive('setTimeout')
+            ->with(5)
+            ->once();
+        $this->curl->shouldReceive('get')
+            ->with(
+                'https://check.getipintel.net/check.php',
+                [
+                    'ip' => $ip,
+                    'contact' => $this->contactEmailAddress
+                ]
+            )
+            ->once()
+            ->andReturn('888');
+
+        $this->assertFalse(
+            $this->ipIntel->validate($ip, 777)
+        );
+    }
+
+    public function testValidateAppendsCustomFlagAndReturnsTrueIfBelowPropability(): void
+    {
+        $ipIntel = new IpIntel(
+            $this->curl,
+            $this->contactEmailAddress,
+            'm'
+        );
+        $ip = '666.42.33.21';
+
+        $this->curl->shouldReceive('setTimeout')
+            ->with(5)
+            ->once();
+        $this->curl->shouldReceive('get')
+            ->with(
+                'https://check.getipintel.net/check.php',
+                [
+                    'ip' => $ip,
+                    'contact' => $this->contactEmailAddress,
+                    'flags' => 'm'
+                ]
+            )
+            ->once()
+            ->andReturn('0.1');
+
+        $this->assertTrue(
+            $ipIntel->validate($ip, 0.2)
+        );
+    }
+
+    public function testValidateThrowsExceptionOnServiceError(): void
+    {
+        $this->expectException(ServiceException::class);
+
+        $ip = '666.42.33.21';
+
+        $this->curl->shouldReceive('setTimeout')
+            ->with(5)
+            ->once();
+        $this->curl->shouldReceive('get')
+            ->with(
+                'https://check.getipintel.net/check.php',
+                [
+                    'ip' => $ip,
+                    'contact' => $this->contactEmailAddress
+                ]
+            )
+            ->once()
+            ->andReturn('');
+
+        $this->ipIntel->validate($ip, 0.2);
+    }
+}