README

What is Brew Buddy?

Brew Buddy is your companion in beer discovery. Whether you're a passionate homebrewer or a talented developer eager to create innovative applications, he is here to support you.

Explore the vast universe of beers through rich APIs filled with accurate data. From ingredient profiles to sensory characteristics, you'll have access to a wealth of information to enhance your applications or websites.

Installation

composer require malvik-lab/brewbuddy-api-client

Initializing

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client as HttpClient;
use MalvikLab\BrewBuddyClient\Client;

$brewBuddyClient = Client::make(Client::CLIENT_V1, new HttpClient());

Client Methods

METHOD	ARGUMENTS
getLanguages	RequestOption $requestOption
getCountries	RequestOption $requestOption
getImages	RequestOption $requestOption
getTypologies	RequestOption $requestOption
getBreweries	RequestOption $requestOption
getGlasses	RequestOption $requestOption
getFermentationMethods	RequestOption $requestOption
getFoams	RequestOption $requestOption
getBeers	RequestOption $requestOption

Basic use

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client as HttpClient;
use MalvikLab\BrewBuddyClient\Client;

$brewBuddyClient = Client::make(Client::CLIENT_V1, new HttpClient());
$beers = $brewBuddyClient->getBeers();

Request Option

The RequestOption class represents request options for API calls. It provides methods to configure pagination, sorting, and filtering options for specific requests.

METHOD	ARGUMENTS	DEFAULT VALUES	DESCRIPTION
setId	string $id		Set the identifier of the requested object
setPage	int $page	1	Set the page number of the results
setLimit	int $limit	20	Set the maximum number of results per page
setSort	string $sort		Set the field to order the results by
setOrder	string $order	asc	Set the sorting direction
addFilterByFullTextSearch	mixed $value		Add a filter for full text search
addFilterByExactMatch	string $field, mixed $value		Add a filter for exact match search
addFilterByPartialMatch	string $field, mixed $value		Add a filter for partial match search
addFilterByLessThanOrEqualValue	string $field, mixed $value		Add a filter for searching based on less than or equal to value
addFilterByGreaterThanOrEqualValue	string $field, mixed $value		Aggiunge un filtro per la ricerca basata su valore maggiore o uguale
getId			Returns the identifier of the requested object
getPage			Returns the page number of the results
getLimit			Returns the maximum number of results per page
getSort			Returns the field to order the results by
getOrder			Returns the sorting direction
getFilters			Returns the filters for searching results

Advanced usage

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client as HttpClient;
use MalvikLab\BrewBuddyClient\Client;
use MalvikLab\BrewBuddyClient\Clients\V1\Options\RequestOption;

$brewBuddyClient = Client::make(Client::CLIENT_V1, new HttpClient());

$requestOption = (new RequestOption())
    ->setPage(1)
    ->setLimit(3)
    ->setSort('name')
    ->setOrder(RequestOption::ORDER_ASC)
    ->addFilterByGreaterThanOrEqualValue('releasedYear', 1980)
    ->addFilterByPartialMatch('name', 'Mamma')
    ->addFilterByExactMatch('filtrated', true)
    ->addFilterByExactMatch('typology.id', '9b97543e-4841-4b49-a5d4-9bdd9e0b8e95')
    ->addFilterByLessThanOrEqualValue('image.size', 187123)
;

$beers = $brewBuddyClient->getBeers($requestOption);

Output example

$beer = $brewBuddyClient->getBeer('0692bda5-b13e-4596-a3c0-e88c404490be');

Running Test

vendor/bin/phpunit Tests/Integration/V1 --testdox

malvik-lab / brewbuddy-api-client

Maintainers

Details