feat: shortcuts for HTTP methods (#15)

* feat: shortcuts for HTTP methods

GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

Author: TimeRaider

README.md

@@ -11,12 +11,13 @@
 > REST-API helper, wrapped around `fetch`.
 
 # Table of Contents
-  * [Installation](#installation)
-  * [API](#api)
-  * [Usage](#usage)
-  * [Example](#example)
-  * [Contributing](#contributing)
-  * [License](#license)
+
+* [Installation](#installation)
+* [API](#api)
+* [Usage](#usage)
+* [Example](#example)
+* [Contributing](#contributing)
+* [License](#license)
 
 # Installation
 
@@ -66,32 +67,38 @@ Query-like object.
 
 Method to be called on `fetch`'s response.
 
+Alternatively you can use provided shortcuts for [every HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
+
 **Example:**
 ```js
+import { GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH } from '../src/shortcuts';
+
 const userResource = {
   namespace: 'user',
 
   methods: {
-    
     // id = 1, extanted = true
-    // GET: /api/user/get/1?extended=true
-    get: ({ id, extended }) => ({ path: ['get', id], query: { extended: !!extended } }),
-    
-    // POST: /api/user/edit
+    // GET: /api/user/1?extended=true
+    get: ({ id, extended }) => ({ path: [id], query: { extended: !!extended } }),
+
+    // POST: /api/user/1/edit
     save: ({ id, firstname, lastname }) => {
-            const formData = new FormData();
-
-            formData.append('firstname', firstname);
-            formData.append('lastname', lastname);
-
-            return {
-                path: 'edit',
-                options: {
-                    method: 'POST',
-                    body: formData
-                }
-            };
-        }
+        const formData = new FormData();
+
+        formData.append('firstname', firstname);
+        formData.append('lastname', lastname);
+
+        return {
+            path: [id, 'edit'],
+            options: {
+                method: 'POST',
+                body: formData
+            }
+        };
+    },
+
+    // DELETE: /api/user/1
+    delete: ({ id }) => DELETE({ path: [id] })
   }
 }
 ```

src/index.js

@@ -1,3 +1,4 @@
 import createAPI from './createAPI';
+export * from './shortcuts';
 
 export default createAPI;

src/shortcuts.js

@@ -0,0 +1,18 @@
+const createShortcut = method => ({ options = {}, ...rest} = {}) => ({
+    ...rest,
+    options: {
+        method,
+        ...options
+    }
+});
+
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
+export const GET = createShortcut('GET');
+export const HEAD = createShortcut('HEAD');
+export const POST = createShortcut('POST');
+export const PUT = createShortcut('PUT');
+export const DELETE = createShortcut('DELETE');
+export const CONNECT = createShortcut('CONNECT');
+export const OPTIONS = createShortcut('OPTIONS');
+export const TRACE = createShortcut('TRACE');
+export const PATCH = createShortcut('PATCH');

test/coverage.spec.js

@@ -0,0 +1,4 @@
+import test from 'ava';
+import module from '../src';
+
+test('coverage', t => t.pass());

test/shortcuts.spec.js

@@ -0,0 +1,86 @@
+import test from 'ava';
+import {
+    GET,
+    HEAD,
+    POST,
+    PUT,
+    DELETE,
+    CONNECT,
+    OPTIONS,
+    TRACE,
+    PATCH
+} from '../src/shortcuts';
+
+const dummy = {
+    path: ['path', 'to', 'resource'],
+    query: { param: 'value' },
+    options: { credentials: 'include' },
+    method: 'text'
+};
+
+test('should set correct HTTP method', t => {
+    t.deepEqual(GET(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'GET' },
+        method: 'text'
+    }, 'GET');
+    t.deepEqual(HEAD(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'HEAD' },
+        method: 'text'
+    }, 'HEAD');
+    t.deepEqual(POST(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'POST' },
+        method: 'text'
+    }, 'POST');
+    t.deepEqual(PUT(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'PUT' },
+        method: 'text'
+    }, 'PUT');
+    t.deepEqual(DELETE(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'DELETE' },
+        method: 'text'
+    }, 'DELETE');
+    t.deepEqual(CONNECT(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'CONNECT' },
+        method: 'text'
+    }, 'CONNECT');
+    t.deepEqual(OPTIONS(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'OPTIONS' },
+        method: 'text'
+    }, 'OPTIONS');
+    t.deepEqual(TRACE(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'TRACE' },
+        method: 'text'
+    }, 'TRACE');
+    t.deepEqual(PATCH(dummy), {
+        path: ['path', 'to', 'resource'],
+        query: { param: 'value' },
+        options: { credentials: 'include', method: 'PATCH' },
+        method: 'text'
+    }, 'PATCH');
+});
+
+test('should add method even when nothing is passed', t => {
+    const result = GET();
+    t.deepEqual(result, { options: { method: 'GET'} });
+});
+
+test('should not take precedence over passed params', t => {
+    const result = PUT({ options: { method: 'POST' } });
+    t.deepEqual(result, { options: { method: 'POST'} });
+});