add set_token

Author: gabrielburnworth

README.md

@@ -71,19 +71,22 @@ bot = Farmbot()
 
 Use the same login credentials associated with the web app account you are interacting with. The server is "https://my.farm.bot" by default.
 ```python
-bot.get_token("email", "password")
+token = bot.get_token("email", "password")
 ```
 
 To avoid storing your account credentials in plaintext, you can print your token:
 ```python
-print(bot.state.token)
+print(token)
 ```
 
 and then delete the `bot.get_token("email", "password")` line and set your token directly instead:
 ```python
-fb.state.token = {'token': {'unencoded': {'aud': ...
+token = {'token': {'unencoded': {'aud': ...
+bot.set_token(token)
 ```
 
+where the part after `token = ` is the entire token pasted from the `print(token)` output. The start should look similar to the value above.
+
 > [!CAUTION]
 > Store your authorization token securely. It grants full access and control over your FarmBot and your FarmBot Web App account.
 
@@ -156,6 +159,7 @@ sidecar-starter-pack/
 | class `ApiConnect()` | Description |
 | :--- | :--- |
 | `get_token()` | Get FarmBot authorization token. Server is "https://my.farm.bot" by default. |
+| `set_token()` | Set FarmBot authorization token. |
 | `check_token()` | Ensure the token persists throughout sidecar. |
 | `request_handling()` | Handle errors associated with different endpoint errors. |
 | `request()` | Make requests to API endpoints using different methods. |

main.py

@@ -43,6 +43,10 @@ def get_token(self, email, password, server="https://my.farm.bot"):
         """Get FarmBot authorization token. Server is 'https://my.farm.bot' by default."""
         return self.api.get_token(email, password, server)
 
+    def set_token(self, token):
+        """Set FarmBot authorization token."""
+        self.state.token = token
+
     # basic_commands.py
 
     def wait(self, duration):

tests/tests_main.py

@@ -27,7 +27,7 @@ class TestFarmbot(unittest.TestCase):
     def setUp(self):
         '''Set up method called before each test case'''
         self.fb = Farmbot()
-        self.fb.state.token = MOCK_TOKEN
+        self.fb.set_token(MOCK_TOKEN)
         self.fb.set_verbosity(0)
         self.fb.state.test_env = True
         self.fb.state.broker_listen_duration = 0.3
@@ -41,7 +41,7 @@ def test_get_token_default_server(self, mock_post):
         mock_response.status_code = 200
         mock_response.text = 'text'
         mock_post.return_value = mock_response
-        self.fb.state.token = None
+        self.fb.set_token(None)
         # Call with default server
         self.fb.get_token('[email protected]', 'test_pass_123')
         mock_post.assert_called_once_with(
@@ -61,7 +61,7 @@ def test_get_token_custom_server(self, mock_post):
         mock_response.status_code = 200
         mock_response.text = 'text'
         mock_post.return_value = mock_response
-        self.fb.state.token = None
+        self.fb.set_token(None)
         # Call with custom server
         self.fb.get_token('[email protected]', 'test_pass_123',
                           'https://staging.farm.bot')
@@ -82,7 +82,7 @@ def helper_get_token_errors(self, *args, **kwargs):
         mock_response = Mock()
         mock_response.status_code = status_code
         mock_post.return_value = mock_response
-        self.fb.state.token = None
+        self.fb.set_token(None)
         self.fb.get_token('[email protected]', 'test_pass_123')
         mock_post.assert_called_once_with(
             'https://my.farm.bot/api/tokens',
@@ -121,7 +121,7 @@ def helper_get_token_exceptions(self, *args, **kwargs):
         exception = kwargs['exception']
         error_msg = kwargs['error_msg']
         mock_post.side_effect = exception
-        self.fb.state.token = None
+        self.fb.set_token(None)
         self.fb.get_token('[email protected]', 'test_pass_123')
         mock_post.assert_called_once_with(
             'https://my.farm.bot/api/tokens',
@@ -288,7 +288,7 @@ def test_api_get_with_id(self, mock_request):
     @patch('requests.request')
     def test_check_token_api_request(self, mock_request):
         '''Test check_token: API request'''
-        self.fb.state.token = None
+        self.fb.set_token(None)
         with self.assertRaises(ValueError) as cm:
             self.fb.api_get('points')
         self.assertEqual(cm.exception.args[0], self.fb.state.NO_TOKEN_ERROR)
@@ -301,7 +301,7 @@ def test_check_token_broker(self, mock_request, mock_mqtt):
         '''Test check_token: broker'''
         mock_client = Mock()
         mock_mqtt.return_value = mock_client
-        self.fb.state.token = None
+        self.fb.set_token(None)
         with self.assertRaises(ValueError) as cm:
             self.fb.on(123)
         self.assertEqual(cm.exception.args[0], self.fb.state.NO_TOKEN_ERROR)
@@ -1774,6 +1774,3 @@ def test_print_status(self, mock_print):
         call_strings = [s.split('(')[0].strip('`') for s in call_strings]
         self.assertIn('[\n    "testing"\n]', call_strings)
         self.assertIn('test_print_status', call_strings)
-
-if __name__ == '__main__':
-    unittest.main()