-Removed request/response state from client classes.

-Updated README -Added Code Climate .yml file -Update doc blocks

Author: mikecbrant

.codeclimate.yml

@@ -0,0 +1,18 @@
+engines:
+ duplication:
+ enabled: true
+ config:
+ languages:
+ - php
+ fixme:
+ enabled: true
+ phpmd:
+ enabled: true
+ratings:
+ paths:
+ - "**.php"
+exclude_paths:
+ - .settings/
+ - build/
+ - tests/
+ - vendor/

README.md

@@ -4,10 +4,12 @@
 
 # php-rest-client
 
-This library provides classes to implement basic REST clients based on PHP's cURL extension. Two client classes are made available:
+This library provides classes implementing basic REST clients based on PHP's cURL extension. Two client classes are made available:
 
 - **RestClient** - a class for executing RESTful service calls using a fluent interface.
 - **RestMultiClient** - a class which extends RestClient to provide curl_multi capabilities to allow for multiple REST calls to be made in parallel.
+
+Additionally this library provides classes which wrap curl responses within object oriented interface:
 - **CurlHttpResponse** - a class which encapsulates curl response into class wrapper.
 - **CurlMultiHttpResponse** - a class which represents a collection of CurlHttpRepsonse objects as returned from multiple parallel REST calls.
 
@@ -31,7 +33,7 @@ This library is developed against PHP 7.1 and tested via Travis CI against:
 Please see Travis CI build status at: https://travis-ci.org/mikecbrant/php-rest-client
 Please see Code Climate code coverage and health informatoin at: https://codeclimate.com/github/mikecbrant/php-rest-client
 
-This version represents a total re-factoring from previous versions of this library, which were getting long in the tooth and were out of compliance with more modern PHP development standards (i.e. PSR) and tools (i.e. composer).
+This library is available as as mikecbrant/php-rest-client omposer package at https://packagist.org/packages/mikecbrant/php-rest-client
 
 **Usage example:**
 

src/RestClientLib/CurlMultiHttpResponse.php

@@ -7,7 +7,7 @@ class CurlMultiHttpResponse
  /**
  * Variable to store individual CurlHttpResponse objects from curl_multi call
  * 
- * @var array
+ * @var CurlHttpResponse[]
  */
  protected $curlHttpResponses = array();
 
