soconnect / ruckus-client
Ruckus WLAN controller API client
Installs: 2 351
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 7
Forks: 0
Open Issues: 2
Type:project
Requires
- php: >=5.6
- ext-json: *
- guzzlehttp/guzzle: ~6.3
Requires (Dev)
- allejo/php-vcr-sanitizer: ~1.0
- jakub-onderka/php-parallel-lint: ~1.0
- php-vcr/php-vcr: ~1.4
- php-vcr/phpunit-testlistener-vcr: ~3.2
- phpstan/phpstan: ~0.11
- phpstan/phpstan-phpunit: ~0.11
- phpunit/phpunit: ~7.5
- squizlabs/php_codesniffer: ~3.4
- vlucas/phpdotenv: ^5.1
This package is auto-updated.
Last update: 2024-12-19 22:43:08 UTC
README
Ruckus Client
Ruckus WLAN controller API client
Requirements
- PHP >= 5.6
Installation
With composer:
composer require soconnect/ruckus-client
Example Usage
Get the list of Access Points
$client = new SoConnect\RuckusClient\Client($host); $res = $client->apConfig()->listAll();
Create new hotspot WLAN
$client = new SoConnect\RuckusClient\Client($host); $res = $client->wlan()->createWispr($zoneId, $body);
Configuration
Configuration is done using environment variables following 12-factor app methodology. Look at getenv() PHP function for details.
.env.example file contains possible config variables.
Development
Configure environment
cp .env.example .env
Running
docker-compose up -d
Installing Dependencies
docker-compose exec client composer install
Testing
Unit & integration tests are provided in the /tests folder. To run these tests simply run following command from the project root.
docker-compose exec client bin/phpunit
VCR
Project is using PHP-VCR snapshots for the integration testing of Ruckus API responses integrated with PHPUnit through phpunit-testlistener-vcr.
- See php-vcr for details
License
Released under the MIT License.