klako/mocknet

En replika av Scoutnet.

v0.3 2022-03-28 21:39 UTC

Requires

• php: >=7.3
• ext-mbstring: *
• ext-pdo: *
• doctrine/annotations: ^1.13
• doctrine/orm: ^2.9.2
• fzaninotto/faker: ^1.9
• slim/psr7: ^1.0
• slim/slim: ^4.4
• symfony/cache: ^5.3
• symfony/process: ^5.0
• tuupola/slim-basic-auth: ^3.2

Requires (Dev)

• ext-pdo_sqlite: *
• phpunit/phpunit: ^9.0

MIT

README

Mocknet is a light weight replica of the scoutnet api using fake data for testing environment.

Installation

Install the package using composer with composer require klako/mocknet

The package requires some database that is compatible with Doctrine, such as sqlite or mysql. Parameters for creating a database connection can be found in the doctrine docs

Running the app

There are three ways to run the app.

Using Scouterna\Mocknet\PhpServer

The following code will start an internal php web server on the host's specified address and port.

$server = new Scouterna\Mocknet\PhpServer(
    "localhost",
    "8080",
    $databaseParams, // parameters for the database connection as specified above
    444, // The group id to be required in the api calls
    "abcdefghikjlmn" // The api key to be required in the api calls
);
$server->start();

Using Scouterna\Mocknet\ServerApp

The following code will run the app if you want to run it programmatically within your existing one.

Scouterna\Mocknet\ServerApp::run(
    $connection, // A Doctrine\DBAL\Connection or parameters for the database connection
    444, // The group id to be required in the api calls
    "abcdefghikjlmn" // The api key to be required in the api calls
);

Using server.php

The server.php file can be used as an entry point for a web server.

The following environment variables must be specified.

• MOCKNET_VENDOR_FOLDER Path to the composer vendor folder
• MOCKNET_DBPARAMS A base64 encoded json object with the database parameters
• MOCKNET_GROUP_ID The group id to be required in the api calls
• MOCKNET_API_KEY The api key to be required in the api calls

Generating and reading the database

In order to simply generate a group, run the generator.php file with the following environment variables.

• MOCKNET_VENDOR_FOLDER Path to the composer vendor folder
• MOCKNET_DBPARAMS A base64 encoded json object with the database parameters
• MOCKNET_GROUP_ID The group id of the generated group

In order to create a manager for reading as well as writing to the database, use the Scouterna\Mocknet\Database\ManagerFactory class. The namespace Scouterna\Mocknet\Database\Model contains all entities that are used by the manager and the api.