Clockify::buildPastTimerObject() - Code Metrics - Inspection of "WIP: add Clockify" - godbout/alfred-time - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#30)

by Guillaume

created 2020-07-30 06:34 UTC

Clockify::buildPastTimerObject() A

↳ Parent: Clockify

Complexity

Conditions	3
Paths	4

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	10
nc	4
nop	3
dl	0
loc	18
ccs	11
cts	11
cp	1
crap	3
rs	9.9332
c	0
b	0
f	0

<?php

namespace Godbout\Alfred\Time\Services;

use Carbon\Carbon;
use GuzzleHttp\Client;

class Clockify extends TimerService
{
    private $client;

    private $data = null;



    public function __construct($apiToken)
    {
        $this->client = new Client([
            'base_uri' => 'https://api.clockify.me/api/v1/',
            'headers' => [
                'content-type' => 'application/json',
                'X-Api-Key' => $apiToken
            ]
        ]);
    }

    public function workspaces()
    {
        try {
            $response = $this->client->get('workspaces');
            $workspaces = json_decode($response->getBody()->getContents());

            return array_column($workspaces, 'name', 'id');
        } catch (\Exception $e) {
            return [];
        }
    }

    public function projects()
    {
        try {
            $workspaceId = getenv('timer_workspace_id');

            $response = $this->client->get("workspaces/$workspaceId/projects");

            $projects = json_decode($response->getBody()->getContents());

            return array_column($projects, 'name', 'id');
        } catch (\Exception $e) {
            return [];
        }
    }

    public function tags()
    {
        try {
            $workspaceId = getenv('timer_workspace_id');

            $response = $this->client->get("workspaces/$workspaceId/tags");
            $tags = json_decode($response->getBody()->getContents());

            return array_column($tags, 'name', 'id');
        } catch (\Exception $e) {
            return [];
        }
    }

    public function startTimer()
    {
        try {
            $workspaceId = getenv('timer_workspace_id');

            $response = $this->client->post("workspaces/$workspaceId/time-entries", [
                'json' => [
                    'start' => (new \DateTime())->format('Y-m-d\TH:i:s\Z'),
                    'description' => getenv('timer_description'),
                    'projectId' => getenv('timer_project_id'),
                    'tagIds' => getenv('timer_tag_id') ? [getenv('timer_tag_id')] : [''],
                ]
            ]);

            $timer = json_decode($response->getBody()->getContents());

            if (! isset($timer->id)) {
                return false;
            }
        } catch (Exception $e) {

            return false;
        }

        return $timer->id;
    }

    public function stopCurrentTimer()
    {
        $workspaceId = getenv('timer_workspace_id');
        $userId = getenv('timer_user_id');

        if ($timerId = $this->runningTimer()) {

            $response = $this->client->patch("workspaces/$workspaceId/user/$userId/time-entries", [
                'json' => [
                    'end' => (new \DateTime())->format('Y-m-d\TH:i:s\Z'),
                ]
            ]) ;

            $timer = json_decode($response->getBody()->getContents());

            if (! isset($timer->timeInterval->end)) {
                throw new Exception("Can't stop current running timer.", 1);

                return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            }

            return true;
        }

        return false;
    }

