add putRequest method

.gitignore

@@ -1,3 +1,5 @@
-/node_modules
-.DS_Store
-/package-lock.json
+/node_modules
+.DS_Store
+/package-lock.json
+index.html
+index.js

CHANGELOG.md

@@ -1,31 +1,42 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- Nothing yet :)
+
+- Added putRequest method
 
 ## 2.1.0 - 2021-3-23
+
 ### Added
+
 - Added postRequest method (by [@Aras14HD](https://github.com/delightedCrow/HabiticaMagic/pull/4))
 
 ## 2.0.1 - 2019-11-15
+
 ### Changed
+
 - Updating HabiticaUser.class to return "mage" instead of "wizard" for users with a mage class.
 
 ## 2.0.0 - 2019-11-2
+
 ### Added
+
 - So. Much. Documentation.
 - This CHANGELOG!
 - The Demo.
 - The Docs.
 - Just... everything good.
 
 ### Changed
+
 - Pretty much everything about HabiticaAPIManager. Nothing is compatible with the last version. sorry :(
 
 ## 1.0.0 - 2019-10-31
+
 ### Added
+
 - EVERYTHING (this was the initial HabiticaMagicJS release)

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Jess Coulter
-
-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.
+MIT License
+
+Copyright (c) 2019 Jess Coulter
+
+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

@@ -16,11 +16,12 @@ For the most comprehensive and up-to-date documentation on HabiticaMagicJS funct
 
 ### HabiticaAPIManager
 
-````javascript
+```javascript
 var apiManager = new HabiticaAPIManager("Your x-client ID", "en@pirate");
-````
+```
 
 The `HabiticaAPIManager` class is the primary way you'll interact with HabiticaMagicJS. Its constructor takes two parameters:
+
 - **x-client-id**: REQUIRED. Your x-client-id. [See Habitica's documentation here for what your x-client should be](https://habitica.fandom.com/wiki/Guidance_for_Comrades#X-Client_Header).
 - **language**: OPTIONAL. The language you want Habitica's content in. [See possible values here](https://habitica.com/apidoc/#api-Content-ContentGet). The default is `"en"` for english.
 
@@ -37,24 +38,25 @@ Check out this example of making multiple API requests and chaining them togethe
 let manager = new HabiticaAPIManager(xclient);
 
 // first we're going to do an API call to fetch the Habitica content data
-manager.fetchContentData()
-// once our content data fetch succeeds we can add the fetchUser()
-// API call to the promise chain.
-.then(() => {
-	return manager.fetchUser(userID);
-})
-// Now that our fetchUser call has finished we're done with API calls
-// (for now!) and we can send the resulting HabiticaUser object to our
-// renderUserTemplate function to display.
-.then((user) => {
-	this.renderUserTemplate(user);
-})
-// The nice thing about promise chains like this is that if an error
-// happens AT ANY POINT in the chain here we'll automatically skip
-// to this catch block, which will render our error template
-.catch((error) => {
-	this.renderErrorTemplate(error);
-});
+manager
+  .fetchContentData()
+  // once our content data fetch succeeds we can add the fetchUser()
+  // API call to the promise chain.
+  .then(() => {
+    return manager.fetchUser(userID);
+  })
+  // Now that our fetchUser call has finished we're done with API calls
+  // (for now!) and we can send the resulting HabiticaUser object to our
+  // renderUserTemplate function to display.
+  .then((user) => {
+    this.renderUserTemplate(user);
+  })
+  // The nice thing about promise chains like this is that if an error
+  // happens AT ANY POINT in the chain here we'll automatically skip
+  // to this catch block, which will render our error template
+  .catch((error) => {
+    this.renderErrorTemplate(error);
+  });
 ```
 
 #### Generic Get Requests
@@ -70,12 +72,11 @@ HabiticaMagicJS provides several fetch functions for getting specific API data (
 var apiManager = new HabiticaAPIManager("Your x-client ID");
 
 let apiURL = "https://habitica.com/api/v3/status";
-apiManager.getRequest(apiURL)
-.then((rawData) => {
-	// process the raw string of data into a JSON object
-	let statusData = JSON.parse(rawData).data;
-	// Now you know the API status!
-	console.log(statusData);
+apiManager.getRequest(apiURL).then((rawData) => {
+  // process the raw string of data into a JSON object
+  let statusData = JSON.parse(rawData).data;
+  // Now you know the API status!
+  console.log(statusData);
 });
 ```
 
@@ -85,13 +86,14 @@ apiManager.getRequest(apiURL)
 var apiManager = new HabiticaAPIManager("Your x-client ID");
 
 let apiURL = "https://habitica.com/api/v3/groups/party";
-apiManager.authGetRequest(apiURL, "USER ID", "USER API TOKEN")
-.then((rawData) => {
-	// process the raw string of data into a JSON object
-	let partyData = JSON.parse(rawData).data;
-	// now you can party!
-	console.log(partyData);
-});
+apiManager
+  .authGetRequest(apiURL, "USER ID", "USER API TOKEN")
+  .then((rawData) => {
+    // process the raw string of data into a JSON object
+    let partyData = JSON.parse(rawData).data;
+    // now you can party!
+    console.log(partyData);
+  });
 ```
 
 #### Generic Post Request
@@ -105,10 +107,10 @@ var apiManager = new HabiticaAPIManager("Your x-client ID");
 
 let apiURL = "https://habitica.com/api/v3/tasks/user";
 let task = {
-	type: "TASK TYPE",
-	text: "TASK NAME",
-}
-apiManager.postRequest(apiURL, "USER ID", "USER API TOKEN", task)
+  type: "TASK TYPE",
+  text: "TASK NAME",
+};
+apiManager.postRequest(apiURL, "USER ID", "USER API TOKEN", task);
 ```
 
 #### Before Fetching HabiticaUsers: Getting the Habitica Content
@@ -135,7 +137,9 @@ apiManager.fetchUser("USER-ID")
 	shield: "shield_base_0"
 }
 ```
+
 #### Example: fetchUser() After Content Fetch: details filled in!
+
 ```javascript
 // fetching the content first
 apiManager.fetchContentData()
@@ -178,23 +182,23 @@ These classes store the API returned by Habitica in a property (`.apiData`) and
 - There is often a lot of complexity in the way the Habitica API returns data, which `HabiticaUser` smoothes over - just look at the following example for getting a user's gems.
 
 ##### Example: getting a user's gems
+
 ```javascript
 // Assuming you've already created an apiManager and fetched
 // Habitica the content data
-apiManager.fetchUserWithTasks("USER ID", "API TOKEN")
-.then((user) => {
-	// you can always get to the raw API object data from
-	// the .apiData property
-	console.log(user.apiData);
-
-	// If you were to use the old-fashioned way of finding out how
-	// many gems a user had you'd have to know the Habitica API
-	// returns gems in a data property called "balance", and that
-	// you had to multiply that value by 4.
-	console.log(user.apiData.balance * 4); // gives you # of gems...
-
-	// But really you should just call:
-	console.log(user.gems); // what it does is obvious!
+apiManager.fetchUserWithTasks("USER ID", "API TOKEN").then((user) => {
+  // you can always get to the raw API object data from
+  // the .apiData property
+  console.log(user.apiData);
+
+  // If you were to use the old-fashioned way of finding out how
+  // many gems a user had you'd have to know the Habitica API
+  // returns gems in a data property called "balance", and that
+  // you had to multiply that value by 4.
+  console.log(user.apiData.balance * 4); // gives you # of gems...
+
+  // But really you should just call:
+  console.log(user.gems); // what it does is obvious!
 });
 ```
 
@@ -204,29 +208,28 @@ apiManager.fetchUserWithTasks("USER ID", "API TOKEN")
 // Assuming you've already created an apiManager and fetched
 // Habitica the content data
 
-apiManager.fetchUserWithTasks("USER ID", "API TOKEN")
-.then((user) => {
-	// you can always get to the raw API object data from
-	// the .apiData property
-	console.log(user.apiData);
-
-	// user.tasks is actually a HabiticaUserTasksManager object that
-	// lets you do neat things like see the amount of damage your
-	// undone dailies will to!
-	console.log(user.tasks.dailyStats.dailyDamageToSelf);
-
-	// want a list of this user's todos, due today?
-	console.log(user.tasks.todosDueToday);
-
-	// user stats will be computed for you! Yay!
-	console.log(user.stats)
-		// output of console.log(user.stats):
-		// {
-		// 	totals: {str: 0, con: 0, int: 0, per: 0},
-		// 	armor: {str: 0, con: 0, int: 0, per: 0},
-		// 	buffs: {str: 0, con: 0, int: 0, per: 0},
-		// 	points: {str: 0, con: 0, int: 0, per: 0}
-		// }
+apiManager.fetchUserWithTasks("USER ID", "API TOKEN").then((user) => {
+  // you can always get to the raw API object data from
+  // the .apiData property
+  console.log(user.apiData);
+
+  // user.tasks is actually a HabiticaUserTasksManager object that
+  // lets you do neat things like see the amount of damage your
+  // undone dailies will to!
+  console.log(user.tasks.dailyStats.dailyDamageToSelf);
+
+  // want a list of this user's todos, due today?
+  console.log(user.tasks.todosDueToday);
+
+  // user stats will be computed for you! Yay!
+  console.log(user.stats);
+  // output of console.log(user.stats):
+  // {
+  // 	totals: {str: 0, con: 0, int: 0, per: 0},
+  // 	armor: {str: 0, con: 0, int: 0, per: 0},
+  // 	buffs: {str: 0, con: 0, int: 0, per: 0},
+  // 	points: {str: 0, con: 0, int: 0, per: 0}
+  // }
 });
 ```
 
@@ -237,6 +240,7 @@ apiManager.fetchUserWithTasks("USER ID", "API TOKEN")
 ### Build Scripts
 
 To run all the build scripts:
+
 ```bash
 npm run build
 ```
@@ -252,17 +256,21 @@ npm run build:minify
 Compiled files will be output in the `/dist` directory. To modify the build process, edit `minify.js`.
 
 ### Generating the Developer Docs
+
 The Developer documentation is generated from [JSDoc](https://jsdoc.app/index.html) formatted comments in the code, and created using [documentation.js](https://documentation.js.org/). To rebuild the documentation file after updating comments:
 
 First, install dependencies locally.
+
 ```bash
 npm install
 ```
 
 Then run the following command to build the html docs:
+
 ```bash
 npm run build:docs
 ```
+
 ---
 
 ## Contributing