Starring::getRepositories() - 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-19 17:50 UTC

Starring::getRepositories() B

↳ Parent: Starring

Complexity

Conditions	4
Paths	4

Size

Total Lines	36
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	19
nc	4
nop	3
dl	0
loc	36
rs	8.5806
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;
use Joomla\Uri\Uri;

/**
 * GitHub API Activity Events class for the Joomla Framework.
 *
 * @documentation http://developer.github.com/v3/activity/starring/
 *
 * @since  1.0
 */
class Starring extends AbstractPackage
{
	/**
	 * List Stargazers.
	 *
	 * @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 . '/stargazers';

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

	/**
	 * List repositories being starred.
	 *
	 * List repositories being starred by a user.
	 *
	 * @param   string  $user       User name.
	 * @param   string  $sort       One of `created` (when the repository was starred) or `updated` (when it was last pushed to).
	 * @param   string  $direction  One of `asc` (ascending) or `desc` (descending).
	 *
	 * @return  object
	 *
	 * @since   1.0
	 * @throws  \InvalidArgumentException
	 */
	public function getRepositories($user = '', $sort = 'created', $direction = 'desc')
	{
		$allowedSort = array('created', 'updated');
		$allowedDir  = array('asc', 'desc');

		if (!in_array($sort, $allowedSort))
		{
			throw new \InvalidArgumentException(
				sprintf(
					'The sorting value is invalid. Allowed values are: %s',
					implode(', ', $allowedSort)
				)
			);
		}

		if (!in_array($direction, $allowedDir))
		{
			throw new \InvalidArgumentException(
				sprintf(
					'The direction value is invalid. Allowed values are: %s',
					implode(', ', $allowedDir)
				)
			);
		}

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

		$path .= "?sort=$sort&direction=$direction";

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

	/**
	 * Check if you are starring a repository.
	 *
	 * 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/starred/' . $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);
	}

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

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

	/**
	 * Unstar a repository.
	 *
	 * Requires for the user to be authenticated.
	 *
	 * @param   string  $owner  Repository owner.
	 * @param   string  $repo   Repository name.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function unstar($owner, $repo)
	{
		// Build the request path.
		$path = '/user/starred/' . $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			use Joomla\Uri\Uri;
13
14			/**
15			* GitHub API Activity Events class for the Joomla Framework.
16			*
17			* @documentation http://developer.github.com/v3/activity/starring/
18			*
19			* @since 1.0
20			*/
21			class Starring extends AbstractPackage
22			{
23			/**
24			* List Stargazers.
25			*
26			* @param string $owner Repository owner.
27			* @param string $repo Repository name.
28			*
29			* @return mixed
30			*
31			* @since 1.0
32			*/
33			public function getList($owner, $repo)
34			{
35			// Build the request path.
36			$path = '/repos/' . $owner . '/' . $repo . '/stargazers';
37
38			return $this->processResponse(
39			$this->client->get($this->fetchUrl($path))
40			);
41			}
42
43			/**
44			* List repositories being starred.
45			*
46			* List repositories being starred by a user.
47			*
48			* @param string $user User name.
49			* @param string $sort One of `created` (when the repository was starred) or `updated` (when it was last pushed to).
50			* @param string $direction One of `asc` (ascending) or `desc` (descending).
51			*
52			* @return object
53			*
54			* @since 1.0
55			* @throws \InvalidArgumentException
56			*/
57			public function getRepositories($user = '', $sort = 'created', $direction = 'desc')
58			{
59			$allowedSort = array('created', 'updated');
60			$allowedDir = array('asc', 'desc');
61
62			if (!in_array($sort, $allowedSort))
63			{
64			throw new \InvalidArgumentException(
65			sprintf(
66			'The sorting value is invalid. Allowed values are: %s',
67			implode(', ', $allowedSort)
68			)
69			);
70			}
71
72			if (!in_array($direction, $allowedDir))
73			{
74			throw new \InvalidArgumentException(
75			sprintf(
76			'The direction value is invalid. Allowed values are: %s',
77			implode(', ', $allowedDir)
78			)
79			);
80			}
81
82			// Build the request path.
83			$path = ($user)
84			? '/users' . $user . '/starred'
85			: '/user/starred';
86
87			$path .= "?sort=$sort&direction=$direction";
88
89			return $this->processResponse(
90			$this->client->get($this->fetchUrl($path))
91			);
92			}
93
94			/**
95			* Check if you are starring a repository.
96			*
97			* Requires for the user to be authenticated.
98			*
99			* @param string $owner Repository owner.
100			* @param string $repo Repository name.
101			*
102			* @return boolean
103			*
104			* @since 1.0
105			* @throws \UnexpectedValueException
106			*/
107			public function check($owner, $repo)
108			{
109			// Build the request path.
110			$path = '/user/starred/' . $owner . '/' . $repo;
111
112			$response = $this->client->get($this->fetchUrl($path));
113
114			switch ($response->code)
115			{
116			case '204' :
117			// This repository is watched by you.
118			return true;
119			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...
120
121			case '404' :
122			// This repository is not watched by you.
123			return false;
124			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...
125			}
126
127			throw new \UnexpectedValueException('Unexpected response code: ' . $response->code);
128			}
129
130			/**
131			* Star a repository.
132			*
133			* Requires for the user to be authenticated.
134			*
135			* @param string $owner Repository owner.
136			* @param string $repo Repository name.
137			*
138			* @return object
139			*
140			* @since 1.0
141			*/
142			public function star($owner, $repo)
143			{
144			// Build the request path.
145			$path = '/user/starred/' . $owner . '/' . $repo;
146
147			return $this->processResponse(
148			$this->client->put($this->fetchUrl($path), ''),
149			204
150			);
151			}
152
153			/**
154			* Unstar a repository.
155			*
156			* Requires for the user to be authenticated.
157			*
158			* @param string $owner Repository owner.
159			* @param string $repo Repository name.
160			*
161			* @return object
162			*
163			* @since 1.0
164			*/
165			public function unstar($owner, $repo)
166			{
167			// Build the request path.
168			$path = '/user/starred/' . $owner . '/' . $repo;
169
170			return $this->processResponse(
171			$this->client->delete($this->fetchUrl($path)),
172			204
173			);
174			}
175			}
176

joomla-projects / com_localise

GitHub Access Token became invalid

Pull Request — develop (#322)

Starring::getRepositories() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like