initial commit

Author: bryanmacfarlane

.gitignore

@@ -0,0 +1,4 @@
+_out
+node_modules
+.DS_Store
+testoutput.txt

LICENSE

@@ -0,0 +1,21 @@
+Typed Rest Client for Node.js
+
+Copyright (c) GitHub, Inc.
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,66 @@
+
+# Typed HTTP Client with TypeScript Typings
+
+A lightweight HTTP client optimized for use with actions, TypeScript with generics and async await.
+
+## Features
+
+  - HTTP client with TypeScript generics and async/await/Promises
+  - Typings included so no need to acquire separately (great for intellisense and no versioning drift)
+  - Basic, Bearer and PAT Support out of the box.  Extensible handlers for others.
+  - Proxy support, just works with actions and the runner
+  - Redirects supported
+
+## Install
+
+```
+npm install @actions/http-client --save
+```
+
+## Samples
+
+See the [HTTP](./__tests__) tests for detailed examples.
+
+## Errors
+
+### HTTP
+
+The HTTP client does not throw unless truly exceptional.
+
+* A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body.
+* Redirects (3xx) will be followed by default.
+
+See [HTTP tests](./__tests__) for detailed examples.
+
+## Debugging
+
+To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible:
+
+```
+export NODE_DEBUG=http
+```
+
+or
+
+```
+set NODE_DEBUG=http
+```
+
+## Node support
+
+The http-client is built using the latest LTS version of Node 12. We also support the latest LTS for Node 6, 8 and Node 10.
+
+## Contributing
+
+We welcome PRs.  Please create an issue and if applicable, a design before proceeding with code.
+
+To build:
+
+```bash
+$ npm run build
+```
+
+To run all tests:
+```bash
+$ npm test
+```

__tests__/auth.test.ts

@@ -0,0 +1,57 @@
+import * as httpm from '../_out';
+import * as path from 'path';
+import * as am from '../_out/auth';
+
+describe('auth', () => {
+    beforeEach(() => {
+
+    })
+  
+    afterEach(() => {
+
+    })
+  
+    it('does basic http get request with basic auth', async() => {
+        let bh: am.BasicCredentialHandler = new am.BasicCredentialHandler('johndoe', 'password');
+        let http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [bh]);
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody(); 
+        let obj:any = JSON.parse(body);
+        let auth: string = obj.headers.Authorization;
+        let creds: string = Buffer.from(auth.substring('Basic '.length), 'base64').toString();
+        expect(creds).toBe('johndoe:password');
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });
+
+    it('does basic http get request with pat token auth', async() => {
+        let token: string = 'scbfb44vxzku5l4xgc3qfazn3lpk4awflfryc76esaiq7aypcbhs';
+        let ph: am.PersonalAccessTokenCredentialHandler = 
+            new am.PersonalAccessTokenCredentialHandler(token);
+
+        let http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [ph]);
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody(); 
+        let obj:any = JSON.parse(body);
+        let auth: string = obj.headers.Authorization;
+        let creds: string = Buffer.from(auth.substring('Basic '.length), 'base64').toString();
+        expect(creds).toBe('PAT:' + token);
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });
+    
+    it('does basic http get request with pat token auth', async() => {
+        let token: string = 'scbfb44vxzku5l4xgc3qfazn3lpk4awflfryc76esaiq7aypcbhs';
+        let ph: am.BearerCredentialHandler = 
+            new am.BearerCredentialHandler(token);
+
+        let http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [ph]);
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody(); 
+        let obj:any = JSON.parse(body);
+        let auth: string = obj.headers.Authorization;
+        expect(auth).toBe('Bearer ' + token);
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });    
+})

__tests__/basics.test.ts

