Add extra docs to Github package; light refactoring; bug fixes.

src/Joomla/Github/AbstractGithubObject.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * Part of the Joomla Framework Github Package
+ *
+ * @copyright  Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\Github;
+
+use Joomla\Http\Response;
+use Joomla\Uri\Uri;
+use Joomla\Registry\Registry;
+
+/**
+ * GitHub API object class for the Joomla Framework.
+ *
+ * @since  1.0
+ */
+abstract class AbstractGithubObject
+{
+	/**
+	 * @var    Registry  Options for the GitHub object.
+	 * @since  1.0
+	 */
+	protected $options;
+
+	/**
+	 * @var    Http  The HTTP client object to use in sending HTTP requests.
+	 * @since  1.0
+	 */
+	protected $client;
+
+	/**
+	 * @var    string
+	 * @since  1.0
+	 */
+	protected $package = '';
+
+	/**
+	 * Constructor.
+	 *
+	 * @param   Registry  $options  GitHub options object.
+	 * @param   Http      $client   The HTTP client object.
+	 *
+	 * @since   1.0
+	 */
+	public function __construct(Registry $options = null, Http $client = null)
+	{
+		$this->options = isset($options) ? $options : new Registry;
+		$this->client = isset($client) ? $client : new Http($this->options);
+
+		$this->package = get_class($this);
+		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
+	}
+
+	/**
+	 * Method to build and return a full request URL for the request.  This method will
+	 * add appropriate pagination details if necessary and also prepend the API url
+	 * to have a complete URL for the request.
+	 *
+	 * @param   string   $path   URL to inflect
+	 * @param   integer  $page   Page to request
+	 * @param   integer  $limit  Number of results to return per page
+	 *
+	 * @return  string   The request URL.
+	 *
+	 * @since   1.0
+	 */
+	protected function fetchUrl($path, $page = 0, $limit = 0)
+	{
+		// Get a new Uri object fousing the api url and given path.
+		$uri = new Uri($this->options->get('api.url') . $path);
+
+		if ($this->options->get('gh.token', false))
+		{
+			// Use oAuth authentication - @todo set in request header ?
+			$uri->setVar('access_token', $this->options->get('gh.token'));
+		}
+		else
+		{
+			// Use basic authentication
+			if ($this->options->get('api.username', false))
+			{
+				$uri->setUser($this->options->get('api.username'));
+			}
+
+			if ($this->options->get('api.password', false))
+			{
+				$uri->setPass($this->options->get('api.password'));
+			}
+		}
+
+		// If we have a defined page number add it to the JUri object.
+		if ($page > 0)
+		{
+			$uri->setVar('page', (int) $page);
+		}
+
+		// If we have a defined items per page add it to the JUri object.
+		if ($limit > 0)
+		{
+			$uri->setVar('per_page', (int) $limit);
+		}
+
+		return (string) $uri;
+	}
+
+	/**
+	 * Process the response and decode it.
+	 *
+	 * @param   Response  $response      The response.
+	 * @param   integer   $expectedCode  The expected "good" code.
+	 *
+	 * @return  mixed
+	 *
+	 * @since   1.0
+	 * @throws  \DomainException
+	 */
+	protected function processResponse(Response $response, $expectedCode = 200)
+	{
+		// Validate the response code.
+		if ($response->code != $expectedCode)
+		{
+			// Decode the error response and throw an exception.
+			$error = json_decode($response->body);
+			$message = isset($error->message) ? $error->message : 'Invalid response received from GitHub.';
+			throw new \DomainException($message, $response->code);
+		}
+
+		return json_decode($response->body);
+	}
+}

src/Joomla/Github/AbstractPackage.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Part of the Joomla Framework Github Package
+ *
+ * @copyright  Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\Github;
+
+use Joomla\Registry\Registry;
+
+/**
+ * GitHub API package class for the Joomla Framework.
+ *
+ * @since  1.0
+ */
+abstract class AbstractPackage extends AbstractGithubObject
+{
+	/**
+	 * Constructor.
+	 *
+	 * @param   Registry  $options  GitHub options object.
+	 * @param   Http      $client   The HTTP client object.
+	 *
+	 * @since   1.0
+	 */
+	public function __construct(Registry $options = null, Http $client = null)
+	{
+		parent::__construct($options, $client);
+
+		$this->package = get_class($this);
+		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
+	}
+
+	/**
+	 * Magic method to lazily create API objects
+	 *
+	 * @param   string  $name  Name of property to retrieve
+	 *
+	 * @since   1.0
+	 * @throws \InvalidArgumentException
+	 *
+	 * @return  AbstractPackage  GitHub API package object.
+	 */
+	public function __get($name)
+	{
+		$class = '\\Joomla\\Github\\Package\\' . $this->package . '\\' . ucfirst($name);
+
+		if (false == class_exists($class))
+		{
+			throw new \InvalidArgumentException(
+				sprintf(
+					'Argument %1$s produced an invalid class name: %2$s in package %3$s',
+					$name, $class, $this->package
+				)
+			);
+		}
+
+		if (false == isset($this->$name))
+		{
+			$this->$name = new $class($this->options, $this->client);
+		}
+
+		return $this->$name;
+	}
+}

src/Joomla/Github/GithubObject.php

