github/abuseipdb
1
0
Fork 0
mirror of https://github.com/kristuff/abuseipdb synced 2025-08-21 05:53:13 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

v0.9.5

Browse source 
**Added**
- Support for clear address request (remove own report for a given IP address)

**Changed**
- internal refactoring
This commit is contained in:
kristuff 2021-01-08 15:51:29 +01:00
commit ed9e4bd8fb
4 changed files with 61 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

62
lib/ApiHandler.php
View file

@ -14,7 +14,7 @@
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 0.9.4
* @version 0.9.5
* @copyright 2020-2021 Kristuff
*/
@ -86,13 +86,13 @@ class ApiHandler extends ApiDefintion
}
/**
* Get a new instance of ApiManager with config stored in a Json file
* Get a new instance of ApiHandler with config stored in a Json file
*
* @access public
* @static
* @param string $configPath The configuration file path
*
* @return \Kristuff\AbuseIPDB\ApiManager
* @return \Kristuff\AbuseIPDB\ApiHandler
* @throws \InvalidArgumentException If the given file does not exist
* @throws \Kristuff\AbuseIPDB\InvalidPermissionException If the given file is not readable
*/
@ -123,17 +123,6 @@ class ApiHandler extends ApiDefintion
return $app;
}
/**
* Get the list of report categories
*
* @access public
* @return array
*/
public function getCategories()
{
return $this->aipdbApiCategories;
}
/**
* Performs a 'report' api request
*
@ -149,7 +138,7 @@ class ApiHandler extends ApiDefintion
* @param string $ip The ip to report
* @param string $categories The report categories
* @param string $message The report message
* @param bool $returnArray True to return an indexed array instead of an object. Default is false.
* @param bool $returnArray True to return an indexed array instead of object. Default is false.
*
* @return object|array
* @throws \InvalidArgumentException
@ -226,7 +215,7 @@ class ApiHandler extends ApiDefintion
* @access public
* @param string $network The network to check
* @param int $maxAge Max age in days
* @param bool $returnArray True to return an indexed array instead of an object. Default is false.
* @param bool $returnArray True to return an indexed array instead of object. Default is false.
*
* @return object|array
* @throws \InvalidArgumentException when maxAge is less than 1 or greater than 365, or when network value was not set.
@ -254,6 +243,42 @@ class ApiHandler extends ApiDefintion
return json_decode($response, $returnArray);
}
/**
* Perform a 'clear-address' api request
*
* Sample response:
*
* {
* "data": {
* "numReportsDeleted": 0
* }
* }
*
*
* @access public
* @param string $ip The ip to check
* @param bool $returnArray True to return an indexed array instead of object. Default is false.
*
* @return object|array
* @throws \InvalidArgumentException When ip value was not set.
*/
public function clear(string $ip = null, bool $returnArray = false)
{
// ip must be set
if (empty($ip)){
throw new \InvalidArgumentException('ip argument must be set (null given)');
}
// minimal data
$data = [
'ipAddress' => $ip,
];
$response = $this->apiRequest('check', $data, 'DELETE', $returnArray) ;
return json_decode($response, $returnArray);
}
/**
* Perform a 'check' api request
*
@ -261,7 +286,7 @@ class ApiHandler extends ApiDefintion
* @param string $ip The ip to check
* @param int $maxAge Max age in days
* @param bool $verbose True to get the full response. Default is false
* @param bool $returnArray True to return an indexed array instead of an object. Default is false.
* @param bool $returnArray True to return an indexed array instead of object. Default is false.
*
* @return object|array
* @throws \InvalidArgumentException when maxAge is less than 1 or greater than 365, or when ip value was not set.
@ -289,7 +314,6 @@ class ApiHandler extends ApiDefintion
$data['verbose'] = true;
}
// check AbuseIPDB request
$response = $this->apiRequest('check', $data, 'GET', $returnArray) ;
return json_decode($response, $returnArray);
@ -301,7 +325,7 @@ class ApiHandler extends ApiDefintion
* @access public
* @param int $limit The blacklist limit. Default is TODO (the api default limit)
* @param bool $plainText True to get the response in plain text list. Default is false
* @param bool $returnArray True to return an indexed array instead of an object (when $plainText is set to false). Default is false.
* @param bool $returnArray True to return an indexed array instead of object (when $plainText is set to false). Default is false.
*
* @return object|array
* @throws \InvalidArgumentException When maxAge is not a numeric value, when maxAge is less than 1 or