Deprecate Http subclass (#43)

mbabker · wilsonge · commit f331095e4d04 · 2018-03-26T15:27:40.000+01:00
* Deprecate Http subclass

* GitHub requires User Agent
diff --git a/src/AbstractGithubObject.php b/src/AbstractGithubObject.php
@@ -9,6 +9,7 @@
 namespace Joomla\Github;
 
 use Joomla\Http\Exception\UnexpectedResponseException;
+use Joomla\Http\Http as BaseHttp;
 use Joomla\Http\Response;
 use Joomla\Uri\Uri;
 use Joomla\Registry\Registry;
@@ -75,14 +76,14 @@ abstract class AbstractGithubObject
 	 * Constructor.
 	 *
 	 * @param   Registry  $options  GitHub options object.
-	 * @param   Http      $client   The HTTP client object.
+	 * @param   BaseHttp  $client   The HTTP client object.
 	 *
 	 * @since   1.0
 	 */
-	public function __construct(Registry $options = null, Http $client = null)
+	public function __construct(Registry $options = null, BaseHttp $client = null)
 	{
-		$this->options = isset($options) ? $options : new Registry;
-		$this->client = isset($client) ? $client : new Http($this->options);
+		$this->options = $options ?: new Registry;
+		$this->client = $client ?: new Http($this->options);
 
 		$this->package = get_class($this);
 		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
diff --git a/src/AbstractPackage.php b/src/AbstractPackage.php
@@ -8,6 +8,7 @@
 
 namespace Joomla\Github;
 
+use Joomla\Http\Http as BaseHttp;
 use Joomla\Registry\Registry;
 
 /**
@@ -21,11 +22,11 @@ abstract class AbstractPackage extends AbstractGithubObject
 	 * Constructor.
 	 *
 	 * @param   Registry  $options  GitHub options object.
-	 * @param   Http      $client   The HTTP client object.
+	 * @param   BaseHttp  $client   The HTTP client object.
 	 *
 	 * @since   1.0
 	 */
-	public function __construct(Registry $options = null, Http $client = null)
+	public function __construct(Registry $options = null, BaseHttp $client = null)
 	{
 		parent::__construct($options, $client);
 
diff --git a/src/Github.php b/src/Github.php
@@ -8,6 +8,7 @@
 
 namespace Joomla\Github;
 
+use Joomla\Http\Http as BaseHttp;
 use Joomla\Registry\Registry;
 
 /**
@@ -50,20 +51,27 @@ class Github
 	 * Constructor.
 	 *
 	 * @param   Registry  $options  GitHub options object.
-	 * @param   Http      $client   The HTTP client object.
+	 * @param   BaseHttp  $client   The HTTP client object.
 	 *
 	 * @since   1.0
 	 */
-	public function __construct(Registry $options = null, Http $client = null)
+	public function __construct(Registry $options = null, BaseHttp $client = null)
 	{
-		$this->options = isset($options) ? $options : new Registry;
-		$this->client  = isset($client) ? $client : new Http($this->options);
+		$this->options = $options ?: new Registry;
+
+		// Setup the default user agent if not already set.
+		if (!$this->getOption('userAgent'))
+		{
+			$this->setOption('userAgent', 'JGitHub/2.0');
+		}
 
 		// Setup the default API url if not already set.
 		if (!$this->getOption('api.url'))
 		{
 			$this->setOption('api.url', 'https://api.github.com');
 		}
+
+		$this->client = $client ?: new Http($this->options);
 	}
 
 	/**
diff --git a/src/Http.php b/src/Http.php
@@ -14,25 +14,29 @@
 /**
  * HTTP client class for connecting to a GitHub instance.
  *
- * @since  1.0
+ * @since       1.0
+ * @deprecated  2.0  Use Joomla\Http\Http instead
  */
 class Http extends BaseHttp
 {
 	/**
 	 * @const  integer  Use no authentication for HTTP connections.
 	 * @since  1.0
+	 * @deprecated  2.0
 	 */
 	const AUTHENTICATION_NONE = 0;
 
 	/**
 	 * @const  integer  Use basic authentication for HTTP connections.
 	 * @since  1.0
+	 * @deprecated  2.0
 	 */
 	const AUTHENTICATION_BASIC = 1;
 
 	/**
 	 * @const  integer  Use OAuth authentication for HTTP connections.
 	 * @since  1.0
+	 * @deprecated  2.0
 	 */
 	const AUTHENTICATION_OAUTH = 2;
 
@@ -43,6 +47,7 @@ class Http extends BaseHttp
 	 * @param   TransportInterface  $transport  The HTTP transport object.
 	 *
 	 * @since   1.0
+	 * @deprecated  2.0
 	 */
 	public function __construct($options = array(), TransportInterface $transport = null)
 	{

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`namespace Joomla\Github;`
`10`	`10`
	`11`	`+use Joomla\Http\Http as BaseHttp;`
`11`	`12`	`use Joomla\Registry\Registry;`
`12`	`13`
`13`	`14`	`/**`
`@@ -21,11 +22,11 @@ abstract class AbstractPackage extends AbstractGithubObject`
`21`	`22`	`* Constructor.`
`22`	`23`	`*`
`23`	`24`	`* @param Registry $options GitHub options object.`
`24`		`- * @param Http $client The HTTP client object.`
	`25`	`+ * @param BaseHttp $client The HTTP client object.`
`25`	`26`	`*`
`26`	`27`	`* @since 1.0`
`27`	`28`	`*/`
`28`		`- public function __construct(Registry $options = null, Http $client = null)`
	`29`	`+ public function __construct(Registry $options = null, BaseHttp $client = null)`
`29`	`30`	`{`
`30`	`31`	`parent::__construct($options, $client);`
`31`	`32`