Replaced httprequest logic with http-request2 logic for snippet generation

Author: shreys7

codegens/php-httprequest/.gitignore codegens/php-httprequest2/.gitignore

@@ -18,10 +18,10 @@ function getHeaders (request, indentation) {
   if (!_.isEmpty(headerArray)) {
     headerArray = _.reject(headerArray, 'disabled');
     headerMap = _.map(headerArray, function (header) {
-      return `${indentation}'${sanitize(header.key, true)}' => ` +
+      return `${indentation}'${sanitize(header.key)}' => ` +
             `'${sanitize(header.value)}'`;
     });
-    return `$request->setHeaders(array(\n${headerMap.join(',\n')}\n));\n`;
+    return `$request->setHeader(array(\n${headerMap.join(',\n')}\n));\n`;
   }
   return '';
 }
@@ -76,7 +76,7 @@ self = module.exports = {
       options = {};
     }
     if (!_.isFunction(callback)) {
-      throw new Error('PHP-HttpRequest-Converter: callback is not valid function');
+      throw new Error('PHP-HttpRequest2-Converter: callback is not valid function');
     }
     options = sanitizeOptions(options, self.getOptions());
 
@@ -85,13 +85,26 @@ self = module.exports = {
     indentString = indentString.repeat(options.indentCount);
 
     snippet = '<?php\n';
-    snippet += '$request = new HttpRequest();\n';
+    snippet += '$request = new HTTP_Request2();\n';
     snippet += `$request->setUrl('${request.url.toString()}');\n`;
-    snippet += `$request->setMethod(HTTP_METH_${request.method});\n`;
-    if (options.requestTimeout !== 0 || !options.followRedirect) {
+    snippet += `$request->setMethod(HTTP_Request2::METHOD_${request.method});\n`;
+    if (options.requestTimeout !== 0 || options.followRedirect) {
+      let configArray = [];
       snippet += '$request->setOptions(array(';
-      snippet += options.requestTimeout === 0 ? '' : `'timeout' => ${options.requestTimeout}`;
-      snippet += options.followRedirect ? '' : ', \'redirect\' => false';
+
+      // PHP-HTTP_Request2 method accepts timeout in seconds and it must be an integer
+      if (options.requestTimeout !== 0 && Number.isInteger(options.requestTimeout / 1000)) {
+        let requestTimeout = options.requestTimeout;
+        requestTimeout /= 1000;
+        configArray.push(`${indentString}'timeout' => ${requestTimeout}`);
+      }
+      if (options.followRedirect) {
+        configArray.push(`${indentString}'redirect' => TRUE`);
+      }
+      if (configArray.length) {
+        snippet += '$request->setOptions(array(\n';
+        snippet += configArray.join(',\n') + '\n';
+      }
       snippet += '));\n';
     }
     if (request.body && !request.headers.has('Content-Type')) {
@@ -116,9 +129,15 @@ self = module.exports = {
       snippet += `${parseBody(request.toJSON(), indentString, options.trimRequestBody)}`;
     }
     snippet += 'try {\n';
-    snippet += `${indentString}echo $request->send()->getBody();\n`;
-    snippet += '} catch(HttpException $ex) {\n';
-    snippet += `${indentString}echo $ex;\n}`;
+    snippet += `${indentString}$response = $request->send();\n`;
+    snippet += `${indentString}if ($response=>getStatus() == 200) {\n`;
+    snippet += `${indentString.repeat(2)} echo $response->getBody();\n`;
+    snippet += `${indentString}} else {\n`;
+    snippet += `${indentString.repeat(2)}echo 'Unexpected HTTP status: . $response->getStatus() . ' ' .\n`;
+    snippet += `${indentString.repeat(3)}$response->getReasonPhrase();\n`;
+    snippet += `${indentString}}\n`;
+    snippet += '} catch(HTTP_Request2_Exception $e) {\n';
+    snippet += `${indentString}echo 'Error: ' . $e->getMessage();\n}`;
     return callback(null, snippet);
   }
 };

codegens/php-httprequest/.npmignore codegens/php-httprequest2/.npmignore

@@ -9,7 +9,7 @@ module.exports = function (request, indentString, trim) {
 
   switch (request.body.mode) {
     case 'raw':
-      bodySnippet += `$request->setBody(${sanitize(request.body[request.body.mode], trim)});\n`;
+      bodySnippet += `$request->setBody('${sanitize(request.body[request.body.mode], trim)}');\n`;
       break;
     // eslint-disable-next-line no-case-declarations
     case 'graphql':
@@ -21,18 +21,18 @@ module.exports = function (request, indentString, trim) {
       catch (e) {
         graphqlVariables = {};
       }
-      bodySnippet += `$request->setBody(${sanitize(JSON.stringify({
+      bodySnippet += `$request->setBody('${sanitize(JSON.stringify({
         query: query,
         variables: graphqlVariables
-      }), trim)});\n`;
+      }), trim)}');\n`;
       break;
     case 'urlencoded':
       enabledBodyList = _.reject(request.body[request.body.mode], 'disabled');
       if (!_.isEmpty(enabledBodyList)) {
         bodyDataMap = _.map(enabledBodyList, (data) => {
           return `${indentString}'${sanitize(data.key, trim)}' => '${sanitize(data.value, trim)}'`;
         });
-        bodySnippet += `$request->setPostFields(array(\n${bodyDataMap.join(',\n')}));\n`;
+        bodySnippet += `$request->addPostParameter(array(\n${bodyDataMap.join(',\n')}));\n`;
       }
       break;
     case 'formdata':
