Skip to content

Commit 6ab15ed

Browse files
detaindetain
committed
updates adding tests in and updating readme/composer file
1 parent d751193 commit 6ab15ed

9 files changed

Lines changed: 1550 additions & 390 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
tests:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
fail-fast: false
14+
matrix:
15+
php: ['8.2', '8.3', '8.4']
16+
17+
name: PHP ${{ matrix.php }}
18+
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
23+
- name: Setup PHP
24+
uses: shivammathur/setup-php@v2
25+
with:
26+
php-version: ${{ matrix.php }}
27+
extensions: soap, simplexml, curl
28+
coverage: none
29+
30+
- name: Install dependencies
31+
run: composer install --prefer-dist --no-progress --no-interaction
32+
33+
- name: Run tests
34+
run: vendor/bin/phpunit --configuration phpunit.xml.dist

‎README.md‎

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,59 @@
1-
# Softaculous Licensing Class
1+
# MyAdmin Softaculous Licensing
22

3-
Softaculous Licensing Class
3+
[![Tests](https://github.com/detain/myadmin-softaculous-licensing/actions/workflows/tests.yml/badge.svg)](https://github.com/detain/myadmin-softaculous-licensing/actions/workflows/tests.yml)
4+
[![Latest Stable Version](https://poser.pugx.org/detain/myadmin-softaculous-licensing/version)](https://packagist.org/packages/detain/myadmin-softaculous-licensing)
5+
[![Total Downloads](https://poser.pugx.org/detain/myadmin-softaculous-licensing/downloads)](https://packagist.org/packages/detain/myadmin-softaculous-licensing)
6+
[![License](https://poser.pugx.org/detain/myadmin-softaculous-licensing/license)](https://packagist.org/packages/detain/myadmin-softaculous-licensing)
47

5-
## Build Status and Code Analysis
8+
A PHP library for managing Softaculous, Webuzo, Virtualizor, and SiteMush licenses through the Softaculous NOC API. This package provides a MyAdmin plugin integration layer along with a standalone API client for license lifecycle operations including purchasing, renewal, cancellation, refunds, IP management, and auto-renewal configuration.
69

7-
Site | Status
8-
--------------|---------------------------
9-
![Travis-CI](http://i.is.cc/storage/GYd75qN.png "Travis-CI") | [![Build Status](https://travis-ci.org/detain/myadmin-softaculous-licensing.svg?branch=master)](https://travis-ci.org/detain/myadmin-softaculous-licensing)
10-
![CodeClimate](http://i.is.cc/storage/GYlageh.png "CodeClimate") | [![Code Climate](https://codeclimate.com/github/detain/myadmin-softaculous-licensing/badges/gpa.svg)](https://codeclimate.com/github/detain/myadmin-softaculous-licensing) [![Test Coverage](https://codeclimate.com/github/detain/myadmin-softaculous-licensing/badges/coverage.svg)](https://codeclimate.com/github/detain/myadmin-softaculous-licensing/coverage) [![Issue Count](https://codeclimate.com/github/detain/myadmin-softaculous-licensing/badges/issue_count.svg)](https://codeclimate.com/github/detain/myadmin-softaculous-licensing)
11-
![Scrutinizer](http://i.is.cc/storage/GYeUnux.png "Scrutinizer") | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/badges/build.png?b=master)](https://scrutinizer-ci.com/g/myadmin-plugins/softaculous-licensing/build-status/master)
12-
![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-softaculous-licensing) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/25fa74eb74c947bf969602fcfe87e349)](https://www.codacy.com/app/detain/myadmin-softaculous-licensing?utm_source=github.com&utm_medium=referral&utm_content=detain/myadmin-softaculous-licensing&utm_campaign=Badge_Coverage)
13-
![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-softaculous-licensing?branch=master)
14-
![Packagist](http://i.is.cc/storage/GYacBEX.png "Packagist") | [![Latest Stable Version](https://poser.pugx.org/detain/myadmin-softaculous-licensing/version)](https://packagist.org/packages/detain/myadmin-softaculous-licensing) [![Total Downloads](https://poser.pugx.org/detain/myadmin-softaculous-licensing/downloads)](https://packagist.org/packages/detain/myadmin-softaculous-licensing) [![Latest Unstable Version](https://poser.pugx.org/detain/myadmin-softaculous-licensing/v/unstable)](//packagist.org/packages/detain/myadmin-softaculous-licensing) [![Monthly Downloads](https://poser.pugx.org/detain/myadmin-softaculous-licensing/d/monthly)](https://packagist.org/packages/detain/myadmin-softaculous-licensing) [![Daily Downloads](https://poser.pugx.org/detain/myadmin-softaculous-licensing/d/daily)](https://packagist.org/packages/detain/myadmin-softaculous-licensing) [![License](https://poser.pugx.org/detain/myadmin-softaculous-licensing/license)](https://packagist.org/packages/detain/myadmin-softaculous-licensing)
10+
## Features
1511

12+
- Full Softaculous NOC API client (`SoftaculousNOC`) supporting Softaculous, Webuzo, Virtualizor, and SiteMush products
13+
- MyAdmin plugin integration with event-driven hooks for license activation, deactivation, and IP changes
14+
- XML/Array conversion utilities (`ArrayToXML`)
15+
- Invoice and billing transaction management
16+
- Auto-renewal management
17+
18+
## Requirements
19+
20+
- PHP 8.2 or higher
21+
- ext-soap
22+
- ext-curl
23+
- ext-simplexml
1624

1725
## Installation
1826

19-
Install with composer like
27+
Install via Composer:
2028

2129
```sh
2230
composer require detain/myadmin-softaculous-licensing
2331
```
2432

25-
## License
33+
## Usage
34+
35+
```php
36+
use Detain\MyAdminSoftaculous\SoftaculousNOC;
37+
38+
$noc = new SoftaculousNOC('your-username', 'your-password');
39+
40+
// Purchase a license
41+
$result = $noc->buy('198.198.198.198', '1M', 1, 'admin@example.com', 1);
42+
43+
// List all licenses
44+
$licenses = $noc->licenses();
2645

27-
The Softaculous Licensing Class class is licensed under the LGPL-v2.1 license.
46+
// Cancel a license by key
47+
$noc->cancel('88888-88888-88888-88888-88888');
48+
```
49+
50+
## Running Tests
51+
52+
```sh
53+
composer install
54+
vendor/bin/phpunit
55+
```
56+
57+
## License
2858

59+
This package is licensed under the LGPL-2.1 license.

‎composer.json‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,28 @@
1616
],
1717
"config": {
1818
"bin-dir": "vendor\/bin",
19-
"minimum-stability": "dev"
19+
"minimum-stability": "dev",
20+
"allow-plugins": {
21+
"detain/myadmin-plugin-installer": true
22+
}
2023
},
2124
"require": {
22-
"php": ">=5.3.0",
25+
"php": ">=8.2",
2326
"ext-soap": "*",
2427
"detain/myadmin-plugin-installer": "dev-master",
25-
"symfony/event-dispatcher": "^5.0@stable"
26-
},
28+
"symfony/event-dispatcher": "^5.0|^6.0|^7.0"
29+
},
2730
"require-dev": {
28-
"phpunit/phpunit": "*",
29-
"phpunit/phpunit-mock-objects": "*",
30-
"vlucas/phpdotenv": "*",
31-
"codeclimate/php-test-reporter": "dev-master",
32-
"satooshi/php-coveralls": "*",
33-
"codacy/coverage": "dev-master"
31+
"phpunit/phpunit": "^9.6"
3432
},
3533
"autoload": {
3634
"psr-4": {
3735
"Detain\\MyAdminSoftaculous\\": "src/"
3836
}
37+
},
38+
"autoload-dev": {
39+
"psr-4": {
40+
"Detain\\MyAdminSoftaculous\\Tests\\": "tests/"
41+
}
3942
}
4043
}

‎phpunit.xml.dist‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
4+
bootstrap="tests/bootstrap.php"
5+
cacheResultFile=".phpunit.cache/test-results"
6+
executionOrder="depends,defects"
7+
forceCoversAnnotation="false"
8+
beStrictAboutCoversAnnotation="false"
9+
beStrictAboutOutputDuringTests="true"
10+
beStrictAboutTodoAnnotatedTests="true"
11+
convertDeprecationsToExceptions="true"
12+
failOnRisky="true"
13+
failOnWarning="true"
14+
verbose="true"
15+
colors="true">
16+
<testsuites>
17+
<testsuite name="Unit">
18+
<directory suffix="Test.php">tests</directory>
19+
</testsuite>
20+
</testsuites>
21+
<coverage cacheDirectory=".phpunit.cache/code-coverage"
22+
processUncoveredFiles="false">
23+
<include>
24+
<directory suffix=".php">src</directory>
25+
</include>
26+
</coverage>
27+
</phpunit>

0 commit comments

Comments
 (0)