LiveStream::getInstance() - Code Metrics - Inspection of "Revert LiveStream Singleton Pattern." - francis94c/vimeo-livestream - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d91ec9...05758d )

by Francis

created 2020-07-24 16:23 UTC

LiveStream::getInstance() A

↳ Parent: LiveStream

Complexity

Conditions	3
Paths	4

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	4
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	9
rs	10

<?php

namespace LiveStream;

use Exception;

use LiveStream\Resources\Event;
use LiveStream\Resources\RTMPKey;
use LiveStream\Resources\Account;
use LiveStream\Interfaces\Resource;

use LiveStream\Exceptions\LiveStreamException;
use LiveStream\Exceptions\InValidResourceException;

class LiveStream
{
    /**
     * Live Stream API Base URL.
     */
    const BASE_URL = 'https://livestreamapis.com/v3/';

    /**
     * LiveStream API HTTP Codes.
     */
    const ERROR_CODES = [
        400 => 'Bad Request: Your request is not properly constructed.',
        401 => 'Unauthorized: Your API key is incorrect.',
        403 => 'Forbidden:',
        405 => 'Method Not Allowed: You tried to access a resource with an invalid method.',
        406 => 'Not Acceptable: You requested a format that is not JSON.',
        500 => 'Internal Server Error: We had a problem with our server. Please try again later.',
        503 => 'Service Unavailable: We are temporarily offline for maintanance. Please try again later.'
    ];

    /**
     * API_KEY.
     *
     * @var string
     */
    private $apiKey;

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

    /**
     * Get Linked LiveStream Accounts
     *
     * @return array Array of LiveStream Accounts 
     */
    public function getAccounts(): array
    {
        $response = $this->request('accounts');

        $accounts = [];

        foreach (json_decode($response) as $account) {
            $accounts[] = Account::fromObject($account);
        }

        return $accounts;
    }

    /**
     * Get Specific Account
     *
     * @param  integer $accountId
     * @return Account|null
     */
    public function getAccount(int $accountId): ?Account
    {
        $response = $this->request("accounts/$accountId");
        if ($response === null) return null;

        return Account::fromObject(json_decode($response));
    }

    /**
     * Create New Event
     *
     * @param  integer $accountId
     * @param  Event $event
     * @return boolean
     */
    public function createEvent(int $accountId, Event &$event): bool
    {
        $event->validate();

        $response = $this->request("accounts/$accountId/events", 'post', $event);

        if ($response === null) return false;

        $event = Event::fromObject(json_decode($response));

        return true;
    }

    /**
     * Update Event.
     *
     * @param  integer $accountId
     * @param  LiveStream\Resources\Event $event

     * @return boolean
     */
    public function updateEvent(int $accountId, Event $event): bool
    {
        $event->validate(true);

        $response = $this->request("accounts/$accountId/events/$event->id", 'put', $event);


        if ($response === null) return false;

        return true;
    }

    /**
     * Get RTMP Key.
     *
     * @param  integer $accountId
     * @param  integer $eventId
     * 
     * @return \LiveStream\Resources\RTMPKey|null
     */
    public function getRtmpKey(
        int $accountId,
        int $eventId,
        bool $notifyFollowers = false,
        bool $publishVideo = false,
        bool $saveVideo = false
    ): ?RTMPKey {

        $response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'get', null, [
            'notifyFollowers' => $notifyFollowers,
            'publishVideo'    => $publishVideo,
            'saveVideo'       => $saveVideo
        ]);

        if ($response === null) return null;

