Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexskrypnyk/integration_report
Drupal module to report on availability status of 3-rd party endpoints.
https://github.com/alexskrypnyk/integration_report
drupal integration
Last synced: about 1 month ago
JSON representation
Drupal module to report on availability status of 3-rd party endpoints.
- Host: GitHub
- URL: https://github.com/alexskrypnyk/integration_report
- Owner: AlexSkrypnyk
- License: gpl-3.0
- Created: 2020-07-16T14:43:39.000Z (over 4 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-08-01T07:29:30.000Z (6 months ago)
- Last Synced: 2024-12-25T18:56:02.283Z (about 1 month ago)
- Topics: drupal, integration
- Language: PHP
- Homepage: https://www.drupal.org/project/integration_report
- Size: 87.9 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Integration Report Drupal module
[](https://github.com/AlexSkrypnyk/integration_report/issues)
[](https://github.com/AlexSkrypnyk/integration_report/pulls)
[](https://circleci.com/gh/AlexSkrypnyk/integration_report)
## Why?
If your website has 3rd-party integration with one or multiple 3rd-party
services via API endpoints, this module allows to call the endpoints and
see all the response information within a single page.
You may also implement status check on behalf of any other Drupal module that
does not have such information page.
## Features
- Single page for all status checks.
- ``-based status checks (useful for SSO with redirects).
## Getting started
1. Extend `IntegrationReport` class with your 3rd-party endpoint request
methods.
2. Register this class as a service in your custom module and tag it:
services:
example_integration_report:
class: Drupal\example\ExampleIntegrationReport
tags:
- { name: integration_report }
3. Go to `/admin/reports/integrations` to check the status.
Refer to [integration_report.api.php](integration_report.api.php) and
`modules/integration_report_example` for an implementation example.
## Local development
Provided that you have PHP installed locally, you can develop an extension using
the provided scripts.
### Build
Run `.devtools/assemble.sh` (or `ahoy assemble`
if [Ahoy](https://github.com/ahoy-cli/ahoy) is installed) to start inbuilt PHP
server locally and run the same commands as in CI, plus installing a site and
your extension automatically.
### Code linting
Run tools individually (or `ahoy lint` to run all tools
if [Ahoy](https://github.com/ahoy-cli/ahoy) is installed) to lint your code
according to
the [Drupal coding standards](https://www.drupal.org/docs/develop/standards).
```
cd build
vendor/bin/phpcs
vendor/bin/phpstan
vendor/bin/rector --clear-cache --dry-run
vendor/bin/phpmd . text phpmd.xml
vendor/bin/twig-cs-fixer
```
- PHPCS config: [`phpcs.xml`](phpcs.xml)
- PHPStan config: [`phpstan.neon`](phpstan.neon)
- PHPMD config: [`phpmd.xml`](phpmd.xml)
- Rector config: [`rector.php`](rector.php)
- Twig CS Fixer config: [`.twig-cs-fixer.php`](.twig-cs-fixer.php)
### Tests
Run tests individually with `cd build && ./vendor/bin/phpunit` (or `ahoy test`
if [Ahoy](https://github.com/ahoy-cli/ahoy) is installed) to run all test for
your extension.
### Browsing SQLite database
To browse the contents of created SQLite database
(located at `/tmp/site_[EXTENSION_NAME].sqlite`),
use [DB Browser for SQLite](https://sqlitebrowser.org/).