Merge pull request #670 from postmanlabs/release/1.4.0

Release/1.4.0

Author: Ankit Saini

.github/workflows/integration.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  Unit-Tests:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Get Code
+        uses: actions/checkout@v3
+      - name: Setup Node JS
+        uses: actions/setup-node@v1
+        with:
+          node-version: '8.x'
+      - name: Install system dependencies
+        run: npm run cirequirements
+      - name: Install package dependencies
+        run: npm install
+      - name: Install dependencies for individual codegens
+        run: npm run deepinstall dev
+      - name: Run tests
+        run: npm run test

.travis.yml

@@ -1,3 +1,9 @@
+v1.4.0 (February 6, 2023)
+* Add support for C# HttpClient Codegen
+* Use short options in CURL as long as possible (9511)[https://github.com/postmanlabs/postman-app-support/issues/9511]
+* Do not add HTTP method explicitly in CURL when not required (10581)[https://github.com/postmanlabs/postman-app-support/issues/10581]
+* Remove usage of semaphore from Swift Codegen (10053)[https://github.com/postmanlabs/postman-app-support/issues/10053]
+
 v1.3.0 (December 16, 2022)
 * Update C# restsharp codegen to support (107)[https://restsharp.dev/v107/]
 * Fixes an issue where HTTP code snippet was generating wrong boundaries (11084)[https://github.com/postmanlabs/postman-app-support/issues/11084]

CHANGELOG.md

@@ -18,6 +18,7 @@ List of supported code generators:
 | Language | Variant        |
 |-----------|---------------|
 | C | libcurl |
+| C# | HttpClient |
 | C# | RestSharp | 
 | cURL | cURL | 
 | Dart | http | 
@@ -49,16 +50,24 @@ List of supported code generators:
 | Swift | URLSession | 
 ## Table of contents 
 
-1. [Getting Started](#getting-started)
-2. [Prerequisite](#prerequisite)
-3. [Usage](#usage)
-    1. [Using postman code generators as a Library](#using-postman-code-generators-as-a-library)
-4. [Development](#development)
-    1. [Installing Dependencies](#installing-dependencies)
-    2. [Testing](#testing)
-    3. [Packaging](#packaging)
-7. [Contributing](#contributing)
-8. [License](#license)
+- [postman-code-generators ![Build Status](https://travis-ci.com/postmanlabs/postman-code-generators)](#postman-code-generators-)
+  - [Table of contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+  - [Prerequisite](#prerequisite)
+  - [Usage](#usage)
+    - [Using postman-code-generators as a Library](#using-postman-code-generators-as-a-library)
+      - [getLanguageList](#getlanguagelist)
+        - [Example:](#example)
+      - [getOptions](#getoptions)
+        - [Example:](#example-1)
+      - [convert](#convert)
+        - [Example:](#example-2)
+  - [Development](#development)
+    - [Installing dependencies](#installing-dependencies)
+    - [Testing](#testing)
+    - [Packaging](#packaging)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Getting Started
 To install postman-code-generators as your dependency

README.md

@@ -0,0 +1,44 @@
+.DS_Store
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Coverage directory used by tools like istanbul
+.coverage
+
+# node-waf configuration
+.lock-wscript
+
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Test Project directories
+testProject/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+out/

codegens/csharp-httpclient/.gitignore

@@ -0,0 +1,35 @@
+{
+    "tags": {
+      "allowUnknownTags": true,
+      "dictionaries": ["jsdoc", "closure"]
+    },
+    "source": {
+      "include": ["lib"],
+      "includePattern": ".+\\.js(doc)?$",
+      "excludePattern": "(^|\\/|\\\\)_"
+    },
+  
+    "plugins": [
+      "plugins/markdown"
+    ],
+  
+    "templates": {
+      "cleverLinks": false,
+      "monospaceLinks": false,
+      "highlightTutorialCode" : true
+    },
+  
+    "opts": {
+      "template": "./node_modules/postman-jsdoc-theme",
+      "encoding": "utf8",
+      "destination": "./out/docs",
+      "recurse": true,
+      "readme": "README.md"
+    },
+  
+    "markdown": {
+      "parser": "gfm",
+      "hardwrap": false
+    }
+  }
+  

codegens/csharp-httpclient/.jsdoc-config.json

@@ -0,0 +1,76 @@
+### NPM Specific: Disregard recursive project files
+### ===============================================
+/.editorconfig
+/.gitmodules
+/test
+
+### Borrowed from .gitignore
+### ========================
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Prevent IDE stuff
+.idea
+.vscode
+*.sublime-*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+.coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+snippet.swift
+
+out/

codegens/csharp-httpclient/.npmignore

@@ -0,0 +1,42 @@
+
+> Converts Postman-SDK Request into code snippet for .
+
+#### Prerequisites
+To run Code-Gen, ensure that you have NodeJS >= v8. A copy of the NodeJS installable can be downloaded from https://nodejs.org/en/download/package-manager.
+
+## Using the Module
+The module will expose an object which will have property `convert` which is the function for converting the Postman-SDK request to swift code snippet.
+
+### convert function
+Convert function takes three parameters
+
+* `request` - Postman-SDK Request Object
+
+* `options` - options is an object which hsa following properties
+    * `indentType` - String denoting type of indentation for code snippet. eg: 'Space', 'Tab'
+    * `indentCount` - The number of indentation characters to add per code level
+    * `trimRequestBody` - Whether or not request body fields should be trimmed
+
+* `callback` - callback function with first parameter as error and second parameter as string for code snippet
+
+##### Example:
+```js
+var request = new sdk.Request('www.google.com'),  //using postman sdk to create request  
+    options = {
+        indentCount: 3,
+        indentType: 'Space',
+        requestTimeout: 200,
+        trimRequestBody: true
+    };
+convert(request, options, function(error, snippet) {
+    if (error) {
+        //  handle error
+    }
+    //  handle snippet
+});
+```
+### Guidelines for using generated snippet
+
+* Since Postman-SDK Request object doesn't provide complete path of the file, it needs to be manually inserted in case of uploading a file.
+
+* This module doesn't support cookies.

codegens/csharp-httpclient/README.md

@@ -0,0 +1 @@
+module.exports = require('./lib');