Changed some stuff around--connect() not working

Author: jmashon

api_connect.py

@@ -2,25 +2,11 @@
 import json
 import requests
 
-# api_functions.py -> api_connect.py
-
 class ApiConnect():
     def __init__(self):
         self.token = None
         self.error = None
 
-    # token_handling() --> errors for token
-    # request_handling() --> errors for request
-
-    # get_token()
-    # check_token()
-
-    # request()
-    # get() --> get endpoint info
-    # post() --> overwrite/new endpoint info
-    # patch() --> edit endpoint info
-    # delete() --> delete endpoint info
-
     def token_handling(self, response):
         """Handle errors relating to bad user auth token requests."""
 
@@ -76,12 +62,9 @@ def get_token(self, email, password, server):
         response = requests.post(f'{server}/api/tokens', headers=headers, json=user)
 
         if self.token_handling(response) == 200:
-            token_obj = response.json()
-            token_str = json.dumps(token_obj)
-            # token_dict = json.loads(token_str)
-            self.token = token_str
+            token_data = response.json()
             self.error = None
-            return token_str
+            return token_data
         else:
             return self.error
 
@@ -92,15 +75,6 @@ def check_token(self):
             print("ERROR: You have no token, please call `get_token` using your login credentials and the server you wish to connect to.")
             sys.exit(1)
 
-    # save response as JSON object:     json_obj = response.json()
-    #                                   json.dumps(json_obj)
-
-    # save response as a string:        json_str = response.text
-
-    # access JSON object fields:        json_obj = response.json()
-    #                                   data = json.dumps(json_obj)
-    #                                   name = data["name"]
-
     def request(self, method, endpoint, id, payload):
         """Send requests from user-accessible functions via API."""
 

api_functions.py

@@ -1,57 +1,49 @@
 from api_connect import ApiConnect
 
-# main.py -> api_functions.py -> api_connect.py
-
 class ApiFunctions():
     def __init__(self):
-        self.connect = ApiConnect()
-
+        self.api_connect = ApiConnect()
         self.token = None
-        self.error = None
 
     def get_token(self, email, password, server='https://my.farm.bot'):
-        # when get_token() is called, set self.token
-        self.token = self.connect.get_token(email, password, server)
-
-        # when get_token() is called, set api.token
-        self.connect.token = self.token
-        # when get_token() is called, set broker.token
-        self.broker.token = self.token
+        token_str = self.api_connect.get_token(email, password, server)
+        return token_str
 
-        return self.token
+    # data = get_info() and like functions will assign 'data' JSON object
+    # data["name"] will access the field "name" and return the field value
 
     def get_info(self, endpoint, id=None):
-        return self.connect.get(endpoint, id)
-        # return self.connect.get(endpoint, id)...
+        return self.api_connect.get(endpoint, id)
+        # return self.api_connect.get(endpoint, id)...
 
     def set_info(self, endpoint, field, value, id=None):
         new_value = {
             field: value
         }
 
-        self.connect.patch(endpoint, id, new_value)
-        return self.connect.get(endpoint, id)
-        # return self.connect.get(endpoint, id)...
+        self.api_connect.patch(endpoint, id, new_value)
+        return self.api_connect.get(endpoint, id)
+        # return self.api_connect.get(endpoint, id)...
 
     def env(self, id=None, field=None, new_val=None):
         if id is None:
-            data = self.connect.get('farmware_envs', id=None)
+            data = self.api_connect.get('farmware_envs', id=None)
             print(data)
         else:
-            data = self.connect.get('farmware_envs', id)
+            data = self.api_connect.get('farmware_envs', id)
             print(data)
 
     def log(self, message, type=None, channel=None):
         log_message = {
             "message": message,
-            "type": type,
+            "type": type, # https://software.farm.bot/v15/app/intro/jobs-and-logs#log-types
             "channel": channel # Specifying channel does not do anything
         }
 
         endpoint = 'logs'
         id = None
 
-        self.connect.post(endpoint, id, log_message)
+        self.api_connect.post(endpoint, id, log_message)
         # return ...
 
     def safe_z(self):

broker_connect.py

@@ -3,56 +3,13 @@
 from datetime import datetime
 import paho.mqtt.client as mqtt
 
-# broker_functions.py -> broker_connect.py
-
 class BrokerConnect():
     def __init__(self):
         self.token = None
         self.client = None
 
-    # connect() --> establish connection to message broker
-    # disconnect() --> disconnect from message broker
-
-    # publish()
-
-    # on_connect() --> subscribe to channel
-    # on_message() --> print channel/message
-
-    # def on_connect(self, client, *_args):
-    #     # subscribe to all channels
-    #     self.client.subscribe(f"bot/{self.token['token']['unencoded']['bot']}/#")
-    #     print('connected')
-
-    # def status_connect(self, client, *_args):
-    #     # Subscribe to specific channel
-    #     device_info = self.api.get('device')
-    #     device_id = device_info['id']
-
-    #     client.subscribe("bot/device_4652/status")
-    #     print('connected via status_connect()')
-
-    def sub_all(self, client, *_args):
-        """Subscribe to all message broker channels."""
-
-        self.client.subscribe(f"bot/{self.token['token']['unencoded']['bot']}/#")
-        print("Connected to all channels.")
-
-    def sub_single(self, client, *_args, channel):
-        """Subscribe to specific message broker channel."""
-
-        self.client.subscribe("bot/{device_id}/{channel}")
-        print("Connected to "+channel+".")
-
-    def on_message(self, _client, _userdata, msg):
-        print('-' * 100)
-        # print channel
-        print("Channel:")
-        print(f'{msg.topic} ({datetime.now().strftime("%Y-%m-%d %H:%M:%S")})\n')
-        # print message
-        print("Message:")
-        print(json.dumps(json.loads(msg.payload), indent=4))
-
     def connect(self):
+        """Establish persistent connection with message broker."""
         self.client = mqtt.Client()
         self.client.username_pw_set(
             username=self.token['token']['unencoded']['bot'],
@@ -65,17 +22,16 @@ def connect(self):
             keepalive=60
         )
 
-        # self.client.on_connect = status_connect
-        # self.client.on_message = on_message
-
         self.client.loop_start()
 
     def disconnect(self):
+        """Disconnect from the message broker."""
         if self.client is not None:
             self.client.loop_stop()
             self.client.disconnect()
 
     def publish(self, message):
+        """Send Celery Script messages via message broker."""
         if self.client is None:
             self.connect()