Updated functions for accessing API endpoints

Author: Juliana Mashon

README.md

@@ -84,6 +84,19 @@ bot.set_verbosity(2)
 | `1` The name of the function will be output. | `e_stop called` |
 | `2` The name of the function will be output with additional information about the return value. | `Triggered device emergency stop at: 2024-08-21 11:16:18.547813` |
 
+### Test 1: Add a new plant to your garden
+
+This test will help familiarize you with sending commands via the [API](https://developer.farm.bot/docs/web-app/rest-api).
+
+### Test 2: Turn your LED strip on and off
+
+This test will help familiarize you with sending commands via the [Message Broker](https://developer.farm.bot/docs/message-broker).
+```
+on(7)           # Turn ON pin 7 (LED strip)
+wait(2000)      # Wait 2000 milliseconds
+off(7)          # Turn OFF pin 7 (LED strip)
+```
+
 ## :compass: Functions
 
 ```

functions/authentication.py

@@ -92,7 +92,9 @@ def request(self, method, endpoint, database_id, payload=None):
             url = f'https:{self.state.token["token"]["unencoded"]["iss"]}/api/{endpoint}/{database_id}'
 
         headers = {'authorization': self.state.token['token']['encoded'], 'content-type': 'application/json'}
-        response = requests.request(method, url, headers=headers, json=payload)
+
+        session = requests.Session()
+        response = session.request(method, url, headers=headers, json=payload)
 
         if self.request_handling(response) == 200:
             self.state.error = None

functions/information.py

@@ -4,7 +4,8 @@
 
 # └── functions/information
 #     ├── [API] get_info()
-#     ├── [API] set_info()
+#     ├── [API] edit_info()
+#     ├── [API] add_info()
 #     ├── [API] safe_z()
 #     ├── [API] garden_size()
 #     ├── [API] group()
@@ -25,23 +26,30 @@ def __init__(self, state):
     def get_info(self, endpoint, id=None):
         """Get information about a specific endpoint."""
 
-        endpoint_data = self.auth.request('GET', endpoint, id)
+        endpoint_data = self.auth.request("GET", endpoint, id)
 
         self.broker.state.print_status("get_info()", endpoint_json=endpoint_data)
 
         return endpoint_data
 
-    def set_info(self, endpoint, field, value, id=None):
+    def edit_info(self, endpoint, new_data, id=None):
         """Change information contained within an endpoint."""
 
-        new_value = {
-            field: value
-        }
+        self.auth.request("PATCH", endpoint, database_id=id, payload=new_data)
+        endpoint_data = self.get_info(endpoint, id)
+
+        self.broker.state.print_status("edit_info()", endpoint_json=endpoint_data)
+
+        return endpoint_data
+
+    def add_info(self, endpoint, new_data, id=None):
+        """Create new informated contained within an endpoint."""
+
+        self.auth.request("POST", endpoint, database_id=id, payload=new_data)
 
-        self.auth.request('PATCH', endpoint, id, new_value)
         endpoint_data = self.get_info(endpoint, id)
 
-        self.broker.state.print_status("set_info()", endpoint_json=endpoint_data)
+        self.broker.state.print_status("add_info()", endpoint_json=endpoint_data)
 
         return endpoint_data
 

main.py

@@ -15,11 +15,11 @@ def print_status(self, function, endpoint_json=None, description=None):
         """Handle changes to output based on user-defined verbosity."""
 
         if self.verbosity >= 1:
-            return print(f"`{function}` called")
+            print(f"`{function}` called")
         if self.verbosity >= 2 and endpoint_json:
-            return print(json.dumps(endpoint_json, indent=4))
+            print(json.dumps(endpoint_json, indent=4))
         if self.verbosity >= 2 and description:
-            return print(description)
+            print(description)
 
 class Farmbot():
     def __init__(self):
@@ -106,9 +106,13 @@ def get_info(self, endpoint, id=None):
         """Get information about a specific endpoint."""
         return self.info.get_info(endpoint, id)
 
-    def set_info(self, endpoint, field, value, id=None):
+    def edit_info(self, endpoint, new_data, id=None):
         """Change information contained within an endpoint."""
-        return self.info.set_info(endpoint, field, value, id)
+        return self.info.edit_info(endpoint, new_data, id)
+
+    def add_info(self, endpoint, new_data, id=None):
+        """Create new informated contained within an endpoint."""
+        return self.info.add_info(endpoint, new_data, id)
 
     def safe_z(self):
         """Returns the highest safe point along the z-axis."""