Enhancements & Documentation changes

Author: gre-dev

composer.json

@@ -1,32 +1,38 @@
 {
-    "name": "greip/api",
-    "description": "Greip, protects your business from fraud and abuse by deploying AI-powered modules into your system.",
-    "keywords": [
-        "api",
-        "ip",
-        "location",
-        "fraud",
-        "abuse",
-        "profanity",
-        "geoip"
-    ],
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Greip",
-            "email": "info@greip.io",
-            "homepage": "https://greip.io/",
-            "role": "Developer"
-        }
-    ],
-    "type": "library",
-    "require": {
-        "php": ">=7.4"
-    },
-    "autoload": {
-        "psr-4": {
-            "Greip\\API\\": "src/"
-        }
-    },
-    "minimum-stability": "stable"
-}
+  "name": "greip/api",
+  "description": "Greip, protects your business from fraud and abuse by deploying AI-powered modules into your system.",
+  "keywords": [
+    "api",
+    "ip",
+    "location",
+    "fraud",
+    "abuse",
+    "profanity",
+    "geoip",
+    "bin lookup",
+    "email verification",
+    "phone verification",
+    "ip reputation",
+    "ip intelligence",
+    "iban validation"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Greip",
+      "email": "info@greip.io",
+      "homepage": "https://greip.io/",
+      "role": "Developer"
+    }
+  ],
+  "type": "library",
+  "require": {
+    "php": ">=7.4"
+  },
+  "autoload": {
+    "psr-4": {
+      "Greip\\API\\": "src/"
+    }
+  },
+  "minimum-stability": "stable"
+}

src/Config.php

@@ -4,16 +4,16 @@
 
 class Config
 {
-    public static $APIKey = "";
+    public static $APIKey = null;
 
     /**
-     * setKey method
+     * Set the API Key
      *
-     * @param string $key Pass you API Key as a string here. You can also store it in a .env file and pass a variable that returns the API Key as a string.
+     * @param string $key The API Key
      *
      * @return bool
      */
-    public function setKey($key): bool
+    public function setToken($key): bool
     {
         if (!empty($key)) {
             self::$APIKey = $key;
@@ -23,7 +23,24 @@ public function setKey($key): bool
         }
     }
 
-    public function getKey(): string
+    /**
+     * Set the API Key
+     *
+     * @param string $key The API Key
+     *
+     * @return bool
+     */
+    public function setKey($key): bool
+    {
+        return self::setToken($key);
+    }
+
+    /**
+     * Get the API Key
+     *
+     * @return string
+     */
+    public function getToken(): string
     {
         return self::$APIKey;
     }

src/Enums/Language.php

@@ -0,0 +1,39 @@
+<?php
+namespace Greip\API\Enums;
+
+use ReflectionClass;
+
+abstract class Language
+{
+    const AR = "AR";
+    const EN = "EN";
+    const DE = "DE";
+    const FR = "FR";
+    const ES = "ES";
+    const JA = "JA";
+    const ZH = "ZH";
+    const RU = "RU";
+
+    /**
+     * Get all constants of this class
+     *
+     * @return array
+     */
+    public static function values()
+    {
+        $reflector = new ReflectionClass(__CLASS__);
+        return $reflector->getConstants();
+    }
+
+    /**
+     * Checks if a constant exist by value
+     *
+     * @param string $constant_value E.g: `isExist('dash')`.
+     * @return boolean
+     */
+    public static function isExist($constant_value)
+    {
+        $constants = self::values();
+        return in_array($constant_value, $constants, true);
+    }
+}

src/Enums/Mode.php

@@ -0,0 +1,33 @@
+<?php
+namespace Greip\API\Enums;
+
+use ReflectionClass;
+
+abstract class Mode
+{
+    const LIVE = "live";
+    const DEVELOPMENT = "test";
+
+    /**
+     * Get all constants of this class
+     *
+     * @return array
+     */
+    public static function values()
+    {
+        $reflector = new ReflectionClass(__CLASS__);
+        return $reflector->getConstants();
+    }
+
+    /**
+     * Checks if a constant exist by value
+     *
+     * @param string $constant_value E.g: `isExist('dash')`.
+     * @return boolean
+     */
+    public static function isExist($constant_value)
+    {
+        $constants = self::values();
+        return in_array($constant_value, $constants, true);
+    }
+}

src/Enums/Param.php

@@ -0,0 +1,38 @@
+<?php
+namespace Greip\API\Enums;
+
+use ReflectionClass;
+
+abstract class Param
+{
+    const LANGUAGE = "language";
+    const FLAG = "flag";
+    const CURRENCY = "currency";
+    const TIMEZONE = "timezone";
+    const LOCATION = "location";
+    const SECURITY = "security";
+    const DEVICE = "device";
+
+    /**
+     * Get all constants of this class
+     *
+     * @return array
+     */
+    public static function values()
+    {
+        $reflector = new ReflectionClass(__CLASS__);
+        return $reflector->getConstants();
+    }
+
+    /**
+     * Checks if a constant exist by value
+     *
+     * @param string $constant_value E.g: `isExist('dash')`.
+     * @return boolean
+     */
+    public static function isExist($constant_value)
+    {
+        $constants = self::values();
+        return in_array($constant_value, $constants, true);
+    }
+}