Merge pull request #11 from GeoffSelby/next

V1.0.0

Author: GeoffSelby

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 
 node_js:
-  - '8'
+  - '12.19.0'
 
 cache:
   directories:
@@ -14,4 +14,4 @@ install:
   - npm install
 
 script:
-  - npm test
+  - npm test

README.md

@@ -1,29 +1,29 @@
-# Forge JavaScript SDK
+# Laravel Forge JavaScript SDK
 
-<p>
-    <a href="https://travis-ci.org/GeoffSelby/nevexo-forge-javascript-sdk"><img src="https://travis-ci.com/GeoffSelby/nevexo-forge-javascript-sdk.svg?branch=master" alt="Build Status"></a>
-</p>
+![Travis (.com)](https://img.shields.io/travis/com/GeoffSelby/laravel-forge-javascript-sdk?&style=for-the-badge)
+![npm](https://img.shields.io/npm/v/@geoffcodesthings/forge-js?&style=for-the-badge)
+![NPM](https://img.shields.io/npm/l/@geoffcodesthings/forge-js?style=for-the-badge)
 
-A complete, promise-based Javascript SDK for the Laravel Forge API
+A complete, asynchronous Javascript SDK for the Laravel Forge API
 
 ## Installation
 
 With yarn (_recommended_):
 
 ```bash
-yarn add nevexo-forge-js
+yarn add @geoffcodesthings/forge-js
 ```
 
 With npm:
 
 ```bash
-npm install nevexo-forge-js
+npm install @geoffcodesthings/forge-js
 ```
 
 ## Basic Usage
 
 ```js
-import Forge from 'nevexo-forge-js';
+import Forge from '@geoffcodesthings/forge-js';
 
 // Instantiate the SDK
 const forge = new Forge('API_TOKEN_HERE');
@@ -37,11 +37,9 @@ try {
 }
 ```
 
-> The SDK utilizes native ES6 promises so you should use async/await to handle the resolved promise. You can, of course, use `.then()` and `.catch()` if you prefer.
-
 ## Documentation
 
-Full documentation coming soon. Until then, please see the tests for more detailed usage.
+Full documentation can be found [here](https://laravel-forge-js-sdk.netlify.app).
 
 ## License
 

__tests__/backups.test.js

@@ -0,0 +1,150 @@
+const {
+  setupFetchStub,
+  expectToHaveBeenCalledWith,
+} = require('./stub/fetchStub');
+const Forge = require('../lib/Forge');
+
+beforeAll(() => {
+  require('cross-fetch/polyfill');
+  jest.spyOn(window, 'fetch');
+});
+
+afterEach(() => {
+  global.fetch.mockReset();
+});
+
+test('it creates a backup config', async () => {
+  setupFetchStub();
+
+  const payload = {
+    provider: 'spaces',
+    credentials: {
+      endpoint: 'https://my-endpoint.com',
+      region: 'region-key',
+      bucket: 'bucket-name',
+      access_key: '',
+      secret_key: '',
+    },
+    frequency: {
+      type: 'weekly',
+      time: '12:30',
+      day: 1,
+    },
+    directory: 'backups/server/db',
+    email: '[email protected]',
+    retention: 7,
+    databases: [24],
+  };
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.createConfig(1, payload);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs', 'POST', payload);
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it lists all backup configs', async () => {
+  setupFetchStub();
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.listConfigs(1);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs', 'GET');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it gets a single backup config', async () => {
+  setupFetchStub();
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.getConfig(1, 1);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs/1', 'GET');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it updates a given backup config', async () => {
+  setupFetchStub();
+
+  const payload = {
+    provider: 'spaces',
+    credentials: {
+      endpoint: 'https://my-endpoint.com',
+      region: 'region-key',
+      bucket: 'bucket-name',
+      access_key: '',
+      secret_key: '',
+    },
+    frequency: {
+      type: 'weekly',
+      time: '12:30',
+      day: 1,
+    },
+    directory: 'backups/server/db',
+    email: '[email protected]',
+    retention: 7,
+    databases: [24],
+  };
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.updateConfig(1, 1, payload);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs/1', 'POST', payload);
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it deletes a given backup config', async () => {
+  setupFetchStub();
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.deleteConfig(1, 1);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs/1', 'DELETE');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it runs a given backup config', async () => {
+  setupFetchStub();
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.runConfig(1, 1);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs/1', 'POST');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it restores a backup', async () => {
+  setupFetchStub();
+
+  const payload = {
+    database: 7,
+  };
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.restore(1, 1, 1, payload);
+
+  expectToHaveBeenCalledWith(
+    '/servers/1/backup-configs/1/backups/1',
+    'POST',
+    payload,
+  );
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});
+
+test('it deletes a backup', async () => {
+  setupFetchStub();
+
+  const forge = new Forge('API_TOKEN');
+  await forge.backups.delete(1, 1, 1);
+
+  expectToHaveBeenCalledWith('/servers/1/backup-configs/1/backups/1', 'DELETE');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});

__tests__/config.test.js

@@ -1,58 +1,66 @@
-import moxios from 'moxios';
-import Forge from '../lib/Forge';
+const {
+  setupFetchStub,
+  expectToHaveBeenCalledWith,
+} = require('./stub/fetchStub');
+const Forge = require('../lib/Forge');
 
-beforeEach(() => {
-  moxios.install();
+beforeAll(() => {
+  require('cross-fetch/polyfill');
+  jest.spyOn(window, 'fetch');
 });
 
 afterEach(() => {
-  moxios.uninstall();
+  global.fetch.mockReset();
 });
 
 test('it gets a given sites Nginx config', async () => {
-  moxios.stubRequest('https://forge.laravel.com/api/v1/servers/1/sites/1/nginx', {
-    status: 200,
-  });
+  setupFetchStub();
 
   const forge = new Forge('API_TOKEN');
-  const config = await forge.config.getNginx(1, 1);
+  await forge.config.getNginx(1, 1);
 
-  expect(config.status).toEqual(200);
+  expectToHaveBeenCalledWith('/servers/1/sites/1/nginx', 'GET');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
 });
 
 test('it updates a given Nginx config', async () => {
-  moxios.stubRequest('https://forge.laravel.com/api/v1/servers/1/sites/1/nginx', {
-    status: 200,
-  });
+  setupFetchStub();
 
-  const forge = new Forge('API_TOKEN');
-  const config = await forge.config.updateNginx(1, 1, {
+  const payload = {
     content: 'CONTENT',
-  });
+  };
+
+  const forge = new Forge('API_TOKEN');
+  await forge.config.updateNginx(1, 1, payload);
+
+  expectToHaveBeenCalledWith('/servers/1/sites/1/nginx', 'POST', payload);
 
-  expect(config.status).toEqual(200);
+  expect(window.fetch).toHaveBeenCalledTimes(1);
 });
 
 test('it gets a given sites .env file', async () => {
-  moxios.stubRequest('https://forge.laravel.com/api/v1/servers/1/sites/1/env', {
-    status: 200,
-  });
+  setupFetchStub();
 
   const forge = new Forge('API_TOKEN');
-  const env = await forge.config.getEnv(1, 1);
+  await forge.config.getEnv(1, 1);
 
-  expect(env.status).toEqual(200);
+  expectToHaveBeenCalledWith('/servers/1/sites/1/env', 'GET');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
 });
 
 test('it updates a given .env file', async () => {
-  moxios.stubRequest('https://forge.laravel.com/api/v1/servers/1/sites/1/env', {
-    status: 200,
-  });
+  setupFetchStub();
 
-  const forge = new Forge('API_TOKEN');
-  const env = await forge.config.updateEnv(1, 1, {
+  const payload = {
     content: 'CONTENT',
-  });
+  };
+
+  const forge = new Forge('API_TOKEN');
+  await forge.config.updateEnv(1, 1, payload);
+
+  expectToHaveBeenCalledWith('/servers/1/sites/1/env', 'POST', payload);
 
-  expect(env.status).toEqual(200);
+  expect(window.fetch).toHaveBeenCalledTimes(1);
 });

__tests__/credentials.test.js

@@ -1,37 +1,25 @@
-import moxios from 'moxios';
-import Forge from '../lib/Forge';
+const {
+  setupFetchStub,
+  expectToHaveBeenCalledWith,
+} = require('./stub/fetchStub');
+const Forge = require('../lib/Forge');
 
-beforeEach(() => {
-  moxios.install();
+beforeAll(() => {
+  require('cross-fetch/polyfill');
+  jest.spyOn(window, 'fetch');
 });
 
 afterEach(() => {
-  moxios.uninstall();
+  global.fetch.mockReset();
 });
 
 test('it lists credentials', async () => {
-  moxios.stubRequest('https://forge.laravel.com/api/v1/credentials', {
-    response: {
-      credentials: [
-        {
-          id: 1,
-          type: 'ocean2',
-          name: 'Personal',
-        },
-      ],
-    },
-  });
+  setupFetchStub();
 
   const forge = new Forge('API_TOKEN');
-  const credentials = await forge.credentials.list();
+  await forge.credentials.list();
 
-  expect(credentials.data).toEqual({
-    credentials: [
-      {
-        id: 1,
-        type: 'ocean2',
-        name: 'Personal',
-      },
-    ],
-  });
-});
+  expectToHaveBeenCalledWith('/credentials', 'GET');
+
+  expect(window.fetch).toHaveBeenCalledTimes(1);
+});