Merge pull request #19 from ByteInternet/add-get-block-attack-descriptions-to-client

add get block attack description to client

Author: vdloo

hypernode_api_python/client.py

@@ -10,19 +10,20 @@
 HYPERNODE_API_APP_EAV_DESCRIPTION_ENDPOINT = "/v2/app/eav_descriptions/"
 HYPERNODE_API_APP_FLAVOR_ENDPOINT = "/v2/app/{}/flavor/"
 HYPERNODE_API_APP_FLOWS_ENDPOINT = "/logbook/v1/logbooks/{}/flows"
-HYPERNODE_API_BRANCHER_APP_ENDPOINT = "/v2/brancher/app/{}/"
-HYPERNODE_API_BRANCHER_ENDPOINT = "/v2/brancher/{}/"
 HYPERNODE_API_APP_NEXT_BEST_PLAN_ENDPOINT = "/v2/app/{}/next_best_plan/"
+HYPERNODE_API_APP_ORDER_ENDPOINT = "/v2/app/order/"
 HYPERNODE_API_APP_PRODUCT_LIST_ENDPOINT = "/v2/product/app/{}/"
 HYPERNODE_API_APP_XGRADE_CHECK_ENDPOINT = "/v2/app/xgrade/{}/check/{}/"
 HYPERNODE_API_APP_XGRADE_ENDPOINT = "/v2/app/xgrade/{}/"
 HYPERNODE_API_BACKUPS_ENDPOINT = "/v2/app/{}/backup/"
+HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT = "/v2/app/block_attack_descriptions/"
+HYPERNODE_API_BRANCHER_APP_ENDPOINT = "/v2/brancher/app/{}/"
+HYPERNODE_API_BRANCHER_ENDPOINT = "/v2/brancher/{}/"
 HYPERNODE_API_PRODUCT_APP_DETAIL_ENDPOINT = "/v2/product/app/{}/current/"
 HYPERNODE_API_PRODUCT_LIST_ENDPOINT = "/v2/product/"
 HYPERNODE_API_PRODUCT_PRICE_DETAIL_ENDPOINT = "/v2/product/{}/with_price/"
 HYPERNODE_API_VALIDATE_APP_NAME_ENDPOINT = "/v2/app/name/validate/"
 HYPERNODE_API_WHITELIST_ENDPOINT = "/v2/whitelist/{}/"
-HYPERNODE_API_APP_ORDER_ENDPOINT = "/v2/app/order/"
 
 
 class HypernodeAPIPython:
@@ -404,6 +405,22 @@ def get_product_info_with_price(self, product_code, error_to_raise=None):
             raise error_to_raise
         return response
 
+    def get_block_attack_descriptions(self):
+        """
+        Get the block attack descriptions. These can be used to block attacks
+        by automatically placing an NGINX snippet in /data/web/nginx if the
+        specified block is compatible with the current NGINX configuration.
+        Example:
+        >    client.requests("GET", "/v2/app/block_attack_descriptions/").json()
+        >    {
+        >        'BlockSqliBruteForce': 'Attempts to deploy NGINX rules to block suspected (blind) SQL injection attack',
+        >        ...
+        >    }
+
+        :return obj response: The request response object
+        """
+        return self.requests("GET", HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT)
+
     def get_whitelist_options(self, app_name):
         """
         Get whitelist options for app. Retrieve the options for specifying

tests/client/test_get_block_attack_descriptions.py

@@ -0,0 +1,37 @@
+from unittest.mock import Mock
+
+from tests.testcase import TestCase
+from hypernode_api_python.client import (
+    HypernodeAPIPython,
+    HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT,
+)
+
+
+class TestGetBlockAttackDescriptions(TestCase):
+    def setUp(self):
+        self.client = HypernodeAPIPython(token="mytoken")
+        self.mock_request = Mock()
+        self.client.requests = self.mock_request
+
+    def test_block_attack_descriptions_endpoint_is_correct(self):
+        self.assertEqual(
+            "/v2/app/block_attack_descriptions/",
+            HYPERNODE_API_BLOCK_ATTACK_DESCRIPTION_ENDPOINT,
+        )
+
+    def test_calls_block_attack_descriptions_detail_endpoint_properly(self):
+        self.client.get_block_attack_descriptions()
+
+        self.mock_request.assert_called_once_with(
+            "GET", "/v2/app/block_attack_descriptions/"
+        )
+
+    def test_returns_block_attack_descriptions(self):
+        response = Mock()
+        response.status_code = 200
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.get_block_attack_descriptions(),
+            self.mock_request.return_value,
+        )