@@ -8,126 +8,12 @@
 
 namespace Joomla\Github;
 
-use Joomla\Http\Response;
-use Joomla\Uri\Uri;
-use Joomla\Registry\Registry;
-
 /**
  * GitHub API object class for the Joomla Framework.
  *
- * @since  1.0
+ * @deprecated  Use AbstractGithubObject instead.
+ * @since       1.0
  */
-abstract class GithubObject
+abstract class GithubObject extends AbstractGithubObject
 {
-	/**
-	 * @var    Registry  Options for the GitHub object.
-	 * @since  1.0
-	 */
-	protected $options;
-
-	/**
-	 * @var    Http  The HTTP client object to use in sending HTTP requests.
-	 * @since  1.0
-	 */
-	protected $client;
-
-	/**
-	 * @var    string  The package in which the object belongs.
-	 * @since  1.0
-	 */
-	protected $package = '';
-
-	/**
-	 * Constructor.
-	 *
-	 * @param   Registry  $options  GitHub options object.
-	 * @param   Http      $client   The HTTP client object.
-	 *
-	 * @since   1.0
-	 */
-	public function __construct(Registry $options = null, Http $client = null)
-	{
-		$this->options = isset($options) ? $options : new Registry;
-		$this->client = isset($client) ? $client : new Http($this->options);
-
-		$this->package = get_class($this);
-		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
-	}
-
-	/**
-	 * Method to build and return a full request URL for the request.  This method will
-	 * add appropriate pagination details if necessary and also prepend the API url
-	 * to have a complete URL for the request.
-	 *
-	 * @param   string   $path   URL to inflect
-	 * @param   integer  $page   Page to request
-	 * @param   integer  $limit  Number of results to return per page
-	 *
-	 * @return  string   The request URL.
-	 *
-	 * @since   1.0
-	 */
-	protected function fetchUrl($path, $page = 0, $limit = 0)
-	{
-		// Get a new Uri object fousing the api url and given path.
-		$uri = new Uri($this->options->get('api.url') . $path);
-
-		if ($this->options->get('gh.token', false))
-		{
-			// Use oAuth authentication - @todo set in request header ?
-			$uri->setVar('access_token', $this->options->get('gh.token'));
-		}
-		else
-		{
-			// Use basic authentication
-			if ($this->options->get('api.username', false))
-			{
-				$uri->setUser($this->options->get('api.username'));
-			}
-
-			if ($this->options->get('api.password', false))
-			{
-				$uri->setPass($this->options->get('api.password'));
-			}
-		}
-
-		// If we have a defined page number add it to the JUri object.
-		if ($page > 0)
-		{
-			$uri->setVar('page', (int) $page);
-		}
-
-		// If we have a defined items per page add it to the JUri object.
-		if ($limit > 0)
-		{
-			$uri->setVar('per_page', (int) $limit);
-		}
-
-		return (string) $uri;
-	}
-
-	/**
-	 * Process the response and decode it.
-	 *
-	 * @param   Response  $response      The response.
-	 * @param   integer   $expectedCode  The expected "good" code.
-	 *
-	 * @return  mixed
-	 *
-	 * @since   1.0
-	 * @throws  \DomainException
-	 */
-	protected function processResponse(Response $response, $expectedCode = 200)
-	{
-		// Validate the response code.
-		if ($response->code != $expectedCode)
-		{
-			// Decode the error response and throw an exception.
-			$error = json_decode($response->body);
-			$message = isset($error->message) ? $error->message : 'Invalid response received from GitHub.';
-			throw new \DomainException($message, $response->code);
-		}
-
-		return json_decode($response->body);
-	}
 }

src/Joomla/Github/Package.php

@@ -8,60 +8,12 @@
 
 namespace Joomla\Github;
 
-use Joomla\Registry\Registry;
-
 /**
  * GitHub API package class for the Joomla Framework.
  *
- * @since  1.0
+ * @deprecated  Use AbstractPackage instead.
+ * @since       1.0
  */
-abstract class Package extends GithubObject
+abstract class Package extends AbstractPackage
 {
-	/**
-	 * Constructor.
-	 *
-	 * @param   Registry  $options  GitHub options object.
-	 * @param   Http      $client   The HTTP client object.
-	 *
-	 * @since   1.0
-	 */
-	public function __construct(Registry $options = null, Http $client = null)
-	{
-		parent::__construct($options, $client);
-
-		$this->package = get_class($this);
-		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
-	}
-
-	/**
-	 * Magic method to lazily create API objects
-	 *
-	 * @param   string  $name  Name of property to retrieve
-	 *
-	 * @since   1.0
-	 * @throws \InvalidArgumentException
-	 *
-	 * @return  Package  GitHub API package object.
-	 */
-	public function __get($name)
-	{
-		$class = '\\Joomla\\Github\\Package\\' . $this->package . '\\' . ucfirst($name);
-
-		if (false == class_exists($class))
-		{
-			throw new \InvalidArgumentException(
-				sprintf(
-					'Argument %1$s produced an invalid class name: %2$s in package %3$s',
-					$name, $class, $this->package
-				)
-			);
-		}
-
-		if (false == isset($this->$name))
-		{
-			$this->$name = new $class($this->options, $this->client);
-		}
-
-		return $this->$name;
-	}
 }