Merge branch 'release/0.1.1'

.editorconfig

@@ -12,5 +12,9 @@ indent_style = space
 indent_size = 2
 trim_trailing_whitespace = false
 
+[*.yml]
+indent_style = space
+indent_size = 2
+
 [composer.json]
 indent_style = space

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+
+php:
+  - 5.5
+  - 5.6
+  - 7.0
+  - hhvm
+
+before_install:
+  - composer self-update
+
+install:
+  - composer install
+
+script: phpunit tests

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
-## [0.1.0] - 2015-06-25
+## [Next][next]
+
+## [0.1.1] - 2015-06-26
+
+### Added
+- Travis configuration for CI.
+
+### Fixed
+- Fix infinitely nested function calls.
+- Add some missing docblock tags.
+- Clean up change log.
+
+## 0.1.0 - 2015-06-25
 
 Initial release.
+
+[next]: https://github.com/thasmo/vagrant.box/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/thasmo/php.honeypot-blacklist/compare/v0.1.0...v0.1.1

README.md

@@ -2,6 +2,8 @@
 
 A simple PHP library for querying the [Project Honeypot Http:BL API](http://www.projecthoneypot.org/httpbl_api.php).
 
+[![Build Status](https://travis-ci.org/thasmo/php.honeypot-blacklist.svg?branch=develop)](https://travis-ci.org/thasmo/php.honeypot-blacklist)
+
 ## Usage
 
 ### Create a new instance

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "thasmo/honeypot-blacklist",
-    "description": "",
+    "description": "A simple PHP library for querying the Project Honeypot Http:BL API.",
     "type": "library",
     "keywords": ["honeypot", "blacklist", "spam", "api", "http"],
     "license": "MIT",

src/Blacklist.php

@@ -32,7 +32,7 @@ class Blacklist {
 	 * Default API key to use.
 	 * @var string
 	 */
-    protected static $defaultKey = NULL;
+	protected static $defaultKey = NULL;
 
 	/**
 	 * API key to use.
@@ -81,15 +81,15 @@ class Blacklist {
 	 * @param string $address
 	 * @param string $key
 	 */
-    public function __construct($address, $key = NULL) {
+	public function __construct($address, $key = NULL) {
 		$this->setAddress($address);
 
 		if(!$key) {
 			$key = static::getDefaultKey();
 		}
 
 		$this->setKey($key);
-    }
+	}
 
 	/**
 	 * Validate an API key.
@@ -128,6 +128,7 @@ public static function getDefaultKey() {
 	/**
 	 * Set the default API key.
 	 * @param $key
+	 * @return void
 	 */
 	public static function setDefaultKey($key) {
 		if(!static::validateKey($key)) {
@@ -139,23 +140,25 @@ public static function setDefaultKey($key) {
 
 	/**
 	 * Reset the default API key.
-     */
+	 * @return void
+	 */
 	public static function unsetDefaultKey() {
 		static::$defaultKey = NULL;
 	}
 
 	/**
 	 * Get the API key.
 	 * @return string|NULL
-     */
+	 */
 	public function getKey() {
 		return $this->key;
 	}
 
 	/**
 	 * Set the API key.
 	 * @param string $key
-     */
+	 * @return void
+	 */
 	public function setKey($key) {
 		if(!static::validateKey($key)) {
 			throw new InvalidArgumentException('API key is invalid.');
@@ -167,15 +170,16 @@ public function setKey($key) {
 	/**
 	 * Get the IP address.
 	 * @return string|NULL
-     */
+	 */
 	public function getAddress() {
 		return $this->address;
 	}
 
 	/**
 	 * Set the IP address.
 	 * @param string $address
-     */
+	 * @return void
+	 */
 	public function setAddress($address) {
 		if(!static::validateAddress($address)) {
 			throw new InvalidArgumentException('IP address is invalid.');
@@ -209,7 +213,7 @@ public function getResult($key = NULL) {
 	 * Indicate whether the IP address refers to a search engine or not.
 	 * @param int $type
 	 * @return bool
-     */
+	 */
 	public function isSearchEngine($type = NULL) {
 		$this->query();
 
@@ -227,7 +231,7 @@ public function isSearchEngine($type = NULL) {
 	/**
 	 * Indicate whether the API address is known for suspicious behavior or not.
 	 * @return bool
-     */
+	 */
 	public function isListed() {
 		$this->query();
 		return (bool) ($this->getType() > static::TYPE_SEARCH_ENGINE);
@@ -236,7 +240,7 @@ public function isListed() {
 	/**
 	 * Indicate whether the IP address is suspicious or not.
 	 * @return bool
-     */
+	 */
 	public function isSuspicious() {
 		$this->query();
 		return (bool) ($this->getType() & static::TYPE_SUSPICIOUS);
@@ -245,7 +249,7 @@ public function isSuspicious() {
 	/**
 	 * Indicate whether the IP address refers to a harvester or not.
 	 * @return bool
-     */
+	 */
 	public function isHarvester() {
 		$this->query();
 		return (bool) ($this->getType() & static::TYPE_HARVESTER);
@@ -254,7 +258,7 @@ public function isHarvester() {
 	/**
 	 * Indicate whether the IP address refers to a spammer or not.
 	 * @return bool
-     */
+	 */
 	public function isSpammer() {
 		$this->query();
 		return (bool) ($this->getType() & static::TYPE_SPAMMER);
@@ -263,7 +267,7 @@ public function isSpammer() {
 	/**
 	 * Get the IP's last activity in days.
 	 * @return int|NULL
-     */
+	 */
 	public function getActivity() {
 		$this->query();
 		return $this->getResult('activity');
@@ -272,7 +276,7 @@ public function getActivity() {
 	/**
 	 * Get the IP's threat score.
 	 * @return int
-     */
+	 */
 	public function getThreat() {
 		$this->query();
 		return $this->getResult('threat');
@@ -281,7 +285,7 @@ public function getThreat() {
 	/**
 	 * Get the IP's type.
 	 * @return int
-     */
+	 */
 	public function getType() {
 		$this->query();
 		return $this->getResult('type');
@@ -291,7 +295,7 @@ public function getType() {
 	 * Check if the IP was active within the given number of days.
 	 * @param int $days
 	 * @return bool
-     */
+	 */
 	public function isActive($days) {
 		$this->query();
 		return $days >= $this->getActivity();
@@ -301,7 +305,7 @@ public function isActive($days) {
 	 * Check if the IP's threat score is within in the given score.
 	 * @param int $threat
 	 * @return bool
-     */
+	 */
 	public function isThreat($threat) {
 		$this->query();
 		return $threat <= $this->getThreat();
@@ -310,7 +314,7 @@ public function isThreat($threat) {
 	/**
 	 * Get the IP's search engine name if applicable.
 	 * @return bool|FALSE
-     */
+	 */
 	public function getName() {
 		$this->query();
 
@@ -334,7 +338,7 @@ public function getName() {
 	 */
 	public function query($force = FALSE) {
 		if($this->queried && !$force) {
-			return $this->getResult();
+			return $this->result;
 		}
 
 		# format address
@@ -405,7 +409,8 @@ protected function formatResult($result) {
 
 	/**
 	 * Reset the state of the object.
-     */
+	 * @return void
+	 */
 	protected function reset() {
 		$this->result = NULL;
 		$this->queried = FALSE;