Update RELNOTES + some other stuff

Also:
 - Fixes some indenting
 - Removes some pointless specificity in @SInCE tags
 - Adds some @SInCE tags

Author: addshore

RELEASENOTES.md

@@ -1,5 +1,11 @@
 These are the release notes for the [mediawiki-api-base](README.md).
 
+## Version 2.3.0 (No yet released)
+
+* All guzzle configuration settings can now be overridden in `ClientFactory`
+* Requests that fail due to maxlag will be automatically retried
+* Added `MediawikiApi::getApiUrl`
+
 ## Version 2.2.1 (3 August 2016)
 
 * Cast SimpleXMLElements attributes as string in `MediawikiApi::newFromPage()`

src/Guzzle/ClientFactory.php

@@ -10,7 +10,7 @@
 use Psr\Log\NullLogger;
 
 /**
- * @since 2.1.0
+ * @since 2.1
  *
  * @author Addshore
  */
@@ -21,9 +21,9 @@ class ClientFactory implements LoggerAwareInterface {
 	private $config;
 
 	/**
-	 * @since 2.1.0
+	 * @since 2.1
 	 *
-	 * @param array $config All configurtion settings supported by Guzzle, and these:
+	 * @param array $config All configuration settings supported by Guzzle, and these:
 	 *          middleware => array of extra middleware to pass to guzzle
 	 *          user-agent => string default user agent to use for requests
 	 */
@@ -33,7 +33,7 @@ public function __construct( array $config = array() ) {
 	}
 
 	/**
-	 * @since 2.1.0
+	 * @since 2.1
 	 *
 	 * @return Client
 	 */
@@ -83,7 +83,7 @@ private function newClient() {
 	/**
 	 * Sets a logger instance on the object
 	 *
-	 * @since 2.1.0
+	 * @since 2.1
 	 *
 	 * @param LoggerInterface $logger
 	 *

src/MediawikiApi.php

@@ -55,7 +55,7 @@ class MediawikiApi implements MediawikiApiInterface, LoggerAwareInterface {
 	private $apiUrl;
 
 	/**
-	 * @since 2.0.0
+	 * @since 2.0
 	 *
 	 * @param string $apiEndpoint e.g. https://en.wikipedia.org/w/api.php
 	 *
@@ -66,7 +66,7 @@ public static function newFromApiEndpoint( $apiEndpoint ) {
 	}
 
 	/**
-	 * @since 2.0.0
+	 * @since 2.0
 	 *
 	 * @param string $url e.g. https://en.wikipedia.org OR https://de.wikipedia.org/wiki/Berlin
 	 *
@@ -106,6 +106,9 @@ public function __construct( $apiUrl, ClientInterface $client = null, MediawikiS
 	/**
 	 * Get the API URL (the URL to which API requests are sent, usually ending in api.php).
 	 * This is useful if you've created this object via MediawikiApi::newFromPage().
+	 *
+	 * @since 2.3
+	 *
 	 * @return string The API URL.
 	 */
 	public function getApiUrl() {
@@ -252,29 +255,37 @@ private function getPostRequestEncoding( Request $request ) {
 	 * @return array as needed by ClientInterface::get and ClientInterface::post
 	 */
 	private function getClientRequestOptions( Request $request, $paramsKey ) {
-	    $params = array_merge( $request->getParams(), array( 'format' => 'json' ) );
-	    if ( $paramsKey === 'multipart' ) {
-            $params = $this->encodeMultipartParams( $params );
-        }
+
+		$params = array_merge( $request->getParams(), array( 'format' => 'json' ) );
+		if ( $paramsKey === 'multipart' ) {
+			$params = $this->encodeMultipartParams( $params );
+		}
 
 		return array(
 			$paramsKey => $params,
 			'headers' => array_merge( $this->getDefaultHeaders(), $request->getHeaders() ),
 		);
 	}
 
-    /**
-     * @param array $params
-     * @return array
-     */
+	/**
+	 * @param array $params
+	 *
+	 * @return array
+	 */
 	private function encodeMultipartParams( $params ) {
-	    return array_map( function( $name, $value ) {
-            return array(
-                'name' => $name,
-                'contents' => $value
-            );
-        }, array_keys( $params ), $params );
-    }
+
+		return array_map(
+			function ( $name, $value ) {
+
+				return array(
+					'name' => $name,
+					'contents' => $value,
+				);
+			},
+			array_keys( $params ),
+			$params
+		);
+	}
 
 	/**
 	 * @return array

tests/unit/Guzzle/ClientFactoryTest.php

@@ -2,7 +2,6 @@
 
 namespace Mediawiki\Api\Test\Unit\Guzzle;
 
-use GuzzleHttp\Client;
 use GuzzleHttp\HandlerStack;
 use Mediawiki\Api\Guzzle\ClientFactory;
 use Psr\Http\Message\RequestInterface;

tests/unit/MediawikiApiTest.php

@@ -144,32 +144,33 @@ public function testPostActionReturnsResult( $expectedResult, $action, $params =
 		$this->assertEquals( $expectedResult, $result );
 	}
 
-    public function testPostActionWithFileReturnsResult() {
-        $dummyFile = fopen( '/dev/null', 'r' );
-        $params = [
-            'filename' => 'foo.jpg',
-            'file' => $dummyFile
-        ];
-        $client = $this->getMockClient();
-        $client->expects( $this->once() )
-            ->method( 'request' )
-            ->with( 'POST', null, array(
-                'multipart' => array(
-                    array( 'name' => 'action', 'contents' => 'upload' ),
-                    array( 'name' => 'filename', 'contents' => 'foo.jpg' ),
-                    array( 'name' => 'file', 'contents' => $dummyFile ),
-                    array( 'name' => 'format', 'contents' => 'json' ),
-                ),
-                'headers' => array( 'User-Agent' => 'addwiki-mediawiki-client' ),
-            ) )
-            ->will( $this->returnValue( $this->getMockResponse( array( 'success ' => 1 ) ) ) );
-        $api = new MediawikiApi( '', $client );
-
-        $result = $api->postRequest( new SimpleRequest( 'upload', $params ) );
-
-        $this->assertEquals( array( 'success ' => 1 ), $result );
-
-    }
+	public function testPostActionWithFileReturnsResult() {
+
+		$dummyFile = fopen( '/dev/null', 'r' );
+		$params = [
+			'filename' => 'foo.jpg',
+			'file' => $dummyFile,
+		];
+		$client = $this->getMockClient();
+		$client->expects( $this->once() )->method( 'request' )->with(
+				'POST',
+				null,
+				array(
+					'multipart' => array(
+						array( 'name' => 'action', 'contents' => 'upload' ),
+						array( 'name' => 'filename', 'contents' => 'foo.jpg' ),
+						array( 'name' => 'file', 'contents' => $dummyFile ),
+						array( 'name' => 'format', 'contents' => 'json' ),
+					),
+					'headers' => array( 'User-Agent' => 'addwiki-mediawiki-client' ),
+				)
+			)->will( $this->returnValue( $this->getMockResponse( array( 'success ' => 1 ) ) ) );
+		$api = new MediawikiApi( '', $client );
+
+		$result = $api->postRequest( new SimpleRequest( 'upload', $params ) );
+
+		$this->assertEquals( array( 'success ' => 1 ), $result );
+	}
 
 	public function provideActionsParamsResults() {
 		return array(