survos/geoapify-bundle

Symfony bundle to interact with https://www.geoapify.com/

1.5.442 2024-12-07 14:16 UTC

Requires

• php: ^8.3
• symfony/config: ^6.4 || ^7.1
• symfony/dependency-injection: ^6.4 || ^7.1
• symfony/http-client-contracts: ^3.5
• symfony/http-kernel: ^6.4 || ^7.1
• twig/twig: ^3.4

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.4
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/cache-contracts: ^3.4
• symfony/framework-bundle: ^6.4 || ^7.1
• symfony/phpunit-bridge: ^6.4 || ^7.1
• symfony/twig-bundle: ^6.4 || ^7.1
• symfony/var-dumper: ^6.4 || ^7.1

Suggests

• symfony/cache-contracts: Cache the lookups

MIT

• geolocation
• IP
• symfony6

README

Symfony Bundle to access the API at https://www.geoapify.com/

The geoapify website offers 3000 free lookups per day, and it's very fast and easy to register for an API key. The main purpose of this bundle is to simplify storing the API key in an environment variable and to cache the responses.

First, get an API key at https://myprojects.geoapify.com/projects and add it to .env.local

echo "GEOAPIFY_API_KEY=my-api-key" >> .env.local
composer req survos/geoapify-bundle
bin/console debug:config survos_geoapify --format=yaml > config/packages/survos_geoapify.yaml

# config/packages/survos_geoapify.yaml
survos_geoapify:
  api_key: '%env(GEOAPIFY_API_KEY)%'

Trivial but functional application

Requirements:

• Locally installed PHP 8
• Symfony CLI
• sed (to change /app to / without opening an editor)
• API Key

symfony new GeoapifyDemo --webapp && cd GeoapifyDemo
echo "GEOAPIFY_API_KEY=my-api-key" >> .env.local
symfony composer req survos/geoapify-bundle
symfony console make:controller AppController
sed -i "s|/app|/|" src/Controller/AppController.php 

cat <<'EOF' > templates/app/index.html.twig
{% extends 'base.html.twig' %}
{% block body %}
{% set ip = app.request.clientIp %}
{{ isLocalhost(ip) ? "<div>Localhost has no geolocation, using value from config</div>" }}
Hello, visitor from {{ ipGeolocation(ip).country_name}} )
<pre>{{ ipGeolocation(ip)|json_encode(constant('JSON_PRETTY_PRINT')) }}</pre>

Powered by Geoapify.io <a href="https://www.geoapify.io">IP geolocation</a> web service.

{% endblock %}
EOF

symfony server:start -d
symfony open:local

Notes

https://freeipapi.com/ is a free service that can be used without an API key (up to 60 requests per minute).