Merge pull request #3163 from DanGe42/master

Improve error message for connection failures

Author: wing328

modules/swagger-codegen/src/main/resources/php/ApiClient.mustache

@@ -224,7 +224,19 @@ class ApiClient
 
         // Handle the response
         if ($response_info['http_code'] == 0) {
-            throw new ApiException("API call to $url timed out: ".serialize($response_info), 0, null, null);
+            $curl_error_message = curl_error($curl);
+
+            // curl_exec can sometimes fail but still return a blank message from curl_error().
+            if (!empty($curl_error_message)) {
+                $error_message = "API call to $url failed: $curl_error_message";
+            } else {
+                $error_message = "API call to $url failed, but for an unknown reason. " .
+                    "This could happen if you are disconnected from the network.";
+            }
+
+            $exception = new ApiException($error_message, 0, null, null);
+            $exception->setResponseObject($response_info);
+            throw $exception;
         } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) {
             // return raw body if response is a file
             if ($responseType == '\SplFileObject' || $responseType == 'string') {

samples/client/petstore-security-test/php/SwaggerClient-php/README.md

@@ -1,10 +1,10 @@
 # SwaggerClient-php
-This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
 
 This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 1.0.0 *_/ ' \" =end
-- Build date: 2016-07-02T16:22:07.280+08:00
+- API version: 1.0.0 */ ' " =end
+- Build date: 2016-07-06T12:09:22.895-07:00
 - Build package: class io.swagger.codegen.languages.PhpClientCodegen
 
 ## Requirements
@@ -58,7 +58,7 @@ Please follow the [installation procedure](#installation--usage) and then run th
 require_once(__DIR__ . '/vendor/autoload.php');
 
 $api_instance = new Swagger\Client\Api\FakeApi();
-$test_code_inject____end = "test_code_inject____end_example"; // string | To test code injection *_/ ' \" =end
+$test_code_inject____end = "test_code_inject____end_example"; // string | To test code injection */ ' \" =end
 
 try {
     $api_instance->testCodeInjectEnd($test_code_inject____end);
@@ -71,11 +71,11 @@ try {
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://petstore.swagger.io *_/ ' \" =end/v2 *_/ ' \" =end*
+All URIs are relative to *https://petstore.swagger.io */ ' " =end/v2 */ ' " =end*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*FakeApi* | [**testCodeInjectEnd**](docs/Api/FakeApi.md#testcodeinjectend) | **PUT** /fake | To test code injection *_/ ' \" =end
+*FakeApi* | [**testCodeInjectEnd**](docs/Api/FakeApi.md#testcodeinjectend) | **PUT** /fake | To test code injection */ ' \" =end
 
 
 ## Documentation For Models
@@ -86,12 +86,6 @@ Class | Method | HTTP request | Description
 ## Documentation For Authorization
 
 
-## api_key
-
-- **Type**: API key
-- **API key parameter name**: api_key  */ ' " =end
-- **Location**: HTTP header
-
 ## petstore_auth
 
 - **Type**: OAuth
@@ -101,9 +95,15 @@ Class | Method | HTTP request | Description
  - **write:pets**: modify pets in your account  */ ' " =end
  - **read:pets**: read your pets  */ ' " =end
 
+## api_key
+
+- **Type**: API key
+- **API key parameter name**: api_key  */ ' " =end
+- **Location**: HTTP header
+
 
 ## Author
 
-[email protected] *_/ ' \" =end
+[email protected] */ ' " =end
 
 

samples/client/petstore-security-test/php/SwaggerClient-php/autoload.php

@@ -1,12 +1,12 @@
 <?php
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

samples/client/petstore-security-test/php/SwaggerClient-php/docs/Api/FakeApi.md

@@ -1,24 +1,24 @@
 # Swagger\Client\FakeApi
 
-All URIs are relative to *https://petstore.swagger.io *_/ ' \" =end/v2 *_/ ' \" =end*
+All URIs are relative to *https://petstore.swagger.io */ ' " =end/v2 */ ' " =end*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**testCodeInjectEnd**](FakeApi.md#testCodeInjectEnd) | **PUT** /fake | To test code injection *_/ ' \" =end
+[**testCodeInjectEnd**](FakeApi.md#testCodeInjectEnd) | **PUT** /fake | To test code injection */ ' \" =end
 
 
 # **testCodeInjectEnd**
 > testCodeInjectEnd($test_code_inject____end)
 
-To test code injection *_/ ' \" =end
+To test code injection */ ' \" =end
 
 ### Example
 ```php
 <?php
 require_once(__DIR__ . '/vendor/autoload.php');
 
 $api_instance = new Swagger\Client\Api\FakeApi();
-$test_code_inject____end = "test_code_inject____end_example"; // string | To test code injection *_/ ' \" =end
+$test_code_inject____end = "test_code_inject____end_example"; // string | To test code injection */ ' \" =end
 
 try {
     $api_instance->testCodeInjectEnd($test_code_inject____end);
@@ -32,7 +32,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **test_code_inject____end** | **string**| To test code injection *_/ &#39; \&quot; &#x3D;end | [optional]
+ **test_code_inject____end** | **string**| To test code injection */ &#39; \&quot; &#x3D;end | [optional]
 
 ### Return type
 
@@ -44,8 +44,8 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, */  " =end
- - **Accept**: application/json, */  " =end
+ - **Content-Type**: application/json, */ ' " =end
+ - **Accept**: application/json, */ ' " =end
 
 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
 

samples/client/petstore-security-test/php/SwaggerClient-php/docs/Model/ModelReturn.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**return** | **int** | property description  *_/ ' \" =end | [optional] 
+**return** | **int** | property description  */ ' \" =end | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

samples/client/petstore-security-test/php/SwaggerClient-php/lib/Api/FakeApi.php

@@ -11,12 +11,12 @@
  */
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -73,7 +73,7 @@ public function __construct(\Swagger\Client\ApiClient $apiClient = null)
     {
         if ($apiClient == null) {
             $apiClient = new ApiClient();
-            $apiClient->getConfig()->setHost('https://petstore.swagger.io *_/ ' \" =end/v2 *_/ ' \" =end');
+            $apiClient->getConfig()->setHost('https://petstore.swagger.io */ ' " =end/v2 */ ' " =end');
         }
 
         $this->apiClient = $apiClient;
@@ -105,9 +105,9 @@ public function setApiClient(\Swagger\Client\ApiClient $apiClient)
     /**
      * Operation testCodeInjectEnd
      *
-     * To test code injection *_/ ' \" =end
+     * To test code injection */ ' \" =end
      *
-     * @param string $test_code_inject____end To test code injection *_/ ' \" =end (optional)
+     * @param string $test_code_inject____end To test code injection */ ' \" =end (optional)
      * @return void
      * @throws \Swagger\Client\ApiException on non-2xx response
      */
@@ -120,9 +120,9 @@ public function testCodeInjectEnd($test_code_inject____end = null)
     /**
      * Operation testCodeInjectEndWithHttpInfo
      *
-     * To test code injection *_/ ' \" =end
+     * To test code injection */ ' \" =end
      *
-     * @param string $test_code_inject____end To test code injection *_/ ' \" =end (optional)
+     * @param string $test_code_inject____end To test code injection */ ' \" =end (optional)
      * @return Array of null, HTTP status code, HTTP response headers (array of strings)
      * @throws \Swagger\Client\ApiException on non-2xx response
      */
@@ -134,11 +134,11 @@ public function testCodeInjectEndWithHttpInfo($test_code_inject____end = null)
         $queryParams = array();
         $headerParams = array();
         $formParams = array();
-        $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', '*/  " =end'));
+        $_header_accept = $this->apiClient->selectHeaderAccept(array('application/json', '*/ ' " =end'));
         if (!is_null($_header_accept)) {
             $headerParams['Accept'] = $_header_accept;
         }
-        $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('application/json','*/  " =end'));
+        $headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(array('application/json','*/ ' " =end'));
 
         // default format to json
         $resourcePath = str_replace("{format}", "json", $resourcePath);

samples/client/petstore-security-test/php/SwaggerClient-php/lib/ApiClient.php

@@ -12,12 +12,12 @@
  */
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -245,7 +245,19 @@ public function callApi($resourcePath, $method, $queryParams, $postData, $header
 
         // Handle the response
         if ($response_info['http_code'] == 0) {
-            throw new ApiException("API call to $url timed out: ".serialize($response_info), 0, null, null);
+            $curl_error_message = curl_error($curl);
+
+            // curl_exec can sometimes fail but still return a blank message from curl_error().
+            if (!empty($curl_error_message)) {
+                $error_message = "API call to $url failed: $curl_error_message";
+            } else {
+                $error_message = "API call to $url failed, but for an unknown reason. " .
+                    "This could happen if you are disconnected from the network.";
+            }
+
+            $exception = new ApiException($error_message, 0, null, null);
+            $exception->setResponseObject($response_info);
+            throw $exception;
         } elseif ($response_info['http_code'] >= 200 && $response_info['http_code'] <= 299) {
             // return raw body if response is a file
             if ($responseType == '\SplFileObject' || $responseType == 'string') {

samples/client/petstore-security-test/php/SwaggerClient-php/lib/ApiException.php

@@ -11,12 +11,12 @@
  */
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

samples/client/petstore-security-test/php/SwaggerClient-php/lib/Configuration.php

@@ -11,12 +11,12 @@
  */
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -102,7 +102,7 @@ class Configuration
      *
      * @var string
      */
-    protected $host = 'https://petstore.swagger.io *_/ ' \" =end/v2 *_/ ' \" =end';
+    protected $host = 'https://petstore.swagger.io */ ' " =end/v2 */ ' " =end';
 
     /**
      * Timeout (second) of the HTTP request, by default set to 0, no timeout
@@ -522,7 +522,7 @@ public static function toDebugReport()
         $report  = 'PHP SDK (Swagger\Client) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . phpversion() . PHP_EOL;
-        $report .= '    OpenAPI Spec Version: 1.0.0 *_/ ' \" =end' . PHP_EOL;
+        $report .= '    OpenAPI Spec Version: 1.0.0 */ ' " =end' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

samples/client/petstore-security-test/php/SwaggerClient-php/lib/Model/ModelReturn.php

@@ -12,12 +12,12 @@
  */
 
 /**
- * Swagger Petstore *_/ ' \" =end
+ * Swagger Petstore */ ' " =end
  *
- * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  *_/ ' \" =end
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\  */ ' \" =end
  *
- * OpenAPI spec version: 1.0.0 *_/ ' \" =end
- * Contact: [email protected] *_/ ' \" =end
+ * OpenAPI spec version: 1.0.0 */ ' " =end
+ * Contact: [email protected] */ ' " =end
  * Generated by: https://github.com/swagger-api/swagger-codegen.git
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -47,7 +47,7 @@
  * ModelReturn Class Doc Comment
  *
  * @category    Class */
- // @description Model for testing reserved words  *_/ ' \" =end
+ // @description Model for testing reserved words  */ ' \" =end
 /** 
  * @package     Swagger\Client
  * @author      http://github.com/swagger-api/swagger-codegen
@@ -167,7 +167,7 @@ public function getReturn()
 
     /**
      * Sets return
-     * @param int $return property description  *_/ ' \" =end
+     * @param int $return property description  */ ' \" =end
      * @return $this
      */
     public function setReturn($return)