README

Version: 1.1

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require wm/wm-package

You can publish and run the migrations with:

php artisan vendor:publish --tag="wm-package-migrations"
php artisan migrate

Available migrations are:

create_jobs_table, for default laravel job with an extra column
create_hoqu_caller_jobs, HoquCallerJob model table, necessary for processor/caller instances

You can publish the config file with:

php artisan vendor:publish --tag="wm-package-config"

This is the contents of the published config file:

return [
    'hoqu_url' => env('HOQU_URL', 'https://hoqu2.webmapp.it'),
    'hoqu_register_username' => env('HOQU_REGISTER_USERNAME'),
    'hoqu_register_password' => env('HOQU_REGISTER_PASSWORD ')
];

Usage

use Wm\WmPackage\Facades\HoquClient;
/** Start store call to hoqu (1)**/
HoquClient::store(['name' => 'test','input' => '{ ... }' ]);
...
/** It logins (to retrieve a token) as an user that can create processors/callers on hoqu **/
HoquClient::registerLogin()
...
/** Register a new processor/caller on hoqu **/
HoquClient::register()

Update

You can update the package via composer:

composer update wm/wm-package

Testing

composer test

Developing

If you need to test the package on full laravel instance clone this repository in the same folder of the laravel dir, then add a new composer path repository in the laravel composer.json file:

"repositories": [
        {
            "type": "path",
            "url": "../wm-package"
        }
    ]

then you can install the package with compose require wm/wm-package

Pushing

We use git flow to add features to this repo. Please create a new feature then push it and ask a pull request via github interface from your feature branch to develop.

License

The MIT License (MIT). Please see License File for more information.

Docs

https://github.com/spatie/laravel-package-tools

https://laravel.com/docs/9.x/facades#facades-vs-dependency-injection

https://pestphp.com/

Default private/public routes (powered by Sanctum )

public routes
- POST /login : consente la login tramite parametri email e password in formato x-www-form-urlencoded
private routes
- POST /logout consente la logout tramite Bearer token
- GET /user restituisce i dettagli dell'utente loggato tramite Bearer token

Artisan commands

hoqu:register-user. Create a new user on Hoqu instance based on credetials provided in .env file. Options:
- --R|role: required, the role of this instance: "caller" , "processor" or "caller,processor"
- --endpoint=false : the endpoint of this instance, default is APP_URL in .env file
hoqu:store. Performs a call to Hoqu to store a job, saves a new HoquCallerModel in the database with the hoqu response. Options:
- --class : required, the class that will execute job on processor}
- --featureId : required, the feature id to update after completed job}
- --field : required, the field to update after completed job}
- --input : required, the input to send to processor}
db:upload_db_aws. Uploads the given sql file and the last-dump of the database to AWS. only from production Arguments:
- dumpname? : the name of the sql zip file to upload
db:download. download a dump.sql from server in storage/app/database folder. Has no arguments:

JWT

JWT verrà installato automaticamente come dipendenza. Gli utenti dovranno solo:

Eseguire composer require wm/wm-package
Pubblicare la configurazione JWT con php artisan vendor:publish --tag="wm-package-jwt-config"
Configurare le variabili d'ambiente JWT nel file .env utilizzando il comando php artisan jwt:secret

Il pacchetto JWT sarà gestito come dipendenza del wm-package invece che dover essere installato separatamente nell'applicazione principale.

wm / wm-package

Maintainers

Details