httpie - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

dist/httpie.js

@@ -1,4 +0,4 @@
-const { parse } = require('url');
 const { request } = require('https');
 const { globalAgent } = require('http');
+const { parse, resolve } = require('url');
 
@@ -9,5 +9,6 @@ function send(method, uri, opts={}) {
 		let o = { method };
-		let headers = opts.headers || {};
+		let { redirect=true } = opts;
 		Object.assign(o, typeof uri === 'string' ? parse(uri) : uri);
 		if (o.protocol === 'http:') o.agent = globalAgent;
+		o.headers = opts.headers || {};
 
@@ -34,2 +35,5 @@ let req = request(o, r => {
 					rej(err);
+				} else if (r.statusCode > 300 && redirect && r.headers.location) {
+					o.path = resolve(o.path, r.headers.location);
+					return send(method, o.path.startsWith('/') ? o : o.path, o).then(res, rej);
 				} else {
@@ -36,0 +40,0 @@ res(r);

package.json

 {
   "name": "httpie",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "repository": "lukeed/httpie",
@@ -5,0 +5,0 @@ "description": "A lightweight, Promise-based wrapper for Node.js HTTP requests~!",

readme.md

@@ -1,6 +0,33 @@
-# httpie [![Build Status](https://badgen.now.sh/travis/lukeed/httpie)](https://travis-ci.org/lukeed/httpie)
+<div align="center">
+  <img src="logo.png" alt="httpie" height="190" />
+</div>
 
-> A lightweight, `Promise`-based wrapper for Node.js HTTP requests~!
+<div align="center">
+  <a href="https://npmjs.org/package/httpie">
+    <img src="https://badgen.now.sh/npm/v/httpie" alt="version" />
+  </a>
+  <a href="https://travis-ci.org/lukeed/httpie">
+    <img src="https://badgen.now.sh/travis/lukeed/httpie" alt="travis" />
+  </a>
+  <a href="https://npmjs.org/package/httpie">
+    <img src="https://badgen.now.sh/npm/dm/httpie" alt="downloads" />
+  </a>
+</div>
 
+<div align="center">A Node.js HTTP client as easy as pie!</div>
 
+## Features
+
+* `Promise`- based HTTP requestor
+* Works with HTTP and HTTPS protocols
+* Automatically handles JSON requests and responses
+* Extremely lightweight with **no dependencies** – 544 bytes!
+* Includes aliases for common HTTP verbs: `get`, `post`, `put`, `patch`, and `del`
+
+Additionally, this module is delivered as:
+
+* **ES Module**: [`dist/httpie.mjs`](https://unpkg.com/httpie/dist/httpie.mjs)
+* **CommonJS**: [`dist/httpie.js`](https://unpkg.com/httpie/dist/httpie.js)
+
+
 ## Install
@@ -15,6 +42,27 @@
 
+> **Note:** The `async` syntax is for demo purposes – you may use Promises in a Node 6.x environment too!
+
 ```js
 import { get, post } from 'httpie';
 
-//
+try {
+  const { data } = await get('https://pokeapi.co/api/v2/pokemon/1');
+
+  // Demo: Endpoint will echo what we've sent
+  const res = await post('https://jsonplaceholder.typicode.com/posts', {
+    body: {
+      id: data.id,
+      name: data.name,
+      number: data.order,
+      moves: data.moves.slice(0, 6)
+    }
+  });
+
+  console.log(res.statusCode); //=> 201
+  console.log(res.data); //=> { id: 1, name: 'bulbasaur', number: 1, moves: [{...}, {...}] }
+} catch (err) {
+  console.error('Error!', err.statusCode, err.message);
+  console.error('~> headers:', err.headers);
+  console.error('~> data:', err.data);
+}
 ```
@@ -25,7 +73,89 @@
 
-TODO
+### send(method, url, opts={})
+Returns: `Promise`
 
+Any `httpie.send` request (and its aliases) will always return a Promise.
 
+If the response's `statusCode` is 400 or above, this Promise will reject with a formatted error – see [Error Handling](#error-handling). Otherwise, the Promise will resolve with the full [`ClientRequest`](https://nodejs.org/api/http.html#http_class_http_clientrequest) stream.
+
+The resolved response will receive a new `data` key, which will contain the response's full payload. Should the response return JSON content, then `httpie` will parse it and the `res.data` value will be the resulting JSON object!
+
+#### method
+Type: `String`
+
+The HTTP method name – it must be uppercase!
+
+#### url
+Type: `String` or [`URL`](https://nodejs.org/api/url.html#url_the_whatwg_url_api)
+
+If `url` is a string, it is automatically parsed with [`url.parse()`](https://nodejs.org/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost) into an object.
+
+#### opts.body
+Type: `Mixed`<br>
+Default: `undefined`
+
+The request's body, can be of any type!
+
+Any non-`Buffer` objects will be converted into a JSON string and the appropriate [`Content-Type`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) header will be attached.
+
+Additionally, `httpie` will _always_ set a value for the [`Content-Length`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length) header!
+
+#### opts.headers
+Type: `Object`<br>
+Default: `{}`
+
+The custom headers to send with your request.
+
+#### opts.redirect
+Type: `Boolean`<br>
+Default: `true`
+
+Whether or not redirect responses should be followed automatically.
+
+> **Note:** This may only happen with a 3xx status _and_ if the response had a [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location) header.
+
+
+### get(url, opts={})
+> Alias for [`send('GET', url, opts)`](#sendmethod-url-opts).
+
+### post(url, opts={})
+> Alias for [`send('POST', url, opts)`](#sendmethod-url-opts).
+
+### put(url, opts={})
+> Alias for [`send('PUT', url, opts)`](#sendmethod-url-opts).
+
+### patch(url, opts={})
+> Alias for [`send('PATCH', url, opts)`](#sendmethod-url-opts).
+
+### del(url, opts={})
+> Alias for [`send('DELETE', url, opts)`](#sendmethod-url-opts).
+
+
+## Error Handling
+
+All responses with `statusCode >= 400` will result in a rejected `httpie` request. When this occurs, an Error instance is formatted with complete information:
+
+* `err.message` – `String` – Identical to `err.statusMessage`;
+* `err.statusMessage` – `String` – The response's `statusMessage` value;
+* `err.statusCode` – `Number` – The response's `statusCode` value;
+* `err.headers` – `Object` – The response's `headers` object;
+* `err.data` – `Mixed` – The response's payload;
+
+> **Important:** The error's `data` property may also be parsed to a JSON object, according to the response's headers.
+
+```js
+import { get } from 'httpie';
+
+get('https://example.com/404').catch(err => {
+  console.error(`(${err.statusCode}) ${err.message}`)
+  console.error(err.headers['content-type']);
+  console.error(`~> ${err.data}`);
+});
+//=> "(404) Not Found"
+//=> "text/html; charset=UTF-8"
+//=> ~> <?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html ...</body>\n</html>
+```
+
 ## License
 
 MIT © [Luke Edwards](https://lukeed.com)

No alert changes

Improved metrics

Total package byte prevSize

10559

increased by101.62%

Lines of code

111

increased by7.77%

Number of lines in readme file

160

increased by433.33%

No dependency changes