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.