Release version 0.1.0

.esdoc.json

@@ -0,0 +1,9 @@
+{
+    "source": "./lib",
+    "destination": "./docs",
+    "plugins": [
+        {"name": "esdoc-standard-plugin"},
+        {"name": "esdoc-node-require"},
+        {"name": "esdoc-lint-plugin", "option": {"enable": false}}
+    ]
+}

.gitignore

@@ -0,0 +1,4 @@
+coverage
+doc
+node_modules
+package-lock.json

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "tabWidth": 4
+}

.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "node"
+cache:
+  directories:
+    - "node_modules"
+notifications:
+  email: false

README.md

@@ -0,0 +1,58 @@
+# Cheeze Wizards API Node Wrapper
+
+[![Build Status](https://travis-ci.org/PierrickGT/node-cheeze-wizards-api.svg?branch=master)](https://travis-ci.org/PierrickGT/node-cheeze-wizards-api) [![npm version](https://badge.fury.io/js/node-cheeze-wizards-api.svg)](https://badge.fury.io/js/node-cheeze-wizards-api) [![Coverage Status](https://coveralls.io/repos/github/PierrickGT/node-cheeze-wizards-api/badge.svg?branch=master)](https://coveralls.io/github/PierrickGT/node-cheeze-wizards-api?branch=master) [![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/PierrickGT/node-cheeze-wizards-api) [![dependencies Status](https://david-dm.org/PierrickGT/node-cheeze-wizards-api/status.svg)](https://david-dm.org/PierrickGT/node-cheeze-wizards-api) [![devDependencies Status](https://david-dm.org/PierrickGT/node-cheeze-wizards-api/dev-status.svg)](https://david-dm.org/PierrickGT/node-cheeze-wizards-api?type=dev)
+
+Node Wrapper for the Alchemy Cheeze Wizards API: https://docs.alchemyapi.io/docs/cheeze-wizards-api
+You'll need a valid API key and a verified email address. To get your key, just sign up on the Cheeze Wizards developer page: https://www.cheezewizards.com/cheezyverse
+
+## Installation
+```
+npm install --save node-cheeze-wizards-api
+```
+
+## Usage
+```
+// Import the desired module
+const { CheezeWizardsAPI } = require('node-cheeze-wizards-api');
+
+// Create an instance
+const cheezeWizardsAPI = new CheezeWizardsAPI('your@email.com', 'your-api-token');
+
+// Get stuff done
+cheezeWizardsAPI
+    .wizard(1)
+    .then(response => {
+        console.log(response.data);
+        console.log(response.status);
+    })
+    .catch(error => {
+        console.log(error);
+    });
+```
+
+## Methods
+
+### Duel
+```
+duel();
+duel(duelId);
+```
+
+### Duels
+```
+duels();
+duels(params);
+```
+
+### Wizard
+```
+wizard();
+wizard(wizardId);
+```
+
+### Wizards
+```
+wizards();
+wizards(params);
+```
+

generate-doc.js

@@ -0,0 +1,21 @@
+const doxdox = require('doxdox');
+const fs = require('fs');
+
+doxdox
+    .parseInputs(['lib/cheeze-wizards.js'], {
+        parser: 'dox',
+        layout: 'bootstrap'
+    })
+    .then(content => {
+        if (!fs.existsSync('doc')) {
+            fs.mkdirSync('doc');
+        }
+        fs.writeFile('./doc/index.html', content, function(err) {
+            if (err) {
+                return console.log(err);
+            }
+            console.log(
+                'Cheeze Wizards API Node Wrapper Doc has been generated!'
+            );
+        });
+    });

lib/cheeze-wizards.js

@@ -0,0 +1,180 @@
+const axios = require('axios');
+const querystring = require('querystring');
+
+/**
+ * Cheeze Wizards Alchemy API url
+ * @type {String}
+ * @return {String} Returns Cheeze Wizards Alchemy API url https://cheezewizards.alchemyapi.io
+ */
+const ALCHEMY_API_URL = 'https://cheezewizards.alchemyapi.io';
+
+/**
+ * Wizards path
+ * @type {String}
+ * @return {String} Returns '/wizards/' path
+ */
+const WIZARDS_BASE_PATH = '/wizards/';
+
+/**
+ * Duels path
+ * @type {String}
+ * @return {String} Returns '/duels/' path
+ */
+const DUELS_BASE_PATH = '/duels/';
+
+/**
+ * Cheeze Wizards API Client
+ * @return {Function}   Returns an empty function
+ * @param  {String} email       Email used to get API token
+ * @param  {String} apiToken    API token
+ * @example
+ * const cheezeWizardsAPI = new CheezeWizardsAPI('your@email.com', 'your-api-token');
+ * cheezeWizardsAPI
+    .wizard(1)
+    .then(response => {
+        console.log(response.data);
+        console.log(response.status);
+    })
+    .catch(error => {
+        console.log(error);
+    });
+ */
+const CheezeWizardsAPI = function(email, apiToken) {
+    axios.defaults.baseURL = ALCHEMY_API_URL;
+    axios.defaults.headers['Content-Type'] = 'application/json';
+    axios.defaults.headers['x-api-token'] = apiToken;
+    axios.defaults.headers['x-email'] = email;
+};
+
+/**
+ * GET method for Cheeze Wizards API
+ * @constructor
+ * @param  {String} url       GET request url
+ * @param  {Object} params    GET request params
+ * @return {Promise}          Returns a promise
+ */
+CheezeWizardsAPI.prototype._get = function(url, params) {
+    let query = '';
+
+    if (params) {
+        query = axios.get(url + '?' + querystring.stringify(params));
+    } else {
+        query = axios.get(url);
+    }
+
+    return query;
+};
+
+/**
+ * Method to get a duel by id
+ * Fallback to get all duels if you forget id
+ * @constructor
+ * @param  {Integer} [duelId]    Duel Id
+ * @return {Promise}             Returns a promise
+ * @example
+ * cheezeWizardsAPI.duel();
+ * cheezeWizardsAPI.duel(1);
+ */
+CheezeWizardsAPI.prototype.duel = function(duelId) {
+    let query = '';
+
+    if (duelId) {
+        query = this._get(DUELS_BASE_PATH + duelId);
+    } else {
+        query = this._get(DUELS_BASE_PATH);
+    }
+
+    return query;
+};
+
+/**
+ * Method to get duels by block, wizard, status, ...
+ * Fallback to get all wizards if you forget params
+ * @constructor
+ * @param  {Object} params                      Query parameters
+ * @param  {Integer} params.startsAfter         Duels that start after this block number
+ * @param  {Integer} params.startsBefore        Duels that start before this block number
+ * @param  {Integer} params.endsAfter           Duels that end after this block number
+ * @param  {Integer} params.endsBefore          Duels that end before this block number
+ * @param  {Array} params.wizardIds             Duels involving these wizards (coma separated list of wizardIds)
+ * @param  {Boolean} params.excludeInProgress   True for completed duels, false for all duels (default)
+ * @param  {Boolean} params.excludeFinished     True for duels in progress, false for all duels (default)
+ * @return {Promise}                            Returns a promise
+ * @example
+ * cheezeWizardsAPI.duels();
+ * cheezeWizardsAPI.duels({
+ *  startsAfter: 8262502,
+ *  wizardIds: [3, 4],
+ * });
+ */
+CheezeWizardsAPI.prototype.duels = function(params) {
+    let query = '';
+
+    if (params) {
+        query = this._get(DUELS_BASE_PATH, params);
+    } else {
+        query = this._get(DUELS_BASE_PATH);
+    }
+
+    return query;
+};
+
+/**
+ * Method to get a wizard by id
+ * Fallback to get all wizards if you forget id
+ * @constructor
+ * @param  {Integer} [wizardId]    Wizard Id
+ * @return {Promise}               Returns a promise
+ * @example
+ * cheezeWizardsAPI.wizard();
+ * cheezeWizardsAPI.wizard(1);
+ */
+CheezeWizardsAPI.prototype.wizard = function(wizardId) {
+    let query = '';
+
+    if (wizardId) {
+        query = this._get(WIZARDS_BASE_PATH + wizardId);
+    } else {
+        query = this._get(WIZARDS_BASE_PATH);
+    }
+
+    return query;
+};
+
+/**
+ * Method to get wizards by affinity, power, owner, ...
+ * Fallback to get all wizards if you forget params
+ * @constructor
+ * @param  {Object} params              Query parameters
+ * @param  {String} params.owner        Wizards owned by this address
+ * @param  {Integer} params.affinity    Wizards with this affinity: 0 = NOTSET, 1 = NEUTRAL, 2 = FIRE, 3 = WIND, 4 = WATER
+ * @param  {Integer} params.minPower    Wizards whose power is greater than or equal to minPower
+ * @param  {Integer} params.maxPower    Wizards whose power is less than or equal to maxPower
+ * @return {Promise}                    Returns a promise
+ * @example
+ * cheezeWizardsAPI.wizards();
+ * cheezeWizardsAPI.wizards({
+ *  affinity: 4,
+ *  owner: '0xF0128825b0c518858971d8521498769148137936',
+ *  minPower: 100000,
+ *  maxPower: 900000000000000,
+ * });
+ */
+CheezeWizardsAPI.prototype.wizards = function(params) {
+    let query = '';
+
+    if (params) {
+        query = this._get(WIZARDS_BASE_PATH, params);
+    } else {
+        query = this._get(WIZARDS_BASE_PATH);
+    }
+
+    return query;
+};
+
+module.exports = {
+    CheezeWizardsAPI,
+    ALCHEMY_API_URL,
+    DUELS_BASE_PATH,
+    WIZARDS_BASE_PATH
+};