orangeopensource/flarum-connection

Connection library for Flarum

dev-master 2019-02-12 13:02 UTC

Requires

• php: >=7.1
• guzzlehttp/guzzle: >=6.3 <7.0.0
• php-http/guzzle6-adapter: ^1.1
• psr/log: >=1.0 <2.0.0
• symfony/http-foundation: ^4.1
• woohoolabs/yang: ^1.4

Requires (Dev)

• phan/phan: ^0.12.14
• phpunit/phpunit: ^7.2
• wa72/simplelogger: >=1.1 <2.0.0

proprietary

• Rémy Darcel

README

Status

Refactoring required on config & sso

Installation

Do the composer install in order to install all the libraries

Configuration

In order to work properly, the following tasks needs to be acheived :

• The portal and the forum needs to share the same root domain (for example : laborange.fr for the portal & forums.laborange.fr for flarum)
• An access token must be created on Flarum in order to allow the library to access to the Flarum API, it should be added in the api_keys table of Flarum
• Forum must be configured in https with a valid SSL certificate (not all the API will work in http only)
• An admin user should be created and it's id retrieved, it will be the user that will be used by the library to perform admin only task.

Once all these tasks are achieved the library could be initialized with a FlarumConnectorConfig object with the following parameters:

• Address of the forum instance
• Root domain to be used to set the cookie
• The access token defined in Flarum database
• The if of the admin user to use for admin request
• The number of days the session will be kept alive

$config = new \FlarumConnection\Models\FlarumConnectorConfig (
                'https://my_forum_adress.mydomain.com', 
                'mydomain.com',
                'AnAccessToken',
                1,
                3000);

The library also requires a logger object that needs to be a PSR-2 logger.

$Connector = new FlarumConnector($config,$logger);

Configuration for test

In order to use unit testing through phpunit, a configuration (in tests/Config directory) needs to be set with the following parameters :

• The login of the test admin user
• The password of the admin test user
• The id of a primary tag that could be used for posting (on a fresh flarum instance, you could use 1)
• The name of a primary tag that could be used for posting (on a fresh flarum instance, you could use general)
• Activate testing on SSL
• The root url of the flarum forum
• The root domain that include both portal & forum
• The API Key
• The default admin user (on a fresh Flarum instance, you could use 1)
• The lifetime in days of the Flarum cookie

return [
    'testUser' => 'admin',
    'testPassword' => 'password',
    'testTagId' => 376,
    'testTagName' => 'TAG15b586f22a4472',
    'testonSSL' => false,
    'flarumUrl' => 'http://flarum.lab.net',
    'flarumRootDomain' => 'lab.net',
    'flarumApiKey' =>'NotSecureToken',
    'flarumDefaultUser' => 1,
    'flarumLifeTime' =>3000

];

Features

HTTP SSO

• Login (and get a cookie)
• Logout (and remove cookie)
• Is connected
• Documentation of HTTP SSO

SSO

• Login
• Creation of an account
• Documentation of SSO

Users

• Update the password of a user
• Update the email of the password
• Associate a user to a group
• Delete of a user
• Get a user by id
• Search for a user
• Documentation of user

Tags

• Create a tag
• Delete a tag
• Define specific rights for tag
• Get all the tags
• Documentation of tags

Groups

• Create a group
• Update a group
• Delete a group
• Documentation of groups

Discussions

• Create a discussion
• Update a discussion
• Delete a discussion
• Documentation of discussions

Posts

• Create a post
• Update a post
• Delete a post
• Documentation of posts

Integration hooks

The integration hooks to be done are detailed there Documentation of integration]