Sypex Geo Laravel4 Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require likewinter/sypex-geo-laravel4
   

   Add the service provider to config/app.php:

   'providers' => [
       // ...
       'Likewinter\SypexGeo\SypexGeoServiceProvider',
   ],
   

2. Publish Config:

   php artisan config:publish likewinter/sypex-geo-laravel4
   

   Configure app/config/packages/likewinter/sypex-geo-laravel4.php with your SypexGeo API key and database path.

3. First Use Case: Fetch geolocation data for an IP address in a controller:

   use Likewinter\SypexGeo\Facades\SypexGeo;
   
   $ip = '8.8.8.8';
   $geoData = SypexGeo::get($ip);
   dd($geoData); // Returns array with country, city, coordinates, etc.
   

Implementation Patterns

Common Workflows

1. Geolocation Lookup:

   // Single IP lookup
   $data = SypexGeo::get('192.168.1.1');
   
   // Batch lookup (if supported by the package)
   $ips = ['1.1.1.1', '2.2.2.2'];
   $results = SypexGeo::get($ips);
   

2. Middleware for Automatic Geo-IP: Create middleware to attach geo-data to requests:

   namespace App\Http\Middleware;
   
   use Closure;
   use Likewinter\SypexGeo\Facades\SypexGeo;
   
   class GeoIpMiddleware
   {
       public function handle($request, Closure $next)
       {
           $ip = $request->ip();
           $request->merge(['geo' => SypexGeo::get($ip)]);
           return $next($request);
       }
   }
   

   Register in app/Http/Kernel.php:

   protected $middleware = [
       // ...
       \App\Http\Middleware\GeoIpMiddleware::class,
   ];
   

3. Database Integration: Store geo-data in a geo_ips table and cache results:

   // Model: GeoIp.php
   class GeoIp extends Model
   {
       protected $fillable = ['ip', 'country', 'city', 'lat', 'lng'];
   
       public static function findOrCreateForIp($ip)
       {
           return static::firstOrCreate(
               ['ip' => $ip],
               SypexGeo::get($ip)
           );
       }
   }
   

4. API Response Enhancement: Attach geo-data to API responses:

   return response()->json([
       'data' => $user,
       'geo' => request()->geo // From middleware
   ]);
   

Gotchas and Tips

Pitfalls

1. Database File Path:

   • Ensure the database_path in config matches the actual SypexGeo database file location (e.g., /path/to/sypexgeo.dat).
   • Default Laravel storage_path('app') may not work; use an absolute path.

2. IPv6 Support:

   • The package may not natively support IPv6. Validate IPs before lookup:

     if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
         $geoData = SypexGeo::get($ip);
     }
     

3. Caching:

   • The package may not cache results by default. Implement a cache layer (e.g., Redis) for frequent lookups:

     $cacheKey = "geo:{$ip}";
     $geoData = Cache::remember($cacheKey, 86400, function() use ($ip) {
         return SypexGeo::get($ip);
     });
     

4. Rate Limiting:

   • SypexGeo databases are large (~100MB). Avoid loading in high-traffic loops. Use middleware sparingly.

Debugging

• Verify Database File: Check if the database file exists and is readable:

  $path = config('sypex-geo.database_path');
  if (!file_exists($path)) {
      throw new \Exception("SypexGeo database not found at {$path}");
  }
  

• Log Missing IPs: Handle cases where an IP isn’t found in the database:

  $geoData = SypexGeo::get($ip);
  if (empty($geoData['country'])) {
      Log::warning("No geo data for IP: {$ip}");
  }
  

Extension Points

1. Custom Fields: Extend the returned data by modifying the package’s get() method (if open-source) or wrapping it:

   class ExtendedSypexGeo extends \Likewinter\SypexGeo\Facades\SypexGeo
   {
       public static function getWithEnrichment($ip)
       {
           $data = parent::get($ip);
           $data['is_eu'] = self::isEuCountry($data['country']);
           return $data;
       }
   
       private static function isEuCountry($countryCode)
       {
           // Logic to check EU membership
       }
   }
   

2. Fallback Mechanism: Implement a fallback to another geo-service if SypexGeo fails:

   try {
       $geoData = SypexGeo::get($ip);
   } catch (\Exception $e) {
       $geoData = GeoIp2::get($ip); // Alternative service
   }
   

3. Testing: Mock the facade for unit tests:

   $this->app->instance('sypex-geo', $mockGeoData);