@@ -29,7 +29,7 @@ public function addResponse(CurlHttpResponse $response) {
  /**
  * Returns array of all CurlHttpResponse objects in collection.
  * 
- * @return array
+ * @return CurlHttpResponse[]
  */
  public function getCurlHttpResponses() {
  return $this->curlHttpResponses;
@@ -38,7 +38,7 @@ public function getCurlHttpResponses() {
  /**
  * Alias for getCurlHttpResponses
  * 
- * @return array
+ * @return CurlHttpResponse[]
  */
  public function getAll() {
  return $this->getCurlHttpResponses();
@@ -47,7 +47,7 @@ public function getAll() {
  /**
  * Returns array of response bodies for each response in collection.
  * 
- * @return array
+ * @return mixed[]
  */
  public function getResponseBodies() {
  return array_map(
@@ -61,7 +61,7 @@ function(CurlHttpResponse $value) {
  /**
  * Returns array of response codes for each response in collection.
  * 
- * @return array
+ * @return integer[]
  */
  public function getHttpCodes() {
  return array_map(
@@ -75,7 +75,7 @@ function(CurlHttpResponse $value) {
  /**
  * Returns array of URL's used for each response in collectoin as returned via curl_getinfo.
  * 
- * @return array
+ * @return string[]
  */
  public function getRequestUrls() {
  return array_map(
@@ -89,7 +89,7 @@ function(CurlHttpResponse $value) {
  /**
  * Returns array of request headers for each response in collection as returned via curl_getinfo.
  * 
- * @return array
+ * @return string[]
  */
  public function getRequestHeaders() {
  return array_map(
@@ -104,7 +104,7 @@ function(CurlHttpResponse $value) {
  * Returns array of curl_getinfo arrays for each response in collection.
  * See documentation at http://php.net/manual/en/function.curl-getinfo.php for expected format for each array element.
  * 
- * @return array
+ * @return array[]
  */
  public function getCurlGetinfoArrays() {
  return array_map(

src/RestClientLib/RestClient.php

@@ -85,13 +85,6 @@ class RestClient
  */
  private $curl = null;
 
- /**
- * Variable to store request URL that is formed before a request is made
- * 
- * @var string
- */
- private $requestUrl = null;
- 
  /**
  * Array containing headers to be used for request
  * 
@@ -105,13 +98,6 @@ class RestClient
  * @var string
  */
 
- /**
- * Variable to store CurlHttpResponse result from curl call
- * 
- * @var CurlHttpResponse
- */
- private $response = null;
- 
  /**
  * Constructor method. Currently there is no instantiation logic.
  *
@@ -133,9 +119,7 @@ public function get($action) {
  $this->setRequestUrl($action);
  curl_setopt($this->curl, CURLOPT_HTTPGET, true);
  // execute call. Can throw \Exception.
- $this->curlExec();
- 
- return $this->response;
+ return $this->curlExec();
  }
 
  /**
@@ -155,9 +139,7 @@ public function post($action, $data) {
  $this->setRequestData($data);
  curl_setopt($this->curl, CURLOPT_POST, true);
  // execute call. Can throw \Exception.
- $this->curlExec();
- 
- return $this->response;
+ return $this->curlExec();
  }
 
  /**
@@ -177,9 +159,7 @@ public function put($action, $data) {
  $this->setRequestData($data);
  curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'PUT');
  // execute call. Can throw \Exception.
- $this->curlExec();
- 
- return $this->response;
+ return $this->curlExec();
  }
 
  /**
@@ -196,9 +176,7 @@ public function delete($action) {
  $this->setRequestUrl($action);
  curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
  // execute call. Can throw \Exception.
- $this->curlExec();
- 
- return $this->response;
+ return $this->curlExec();
  }
 
  /**
@@ -216,9 +194,7 @@ public function head($action) {
  curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'HEAD');
  curl_setopt($this->curl, CURLOPT_NOBODY, true);
  // execute call. Can throw \Exception.
- $this->curlExec();
- 
- return $this->response;
+ return $this->curlExec();
  }
 
  /**
@@ -469,21 +445,17 @@ public function getMaxRedirects() {
  }
 
  /**
- * Method to initialize curl handle in object
+ * Method to set up curl handle on client
  * 
  * @return void
  * @throws \Exception
  */
  private function curlSetup() { 
- // reset all request/response properties
- $this->resetRequestResponseProperties();
- 
- // initialize curl. Throws \Exception on failure.
  $this->curl = $this->curlInit();
  }
 
  /**
- * Method to initilize a curl handle
+ * Method to initilize and return a curl handle
  * 
  * @return resource
  * @throws \Exception
@@ -557,7 +529,7 @@ protected function curlClose($curl) {
  /**
  * Method to execute curl call
  * 
- * @return void
+ * @return CurlHttpResponse
  * @throws \Exception
  */
  private function curlExec() {
@@ -571,7 +543,7 @@ private function curlExec() {
 
  // return CurlHttpResponse
  try {
- $this->response = new CurlHttpResponse($curlResult, curl_getinfo($this->curl));
+ $response = new CurlHttpResponse($curlResult, curl_getinfo($this->curl));
  } catch (\InvalidArgumentException $e) {
  throw new \Exception(
  'Unable to instantiate CurlHttpResponse. Message: "' . $e->getMessage() . '"',
@@ -581,16 +553,8 @@ private function curlExec() {
  } finally {
  $this->curlTeardown();
  }
- }
- 
- /**
- * Method to reset all properties specific to a particular request/response sequence.
- * 
- * @return void
- */
- protected function resetRequestResponseProperties() {
- $this->requestUrl = null;
- $this->response = null;
+ 
+ return $response;
  }
 
  /**
@@ -601,7 +565,6 @@ protected function resetRequestResponseProperties() {
  */
  protected function setRequestUrl($action) {
  $url = $this->buildUrl($action);
- $this->requestUrl = $url;
  curl_setopt($this->curl, CURLOPT_URL, $url);
  }