    public function runningTimer()
    {
        try {
            $workspaceId = getenv('timer_workspace_id');
            $userId = getenv('timer_user_id');

            $response = $this->client->get("workspaces/$workspaceId/user/$userId/time-entries?in-progress=true");

            $timer = json_decode($response->getBody()->getContents());

            return $timer[0]->id ?? false;
        } catch (\Exception $e) {
            return false;
        }

        return true;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    public function pastTimers()
    {
        try {
            $pastTimers = [];


            $workspaceId = getenv('timer_workspace_id');
            $userId = getenv('timer_user_id');

            $response = $this->client->get("workspaces/$workspaceId/user/$userId/time-entries", [
                'start' => Carbon::today(),
                'end' => Carbon::today()->subDays(30),
            ]);
            $clockifyTimers = json_decode($response->getBody()->getContents());

            return $this->convertToPastTimers($clockifyTimers);
        } catch (Exception $e) {
            return [];
        }
    }

    public function continueTimer($timerId = null)
    {
        /**
         * Timer attributes are stored in env variables
         * gathered in startTimer.
         */
        return $this->startTimer();
    }

    public function deleteTimer($timerId)
    {
        return false;
    }

    protected function convertToPastTimers($clockifyTimers)
    {
        $projects = $this->projects();
        $tags = $this->tags();

        return array_map(function ($clockifyTimer) use ($projects, $tags) {
            return $this->buildPastTimerObject($clockifyTimer, $projects, $tags);
        }, $clockifyTimers);
    }

    protected function buildPastTimerObject($clockifyTimer, $projects, $tags)
    {
        $pastTimer['id'] = $clockifyTimer->id;

        $pastTimer['description'] = $clockifyTimer->description;

        if (isset($clockifyTimer->projectId)) {
            $pastTimer['project_id'] = $clockifyTimer->projectId;
            $pastTimer['project_name'] = $projects[$clockifyTimer->projectId];
        }

        if (isset($clockifyTimer->tagIds[0])) {
            $pastTimer['tag_id'] = $clockifyTimer->tagIds[0];
            $pastTimer['tags'] = $tags[$clockifyTimer->tagIds[0]];
        }

        $pastTimer['duration'] = $clockifyTimer->timeInterval->duration;

        return (object) $pastTimer;
    }
}


1		<?php
2
3		namespace Godbout\Alfred\Time\Services;
4
5		use Carbon\Carbon;
6		use GuzzleHttp\Client;
7
8		class Clockify extends TimerService
9		{
10		private $client;
11
12		private $data = null;
		0 ignored issues – show introduced 2020-07-19 15:22 UTC by Report Bug Copy Issue Report The private property `$data` is not used, and could be removed. Loading history...
13
14
15	66	public function __construct($apiToken)
16		{
17	66	$this->client = new Client([
18	66	'base_uri' => 'https://api.clockify.me/api/v1/',
19		'headers' => [
20	66	'content-type' => 'application/json',
21	66	'X-Api-Key' => $apiToken
22		]
23		]);
24	66	}
25
26	12	public function workspaces()
27		{
28		try {
29	12	$response = $this->client->get('workspaces');
30	2	$workspaces = json_decode($response->getBody()->getContents());
31
32	2	return array_column($workspaces, 'name', 'id');
33	10	} catch (\Exception $e) {
34	10	return [];
35		}
36		}
37
38	14	public function projects()
39		{
40		try {
41	14	$workspaceId = getenv('timer_workspace_id');
42
43	14	$response = $this->client->get("workspaces/$workspaceId/projects");
44
45	4	$projects = json_decode($response->getBody()->getContents());
46
47	4	return array_column($projects, 'name', 'id');
48	10	} catch (\Exception $e) {
49	10	return [];
50		}
51		}
52
53	14	public function tags()
54		{
55		try {
56	14	$workspaceId = getenv('timer_workspace_id');
57
58	14	$response = $this->client->get("workspaces/$workspaceId/tags");
59	4	$tags = json_decode($response->getBody()->getContents());
60
61	4	return array_column($tags, 'name', 'id');
62	10	} catch (\Exception $e) {
63	10	return [];
64		}
65		}
66
67	10	public function startTimer()
68		{
69		try {
70	10	$workspaceId = getenv('timer_workspace_id');
71
72	10	$response = $this->client->post("workspaces/$workspaceId/time-entries", [
73	5	'json' => [
74	10	'start' => (new \DateTime())->format('Y-m-d\TH:i:s\Z'),
75	10	'description' => getenv('timer_description'),
76	10	'projectId' => getenv('timer_project_id'),
77	10	'tagIds' => getenv('timer_tag_id') ? [getenv('timer_tag_id')] : [''],
78		]
79		]);
80
81	10	$timer = json_decode($response->getBody()->getContents());
82
83	10	if (! isset($timer->id)) {
84	10	return false;
85		}
86		} catch (Exception $e) {
		0 ignored issues – show Bug introduced 2020-07-20 16:43 UTC by Report Bug Copy Issue Report The type `Godbout\Alfred\Time\Services\Exception` was not found. Did you mean `Exception`? If so, make sure to prefix the type with `\`. Loading history...
87		return false;
88		}
89
90	10	return $timer->id;
91		}
92
93	11	public function stopCurrentTimer()
94		{
95	11	$workspaceId = getenv('timer_workspace_id');
96	11	$userId = getenv('timer_user_id');
97
98	11	if ($timerId = $this->runningTimer()) {
		0 ignored issues – show Unused Code introduced 2020-07-20 16:43 UTC by Report Bug Copy Issue Report The assignment to `$timerId` is dead and can be removed. Loading history...
99	11	$response = $this->client->patch("workspaces/$workspaceId/user/$userId/time-entries", [
100		'json' => [
101	11	'end' => (new \DateTime())->format('Y-m-d\TH:i:s\Z'),
102		]
103		]) ;
104
105	10	$timer = json_decode($response->getBody()->getContents());
106
107	10	if (! isset($timer->timeInterval->end)) {
108		throw new Exception("Can't stop current running timer.", 1);
109
110		return false;
		0 ignored issues – show Unused Code introduced 2019-06-15 04:20 UTC by Report Bug Copy Issue Report `return false` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
111		}
112
113	10	return true;
114		}
115
116	2	return false;
117		}
118
119	66	public function runningTimer()
120		{
121		try {
122	66	$workspaceId = getenv('timer_workspace_id');
123	66	$userId = getenv('timer_user_id');
124
125	66	$response = $this->client->get("workspaces/$workspaceId/user/$userId/time-entries?in-progress=true");
126
127	66	$timer = json_decode($response->getBody()->getContents());
128
129	66	return $timer[0]->id ?? false;
130		} catch (\Exception $e) {
131		return false;
132		}
133
134		return true;
		0 ignored issues – show Unused Code introduced 2020-07-20 19:04 UTC by Report Bug Copy Issue Report `return true` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
135		}
136
137	2	public function pastTimers()
138		{
139		try {
140	2	$pastTimers = [];
		0 ignored issues – show Unused Code introduced 2020-07-20 19:04 UTC by Report Bug Copy Issue Report The assignment to `$pastTimers` is dead and can be removed. Loading history...
141
142	2	$workspaceId = getenv('timer_workspace_id');
143	2	$userId = getenv('timer_user_id');
144
145	2	$response = $this->client->get("workspaces/$workspaceId/user/$userId/time-entries", [
146	2	'start' => Carbon::today(),
147	2	'end' => Carbon::today()->subDays(30),
148		]);
149	2	$clockifyTimers = json_decode($response->getBody()->getContents());
150
151	2	return $this->convertToPastTimers($clockifyTimers);
152		} catch (Exception $e) {
153		return [];
154		}
155		}
156
157	2	public function continueTimer($timerId = null)
158		{
159		/**
160		* Timer attributes are stored in env variables
161		* gathered in startTimer.
162		*/
163	2	return $this->startTimer();
164		}
165
166	2	public function deleteTimer($timerId)
167		{
168	2	return false;
169		}
170
171	2	protected function convertToPastTimers($clockifyTimers)
172		{
173	2	$projects = $this->projects();
174	2	$tags = $this->tags();
175
176		return array_map(function ($clockifyTimer) use ($projects, $tags) {
177	2	return $this->buildPastTimerObject($clockifyTimer, $projects, $tags);
178	2	}, $clockifyTimers);
179		}
180
181	2	protected function buildPastTimerObject($clockifyTimer, $projects, $tags)
182		{
183	2	$pastTimer['id'] = $clockifyTimer->id;
		0 ignored issues – show Comprehensibility Best Practice introduced 2020-07-20 16:43 UTC by Report Bug Copy Issue Report `$pastTimer` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$pastTimer = array();` before regardless. Loading history...
184	2	$pastTimer['description'] = $clockifyTimer->description;
185
186	2	if (isset($clockifyTimer->projectId)) {
187	2	$pastTimer['project_id'] = $clockifyTimer->projectId;
188	2	$pastTimer['project_name'] = $projects[$clockifyTimer->projectId];
189		}
190
191	2	if (isset($clockifyTimer->tagIds[0])) {
192	2	$pastTimer['tag_id'] = $clockifyTimer->tagIds[0];
193	2	$pastTimer['tags'] = $tags[$clockifyTimer->tagIds[0]];
194		}
195
196	2	$pastTimer['duration'] = $clockifyTimer->timeInterval->duration;
197
198	2	return (object) $pastTimer;
199		}
200		}
201

godbout / alfred-time

Pull Request — master (#30)

Clockify::buildPastTimerObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like