pixelpeter/laravel-genderize-api-client

Laravel 8+ client for the genderize.io API

v10.2.0 2024-10-16 00:36 UTC

Requires

• php: ^8.1|^8.2|^8.3
• laravel/framework: ^10.0|^11.0
• mashape/unirest-php: ^3.0.4

Requires (Dev)

• mockery/mockery: ^1.6.12
• orchestra/testbench: ^8.0|^9.0
• php-coveralls/php-coveralls: ^2.7
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.12.6
• phpunit/phpunit: ^10.5|^11.0

MIT

• Peter Haak

• api
• validation
• laravel
• gender

README

A simple Laravel 8+ client for the Genderize.io API. It provides a fluent interface for easy request building.

Version overview

Installation

Step 1: Install Through Composer

composer require pixelpeter/laravel-genderize-api-client

Step 2: Add the Facade

Add the alias in app/config/app.php

'aliases' => [
    ...
    'Genderize' => Pixelpeter\Genderize\Facades\Genderize::class,
    ...
];

Step 3: Publish the configuration file

This is only needed when you have an API key from Genderize.io

php artisan vendor:publish --provider="Pixelpeter\Genderize\GenderizeServiceProvider"

Examples

Send requests

Single name

use Genderize;

Genderize::name('Peter')->get();

Multiple names (max. 10)

use Genderize;

Genderize::name(['John', 'Jane'])->get();

// or for better readability you can use the plural
Genderize::names(['John', 'Jane'])->get();

Add language and country options

use Genderize;

Genderize::name('John')->country('US')->lang('EN')->get();

Working with the response

For single usage

use Genderize;

$response = Genderize::name('Peter')->get();

print $response->result->gender; // 'male'
print $response->result->name; // 'Peter'
print $response->result->probability; '0.99'
print $response->result->count; 144
print $response->result->isMale(); true
print $response->result->isFemale(); false
print $response->result->isNotMale(); false
print $response->result->isNotFemale(); true

For batch usage

use Genderize;

$response = Genderize::names(['John', 'Jane'])->country('US')->lang('EN')->get();

foreach($response->result as $row)
{
    print $row->name;
}

Getting information about the request and limits

use Genderize;

$response = Genderize::name('Peter')->get();

print $response->meta->code; // 200 - HTTP response code
print $response->meta->limit; // 1000 - Max number of allowed requests
print $response->meta->remaining; // 950 - Number of requests left
print $response->meta->reset->diffInSeconds(); // Carbon\Carbon - time left till reset

More documentation

Refer to Genderize.io API Documentation for more examples and documentation.

Testing

Run the tests with:

vendor/bin/phpunit

License

The MIT License (MIT). Please see License File for more information.