@@ -45,10 +45,10 @@ module.exports = function (request, indentString, trim) {
           return `${indentString}'${sanitize(data.key, trim)}', '${data.src}', <Content-Type Header>`;
         });
         if (bodyDataMap.length) {
-          bodySnippet += `$request->setPostFields(array(\n${bodyDataMap.join(',\n')}));\n`;
+          bodySnippet += `$request->addPostParameter(array(\n${bodyDataMap.join(',\n')}));\n`;
         }
         if (bodyFileMap.length) {
-          bodySnippet += `$request->setPostFiles(array(\n${bodyDataMap.join(',\n')}));\n`;
+          bodySnippet += `$request->addUpload(array(\n${bodyDataMap.join(',\n')}));\n`;
         }
       }
       break;

codegens/php-httprequest/README.md codegens/php-httprequest2/README.md

@@ -1,12 +1,12 @@
 {
-  "name": "@postman/codegen-php-httprequest",
+  "name": "@postman/codegen-php-httprequest2",
   "version": "0.0.1",
-  "description": "Converts Postman SDK Requests to PHP HttpRequest code snippet",
+  "description": "Converts Postman SDK Requests to PHP HTTP_Request2 code snippet",
   "main": "index.js",
   "com_postman_plugin": {
     "type": "code_generator",
     "lang": "php",
-    "variant": "httprequest",
+    "variant": "HTTP_Request2",
     "syntax_mode": "php"
   },
   "directories": {
@@ -24,7 +24,7 @@
   },
   "author": "Postman Labs <help@getpostman.com>",
   "license": "Apache-2.0",
-  "homepage": "https://github.com/postmanlabs/code-generators/tree/master/codegens/php-httprequest",
+  "homepage": "https://github.com/postmanlabs/code-generators/tree/master/codegens/php-httprequest2",
   "dependencies": {},
   "devDependencies": {},
   "engines": {

codegens/php-httprequest/index.js codegens/php-httprequest2/index.js

@@ -2,7 +2,7 @@ var runNewmanTest = require('../../../../test/codegen/newman/newmanTestUtil').ru
   convert = require('../../index').convert;
 
 
-describe('PHP HttpRequest Converter', function () {
+describe('PHP HttpRequest2 Converter', function () {
   describe('convert for different request types', function () {
     var options = {
         indentType: 'Space',