Joomla\Github\Package\Activity\Notifications

Complexity

Total Complexity

19

Size/Duplication

Total Lines	286
Duplicated Lines	16.78 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
B	getList()	0	31	5
B	getListRepository()	0	31	5
A	markRead()	0	20	2
A	markReadRepository()	0	20	2
A	viewThread()	0	9	1
A	markReadThread()	15	15	1
A	getThreadSubscription()	9	9	1
A	setThreadSubscription()	14	14	1
A	deleteThreadSubscription()	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\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/notifications/
 *
 * @since  1.0
 */
class Notifications extends AbstractPackage
{
	/**
	 * List your notifications.
	 *
	 * List all notifications for the current user, grouped by repository.
	 *
	 * @param   boolean    $all            True to show notifications marked as read.
	 * @param   boolean    $participating  True to show only notifications in which the user is directly participating or mentioned.
	 * @param   \DateTime  $since          Only show notifications updated after the given time.
	 * @param   \DateTime  $before         Only show notifications updated before the given time.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function getList($all = true, $participating = true, \DateTime $since = null, \DateTime $before = null)
	{
		// Build the request path.
		$path = '/notifications?';

		$uri = new Uri($this->fetchUrl($path));

		if ($all)
		{
			$uri->setVar('all', 1);
		}

		if ($participating)
		{
			$uri->setVar('participating', 1);
		}

		if ($since)
		{
			$uri->setVar('since', $since->format(\DateTime::RFC3339));
		}

		if ($before)
		{
			$uri->setVar('before', $before->format(\DateTime::RFC3339));
		}

		return $this->processResponse(
			$this->client->get((string) $uri)
		);
	}

	/**
	 * List your notifications in a repository.
	 *
	 * List all notifications for the current user.
	 *
	 * @param   string     $owner          Repository owner.
	 * @param   string     $repo           Repository name.
	 * @param   boolean    $all            True to show notifications marked as read.
	 * @param   boolean    $participating  True to show only notifications in which the user is directly participating or mentioned.
	 * @param   \DateTime  $since          Only show notifications updated after the given time.
	 * @param   \DateTime  $before         Only show notifications updated before the given time.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function getListRepository($owner, $repo, $all = true, $participating = true, \DateTime $since = null, \DateTime $before = null)
	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/notifications?';

		$uri = new Uri($this->fetchUrl($path));

		if ($all)
		{
			$uri->setVar('all', 1);
		}

		if ($participating)
		{
			$uri->setVar('participating', 1);
		}

		if ($since)
		{
			$uri->setVar('since', $since->format(\DateTime::RFC3339));
		}

		if ($before)
		{
			$uri->setVar('before', $before->format(\DateTime::RFC3339));
		}

		return $this->processResponse(
			$this->client->get((string) $uri)
		);
	}

	/**
	 * Mark as read.
	 *
	 * Marking a notification as “read” removes it from the default view on GitHub.com.
	 *
	 * @param   boolean    $unread      Changes the unread status of the threads.
	 * @param   boolean    $read        Inverse of “unread”.
	 * @param   \DateTime  $lastReadAt  Describes the last point that notifications were checked.
	 *                                  Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function markRead($unread = true, $read = true, \DateTime $lastReadAt = null)
	{
		// Build the request path.
		$path = '/notifications';

		$data = array(
			'unread' => $unread,
			'read'   => $read
		);

		if ($lastReadAt)
		{
			$data['last_read_at'] = $lastReadAt->format(\DateTime::RFC3339);
		}

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

	/**
	 * Mark notifications as read in a repository.
	 *
	 * Marking all notifications in a repository as “read” removes them from the default view on GitHub.com.
	 *
	 * @param   string     $owner       Repository owner.
	 * @param   string     $repo        Repository name.
	 * @param   boolean    $unread      Changes the unread status of the threads.
	 * @param   boolean    $read        Inverse of “unread”.
	 * @param   \DateTime  $lastReadAt  Describes the last point that notifications were checked.
	 *                                  Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function markReadRepository($owner, $repo, $unread, $read, \DateTime $lastReadAt = null)
	{
		// Build the request path.
		$path = '/repos/' . $owner . '/' . $repo . '/notifications';

		$data = array(
			'unread' => $unread,
			'read'   => $read
		);

		if ($lastReadAt)
		{
			$data['last_read_at'] = $lastReadAt->format(\DateTime::RFC3339);
		}

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

	/**
	 * View a single thread.
	 *
	 * @param   integer  $id  The thread id.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function viewThread($id)
	{
		// Build the request path.
		$path = '/notifications/threads/' . $id;

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

	/**
	 * Mark a thread as read.
	 *
	 * @param   integer  $id      The thread id.
	 * @param   boolean  $unread  Changes the unread status of the threads.
	 * @param   boolean  $read    Inverse of “unread”.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function markReadThread($id, $unread = true, $read = true)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/notifications/threads/' . $id;

		$data = array(
			'unread' => $unread,
			'read'   => $read
		);

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

	/**
	 * Get a Thread Subscription.
	 *
	 * This checks to see if the current user is subscribed to a thread.
	 * You can also get a Repository subscription.
	 *
	 * @param   integer  $id  The thread id.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function getThreadSubscription($id)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/notifications/threads/' . $id . '/subscription';

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

	/**
	 * Set a Thread Subscription.
	 *
	 * This lets you subscribe to a thread, or ignore it. Subscribing to a thread is unnecessary
	 * if the user is already subscribed to the repository. Ignoring a thread will mute all
	 * future notifications (until you comment or get @mentioned).
	 *
	 * @param   integer  $id          The thread id.
	 * @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 setThreadSubscription($id, $subscribed, $ignored)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/notifications/threads/' . $id . '/subscription';

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

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

	/**
	 * Delete a Thread Subscription.
	 *
	 * @param   integer  $id  The thread id.
	 *
	 * @return  object
	 *
	 * @since   1.0
	 */
	public function deleteThreadSubscription($id)

This method seems to be duplicated in your project.

	{
		// Build the request path.
		$path = '/notifications/threads/' . $id . '/subscription';

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