Merge pull request #8 from ByteInternet/HNWEB-5220-add-active-branchers-endpoint

HNWEB-5220-add-active-branchers-endpoint

Author: alejandrogarza

hypernode_api_python/client.py

@@ -630,6 +630,39 @@ def order_hypernode(self, data):
         """
         return self.requests("POST", HYPERNODE_API_APP_ORDER_ENDPOINT, data=data)
 
+    def get_active_branchers(self, app_name):
+        """
+        List all active brancher nodes of your Hypernode.
+        Example:
+        >    client.get_active_branchers("yourhypernodeappname").json()
+        >    {
+        >        "monthly_total_time": 6397,
+        >        "monthly_total_cost": 109,
+        >        "branchers": [
+        >            {
+        >                "id": 21,
+        >                "name": "yourhypernodeappname-eph123456",
+        >                "created": "2019-08-24T14:15:22Z"
+        >                "ip": "127.0.0.1",
+        >                "elapsed_time": 7824,
+        >            },
+        >            {
+        >                "id": 22,
+        >                "name": "yourhypernodeappname-eph654321",
+        >                "ip": "52.68.96.58",
+        >                "created": "2019-08-24T14:15:22Z"
+        >                "elapsed_time": 7224,
+        >            }
+        >        ]
+        >    }
+
+        :param str app_name: The name of the Hypernode to get your active branchers for
+        :return obj response: The request response object
+        """
+        return self.requests(
+            "GET", HYPERNODE_API_APP_BRANCHER_ENDPOINT.format(app_name)
+        )
+
     def create_brancher(self, app_name, data):
         """
         Create a new branch (server replica) of your Hypernode.

tests/client/test_get_active_branchers.py

@@ -0,0 +1,35 @@
+from unittest import TestCase
+from unittest.mock import Mock
+
+from hypernode_api_python.client import (
+    HYPERNODE_API_APP_BRANCHER_ENDPOINT,
+    HypernodeAPIPython,
+)
+
+
+class TestGetActiveBranchers(TestCase):
+    def setUp(self):
+        self.client = HypernodeAPIPython(token="my_token")
+        self.mock_request = Mock()
+        self.client.requests = self.mock_request
+        self.app_name = "my_app"
+
+    def test_brancher_endpoint_is_correct(self):
+        self.assertEqual("/v2/app/{}/brancher/", HYPERNODE_API_APP_BRANCHER_ENDPOINT)
+
+    def test_calls_get_active_branchers_endpoint_properly(self):
+        self.client.get_active_branchers(self.app_name)
+
+        self.mock_request.assert_called_once_with(
+            "GET", f"/v2/app/{self.app_name}/brancher/"
+        )
+
+    def test_returns_active_branchers_data(self):
+        response = Mock()
+        response.status_code = 200
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.get_active_branchers(self.app_name),
+            self.mock_request.return_value,
+        )