Joomla\Github\Package\Repositories\Releases

Complexity

Total Complexity

19

Size/Duplication

Total Lines	319
Duplicated Lines	11.6 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	20	1
A	delete()	10	10	1
B	edit()	0	42	6
A	get()	0	8	1
A	getLatest()	0	8	1
A	getByTag()	0	8	1
A	getList()	0	20	3
A	getListAssets()	0	8	1
A	getAsset()	0	8	1
A	editAsset()	17	17	2
A	deleteAsset()	10	10	1

<?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\Repositories;

use Joomla\Github\AbstractPackage;

/**
 * GitHub API References class for the Joomla Platform.
 *
 * @documentation http://developer.github.com/v3/repos/releases
 *
 * @since  1.1.0
 */
class Releases extends AbstractPackage
{
	/**
	 * Create a release.
	 *
	 * @param   string   $user             The name of the owner of the GitHub repository.
	 * @param   string   $repo             The name of the GitHub repository.
	 * @param   string   $tagName          The name of the tag.
	 * @param   string   $targetCommitish  The commitish value that determines where the Git tag is created from.
	 * @param   string   $name             The name of the release.
	 * @param   string   $body             Text describing the contents of the tag.
	 * @param   boolean  $draft            True to create a draft (unpublished) release, false to create a published one.
	 * @param   boolean  $preRelease       True to identify the release as a prerelease. false to identify the release as a full release.
	 *
	 * @return  object
	 *
	 * @link    http://developer.github.com/v3/repos/releases/#create-a-release
	 * @since   1.1.0
	 */
	public function create($user, $repo, $tagName, $targetCommitish = '', $name = '', $body = '', $draft = false, $preRelease = false)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases';

		// Build the request data.
		$data = json_encode(
			array(
				'tag_name' => $tagName,
				'target_commitish' => $targetCommitish,
				'name' => $name,
				'body' => $body,
				'draft' => (boolean) $draft,
				'prerelease' => (boolean) $preRelease,
			)
		);

