graphcomment / sdk-api-php

src/Graphcomment.php

<?php
/**
 * Wrapper API Graphcomment v2.3.2
 * @author ddtraceweb <david@semiologic.fr>
 * @copyright 2018 Graphcomment
 * Date: 12/11/2018
 * Time: 18:37
 */

namespace Graphcomment;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

/**
 * Class Sdk
 * @package Graphcomment
 */
class Sdk
{

    /**
     * @var
     */
    protected $gcPublic;
    protected $gcSecret;
    protected $dir = 'https://graphcomment.com/api';

    /**
     * Sdk constructor.
     * @param $GC_PUBLIC
     * @param $GC_SECRET
     */
    public function __construct($GC_PUBLIC, $GC_SECRET)
    {
        $this->setGcPublic($GC_PUBLIC);
        $this->setGcSecret($GC_SECRET);
    }

    /**
     * @return mixed
     */
    public function getGcPublic()
    {
        return $this->gcPublic;
    }

    /**
     * @param mixed $gcPublic
     */
    public function setGcPublic($gcPublic)
    {
        $this->gcPublic = $gcPublic;
    }

    /**
     * @return mixed
     */
    public function getGcSecret()
    {
        return $this->gcSecret;
    }

    /**
     * @param mixed $gcSecret
     */
    public function setGcSecret($gcSecret)
    {
        $this->gcSecret = $gcSecret;
    }

    /**
     * @return mixed
     */
    public function getDir()
    {
        return $this->dir;
    }

    /**
     * @param mixed $dir
     */
    public function setDir($dir)
    {
        $this->dir = $dir;
    }

    /**
     * registerUser() Register a user to Graphcomment.
     *
     * @param string $username required unique
     * @param string $email required unique
     * @param string $language (optionnal) default value : en (codes ISO 639-1)
     * @param string $picture (full url only example : https://graphcomment.com/image.jpg)
     *
     * @return object  json response gc_id to store in your database and do_sync which define date of synchronisation
     * @throws GuzzleException
     */
    public function registerUser($username, $email, $language = "en", $picture = '')
    {
        $client = new Client();
        $data = array(
            "username" => $username, // required unique
            "email" => $email, // required unique
            "language" => $language, //(optionnal) default value : en (codes ISO 639-1)
            "picture" => $picture // (optionnal) full url only
        );

        $res = $client->request('POST', $this->getDir() . '/pub/sso/registerUser/pubkey/' . $this->getGcPublic() . '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        if ($res->getStatusCode() == "200") {
            return $res->getBody();
        } else {
            return $res->getBody();
        }
    }

