updates adding tests in and updating readme/composer file

Author: detain

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: ['8.2', '8.3', '8.4']
+
+    name: PHP ${{ matrix.php-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: soap
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run tests
+        run: vendor/bin/phpunit

README.md

@@ -1,28 +1,54 @@
-# Kayako handling plugin for MyAdmin
+# MyAdmin Kayako Support Plugin
 
-Kayako handling plugin for MyAdmin
+[![Build Status](https://github.com/detain/myadmin-kayako-support/actions/workflows/tests.yml/badge.svg)](https://github.com/detain/myadmin-kayako-support/actions)
+[![Latest Stable Version](https://poser.pugx.org/detain/myadmin-kayako-support/version)](https://packagist.org/packages/detain/myadmin-kayako-support)
+[![Total Downloads](https://poser.pugx.org/detain/myadmin-kayako-support/downloads)](https://packagist.org/packages/detain/myadmin-kayako-support)
+[![License](https://poser.pugx.org/detain/myadmin-kayako-support/license)](https://packagist.org/packages/detain/myadmin-kayako-support)
 
-## Build Status and Code Analysis
+A MyAdmin plugin that integrates with the Kayako ticket and helpdesk system. It provides event-driven hooks for API registration, requirement loading, and settings management within the MyAdmin platform. The package exposes SOAP-compatible API functions for creating, listing, viewing, and replying to support tickets through Kayako.
 
-Site          | Status
---------------|---------------------------
-![Travis-CI](http://i.is.cc/storage/GYd75qN.png "Travis-CI")     | [![Build Status](https://travis-ci.org/detain/myadmin-kayako-support.svg?branch=master)](https://travis-ci.org/detain/myadmin-kayako-support)
-![CodeClimate](http://i.is.cc/storage/GYlageh.png "CodeClimate")  | [![Code Climate](https://codeclimate.com/github/detain/myadmin-kayako-support/badges/gpa.svg)](https://codeclimate.com/github/detain/myadmin-kayako-support) [![Test Coverage](https://codeclimate.com/github/detain/myadmin-kayako-support/badges/coverage.svg)](https://codeclimate.com/github/detain/myadmin-kayako-support/coverage) [![Issue Count](https://codeclimate.com/github/detain/myadmin-kayako-support/badges/issue_count.svg)](https://codeclimate.com/github/detain/myadmin-kayako-support)
-![Scrutinizer](http://i.is.cc/storage/GYeUnux.png "Scrutinizer")   | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/badges/build.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/kayako-support/build-status/master)
-![Codacy](http://i.is.cc/storage/GYi66Cx.png "Codacy")        | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/226251fc068f4fd5b4b4ef9a40011d06)](https://www.codacy.com/app/detain/myadmin-kayako-support) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/25fa74eb74c947bf969602fcfe87e349)](https://www.codacy.com/app/detain/myadmin-kayako-support?utm_source=github.com&utm_medium=referral&utm_content=detain/myadmin-kayako-support&utm_campaign=Badge_Coverage)
-![Coveralls](http://i.is.cc/storage/GYjNSim.png "Coveralls")    | [![Coverage Status](https://coveralls.io/repos/github/detain/db_abstraction/badge.svg?branch=master)](https://coveralls.io/github/detain/myadmin-kayako-support?branch=master)
-![Packagist](http://i.is.cc/storage/GYacBEX.png "Packagist")     | [![Latest Stable Version](https://poser.pugx.org/detain/myadmin-kayako-support/version)](https://packagist.org/packages/detain/myadmin-kayako-support) [![Total Downloads](https://poser.pugx.org/detain/myadmin-kayako-support/downloads)](https://packagist.org/packages/detain/myadmin-kayako-support) [![Latest Unstable Version](https://poser.pugx.org/detain/myadmin-kayako-support/v/unstable)](//packagist.org/packages/detain/myadmin-kayako-support) [![Monthly Downloads](https://poser.pugx.org/detain/myadmin-kayako-support/d/monthly)](https://packagist.org/packages/detain/myadmin-kayako-support) [![Daily Downloads](https://poser.pugx.org/detain/myadmin-kayako-support/d/daily)](https://packagist.org/packages/detain/myadmin-kayako-support) [![License](https://poser.pugx.org/detain/myadmin-kayako-support/license)](https://packagist.org/packages/detain/myadmin-kayako-support)
+## Features
 
+- Registers ticket management API endpoints (create, list, view, reply)
+- Hooks into MyAdmin's event dispatcher for seamless plugin integration
+- Manages Kayako connection settings (API URL, key, secret)
+- Input validation with descriptive error messages on all API calls
+- Pagination support for ticket listing
 
 ## Installation
 
-Install with composer like
+Install with Composer:
 
 ```sh
 composer require detain/myadmin-kayako-support
 ```
 
-## License
+## Configuration
+
+The plugin uses three configuration constants that should be defined in your MyAdmin environment:
+
+- `KAYAKO_API_URL` - The base URL for the Kayako REST API
+- `KAYAKO_API_KEY` - Your Kayako API key
+- `KAYAKO_API_SECRET` - Your Kayako API secret
+
+## Usage
 
-The Kayako handling plugin for MyAdmin class is licensed under the LGPL-v2.1 license.
+The plugin registers itself through MyAdmin's event dispatcher. The `Plugin::getHooks()` method returns the event-to-handler mappings:
+
+```php
+use Detain\MyAdminKayako\Plugin;
+
+$hooks = Plugin::getHooks();
+// Returns: ['api.register' => ..., 'function.requirements' => ..., 'system.settings' => ...]
+```
+
+## Running Tests
+
+```sh
+composer install
+vendor/bin/phpunit
+```
+
+## License
 
+Licensed under the LGPL-2.1. See [LICENSE](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html) for details.

composer.json

@@ -25,16 +25,16 @@
 		"detain/myadmin-plugin-installer": "dev-master"
     },
 	"require-dev": {
-		"phpunit/phpunit": "*",
-		"phpunit/phpunit-mock-objects": "*",
-		"vlucas/phpdotenv": "*",
-		"codeclimate/php-test-reporter": "dev-master",
-		"satooshi/php-coveralls": "*",
-		"codacy/coverage": "dev-master"
+		"phpunit/phpunit": "^9.6"
 	},
 	"autoload": {
 		"psr-4": {
 			"Detain\\MyAdminKayako\\": "src/"
 		}
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"Detain\\MyAdminKayako\\Tests\\": "tests/"
+		}
 	}
 }

phpunit.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         verbose="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         beStrictAboutOutputDuringTests="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>