		// Send the request.
		return $this->processResponse($this->client->post($this->fetchUrl($path), $data), 201);
	}

	/**
	 * Delete a release.
	 *
	 * @param   string   $owner      The name of the owner of the GitHub repository.
	 * @param   string   $repo       The name of the GitHub repository.
	 * @param   integer  $releaseId  The release id.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function delete($owner, $repo, $releaseId)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/releases/' . (int) $releaseId;

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

	/**
	 * Edit a release.
	 *
	 * @param   string   $user             The name of the owner of the GitHub repository.
	 * @param   string   $repo             The name of the GitHub repository.
	 * @param   integer  $releaseId        The release id.
	 * @param   string   $tagName          The name of the tag.
	 * @param   string   $targetCommitish  The commitish value that determines where the Git tag is created from.
	 * @param   string   $name             The branch (or git ref) you want your changes pulled into. This
	 *                                     should be an existing branch on the current repository. You cannot
	 *                                     submit a pull request to one repo that requests a merge to a base
	 *                                     of another repo.
	 * @param   boolean  $body             The body text for the new pull request.
	 * @param   boolean  $draft            The branch (or git ref) where your changes are implemented.
	 * @param   string   $preRelease       The branch (or git ref) where your changes are implemented.
	 *
	 * @return  object
	 *
	 * @link    http://developer.github.com/v3/repos/releases/#edit-a-release
	 * @since   1.1.0
	 * @throws  \DomainException
	 */
	public function edit($user, $repo, $releaseId, $tagName,
		$targetCommitish = null, $name = null, $body = null, $draft = null, $preRelease = null)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/' . (int) $releaseId;

		// Create the data object.
		$data = new \stdClass;
		$data->tag_name = $tagName;

		// Check if input values are set and add them to the data object.
		if (isset($targetCommitish))
		{
			$data->target_commitish = $targetCommitish;
		}

		if (isset($name))
		{
			$data->name = $name;
		}

		if (isset($body))
		{
			$data->body = $body;
		}

		if (isset($draft))
		{
			$data->draft = $draft;
		}

		if (isset($preRelease))
		{
			$data->prerelease = $preRelease;
		}

		// Encode the request data.
		$data = json_encode($data);

		// Send the request.
		return $this->processResponse($this->client->patch($this->fetchUrl($path), $data));
	}

	/**
	 * Get a single release.
	 *
	 * @param   string  $user  The name of the owner of the GitHub repository.
	 * @param   string  $repo  The name of the GitHub repository.
	 * @param   string  $ref   Valid values are: 'latest', 'tags/2.0.24' or Release Id, for example: '1643513'
	 *
	 * @return  object
	 *
	 * @since   1.1.0
	 * @throws  \DomainException
	 */
	public function get($user, $repo, $ref)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/' . $ref;

		// Send the request.
		return $this->processResponse($this->client->get($this->fetchUrl($path)));
	}

	/**
	 * Get the latest release.
	 *
	 * View the latest published full release for the repository.
	 * Draft releases and prereleases are not returned by this endpoint.
	 *
	 * @param   string  $user  The name of the owner of the GitHub repository.
	 * @param   string  $repo  The name of the GitHub repository.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function getLatest($user, $repo)
	{
		// Build the request path.
		$path = "/repos/$user/$repo/releases/latest";

		// Send the request.
		return $this->processResponse($this->client->get($this->fetchUrl($path)));
	}

	/**
	 * Get a release by tag name.
	 *
	 * @param   string  $user  The name of the owner of the GitHub repository.
	 * @param   string  $repo  The name of the GitHub repository.
	 * @param   string  $tag   The name of the tag.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function getByTag($user, $repo, $tag)
	{
		// Build the request path.
		$path = "/repos/$user/$repo/releases/tags/$tag";

		// Send the request.
		return $this->processResponse($this->client->get($this->fetchUrl($path)));
	}

	/**
	 * List releases for a repository.
	 *
	 * @param   string   $user   The name of the owner of the GitHub repository.
	 * @param   string   $repo   The name of the GitHub repository.
	 * @param   integer  $page   The page number from which to get items.
	 * @param   integer  $limit  The number of items on a page.
	 *
	 * @return  array  An associative array of releases keyed by the tag name.
	 *
	 * @since   1.1.0
	 * @throws  \DomainException
	 */
	public function getList($user, $repo, $page = 0, $limit = 0)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases';

		// Send the request.
		$response = $this->processResponse($this->client->get($this->fetchUrl($path, $page, $limit)));

		$releases = array();

		if (is_array($response))
		{
			foreach ($response as $release)
			{
				$releases[$release->tag_name] = $release;
			}
		}

		return $releases;
	}

	/**
	 * List assets for a release.
	 *
	 * @param   string   $user       The name of the owner of the GitHub repository.
	 * @param   string   $repo       The name of the GitHub repository.
	 * @param   integer  $releaseId  The release id.
	 * @param   integer  $page       The page number from which to get items.
	 * @param   integer  $limit      The number of items on a page.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function getListAssets($user, $repo, $releaseId, $page = 0, $limit = 0)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/' . (int) $releaseId . '/assets';

		// Send the request.
		return $this->processResponse($this->client->get($this->fetchUrl($path, $page, $limit)));
	}

	/**
	 * Get a single release asset.
	 *
	 * @param   string   $user     The name of the owner of the GitHub repository.
	 * @param   string   $repo     The name of the GitHub repository.
	 * @param   integer  $assetId  The asset id.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function getAsset($user, $repo, $assetId)
	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/assets/' . (int) $assetId;

		// Send the request.
		return $this->processResponse($this->client->get($this->fetchUrl($path)));
	}

	/**
	 * Edit a release asset.
	 *
	 * @param   string   $user     The name of the owner of the GitHub repository.
	 * @param   string   $repo     The name of the GitHub repository.
	 * @param   integer  $assetId  The asset id.
	 * @param   string   $name     The file name of the asset.
	 * @param   string   $label    An alternate short description of the asset. Used in place of the filename.
	 *
	 * @return  object
	 *
	 * @since   1.4.0
	 */
	public function editAsset($user, $repo, $assetId, $name, $label = '')

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/assets/' . (int) $assetId;

		$data = array(
			'name' => $name,
		);

		if ($label)
		{
			$data['label'] = $label;
		}

		// Send the request.
		return $this->processResponse($this->client->patch($this->fetchUrl($path), json_encode($data)));
	}

	/**
	 * Delete a release asset.
	 *
	 * @param   string   $user     The name of the owner of the GitHub repository.
	 * @param   string   $repo     The name of the GitHub repository.
	 * @param   integer  $assetId  The asset id.
	 *
	 * @return  boolean
	 *
	 * @since   1.4.0
	 */
	public function deleteAsset($user, $repo, $assetId)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/repos/' . $user . '/' . $repo . '/releases/assets/' . (int) $assetId;

		// Send the request.
		$this->processResponse($this->client->delete($this->fetchUrl($path)), 204);

		return true;
	}
}