pixelpeter / laravel5-genderize-api-client
Laravel 5 client for the genderize.io API
Installs: 65 410
Dependents: 0
Suggesters: 0
Security: 0
Stars: 46
Watchers: 4
Forks: 6
Open Issues: 4
Requires
- php: ^7.0
- mashape/unirest-php: ^3.0
Requires (Dev)
- laravel/laravel: 5.5.*
- mockery/mockery: ^1.0.0
- phpunit/phpunit: ^6.5
- satooshi/php-coveralls: ^1.0
README
A simple Laravel 5 client for the Genderize.io API. It provides a fluent interface for easy request building.
WARNING: This library is deprecated. Please use https://github.com/pixelpeter/laravel-genderize-api-client instead.
Version overview
Installation
Step 1: Install Through Composer
composer require pixelpeter/laravel5-genderize-api-client
Step 2: Add the Service Provider (not needed with v2.x because of auto discovery)
Add the service provider in app/config/app.php
'provider' => [ ... Pixelpeter\Genderize\GenderizeServiceProvider::class, ... ];
Step 3: Add the Facade
Add the alias in app/config/app.php
'aliases' => [ ... 'Genderize' => Pixelpeter\Genderize\Facades\Genderize::class, ... ];
Step 4: 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->first()->gender; // 'male' print $response->result->first()->name; // 'Peter' print $response->result->first()->probability; '0.99' print $response->result->first()->count; 144 print $response->result->first()->isMale(); true print $response->result->first()->isFemale(); false print $response->result->first()->isNotMale(); false print $response->result->first()->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.