naymyomhan/hello-cat

Package to get random cat images from internet 😺

1.1.0 2024-11-14 16:39 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7.0
• laravel/framework: ^8.0|^9.0|^10.0

MIT

• Nay Myo Mhan

README

A simple Laravel package to get random cat images. This package provides two main functions to retrieve a single cat image or multiple images with optional breed filters.

Installation

To install the package via Composer, use:

composer require naymyomhan/hello-cat

After installation, publish the configuration file to set up your API key:

php artisan vendor:publish --tag=hello-cat

Set your CAT_API_KEY in the .env file:(optional)

CAT_API_KEY=your-cat-api-key-here

Usage

This package provides two main classes: Cat and CatGroup.

1. Get a Single Random Cat Image

You can use the Cat class to fetch a single random cat image.

use Naymyomhan\HelloCat\Cat;

$cat = new Cat(); 
$response = $cat->image();

Example JSON Response

{
    "success": true,
    "message": "OK",
    "data": {
        "image": "https://cdn2.thecatapi.com/images/abc.jpg",
        "width": 500,
        "height": 400
    }
}

2. Get Multiple Random Cat Images

The CatGroup class allows you to retrieve multiple random cat images with optional breed filtering.

use Naymyomhan\HelloCat\CatGroup;

$catGroup = new CatGroup();
$response = $catGroup->images(5, 'beng'); // Fetch 5 images of 'beng' breed

Example JSON Response

{
    "success": true,
    "message": "OK",
    "data": [
        {
            "url": "https://cdn2.thecatapi.com/images/abc.jpg",
            "width": 500,
            "height": 400
        },
        {
            "url": "https://cdn2.thecatapi.com/images/xyz.jpg",
            "width": 600,
            "height": 450
        }
        // Additional images
    ]
}

Credits

This package uses The Cat API to fetch random cat images. A big thank you to them for providing such an awesome service!

Error Handling

The CatGroup class allows you to retrieve multiple random cat images with optional breed filtering.

{
    "success": false,
    "message": "Something went wrong"
}

License

This package is open-source software licensed under the MIT license.

Additional Notes

• Make sure to replace "your-cat-api-key-here" with an actual API key from The Cat API.
• Customize the package configuration as needed, especially if you have more environment settings.

This README.md file provides clear instructions for installation, configuration, and usage of the package's two functions.