    /**
     * loginUser() authenticate a user and return a token to login in graphcomment.
     *
     * @param string $gc_id
     *
     * @return object  json JWT response
     * @throws GuzzleException
     */
    public function loginUser($gc_id)
    {
        $client = new Client();

        $data = array(
            "gc_id" => $gc_id
        );

        $res = $client->request('POST', $this->getDir() . '/pub/sso/loginUser/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }


    /**
     * getUser() return the informations that we have on the user
     *
     * @param $gc_id
     * @return object JSON with do_sync date, if changed, you must synchronise the informations.
     * @throws GuzzleException
     */
    public function getUser($gc_id)
    {
        $client = new Client();

        $data = array(
            "gc_id" => $gc_id
        );

        $res = $client->request('GET', $this->getDir() . '/pub/sso/getUser/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }


    /**
     * updateUser() return the informations that we have on the user
     *
     * @param $gc_id
     * @param string $username required unique
     * @param string $email required unique
     * @param string $language (optionnal) default value : en (codes ISO 639-1)
     * @param string $picture (full url only example : https://graphcomment.com/image.jpg)
     *
     * @return object JSON {
     *   gc_id : data.gc_id,
     *   do_sync : date of synchronisation
     *  res :'updated'
     *  } or {
     *      gc_id : data.gc_id,
     *      res :'nothing updated'
     *  }
     * @throws GuzzleException
     */
    public function updateUser($gc_id, $username, $email, $language, $picture)
    {
        $client = new Client();

        $data = array(
            "gc_id" => $gc_id,
            "username" => $username,
            "email" => $email,
            "language" => $language,
            "picture" => $picture
        );

        $res = $client->request('PUT', $this->getDir() . '/pub/sso/updateUser/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }


    /**
     * deleteUser() delete a user and return ok confirmation.
     *
     * @param string $gc_id
     *
     * @return string ok
     * @throws GuzzleException
     */
    public function deleteUser($gc_id)
    {
        $client = new Client();

        $data = array(
            "gc_id" => $gc_id);

        $res = $client->request('DELETE', $this->getDir() . '/pub/sso/deleteProfileByGcId/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }


    /**
     * countComments() return the number thread's comment
     *
     * @param $url (full url only) required

The doc comment (full at position 1 could not be parsed: Expected ')' at position 1, but found 'full'.

     * @param string $uid (unique id of the thread) optionnal
     * @return object json {count: numberOfComments }
     * @throws GuzzleException
     */
    public function countComments($url, $uid='') {
        $client = new Client();

        $data = array(
            "url" => $url,
            "uid" => $uid
        );

        $res = $client->request('GET', $this->getDir() . '/pub/sso/numberOfComments/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }

    /**
     * getThreadJsonLdFormat() return the number thread's comment
     *
     * @param $url (full url only) required
     * @param string $uid (unique id of the thread) optionnal
     * @param string $pageId (page id of the thread) optionnal for graphdebate
     * @return object json-ld
     * @throws GuzzleException
     */
    public function getThreadJsonLdFormat($url, $uid='', $pageId='') {
        $client = new Client();

        $data = array(
            "url" => $url,
            "uid" => $uid,
            "page_id" => $pageId
        );

        $res = $client->request('GET', $this->getDir() . '/pub/sso/thread-jsonld/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();
    }

    /**
     * exportComments() return the comments to import in your system, group by 20 comments
     *
     * @return array of object json [{commentObject}]
     * @throws GuzzleException
     */
    public function exportComments() {
        $client = new Client();

        $res = $client->request('GET', $this->getDir() . '/pub/export-comments/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData('key'), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();

The expression return $res->getBody() returns the type Psr\Http\Message\StreamInterface which is incompatible with the documented return type array.

    }

    /**
     * exportConfirmComments() send id
     *
     * @param array $commentIds
     *
     * @return array of object json [{commentObject}]
     * @throws GuzzleException
     */
    public function exportConfirmComments(Array $commentIds) {
        $client = new Client();

        $data = $commentIds;

        $res = $client->request('POST', $this->getDir() . '/pub/export-comments/pubkey/' . $this->getGcPublic(). '?key=' . $this->generateSsoData($data), ['http_errors' => false, 'timeout' => 5]);

        return $res->getBody();

The expression return $res->getBody() returns the type Psr\Http\Message\StreamInterface which is incompatible with the documented return type array.

    }

    /**
     * generateSsoData() generate sso Data
     *
     * @param $data array|string
     * @return string
     */
    private function generateSsoData($data) {
        $message = base64_encode(json_encode($data));
        $timestamp = time();

        $hexsig = $this->gcHmacsha1($message . ' ' . $timestamp, $this->getGcSecret());

        return $message . ' ' . $hexsig . ' ' . $timestamp;
    }

    /**
     * gcHmacsha1() encode datas
     *
     * @param $data
     * @param $key
     * @return string
     */
    private function gcHmacsha1($data, $key)
    {

        $blocksize = 64;
        $hashfunc = 'sha1';

        if (strlen($key) > $blocksize)
            $key = pack('H*', $hashfunc($key));

        $key = str_pad($key, $blocksize, chr(0x00));
        $ipad = str_repeat(chr(0x36), $blocksize);
        $opad = str_repeat(chr(0x5c), $blocksize);
        $hmac = pack(
            'H*', $hashfunc(
                ($key ^ $opad) . pack(
                    'H*', $hashfunc(
                        ($key ^ $ipad) . $data
                    )
                )
            )
        );

        return bin2hex($hmac);
    }
}