geoip2-api/test/index.test.js

This module allows obtaining the client's geolocation using their IP address, leveraging data retrieved from a fast API.

const geoIp = require('../index.js');

describe('GeoIP Wrapper Module', () => {
	test('Should resolve with valid data for Cloudflare IP address [1.1.1.1]', async () => {
		const cfIp = '1.1.1.1';

		const result = await geoIp.get(cfIp);
		expect(result).toMatchObject({
			success: true,
			status: 200,
			ip: cfIp,
			data: expect.any(Object),
		});
	});

	test('Should resolve with valid data for Google IP address [8.8.8.8]', async () => {
		const googleIp = '8.8.8.8';

		const result = await geoIp.get(googleIp);
		expect(result).toMatchObject({
			success: true,
			status: 200,
			ip: googleIp,
			data: expect.objectContaining({
				country: 'US',
			}),
		});
	});

	test('Should resolve with valid data for a Polish IP address [5.172.224.0]', async () => {
		const validIP = '5.172.224.0';

		const result = await geoIp.get(validIP);
		expect(result).toMatchObject({
			success: true,
			status: 200,
			ip: validIP,
			data: expect.objectContaining({
				country: 'PL',
				timezone: 'Europe/Warsaw',
			}),
		});
	});

	test('Should reject with an error for an invalid IP address', async () => {
		const invalidIP = 'invalid.ip';

		try {
			await geoIp.get(invalidIP);
		} catch (result) {
			expect(result).toBeDefined();
			expect(result.message).toBe('HTTP Status Code: 400');
		}
	});

	test('Should reject with an error for a private IP address', async () => {
		const privateIP = '192.168.1.1';

		await expect(geoIp.get(privateIP)).rejects.toMatchObject({
			message: 'HTTP Status Code: 403',
		});
	});

	test('Should reject with an error for the loopback IP address [127.0.0.1]', async () => {
		const loopbackIP = '127.0.0.1';

		await expect(geoIp.get(loopbackIP)).rejects.toMatchObject({
			message: 'HTTP Status Code: 403',
		});
	});

	test('Should resolve with valid data for an IPv4 address [104.113.255.255]', async () => {
		const ipv4Address = '104.113.255.255';

		const result = await geoIp.get(ipv4Address);
		expect(result).toMatchObject({
			success: true,
			status: 200,
			ip: ipv4Address,
			data: expect.objectContaining({
				country: expect.any(String),
			}),
		});
	});

	test('Should reject with an error for a malformed IP address', async () => {
		try {
			await geoIp.get('123.456.789.000');
		} catch (result) {
			expect(result).toBeDefined();
			expect(result.message).toBe('HTTP Status Code: 400');
		}
	});
});