Merge "Add support for v2/rating/modules endpoints"

Author: Zuul

cloudkittyclient/tests/unit/v2/base.py

@@ -12,8 +12,10 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+
 from cloudkittyclient.tests import utils
 from cloudkittyclient.v2 import dataframes
+from cloudkittyclient.v2.rating import modules
 from cloudkittyclient.v2 import scope
 from cloudkittyclient.v2 import summary
 
@@ -26,3 +28,4 @@ def setUp(self):
         self.dataframes = dataframes.DataframesManager(self.api_client)
         self.scope = scope.ScopeManager(self.api_client)
         self.summary = summary.SummaryManager(self.api_client)
+        self.rating = modules.RatingManager(self.api_client)

cloudkittyclient/tests/unit/v2/test_rating.py

@@ -0,0 +1,38 @@
+# Copyright 2019 Objectif Libre
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+#
+
+from cloudkittyclient.tests.unit.v2 import base
+
+
+class TestRating(base.BaseAPIEndpointTestCase):
+
+    def test_get_modules(self):
+        self.rating.get_module()
+        self.api_client.get.assert_called_once_with('/v2/rating/modules')
+
+    def test_get_one_module(self):
+        self.rating.get_module(module_id="moduleidtest")
+        self.api_client.get.assert_called_once_with(
+            '/v2/rating/modules/moduleidtest')
+
+    def test_update_one_module(self):
+        self.rating.update_module(module_id="moduleidtest",
+                                  enabled=False, priority=42)
+        self.api_client.put.assert_called_once_with(
+            '/v2/rating/modules/moduleidtest',
+            json={
+                'enabled': False,
+                'priority': 42,
+            })

cloudkittyclient/v2/client.py

@@ -15,6 +15,7 @@
 #
 from cloudkittyclient.v1 import client
 from cloudkittyclient.v2 import dataframes
+from cloudkittyclient.v2.rating import modules
 from cloudkittyclient.v2 import scope
 from cloudkittyclient.v2 import summary
 
@@ -40,3 +41,4 @@ def __init__(self,
         self.dataframes = dataframes.DataframesManager(self.api_client)
         self.scope = scope.ScopeManager(self.api_client)
         self.summary = summary.SummaryManager(self.api_client)
+        self.rating = modules.RatingManager(self.api_client)

cloudkittyclient/v2/rating/__init__.py

@@ -0,0 +1,59 @@
+
+# Copyright 2019 Objectif Libre
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+#
+from cloudkittyclient import exc
+from cloudkittyclient.v1.client import rating
+
+
+class RatingManager(rating.RatingManager):
+    """Class used to handle /v2/rating/modules endpoint"""
+
+    url = '/v2/rating/modules'
+
+    def get_module(self, **kwargs):
+        """Returns the given module.
+
+        If module_id is not specified, returns the list of loaded modules.
+
+        :param module_id: ID of the module on which you want information.
+        :type module_id: str
+        """
+        module_id = kwargs.get('module_id', None)
+        if module_id is not None:
+            url = "{}/{}".format(self.url, module_id)
+        else:
+            url = self.url
+        return self.api_client.get(url).json()
+
+    def update_module(self, **kwargs):
+        """Update the given module.
+
+        :param module_id: Id of the module to update.
+        :type module_id: str
+        :param enabled: Set to True to enable the module, False to disable it.
+        :type enabled: bool
+        :param priority: New priority of the module.
+        :type priority: int
+        """
+        if not kwargs.get('module_id', None):
+            raise exc.ArgumentRequired("'module_id' argument is required.")
+        mutable_fields = ['enabled', 'priority']
+        changes = {}
+        for key, value in kwargs.items():
+            if value is not None and key in mutable_fields:
+                changes[key] = value
+        self.api_client.put("{}/{}".format(self.url, kwargs['module_id']),
+                            json=changes)
+        return self.get_module(**kwargs)

cloudkittyclient/v2/rating/modules.py

@@ -0,0 +1,29 @@
+# Copyright 2019 Objectif Libre
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+#
+from cliff import lister
+
+from cloudkittyclient import utils
+
+
+class CliModuleList(lister.Lister):
+    """Get loaded rating modules list"""
+
+    def get_parser(self, prog_name):
+        parser = super(CliModuleList, self).get_parser(prog_name)
+        return parser
+
+    def take_action(self, parsed_args):
+        resp = utils.get_client_from_osc(self).ratingmodules.get_modules_list()
+        return resp['modules']