initial commit

Author: harrisonratcliffe

.gitattributes

@@ -21,3 +21,6 @@ Homestead.yaml
 Homestead.json
 /.vagrant
 .phpunit.result.cache
+
+# Jet Brains
+/.idea

.gitignore

@@ -0,0 +1,142 @@
+# IP-Api Laravel - IP Address Information Lookup
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/harrisonratcliffe/ip-api-laravel.svg?style=flat-square)](https://packagist.org/packages/harrisonratcliffe/ip-api-laravel)
+[![Total Downloads](https://img.shields.io/packagist/dt/harrisonratcliffe/ip-api-laravel?style=flat-square)](https://packagist.org/packages/harrisonratcliffe/ip-api-laravel)
+[![Repo Size](https://img.shields.io/github/repo-size/harrisonratcliffe/ip-api-laravel?style=flat-square)](https://packagist.org/packages/harrisonratcliffe/ip-api-laravel)
+[![Repo Size](https://img.shields.io/packagist/l/harrisonratcliffe/ip-api-laravel?style=flat-square)](https://packagist.org/packages/harrisonratcliffe/ip-api-laravel)
+
+The `IpApiLaravel` package provides an easy-to-use interface for looking up information about IP addresses using the ip-api-laravel.com API. It allows you to fetch various details about an IP address, such as geographical location, time zone, currency, and more.
+
+This package is a fork of [el-factory/ip-api](https://github.com/el-factory/ip-api) with additional features.
+
+## Requirements
+
+- PHP 7.2 or higher
+- Laravel 7 or higher
+
+## Installation
+
+The `IpApiLaravel` package requires Laravel version 7 or higher.
+
+To install the package, you can use Composer:
+
+```bash
+composer require harrisonratcliffe/ip-api-laravel
+```
+
+## Configuration
+
+After installing the package, you can optionally publish the configuration file to customize the default settings:
+
+```bash
+php artisan vendor:publish --tag=ip-api-laravel-config
+```
+
+This will create a `ip-api-laravel.php` file in the `config` directory of your Laravel application. You can modify the default configuration values in this file according to your specific requirements.
+
+## Usage
+
+### IP Address Lookup
+
+To perform an IP address lookup, you can use the `lookup` method on the `IpApiLaravel` class:
+
+```php
+use Harrisonratcliffe\IpApiLaravel\IpApiLaravel;
+
+$ipDetails = IpApiLaravel::default('188.216.103.93')->lookup();
+```
+
+This will return an array with the details of the provided IP address.
+
+### Additional Configuration
+
+You can also customize the IP address lookup by using the following methods:
+
+#### `fields(array $fields): IpApiLaravel`
+
+Set the fields to be included in the API response. The `$fields` parameter should be an array of fields you want to retrieve.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->fields(['city', 'country', 'timezone'])->lookup();
+```
+
+#### `usingKey(string $apiKey): IpApiLaravel`
+
+By default, the package uses the API key provided in the config file. If you wish to send a different API key for a specific request, you can use the `usingKey` method to set the API key for that request.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->usingKey('YOUR_API_KEY')->lookup();
+```
+
+#### `retry(int $times, int $sleep): IpApiLaravel`
+
+Set the retry configuration for failed API requests. The `$times` parameter represents the number of retry attempts, and the `$sleep` parameter specifies the number of seconds to sleep between retries.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->retry(3, 2)->lookup();
+```
+
+#### `lang(string $language): IpApiLaravel`
+
+Set the language for the API response. The `$language` parameter should be a two-letter language code.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->lang('en')->lookup();
+```
+
+#### `withHeaders(): IpApiLaravel`
+
+Include request limit and remaining requests headers in the API response.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->withHeaders()->lookup();
+```
+
+#### `timeout(int $seconds): IpApiLaravel`
+
+Set a timeout for the API request. The `$seconds` parameter specifies the maximum number of seconds to wait for a response. If the request times out, an exception will be thrown.
+
+```php
+$ipDetails = IpApiLaravel::default('188.216.103.93')->timeout(10)->lookup(); // Set timeout to 10 seconds
+```
+
+### Console Command - `ip-api-laravel:connection`
+
+The `IpApiLaravel` package also includes a console command named `ip-api-laravel:connection` that allows you to test the connection to the ip-api-laravel.com API with a specific IP address or your public IP address (if not provided).
+
+To use the command, run the following Artisan command:
+
+```bash
+php artisan ip-api-laravel:connection {ip?}
+```
+
+- `{ip}` (optional): The IP address to test with. If not provided, the command will use your public IP address.
+
+The command will display the details retrieved from the ip-api-laravel.com API for the provided IP address.
+
+### Example
+
+Here's an example of using the `ip-api-laravel:connection` command:
+
+```bash
+php artisan ip-api-laravel:connection 188.216.103.93
+```
+
+This will test the connection to ip-api-laravel.com API with the specified IP address and display the details retrieved.
+
+If no IP address is provided, the command will automatically use your public IP address:
+
+```bash
+php artisan ip-api-laravel:connection
+```
+
+## Exceptions
+
+The `IpApiLaravel` class may throw the following exceptions:
+
+- `Exception`: If the provided IP address is invalid or reserved.
+- `RequestException`: If an error occurs while making the API request.
+
+## License
+
+The `IpApiLaravel` package is open-source software licensed under the [MIT License](https://opensource.org/licenses/MIT). Feel free to use and modify it according to your needs.

README.md

@@ -0,0 +1,37 @@
+{
+    "name": "harrisonratcliffe/ip-api",
+    "description": "A simple Laravel package to get IP address information from ip-api.com",
+    "type": "library",
+    "keywords": ["ip-api.com", "ip api laravel", "ip api php", "ip api"],
+    "license": "MIT",
+    "require": {
+        "php": ">=7.2",
+        "illuminate/support": ">=7.0"
+    },
+    "require-dev": {
+        "pestphp/pest": "^2.9",
+        "orchestra/testbench": "^8.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "Harrisonratcliffe\\IpApiLaravel\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Harrisonratcliffe\\IpApiLaravel\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Harrisonratcliffe\\IpApiLaravel\\IpApiLaravelServiceProvider"
+            ]
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    }
+}

composer.json

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'key' => env('IP_API_KEY', ''),
+    'url' => env('IP_API_URL', 'http://ip-api.com/json/'),
+    'lang' => env('IP_API_LANG', 'en'),
+];

config/ip-api.php

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false"
+         colors="true" processIsolation="false" stopOnFailure="false"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" cacheDirectory=".phpunit.cache"
+         backupStaticProperties="false">
+    <coverage/>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </source>
+    <php>
+        <env name="IP_API_KEY" value=""/>
+        <env name="IP_API_URL" value="http://ip-api.com/json/"/>
+        <env name="IP_API_LANG" value="en"/>
+    </php>
+</phpunit>

phpunit.xml.dist

@@ -0,0 +1,43 @@
+<?php
+
+namespace Harrisonratcliffe\IpApiLaravel\Console;
+
+use Harrisonratcliffe\IpApiLaravel\IpApiLaravel;
+use Exception;
+use Illuminate\Console\Command;
+use Illuminate\Http\Client\RequestException;
+use Illuminate\Support\Facades\Http;
+
+class TestConnection extends Command
+{
+    protected $signature = 'ip-api:connection 
+                            {ip? : The IP address to test with}';
+
+    protected $description = 'Test connection to ip-api.com';
+
+    /**
+     * @throws RequestException
+     * @throws Exception
+     */
+    public function handle(): int
+    {
+        $ip = $this->argument('ip') ?? $this->publicIp();
+        $response = IpApiLaravel::default($ip)->lookup();
+
+        $this->warn('Testing connection to ip-api.com api with ip: '.$ip);
+        $this->info(json_encode($response));
+
+        return 0;
+    }
+
+    /**
+     * Get the public IP address
+     */
+    private function publicIp(): string
+    {
+        $response = Http::get('https://httpbin.org/ip');
+        $data = $response->json();
+
+        return $data['origin'];
+    }
+}