Watching::getList() - Code Metrics - Inspection of "Composer" - joomla-projects/com_localise - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#322)

unknown

created 2017-12-20 21:18 UTC

Watching::getList() A

↳ Parent: Watching

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Part of the Joomla Framework Github Package
 *
 * @copyright  Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\Github\Package\Activity;

use Joomla\Github\AbstractPackage;

/**
 * GitHub API Activity Watching Events class for the Joomla Framework.
 *
 * @documentation http://developer.github.com/v3/activity/watching/
 *
 * @since  1.0
 */
class Watching extends AbstractPackage
{
	/**
	 * List watchers
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  mixed
	 *
	 * @since   1.0
	 */
	public function getList($owner, $repo)
	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/subscribers';

		return $this->processResponse(
			$this->client->get($this->fetchUrl($path))
		);
	}

	/**
	 * List repositories being watched.
	 *
	 * List repositories being watched by a user.
	 *
	 * @param   string  $user  User name.
	 *
	 * @return  mixed
	 *
	 * @since   1.0
	 */
	public function getRepositories($user = '')

	{
		// Build the request path.
		$path = ($user)
			? '/users/' . $user . '/subscriptions'
			: '/user/subscriptions';

		return $this->processResponse(
			$this->client->get($this->fetchUrl($path))
		);
	}

	/**
	 * Get a Repository Subscription.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function getSubscription($owner, $repo)
	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/subscription';

		return $this->processResponse(
			$this->client->get($this->fetchUrl($path))
		);
	}

	/**
	 * Set a Repository Subscription.
	 *
	 * @param   string   $owner       Repository owner.
	 * @param   string   $repo        Repository name.
	 * @param   boolean  $subscribed  Determines if notifications should be received from this thread.
	 * @param   boolean  $ignored     Determines if all notifications should be blocked from this thread.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function setSubscription($owner, $repo, $subscribed, $ignored)
	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/subscription';

		$data = array(
			'subscribed' => $subscribed,
			'ignored'    => $ignored
		);

		return $this->processResponse(
			$this->client->put($this->fetchUrl($path), json_encode($data))
		);
	}

	/**
	 * Delete a Repository Subscription.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function deleteSubscription($owner, $repo)

	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/subscription';

		return $this->processResponse(
			$this->client->delete($this->fetchUrl($path)),
			204
		);
	}

	/**
	 * Check if you are watching a repository (LEGACY).
	 *
	 * Requires for the user to be authenticated.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  boolean
	 *
	 * @since   1.0
	 * @throws  \UnexpectedValueException
	 */
	public function check($owner, $repo)
	{
		// Build the request path.
		$path = '/user/subscriptions/' . $owner . '/' . $repo;

		$response = $this->client->get($this->fetchUrl($path));

		switch ($response->code)
		{
			case '204' :
				// This repository is watched by you.
				return true;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

			case '404' :
				// This repository is not watched by you.
				return false;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
		}

		throw new \UnexpectedValueException('Unexpected response code: ' . $response->code);
	}

	/**
	 * Watch a repository (LEGACY).
	 *
	 * Requires for the user to be authenticated.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function watch($owner, $repo)
	{
		// Build the request path.
		$path = '/user/subscriptions/' . $owner . '/' . $repo;

		return $this->processResponse(
			$this->client->put($this->fetchUrl($path), ''),
			204
		);
	}

	/**
	 * Stop watching a repository (LEGACY).
	 *
	 * Requires for the user to be authenticated.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function unwatch($owner, $repo)
	{
		// Build the request path.
		$path = '/user/subscriptions/' . $owner . '/' . $repo;

		return $this->processResponse(
			$this->client->delete($this->fetchUrl($path)),
			204
		);
	}
}


1		<?php
2		/**
3		* Part of the Joomla Framework Github Package
4		*
5		* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
6		* @license GNU General Public License version 2 or later; see LICENSE
7		*/
8
9		namespace Joomla\Github\Package\Activity;
10
11		use Joomla\Github\AbstractPackage;
12
13		/**
14		* GitHub API Activity Watching Events class for the Joomla Framework.
15		*
16		* @documentation http://developer.github.com/v3/activity/watching/
17		*
18		* @since 1.0
19		*/
20		class Watching extends AbstractPackage
21		{
22		/**
23		* List watchers
24		*
25		* @param string $owner Repository owner.
26		* @param string $repo Repository name.
27		*
28		* @return mixed
29		*
30		* @since 1.0
31		*/
32		public function getList($owner, $repo)
33		{
34		// Build the request path.
35		$path = '/repos/' . $owner . '/' . $repo . '/subscribers';
36
37		return $this->processResponse(
38		$this->client->get($this->fetchUrl($path))
39		);
40		}
41
42		/**
43		* List repositories being watched.
44		*
45		* List repositories being watched by a user.
46		*
47		* @param string $user User name.
48		*
49		* @return mixed
50		*
51		* @since 1.0
52		*/
53	View Code Duplication	public function getRepositories($user = '')
		0 ignored issues – show Duplication introduced 2017-12-19 12:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
54		{
55		// Build the request path.
56		$path = ($user)
57		? '/users/' . $user . '/subscriptions'
58		: '/user/subscriptions';
59
60		return $this->processResponse(
61		$this->client->get($this->fetchUrl($path))
62		);
63		}
64
65		/**
66		* Get a Repository Subscription.
67		*
68		* @param string $owner Repository owner.
69		* @param string $repo Repository name.
70		*
71		* @return object
72		*
73		* @since 1.0
74		*/
75		public function getSubscription($owner, $repo)
76		{
77		// Build the request path.
78		$path = '/repos/' . $owner . '/' . $repo . '/subscription';
79
80		return $this->processResponse(
81		$this->client->get($this->fetchUrl($path))
82		);
83		}
84
85		/**
86		* Set a Repository Subscription.
87		*
88		* @param string $owner Repository owner.
89		* @param string $repo Repository name.
90		* @param boolean $subscribed Determines if notifications should be received from this thread.
91		* @param boolean $ignored Determines if all notifications should be blocked from this thread.
92		*
93		* @return object
94		*
95		* @since 1.0
96		*/
97		public function setSubscription($owner, $repo, $subscribed, $ignored)
98		{
99		// Build the request path.
100		$path = '/repos/' . $owner . '/' . $repo . '/subscription';
101
102		$data = array(
103		'subscribed' => $subscribed,
104		'ignored' => $ignored
105		);
106
107		return $this->processResponse(
108		$this->client->put($this->fetchUrl($path), json_encode($data))
109		);
110		}
111
112		/**
113		* Delete a Repository Subscription.
114		*
115		* @param string $owner Repository owner.
116		* @param string $repo Repository name.
117		*
118		* @return object
119		*
120		* @since 1.0
121		*/
122	View Code Duplication	public function deleteSubscription($owner, $repo)
		0 ignored issues – show Duplication introduced 2017-12-19 12:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		{
124		// Build the request path.
125		$path = '/repos/' . $owner . '/' . $repo . '/subscription';
126
127		return $this->processResponse(
128		$this->client->delete($this->fetchUrl($path)),
129		204
130		);
131		}
132
133		/**
134		* Check if you are watching a repository (LEGACY).
135		*
136		* Requires for the user to be authenticated.
137		*
138		* @param string $owner Repository owner.
139		* @param string $repo Repository name.
140		*
141		* @return boolean
142		*
143		* @since 1.0
144		* @throws \UnexpectedValueException
145		*/
146		public function check($owner, $repo)
147		{
148		// Build the request path.
149		$path = '/user/subscriptions/' . $owner . '/' . $repo;
150
151		$response = $this->client->get($this->fetchUrl($path));
152
153		switch ($response->code)
154		{
155		case '204' :
156		// This repository is watched by you.
157		return true;
158		break;
		0 ignored issues – show Unused Code introduced 2017-12-19 12:54 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
159
160		case '404' :
161		// This repository is not watched by you.
162		return false;
163		break;
		0 ignored issues – show Unused Code introduced 2017-12-19 12:54 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
164		}
165
166		throw new \UnexpectedValueException('Unexpected response code: ' . $response->code);
167		}
168
169		/**
170		* Watch a repository (LEGACY).
171		*
172		* Requires for the user to be authenticated.
173		*
174		* @param string $owner Repository owner.
175		* @param string $repo Repository name.
176		*
177		* @return object
178		*
179		* @since 1.0
180		*/
181		public function watch($owner, $repo)
182		{
183		// Build the request path.
184		$path = '/user/subscriptions/' . $owner . '/' . $repo;
185
186		return $this->processResponse(
187		$this->client->put($this->fetchUrl($path), ''),
188		204
189		);
190		}
191
192		/**
193		* Stop watching a repository (LEGACY).
194		*
195		* Requires for the user to be authenticated.
196		*
197		* @param string $owner Repository owner.
198		* @param string $repo Repository name.
199		*
200		* @return object
201		*
202		* @since 1.0
203		*/
204		public function unwatch($owner, $repo)
205		{
206		// Build the request path.
207		$path = '/user/subscriptions/' . $owner . '/' . $repo;
208
209		return $this->processResponse(
210		$this->client->delete($this->fetchUrl($path)),
211		204
212		);
213		}
214		}
215

joomla-projects / com_localise

GitHub Access Token became invalid

Pull Request — develop (#322)

Watching::getList() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like