soconnect/ruckus-client

Ruckus WLAN controller API client

Installs: 2 323

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 7

Forks: 0

Open Issues: 2

Type:project

v1.6.0 2020-08-10 13:36 UTC

README

Build Status 68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f36373333376338386335313131393238643134642f746573745f636f766572616765 Latest Stable Version License

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.

License

Released under the MIT License.