@@ -0,0 +1,182 @@
+import * as httpm from '../_out';
+import * as path from 'path';
+import * as am from '../_out/auth';
+import * as fs from 'fs';
+
+let sampleFilePath: string = path.join(__dirname, 'testoutput.txt');
+
+describe('basics', () => {
+    let _http: httpm.HttpClient;
+    let _httpbin: httpm.HttpClient;
+
+    beforeEach(() => {
+        _http = new httpm.HttpClient('http-client-tests');
+    })
+  
+    afterEach(() => {
+
+    })
+  
+    it('constructs', () => {
+        let http: httpm.HttpClient = new httpm.HttpClient('typed-test-client-tests');
+        expect(http).toBeDefined();
+    });
+
+    // responses from httpbin return something like:
+    // {
+    //     "args": {}, 
+    //     "headers": {
+    //       "Connection": "close", 
+    //       "Host": "httpbin.org", 
+    //       "User-Agent": "typed-test-client-tests"
+    //     }, 
+    //     "origin": "173.95.152.44", 
+    //     "url": "https://httpbin.org/get"
+    //  }
+
+    it('does basic http get request', async() => {
+        let res: httpm.HttpClientResponse = await _http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();      
+        let obj: any = JSON.parse(body);
+        expect(obj.url).toBe("https://httpbin.org/get");
+        expect(obj.headers["User-Agent"]).toBeTruthy();
+    });   
+        
+    it('does basic http get request with no user agent', async() => {
+        let http: httpm.HttpClient = new httpm.HttpClient();
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();      
+        let obj: any = JSON.parse(body);
+        expect(obj.url).toBe("https://httpbin.org/get");
+        expect(obj.headers["User-Agent"]).toBeFalsy();
+    });    
+
+    it('does basic https get request', async() => {
+        let res: httpm.HttpClientResponse = await _http.get('https://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+        let obj: any = JSON.parse(body);
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });
+
+    it('does basic http get request with default headers', async() => {
+        let http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [], {
+            headers: {
+                'Accept': 'application/json',
+                'Content-Type': 'application/json'
+            }
+        });
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody(); 
+        let obj:any = JSON.parse(body);
+        expect(obj.headers.Accept).toBe('application/json');
+        expect(obj.headers['Content-Type']).toBe('application/json');
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });    
+
+    it('does basic http get request with merged headers', async() => {
+        let http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [], {
+            headers: {
+                'Accept': 'application/json',
+                'Content-Type': 'application/json'
+            }
+        });
+        let res: httpm.HttpClientResponse = await http.get('http://httpbin.org/get', {
+            'content-type': 'application/x-www-form-urlencoded'
+        });
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody(); 
+        let obj:any = JSON.parse(body);
+        expect(obj.headers.Accept).toBe('application/json');
+        expect(obj.headers['Content-Type']).toBe('application/x-www-form-urlencoded');
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });    
+
+    it('pipes a get request', () => {
+        return new Promise<string>(async (resolve, reject) => {
+            let file: NodeJS.WritableStream = fs.createWriteStream(sampleFilePath);
+            (await _http.get('https://httpbin.org/get')).message.pipe(file).on('close', () => {
+                let body: string = fs.readFileSync(sampleFilePath).toString();
+                let obj:any = JSON.parse(body);
+                expect(obj.url).toBe("https://httpbin.org/get");
+                resolve();
+            });
+        });
+    });
+    
+    it('does basic get request with redirects', async() => {
+        let res: httpm.HttpClientResponse = await _http.get("https://httpbin.org/redirect-to?url=" + encodeURIComponent("https://httpbin.org/get"))
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+        let obj:any = JSON.parse(body);
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });
+
+    it('does basic get request with redirects (303)', async() => {
+        let res: httpm.HttpClientResponse = await _http.get("https://httpbin.org/redirect-to?url=" + encodeURIComponent("https://httpbin.org/get") + '&status_code=303')
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+        let obj:any = JSON.parse(body);
+        expect(obj.url).toBe("https://httpbin.org/get");
+    });    
+
+    it('returns 404 for not found get request on redirect', async() => {
+        let res: httpm.HttpClientResponse = await _http.get("https://httpbin.org/redirect-to?url=" + encodeURIComponent("https://httpbin.org/status/404") + '&status_code=303')
+        expect(res.message.statusCode).toBe(404);
+        let body: string = await res.readBody();
+    });    
+
+    it('does not follow redirects if disabled', async() => {
+        let http: httpm.HttpClient = new httpm.HttpClient('typed-test-client-tests', null, { allowRedirects: false });
+        let res: httpm.HttpClientResponse = await http.get("https://httpbin.org/redirect-to?url=" + encodeURIComponent("https://httpbin.org/get"))
+        expect(res.message.statusCode).toBe(302);
+        let body: string = await res.readBody();
+    });
+
+    it('does basic head request', async() => {
+        let res: httpm.HttpClientResponse = await _http.head('http://httpbin.org/get');
+        expect(res.message.statusCode).toBe(200);
+    });    
+
+    it('does basic http delete request', async() => {
+        let res: httpm.HttpClientResponse = await _http.del('http://httpbin.org/delete');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();      
+        let obj:any = JSON.parse(body);
+    });
+
+    it('does basic http post request', async() => {
+        let b: string = 'Hello World!';
+        let res: httpm.HttpClientResponse = await _http.post('http://httpbin.org/post', b);
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+        let obj:any = JSON.parse(body);
+        expect(obj.data).toBe(b);
+        expect(obj.url).toBe("https://httpbin.org/post");
+    });    
+
+    it('does basic http patch request', async() => {
+        let b: string = 'Hello World!';
+        let res: httpm.HttpClientResponse = await _http.patch('http://httpbin.org/patch', b);
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+        let obj:any = JSON.parse(body);
+        expect(obj.data).toBe(b);
+        expect(obj.url).toBe("https://httpbin.org/patch");
+    });
+    
+    it('does basic http options request', async() => {
+        let res: httpm.HttpClientResponse = await _http.options('http://httpbin.org');
+        expect(res.message.statusCode).toBe(200);
+        let body: string = await res.readBody();
+    }); 
+    
+    it('returns 404 for not found get request', async() => {
+        let res: httpm.HttpClientResponse = await _http.get('http://httpbin.org/status/404');
+        expect(res.message.statusCode).toBe(404);
+        let body: string = await res.readBody();
+    });    
+})