README

Remote API Communication package for WoW private servers

Installation
Configuration
Usage
- Facade
- Manager
Testing
Events
Issues
License

Installation

For Laravel ~5

composer require sasin91/wow-emulator-communication

Add the following service provider in your providers array, in your config/app.php

\Sasin91\WoWEmulatorCommunication\EmulatorServiceProvider::class,

Configuration

To publish emulator.php config file, run the following, vendor:publish command.

php artisan vendor:publish --provider="\Sasin91\WoWEmulatorCommunication\EmulatorServiceProvider"

You may configure the config file to your liking, however the defaults should work for most cases.

If you would like to dispatch a command to multiple drivers, prefix a driver with multiple that returns an array of existing drivers.

Custom drivers

In addition to the config file, it is also possible to register your own drivers directly on the Manager, by the following syntax:

\Emulators::extend(string $class_name, \Closure $callback);

The $callback should return an implementation of Sasin91\WoWEmulatorCommunication\Drivers\EmulatorCommunicationContract.

In addition to providing your own implementation, you're also welcome to use the generic driver, like so:

\Emulators::extend('SkyFire', \Emulators::genericDriverCallback());

Note: driver constructors should accept a string $name and array of $configurations as parameters.

** There are no constructor dependency injection support implemented. **

Custom driver trait

For your own implementation, there is some convenient traits available in the Sasin91\WoWEmulatorCommunication\Drivers\Concerns namespace:

* DispatchesDynamicCommands [allows for commands such as Emulator::accountOnlineList() or Emulator::account_online_list()]
* ExecutesCommands [Enables execution of Command(s)]
* HasConfigurations

Only ExecutesCommands is mandatory for the most parts. However without the HasConfigurations trait, the Contract would require you to implement your own config($key = null, $default = null) method.

Optionally, you can extend the default driver, Sasin91\WoWEmulatorCommunication\Drivers\EmulatorCommunicationDriver instead.

Communication Pipes

Think of the pipes as a middleware layer that runs before a command is passed to the Handler.

The pipes receives the are plain PHP classes that should implement a public handle method, which receives Command object and a Closure representing the next slice of the stack.

public function handle($command, $next) 
{
	// Your Logic

	return $next($command);
}

if you need inspiration, take a look at the existing Pipes in the Sasin91\WoWEmulatorCommunication\Communication\Pipes namespace.

For custom drivers, you should register pipes like any other driver, in the 'drivers' array in the emulator.php config file.

Named commands

Writing every command string manually can get a little bit tedious and error phrone. Enter named commands!

These commands, unlike the conventional commands will contain the command string themselves and only require the input parameters to be entered. In addition to the communication pipes, it is possible to leverage the Laravel Validator, by using Sasin91\WoWEmulatorCommunication\Commands\Concerns\Validatable and setting your rules([...]).

As with the drivers, it is also possible to write your own named commands, a named command should implement the Sasin91\WoWEmulatorCommunication\NamedEmulatorCommandContract interface.

Http Middleware

TODO

As with any package, it's a good idea to refresh composer autoloader.

composer dump-autoload

And you are ready to go.

Usage

Emulators Facade

Dispatching a command to the default driver

\Emulators::command($command);

Dispatching a command a specific driver

\Emulators::driver('driver')->command($command);

Dispatching a command to multiple drivers

\Emulators::driver('multiple')->command($command);

In addition to the conventional driver method, it is also possible to call

\Emulators::emulator('driver')

instead. As an extra convenience, dispatchTo($driver, $command) is also available on the Facade.

$command can be an instance of \Sasin91\WoWEmulatorCommunication\EmulatorCommand or a string.

Facade tip

A little nugget with the Laravel Facades, is the ability to write and register your own.

This enables you to make driver specific Facades, for instance App\Facades\TrinityCore.

class TrinityCore extends \Illuminate\Support\Facades\Facade 
{
    /**
     * Get the root object behind the facade.
     *
     * @return mixed
     */
    public static function getFacadeRoot()
    {
        return parent::getFacadeRoot()->driver('TrinityCore');
    }

    /**
     * Get the registered name of the component.
     *
     * @return string
     *
     * @throws \RuntimeException
     */
    protected static function getFacadeAccessor()
    {
        return 'Sasin91\WoWEmulatorCommunication\EmulatorManager';
    }
}

Driver Manager

There isn't really that much to say about this, if you prefer depedency injection over service locator (ie. Facade), then injecting or resolving the \Sasin91\WoWEmulatorCommunication\EmulatorManager is also an option.

Testing

assertDispatched & assertNotDispatched is available when using the fake.

    \Emulators::fake();

    // perform command

    \Emulators::assertDispatched(EmulatorCommand::class, function ($event) use ($command) {
        return (string)$event === (string)$command;
    });

    \Emulators::assertNotDispatched(EmulatorCommand::class);

Events

During the lifecycle of a Command,

the [CommandCreating, CommandCreated, CommandFiring, CommandFired] events, are expected to be fired.

However the creating & created events are optional for custom commands, in the sense that they're expected to be manually fired.

A typical place would be in the constructor for these events.

Additionally, it is possible to disable the events complete, by calling EmulatorCommand::unsetEventDispatcher(). In the same sense, it is also possible to replace the dispatcher, by calling EmulatorCommand::setEventDispatcher($dispatcher).

Issues

If you discover any vulnerabilities, please e-mail them to me at jonas.kerwin.hansen@gmail.com.

For issues, open a issue on Github.

I'm currently aware of issues with proxy-driver-commands and testing.

License

wow-emulator-communication is free software distributed under the terms of the MIT license.

sasin91 / wow-emulator-communication

Maintainers

Details