        return RTMPKey::fromObject(json_decode($response));
    }

    /**
     * Reset RTMPKey
     *
     * @param  integer $accountId
     * @param  integer $eventId
     * @return \LiveStream\Resources\RTMPKey|null
     */
    public function resetRtmpKey(int $accountId, int $eventId): ?RTMPKey
    {
        $response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'put');

        if ($response === null) return null;

        return RTMPKey::fromObject(json_decode($response));
    }

    /**
     * CURL Request
     *
     * @param  string $endpoint
     * @return 
     */
    private function request(
        string $endpoint,
        string $verb = 'get',
        ?Resource $body = null,
        ?array $query = null
    ): ?string {
        $ch = curl_init();

        if (!$ch) throw new Exception("Could not initialize CURL.");


        curl_setopt(
            $ch,
            CURLOPT_URL,
            $this->get_base_url() . $endpoint . ($query ? '?' . http_build_query($query) : '')
        );

        curl_setopt($ch, CURLOPT_USERPWD, $this->apiKey . ':');
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

        if ($verb != 'get') {
            if ($verb == 'post') curl_setopt($ch, CURLOPT_POST, true);
            if ($verb == 'put') curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
            if ($body) {
                curl_setopt($ch, CURLOPT_HTTPHEADER, [
                    'Content-Type: ' . $body->getContentType()
                ]);
                curl_setopt($ch, CURLOPT_POSTFIELDS, $body->getResourceBody());
            }
        }

        $response = curl_exec($ch);
        $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

        curl_close($ch);

        if ($code == 200 || $code == 201) return $response;

        if ($code == 404) return null;

        if ($code <= 199) throw new Exception("A CURL erorr with code '$code', has occurred.");

        if ($code == 403) throw new LiveStreamException(self::ERROR_CODES[$code] . ' ' . json_decode($response)->message);

        throw new LiveStreamException(self::ERROR_CODES[$code]);
    }

    /**
     * Get Base URL.
     *
     * @return string
     */
    private function get_base_url(): string
    {
        return getenv('LIB_ENV') == 'testing' ? 'http://127.0.0.1:3067/' : self::BASE_URL;
    }
}


