Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/avto-dev/rabbitmq-api-client

RabbitMQ API client
https://github.com/avto-dev/rabbitmq-api-client

client laravel-package php rabbitmq

Last synced: 2 months ago
JSON representation

RabbitMQ API client

Awesome Lists containing this project

README

        


Laravel

# RabbitMQ API Client

[![Version][badge_packagist_version]][link_packagist]
[![PHP Version][badge_php_version]][link_packagist]
[![Build Status][badge_build_status]][link_build_status]
[![Coverage][badge_coverage]][link_coverage]
[![Downloads count][badge_downloads_count]][link_packagist]
[![License][badge_license]][link_license]

This package adds into your PHP application RabbitMQ API client implementation.

## Install

Require this package with composer using the following command:

```bash
$ composer require avto-dev/rabbitmq-api-client "^2.0"
```

> Installed `composer` is required ([how to install composer][getcomposer]).

> You need to fix the major version of package.

After that you can "publish" package configuration file using following command:

```bash
$ php artisan vendor:publish --provider="AvtoDev\\RabbitMqApiClient\\Frameworks\\Illuminate\\LaravelServiceProvider"
```

## Usage

At first, you should create API client instance:

```php
healthcheck(); // `true` or `false`
$client->queueInfo('some-queue-name'); // Object with information about queue
```

If you are using Laravel framework with registered package service-provider, you can resolve client instance using DI, for example:

```php
healthcheck(); // `true` or `false`
}
}
```

### Testing

For package testing we use `phpunit` framework and `docker-ce` + `docker-compose` as develop environment. So, just write into your terminal after repository cloning:

```bash
$ make build
$ make latest # or 'make lowest'
$ make test
```

## Changes log

[![Release date][badge_release_date]][link_releases]
[![Commits since latest release][badge_commits_since_release]][link_commits]

Changes log can be [found here][link_changes_log].

## Support

[![Issues][badge_issues]][link_issues]
[![Issues][badge_pulls]][link_pulls]

If you will find any package errors, please, [make an issue][link_create_issue] in current repository.

## License

This is open-sourced software licensed under the [MIT License][link_license].

[badge_packagist_version]:https://img.shields.io/packagist/v/avto-dev/rabbitmq-api-client.svg?maxAge=180
[badge_php_version]:https://img.shields.io/packagist/php-v/avto-dev/rabbitmq-api-client.svg?longCache=true
[badge_build_status]:https://img.shields.io/github/actions/workflow/status/avto-dev/rabbitmq-api-client/tests.yml
[badge_coverage]:https://img.shields.io/codecov/c/github/avto-dev/rabbitmq-api-client/master.svg?maxAge=60
[badge_downloads_count]:https://img.shields.io/packagist/dt/avto-dev/rabbitmq-api-client.svg?maxAge=180
[badge_license]:https://img.shields.io/packagist/l/avto-dev/rabbitmq-api-client.svg?longCache=true
[badge_release_date]:https://img.shields.io/github/release-date/avto-dev/rabbitmq-api-client.svg?style=flat-square&maxAge=180
[badge_commits_since_release]:https://img.shields.io/github/commits-since/avto-dev/rabbitmq-api-client/latest.svg?style=flat-square&maxAge=180
[badge_issues]:https://img.shields.io/github/issues/avto-dev/rabbitmq-api-client.svg?style=flat-square&maxAge=180
[badge_pulls]:https://img.shields.io/github/issues-pr/avto-dev/rabbitmq-api-client.svg?style=flat-square&maxAge=180
[link_releases]:https://github.com/avto-dev/rabbitmq-api-client/releases
[link_packagist]:https://packagist.org/packages/avto-dev/rabbitmq-api-client
[link_build_status]:https://github.com/avto-dev/rabbitmq-api-client/actions
[link_coverage]:https://codecov.io/gh/avto-dev/rabbitmq-api-client/
[link_changes_log]:https://github.com/avto-dev/rabbitmq-api-client/blob/master/CHANGELOG.md
[link_issues]:https://github.com/avto-dev/rabbitmq-api-client/issues
[link_create_issue]:https://github.com/avto-dev/rabbitmq-api-client/issues/new/choose
[link_commits]:https://github.com/avto-dev/rabbitmq-api-client/commits
[link_pulls]:https://github.com/avto-dev/rabbitmq-api-client/pulls
[link_license]:https://github.com/avto-dev/rabbitmq-api-client/blob/master/LICENSE
[getcomposer]:https://getcomposer.org/download/