malvik-lab/punk-api-client

Maintainers

Details

github.com/malvik-lab/punk-api-client

Source

Issues

Installs: 31

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.2 2023-09-20 07:42 UTC

Requires

Requires (Dev)

MIT 7d289d644e742e9940778e13c03ff0385575245b

  • Vittorio Malaspina <vittorio.malaspina.woop@gmail.com>

This package is auto-updated.

Last update: 2024-04-20 09:10:36 UTC

README

Unofficial Punk Api Client.
You can find all the documentation on the official website: https://www.punkapi.com

Installation

composer require malvik-lab/punk-api-client

Instantiate the client

<?php

require 'vendor/autoload.php';

use MalvikLab\PunkApiClient\Client;

$client = Client::make(Client::V2);

// or

$httpClient = new \GuzzleHttp\Client();
$client = Client::make(Client::V2, $httpClient);

Available methods

Beers

<?php

// ...

$page = 1;
$perPage = 25;
$beers = $client->beers($page, $perPage);

Beers with pagination

This method works like the previous one, adding information on pagination (current page, the previous page if present and the next page if present).

<?php

// ...

$page = 1;
$perPage = 25;
$data = $client->beersWithPagination($page, $perPage);

Beer

<?php

// ...

$beerId = 1;
$beer = $client->beer($beerId);

Random beer

<?php

// ...

$beer = $client->randomBeer();

Output example

MalvikLab\PunkApiClient\Clients\V2\DTO\BeerDTO Object
(
    [id] => 58
    [name] => Coffee Imperial Stout
    [tagline] => Beats a Cup of Joe.
    [first_brewed] => 11/2008
    [description] => This beer was released as both as "Danish Beerhouse Coffee Imperial Stout" and "BrewDog Coffee Imperial Stout". Deep, dark, roasted flavours make this a perfect Sunday brunch beer.
    [image_url] => https://images.punkapi.com/v2/58.png
    [abv] => 9
    [ibu] => 65
    [target_fg] => 1019
    [target_og] => 1080
    [ebc] => 97
    [srm] => 49
    [ph] => 4.4
    [attenuation_level] => 76
    [volume] => MalvikLab\PunkApiClient\Clients\V2\DTO\VolumeDTO Object
        (
            [value] => 20
            [unit] => litres
        )

    [boil_volume] => MalvikLab\PunkApiClient\Clients\V2\DTO\BoilVolumeDTO Object
        (
            [value] => 25
            [unit] => litres
        )

    [method] => MalvikLab\PunkApiClient\Clients\V2\DTO\MethodDTO Object
        (
            [mash_temp] => Array
                (
                    [0] => MalvikLab\PunkApiClient\Clients\V2\DTO\MashTempDTO Object
                        (
                            [temp] => MalvikLab\PunkApiClient\Clients\V2\DTO\TempDTO Object
                                (
                                    [value] => 64
                                    [unit] => celsius
                                )

                            [duration] => 90
                        )

                )

            [fermentation] => MalvikLab\PunkApiClient\Clients\V2\DTO\FermentationDTO Object
                (
                    [temp] => MalvikLab\PunkApiClient\Clients\V2\DTO\TempDTO Object
                        (
                            [value] => 19
                            [unit] => celsius
                        )

                )

            [twist] => Coffee added after boil. Aged on French oak chips., Dark muscovado sugar: 312.5g for 20mins
        )

    [ingredients] => MalvikLab\PunkApiClient\Clients\V2\DTO\IngredientsDTO Object
        (
            [malt] => Array
                (
                    [0] => MalvikLab\PunkApiClient\Clients\V2\DTO\MaltDTO Object
                        (
                            [name] => Extra Pale
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 7.5
                                    [unit] => kilograms
                                )

                        )

                    [1] => MalvikLab\PunkApiClient\Clients\V2\DTO\MaltDTO Object
                        (
                            [name] => Dark Crystal
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 0.63
                                    [unit] => kilograms
                                )

                        )

                    [2] => MalvikLab\PunkApiClient\Clients\V2\DTO\MaltDTO Object
                        (
                            [name] => Chocolate
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 0.31
                                    [unit] => kilograms
                                )

                        )

                    [3] => MalvikLab\PunkApiClient\Clients\V2\DTO\MaltDTO Object
                        (
                            [name] => Roasted Barley
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 0.31
                                    [unit] => kilograms
                                )

                        )

                )

            [hops] => Array
                (
                    [0] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => Chinook
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 25
                                    [unit] => grams
                                )

                            [add] => start
                            [attribute] => bitter
                        )

                    [1] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => Galena
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 25
                                    [unit] => grams
                                )

                            [add] => start
                            [attribute] => bitter
                        )

                    [2] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => Galena
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 25
                                    [unit] => grams
                                )

                            [add] => end
                            [attribute] => flavour
                        )

                    [3] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => First Gold
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 25
                                    [unit] => grams
                                )

                            [add] => end
                            [attribute] => flavour
                        )

                    [4] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => Coffee
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 9.4
                                    [unit] => grams
                                )

                            [add] => end
                            [attribute] => flavour
                        )

                    [5] => MalvikLab\PunkApiClient\Clients\V2\DTO\HopsDTO Object
                        (
                            [name] => Coffee
                            [amount] => MalvikLab\PunkApiClient\Clients\V2\DTO\AmountDTO Object
                                (
                                    [value] => 9.4
                                    [unit] => grams
                                )

                            [add] => dry hop
                            [attribute] => aroma
                        )

                )

            [yeast] => Wyeast 1056 - American Ale™
        )

    [food_pairing] => Array
        (
            [0] => Gooey chocolate brownies
            [1] => Chicken fried steak with cheesy mash
            [2] => Spicy chicken empanadas
        )

    [brewers_tips] => Grind the coffee as if making an espresso to really get the most out of it.
    [contributed_by] => Sam Mason <samjbmason>
)

Running Test

vendor/bin/phpunit tests --testdox