1			<?php
2
3			namespace LiveStream;
4
5			use Exception;
6
7			use LiveStream\Resources\Event;
8			use LiveStream\Resources\RTMPKey;
9			use LiveStream\Resources\Account;
10			use LiveStream\Interfaces\Resource;
11
12			use LiveStream\Exceptions\LiveStreamException;
13			use LiveStream\Exceptions\InValidResourceException;
14
15			class LiveStream
16			{
17			/**
18			* Live Stream API Base URL.
19			*/
20			const BASE_URL = 'https://livestreamapis.com/v3/';
21
22			/**
23			* LiveStream API HTTP Codes.
24			*/
25			const ERROR_CODES = [
26			400 => 'Bad Request: Your request is not properly constructed.',
27			401 => 'Unauthorized: Your API key is incorrect.',
28			403 => 'Forbidden:',
29			405 => 'Method Not Allowed: You tried to access a resource with an invalid method.',
30			406 => 'Not Acceptable: You requested a format that is not JSON.',
31			500 => 'Internal Server Error: We had a problem with our server. Please try again later.',
32			503 => 'Service Unavailable: We are temporarily offline for maintanance. Please try again later.'
33			];
34
35			/**
36			* API_KEY.
37			*
38			* @var string
39			*/
40			private $apiKey;
41
42			/**
43			* Class Constructor
44			*
45			* @param string $apiKey
46			*/
47			public function __construct(string $apiKey)
48			{
49			$this->apiKey = $apiKey;
50			}
51
52			/**
53			* Get Linked LiveStream Accounts
54			*
55			* @return array Array of LiveStream Accounts
56			*/
57			public function getAccounts(): array
58			{
59			$response = $this->request('accounts');
60
61			$accounts = [];
62
63			foreach (json_decode($response) as $account) {
64			$accounts[] = Account::fromObject($account);
65			}
66
67			return $accounts;
68			}
69
70			/**
71			* Get Specific Account
72			*
73			* @param integer $accountId
74			* @return Account\|null
75			*/
76			public function getAccount(int $accountId): ?Account
77			{
78			$response = $this->request("accounts/$accountId");
79			if ($response === null) return null;
80
81			return Account::fromObject(json_decode($response));
82			}
83
84			/**
85			* Create New Event
86			*
87			* @param integer $accountId
88			* @param Event $event
89			* @return boolean
90			*/
91			public function createEvent(int $accountId, Event &$event): bool
92			{
93			$event->validate();
94
95			$response = $this->request("accounts/$accountId/events", 'post', $event);
96
97			if ($response === null) return false;
98
99			$event = Event::fromObject(json_decode($response));
100
101			return true;
102			}
103
104			/**
105			* Update Event.
106			*
107			* @param integer $accountId
108			* @param LiveStream\Resources\Event $event
			0 ignored issues – show Bug introduced 2020-07-24 16:19 UTC by Report Bug Copy Issue Report The type `LiveStream\LiveStream\Resources\Event` was not found. Did you mean `LiveStream\Resources\Event`? If so, make sure to prefix the type with `\`. Loading history...
109			* @return boolean
110			*/
111			public function updateEvent(int $accountId, Event $event): bool
112			{
113			$event->validate(true);
114
115			$response = $this->request("accounts/$accountId/events/$event->id", 'put', $event);
			0 ignored issues – show Bug Best Practice introduced 2020-07-24 16:19 UTC by Report Bug Copy Issue Report The property `id` does not exist on `LiveStream\Resources\Event`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
116
117			if ($response === null) return false;
118
119			return true;
120			}
121
122			/**
123			* Get RTMP Key.
124			*
125			* @param integer $accountId
126			* @param integer $eventId
127			*
128			* @return \LiveStream\Resources\RTMPKey\|null
129			*/
130			public function getRtmpKey(
131			int $accountId,
132			int $eventId,
133			bool $notifyFollowers = false,
134			bool $publishVideo = false,
135			bool $saveVideo = false
136			): ?RTMPKey {
137
138			$response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'get', null, [
139			'notifyFollowers' => $notifyFollowers,
140			'publishVideo' => $publishVideo,
141			'saveVideo' => $saveVideo
142			]);
143
144			if ($response === null) return null;
145
146			return RTMPKey::fromObject(json_decode($response));
147			}
148
149			/**
150			* Reset RTMPKey
151			*
152			* @param integer $accountId
153			* @param integer $eventId
154			* @return \LiveStream\Resources\RTMPKey\|null
155			*/
156			public function resetRtmpKey(int $accountId, int $eventId): ?RTMPKey
157			{
158			$response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'put');
159
160			if ($response === null) return null;
161
162			return RTMPKey::fromObject(json_decode($response));
163			}
164
165			/**
166			* CURL Request
167			*
168			* @param string $endpoint
169			* @return
170			*/
171			private function request(
172			string $endpoint,
173			string $verb = 'get',
174			?Resource $body = null,
175			?array $query = null
176			): ?string {
177			$ch = curl_init();
178
179			if (!$ch) throw new Exception("Could not initialize CURL.");
			0 ignored issues – show introduced 2020-07-22 09:04 UTC by Report Bug Copy Issue Report `$ch` is of type `false\|resource`, thus it always evaluated to `false`. Loading history...
180
181			curl_setopt(
182			$ch,
183			CURLOPT_URL,
184			$this->get_base_url() . $endpoint . ($query ? '?' . http_build_query($query) : '')
185			);
186
187			curl_setopt($ch, CURLOPT_USERPWD, $this->apiKey . ':');
188			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
189
190			if ($verb != 'get') {
191			if ($verb == 'post') curl_setopt($ch, CURLOPT_POST, true);
192			if ($verb == 'put') curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
193			if ($body) {
194			curl_setopt($ch, CURLOPT_HTTPHEADER, [
195			'Content-Type: ' . $body->getContentType()
196			]);
197			curl_setopt($ch, CURLOPT_POSTFIELDS, $body->getResourceBody());
198			}
199			}
200
201			$response = curl_exec($ch);
202			$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
203
204			curl_close($ch);
205
206			if ($code == 200 \|\| $code == 201) return $response;
207
208			if ($code == 404) return null;
209
210			if ($code <= 199) throw new Exception("A CURL erorr with code '$code', has occurred.");
211
212			if ($code == 403) throw new LiveStreamException(self::ERROR_CODES[$code] . ' ' . json_decode($response)->message);
213
214			throw new LiveStreamException(self::ERROR_CODES[$code]);
215			}
216
217			/**
218			* Get Base URL.
219			*
220			* @return string
221			*/
222			private function get_base_url(): string
223			{
224			return getenv('LIB_ENV') == 'testing' ? 'http://127.0.0.1:3067/' : self::BASE_URL;
225			}
226			}
227

francis94c / vimeo-livestream

Push — master ( d91ec9...05758d )

LiveStream::getInstance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like