joseayram\WebinarJam

Complexity

Total Complexity

10

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	addToWebinar()	0	24	1
A	getWebinars()	0	3	1
A	getWebinar()	0	3	1
A	authenticatedCall()	0	32	6

<?php
namespace joseayram;

/**
 *
 * Implements the WebinarJam API
 *
 */
class WebinarJam
{
    protected const API_URL = 'https://webinarjam.genndi.com/api/';

    protected const CURL_OPTIONS = [
        CURLOPT_CONNECTTIMEOUT => 10,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT        => 60,
    ];

    /**
     * WebinarJam API Key
     * @var string
     */
    protected $apiKey;

    /**
     * WebinarJam Class Constructor
     *
     * @param  string $apiKey WebinarJam API Key
     */
    public function __construct(string $apiKey)
    {
        $this->apiKey = $apiKey;
    }

    /**
     * Call to API URL through curl extension
     *
     * @param  string $endpoint WebinarJam API EndPoint
     * @return array $jsonResults
     */
    protected function authenticatedCall(string $endpoint, array $params = []): array
    {
        $curl = curl_init(self::API_URL . $endpoint);

        if (empty($this->apiKey)) {
            throw new \Exception('You must specify a valid WebinarJam API Key');
        }

        if (is_resource($curl)) {
            $params['api_key'] = $this->apiKey;
            curl_setopt_array($curl, self::CURL_OPTIONS);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $params);
            $result = curl_exec($curl);

            if (false === $result) {
                $error = curl_error($curl);
                curl_close($curl);
                throw new \Exception($error);
            }

            curl_close($curl);

            $jsonResults = is_string($result) ? json_decode($result, true) : null;

            if (!is_array($jsonResults)) {
                throw new \Exception($result);

It seems like $result can also be of type true; however, parameter $message of Exception::__construct() does only seem to accept string, maybe add an additional type check?

            }

            return $jsonResults;
        }

        return [];
    }

    /**
     * Retrieve a full list of all webinars published in your account
     * @return array Webinar List
     */
    public function getWebinars(): ?array
    {
        return $this->authenticatedCall('webinars');
    }

    /**
     * Get details about one particular webinar from your account
     *
     * @param  string $webinarId Webinar ID
     * @return array $webinar Webinar Details
     */
    public function getWebinar(string $webinarId): ?array
    {
        return $this->authenticatedCall('webinar', ['webinar_id' => $webinarId]);
    }

    /**
     * Register a person to a specific webinar
     *
     * @param string      $webinarId   Webinar ID (required)
     * @param string      $first_name  First Name (required)
     * @param string      $email       E-mail (required)
     * @param int         $schedule    Schedule (required)
     * @param string|null $last_name   Last Name (optional)
     * @param string|null $ipAddress   IP Address (optional)
     * @param int|null $countryCode Country Code (optional)
     * @param int|null $phone       Phone (optional)
     * @return array $webinar Webinar Details
     */
    public function addToWebinar(
        string $webinarId,
        string $first_name,
        string $email,
        int $schedule = 0,
        string $last_name = null,
        string $ipAddress = null,
        int $countryCode = null,
        int $phone = null
    ): array
    {
        $params = [
            'webinar_id' => $webinarId,
            'first_name' => $first_name,
            'email' => $email,
            'schedule' => $schedule
        ];

        $params['last_name'] = $last_name ?? null;
        $params['ip_address'] = $ipAddress ?? null;
        $params['phone_country_code'] = $countryCode ?? null;
        $params['phone'] = $phone ?? null;

        return $this->authenticatedCall('register', $params);
    }
}