https://github.com/pixelbrackets/give-notice

Send a request to a preset URI and don’t expect a response
https://github.com/pixelbrackets/give-notice

notice notification php request tracker

Last synced: 10 months ago
JSON representation

Send a request to a preset URI and don’t expect a response

• Host: GitHub
• URL: https://github.com/pixelbrackets/give-notice
• Owner: pixelbrackets
• Created: 2020-09-29T19:28:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-30T19:38:10.000Z (over 5 years ago)
• Last Synced: 2025-03-06T18:29:37.834Z (about 1 year ago)
• Topics: notice, notification, php, request, tracker
• Language: PHP
• Homepage: https://gitlab.com/pixelbrackets/give-notice/
• Size: 54.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# Give Notice

![Logo](docs/icon.png)

[![Version](https://img.shields.io/packagist/v/pixelbrackets/give-notice.svg?style=flat-square)](https://packagist.org/packages/pixelbrackets/give-notice/)

[![Build Status](https://img.shields.io/gitlab/pipeline/pixelbrackets/give-notice?style=flat-square)](https://gitlab.com/pixelbrackets/give-notice/pipelines)

[![Made With](https://img.shields.io/badge/made_with-php-blue?style=flat-square)](https://gitlab.com/pixelbrackets/give-notice#requirements)

[![License](https://img.shields.io/badge/license-gpl--2.0--or--later-blue.svg?style=flat-square)](https://spdx.org/licenses/GPL-2.0-or-later.html)

[![Contribution](https://img.shields.io/badge/contributions_welcome-%F0%9F%94%B0-brightgreen.svg?labelColor=brightgreen&style=flat-square)](https://gitlab.com/pixelbrackets/give-notice/-/blob/master/CONTRIBUTING.md)

Send a request to a preset URI and don’t expect a response.

![Screenshot](./docs/screenshot.png)

## Vision

The idea of the package is to just “give notice” to another service. When the

notification is send, it is not relevant to get any feedback.

This package provides a static method to sends requests to a preset URI.

The URI is configured with an environment variable and therefore separated

from application code.

The app calling the method does not need or want a response.

The method is silent. The request timeout of the method is very low by default.

Use cases:

- Send a heartbeat to another service, to 

  [push instead of polling](https://resthooks.org/), but yet don't reverse

  responsibilities to react to unavailability

- Ping a tracking service whenever a certain API endpoint was called,

  [limit the timeout and discard any response](https://stackoverflow.com/questions/14359926/send-http-request-from-php-without-waiting-for-response),

  because under heavy load it is more important to keep a fast API than 

  loosing some tracking requests

- Notify an unimportant service or be absolutely positive the message will

  receive its target and do not block the app unnecessarily

See [»Usage«](#usage) for an example.

The package follows the KISS principle.

## Requirements

- PHP

## Installation

Packagist Entry https://packagist.org/packages/pixelbrackets/give-notice/

## Source

https://gitlab.com/pixelbrackets/give-notice/

Mirror https://github.com/pixelbrackets/give-notice/

## Usage

Set an environment variable to preset a URI to call later on.

```bash

GIVENOTICE_URI='https://example.com/endpoint/11azqde1'

```

1. Send a request straightaway

   ```php

   \Pixelbrackets\GiveNotice\Notification::push();

   ```

☝️ Be aware that the static notification object is silent by design. It returns

nothing and catches exceptions, such as connection errors. If the notified 

service is not available then your app will not hear about it. Instead, 

the service needs to monitor and react to overdue messages.

## License

GNU General Public License version 2 or later

The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.

## Author

Dan Untenzu ( / [@pixelbrackets](https://pixelbrackets.de))

## Changelog

See [./CHANGELOG.md](CHANGELOG.md)

## Contribution

This script is Open Source, so please use, patch, extend or fork it.

[Contributions](CONTRIBUTING.md) are welcome!