LiveStream::getDraftEvents() - Code Metrics - Inspection of "Get Draft Events." - francis94c/vimeo-livestream - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 68c176...9724fd )

by Francis

created 2020-07-27 10:43 UTC

LiveStream::getDraftEvents() A

↳ Parent: LiveStream

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace LiveStream;

use CURLFile;
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;
    }

    /**
     * Undocumented function
     *
     * @param  integer $accountId
     * @param  integer $eventId
     * @param  string  $filePath
     * @return boolean
     */
    public function updateEventLogo(int $accountId, int $eventId, string $filePath): Event
    {
        if (!in_array(mime_content_type($filePath), [
            'image/png',
            'image/jpg',
            'image/jpeg',
            'image/gif'
        ])) {
            throw new InValidResourceException('Logo', 'poster (MIME Type must be one of image/png, image/jpg, image/gif)');
        }

        $response = $this->request("accounts/$accountId/events/$eventId/logo", 'put', null, null, [
            'logo' => new CURLFile($filePath, mime_content_type($filePath), basename($filePath))
        ]);

        if ($response == null) return null;


        return Event::fromObject(json_decode($response));

    }

    /**
     * Get Draft Events
     *
     * @param integer $accountId
     * @param integer $page
     * @param integer $maxItems
     * @param string  $order
     * 
     * @return array
     */
    public function getDraftEvents(
        int $accountId,
        int $page = 1,
        int $maxItems = 10,
        string $order = 'desc'
    ): array {
        $response = $this->request("accounts/$accountId/draft_events", 'get', null, [
            'page'     => $page,
            'maxItems' => $maxItems,
            'order'    => $order
        ]);

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


        $events = [];

        foreach (json_decode($response)->data as $event) {
            $events[] = Event::fromObject($event);
        }

        return $events;
    }

    /**
     * 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,
        ?array $multipartFormData = 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());
            } elseif ($multipartFormData) {
                curl_setopt($ch, CURLOPT_HTTPHEADER, [
                    'Content-Type: multipart/form-data'
                ]);
                curl_setopt($ch, CURLOPT_POSTFIELDS, $multipartFormData);
            }
        }

        $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 CURLFile;
6			use Exception;
7
8			use LiveStream\Resources\Event;
9			use LiveStream\Resources\RTMPKey;
10			use LiveStream\Resources\Account;
11			use LiveStream\Interfaces\Resource;
12
13			use LiveStream\Exceptions\LiveStreamException;
14			use LiveStream\Exceptions\InValidResourceException;
15
16			class LiveStream
17			{
18			/**
19			* Live Stream API Base URL.
20			*/
21			const BASE_URL = 'https://livestreamapis.com/v3/';
22
23			/**
24			* LiveStream API HTTP Codes.
25			*/
26			const ERROR_CODES = [
27			400 => 'Bad Request: Your request is not properly constructed.',
28			401 => 'Unauthorized: Your API key is incorrect.',
29			403 => 'Forbidden:',
30			405 => 'Method Not Allowed: You tried to access a resource with an invalid method.',
31			406 => 'Not Acceptable: You requested a format that is not JSON.',
32			500 => 'Internal Server Error: We had a problem with our server. Please try again later.',
33			503 => 'Service Unavailable: We are temporarily offline for maintanance. Please try again later.'
34			];
35
36			/**
37			* API_KEY.
38			*
39			* @var string
40			*/
41			private $apiKey;
42
43			/**
44			* Class Constructor
45			*
46			* @param string $apiKey
47			*/
48			public function __construct(string $apiKey)
49			{
50			$this->apiKey = $apiKey;
51			}
52
53			/**
54			* Get Linked LiveStream Accounts
55			*
56			* @return array Array of LiveStream Accounts
57			*/
58			public function getAccounts(): array
59			{
60			$response = $this->request('accounts');
61
62			$accounts = [];
63
64			foreach (json_decode($response) as $account) {
65			$accounts[] = Account::fromObject($account);
66			}
67
68			return $accounts;
69			}
70
71			/**
72			* Get Specific Account
73			*
74			* @param integer $accountId
75			* @return Account\|null
76			*/
77			public function getAccount(int $accountId): ?Account
78			{
79			$response = $this->request("accounts/$accountId");
80			if ($response === null) return null;
81
82			return Account::fromObject(json_decode($response));
83			}
84
85			/**
86			* Create New Event
87			*
88			* @param integer $accountId
89			* @param Event $event
90			* @return boolean
91			*/
92			public function createEvent(int $accountId, Event &$event): bool
93			{
94			$event->validate();
95
96			$response = $this->request("accounts/$accountId/events", 'post', $event);
97
98			if ($response === null) return false;
99
100			$event = Event::fromObject(json_decode($response));
101
102			return true;
103			}
104
105			/**
106			* Update Event.
107			*
108			* @param integer $accountId
109			* @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...
110			* @return boolean
111			*/
112			public function updateEvent(int $accountId, Event $event): bool
113			{
114			$event->validate(true);
115
116			$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...
117
118			if ($response === null) return false;
119
120			return true;
121			}
122
123			/**
124			* Undocumented function
125			*
126			* @param integer $accountId
127			* @param integer $eventId
128			* @param string $filePath
129			* @return boolean
130			*/
131			public function updateEventLogo(int $accountId, int $eventId, string $filePath): Event
132			{
133			if (!in_array(mime_content_type($filePath), [
134			'image/png',
135			'image/jpg',
136			'image/jpeg',
137			'image/gif'
138			])) {
139			throw new InValidResourceException('Logo', 'poster (MIME Type must be one of image/png, image/jpg, image/gif)');
140			}
141
142			$response = $this->request("accounts/$accountId/events/$eventId/logo", 'put', null, null, [
143			'logo' => new CURLFile($filePath, mime_content_type($filePath), basename($filePath))
144			]);
145
146			if ($response == null) return null;
			0 ignored issues – show Bug Best Practice introduced 2020-07-27 09:39 UTC by Report Bug Copy Issue Report The expression `return null` returns the type `null` which is incompatible with the type-hinted return `LiveStream\Resources\Event`. Loading history...
147
148			return Event::fromObject(json_decode($response));
			0 ignored issues – show Bug Best Practice introduced 2020-07-27 09:39 UTC by Report Bug Copy Issue Report The expression `return LiveStream\Resour...json_decode($response))` returns the type `LiveStream\Resources\Event` which is incompatible with the documented return type `boolean`. Loading history...
149			}
150
151			/**
152			* Get Draft Events
153			*
154			* @param integer $accountId
155			* @param integer $page
156			* @param integer $maxItems
157			* @param string $order
158			*
159			* @return array
160			*/
161			public function getDraftEvents(
162			int $accountId,
163			int $page = 1,
164			int $maxItems = 10,
165			string $order = 'desc'
166			): array {
167			$response = $this->request("accounts/$accountId/draft_events", 'get', null, [
168			'page' => $page,
169			'maxItems' => $maxItems,
170			'order' => $order
171			]);
172
173			if ($response === null) return null;
			0 ignored issues – show Bug Best Practice introduced 2020-07-27 10:44 UTC by Report Bug Copy Issue Report The expression `return null` returns the type `null` which is incompatible with the type-hinted return `array`. Loading history...
174
175			$events = [];
176
177			foreach (json_decode($response)->data as $event) {
178			$events[] = Event::fromObject($event);
179			}
180
181			return $events;
182			}
183
184			/**
185			* Get RTMP Key.
186			*
187			* @param integer $accountId
188			* @param integer $eventId
189			*
190			* @return \LiveStream\Resources\RTMPKey\|null
191			*/
192			public function getRtmpKey(
193			int $accountId,
194			int $eventId,
195			bool $notifyFollowers = false,
196			bool $publishVideo = false,
197			bool $saveVideo = false
198			): ?RTMPKey {
199
200			$response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'get', null, [
201			'notifyFollowers' => $notifyFollowers,
202			'publishVideo' => $publishVideo,
203			'saveVideo' => $saveVideo
204			]);
205
206			if ($response === null) return null;
207
208			return RTMPKey::fromObject(json_decode($response));
209			}
210
211			/**
212			* Reset RTMPKey
213			*
214			* @param integer $accountId
215			* @param integer $eventId
216			* @return \LiveStream\Resources\RTMPKey\|null
217			*/
218			public function resetRtmpKey(int $accountId, int $eventId): ?RTMPKey
219			{
220			$response = $this->request("accounts/$accountId/events/$eventId/rtmp", 'put');
221
222			if ($response === null) return null;
223
224			return RTMPKey::fromObject(json_decode($response));
225			}
226
227			/**
228			* CURL Request
229			*
230			* @param string $endpoint
231			* @return
232			*/
233			private function request(
234			string $endpoint,
235			string $verb = 'get',
236			?Resource $body = null,
237			?array $query = null,
238			?array $multipartFormData = null
239			): ?string {
240			$ch = curl_init();
241
242			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...
243
244			curl_setopt(
245			$ch,
246			CURLOPT_URL,
247			$this->get_base_url() . $endpoint . ($query ? '?' . http_build_query($query) : '')
248			);
249
250			curl_setopt($ch, CURLOPT_USERPWD, $this->apiKey . ':');
251			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
252
253			if ($verb != 'get') {
254			if ($verb == 'post') curl_setopt($ch, CURLOPT_POST, true);
255			if ($verb == 'put') curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
256			if ($body) {
257			curl_setopt($ch, CURLOPT_HTTPHEADER, [
258			'Content-Type: ' . $body->getContentType()
259			]);
260			curl_setopt($ch, CURLOPT_POSTFIELDS, $body->getResourceBody());
261			} elseif ($multipartFormData) {
262			curl_setopt($ch, CURLOPT_HTTPHEADER, [
263			'Content-Type: multipart/form-data'
264			]);
265			curl_setopt($ch, CURLOPT_POSTFIELDS, $multipartFormData);
266			}
267			}
268
269			$response = curl_exec($ch);
270			$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
271
272			curl_close($ch);
273
274			if ($code == 200 \|\| $code == 201) return $response;
275
276			if ($code == 404) return null;
277
278			if ($code <= 199) throw new Exception("A CURL erorr with code '$code', has occurred.");
279
280			if ($code == 403) throw new LiveStreamException(self::ERROR_CODES[$code] . ' ' . json_decode($response)->message);
281
282			throw new LiveStreamException(self::ERROR_CODES[$code]);
283			}
284
285			/**
286			* Get Base URL.
287			*
288			* @return string
289			*/
290			private function get_base_url(): string
291			{
292			return getenv('LIB_ENV') == 'testing' ? 'http://127.0.0.1:3067/' : self::BASE_URL;
293			}
294			}
295

francis94c / vimeo-livestream

Push — master ( 68c176...9724fd )

LiveStream::getDraftEvents() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like