Merge pull request #1154 from aandrewchung/tennis-rankings

Add plugin for getting tennis rankings, corresponding tests

jarviscli/plugins/tennis.py

@@ -0,0 +1,152 @@
+import requests
+from plugin import plugin, require
+from colorama import Fore
+from packages.memory.memory import Memory
+
+URL = "https://api.sportradar.com/tennis/trial/v3/en/rankings"
+
+
+@require(network=True)
+@plugin("tennis")
+class tennis():
+    """
+    Tennis Plugin for getting information about ATP and
+    !!! needs api.sportradar.com/tennis API_KEY for usage
+    """
+
+    def __call__(self, jarvis, s):
+        print("\nTennis data provided by the sportradar.com")
+        self.get_api_key(jarvis)
+        while True:
+            option = self.get_option(jarvis)
+            if option is None:
+                return
+            self.process_option(jarvis, option)
+
+    def process_option(self, jarvis, option):
+        """
+        Processes the users input option and performs required action,
+        either getting and printing ATP rankings,
+        getting and printing WTA rankings, or resetting API key
+        """
+        data = self.fetch_data(f'?api_key={self.key}')
+        if data is None:
+            jarvis.spinner_stop("Error While Loading Data - "
+                                "Try Again Later.", Fore.YELLOW)
+            return
+        if option == 'atp':
+            self.get_atp_top10(data)
+        if option == 'wta':
+            self.get_wta_top10(data)
+        if option == 'new_key':
+            self.update_api_key(jarvis)
+
+    def get_atp_top10(self, data):
+        """
+        Makes API call to get ATP rankings, prints out top 10 players
+        """
+        atp_rankings = data['rankings'][0]['competitor_rankings']
+        atp_names = [obj['competitor']['name'] for obj in atp_rankings]
+        i = 1
+        print('\nCurrent ATP Rankings\n')
+        for name in atp_names[:10]:
+            print(f'{i}. {name}')
+            i += 1
+
+    def get_wta_top10(self, data):
+        """
+        Makes API call to get WTA rankings, prints out top 10 players
+        """
+        wta_rankings = data['rankings'][1]['competitor_rankings']
+        wta_names = [obj['competitor']['name'] for obj in wta_rankings]
+        i = 1
+        print('\nCurrent WTA Rankings:\n')
+        for name in wta_names[:10]:
+            print(f'{i}. {name}')
+            i += 1
+
+    def get_headers(self):
+        """
+        Gets headers required for all HTTP requests made by this plugin
+        """
+        return {"accept": "application/json"}
+
+    def fetch_data(self, route):
+        """
+        Makes API call for given route
+        """
+        r = requests.get(URL + route, headers=self.get_headers())
+        r = r.json()
+        if "errorCode" in r.keys():
+            return None
+        return r
+
+    def get_api_key(self, jarvis):
+        """
+        Either gets API key from memory or, if one is not there,
+        asks the user for an API key and stores it in memory
+        """
+        m = Memory("tennis.json")
+        if m.get_data("API_KEY") is None:
+            user_api_key = jarvis.input("Enter api.sportradar.com/tennis "
+                                        "API_KEY: ", Fore.GREEN)
+            m.add_data("API_KEY", user_api_key)
+            m.save()
+            self.key = user_api_key
+        else:
+            self.key = m.get_data("API_KEY")
+
+    def update_api_key(self, jarvis):
+        """
+        Prompts user to enter a new API key and stores this key in memory
+        """
+        user_api_key = jarvis.input("Enter New api.sportradar.com/tennis "
+                                    "API_KEY: ", Fore.GREEN)
+        m = Memory("tennis.json")
+        m.update_data("API_KEY", user_api_key)
+        m.save()
+        self.key = user_api_key
+
+    def get_option(self, jarvis):
+        """
+        Prompts user for what feature of the tennis plugin they'd like
+        to use and takes in and returns the user's choice
+        """
+        options = {1: "atp", 2: "wta", 3: "new_key"}
+
+        print()
+        jarvis.say("How Can I Help You?", Fore.BLUE)
+        print()
+        print("1: Get ATP (mens) tennis rankings")
+        print("2: Get WTA (womens) tennis rankings")
+        print("3: Insert new API_KEY")
+        print("4: exit")
+        print()
+        choice = self.get_choice(jarvis)
+        if choice == -1:
+            return
+        else:
+            return options[choice]
+
+    def get_choice(self, jarvis):
+        """
+        Prompts user for integer choice indicating what part of the
+        tennis plugin they want to use, returns this choice
+        """
+        while True:
+            try:
+                inserted_value = int(jarvis.input("Enter your "
+                                                  "choice: ", Fore.GREEN))
+                if inserted_value == 4:
+                    return -1
+                elif inserted_value in [1, 2, 3]:
+                    return inserted_value
+                else:
+                    jarvis.say(
+                        "Invalid input! Enter a number "
+                        "from the choices provided.", Fore.YELLOW)
+            except ValueError:
+                jarvis.say(
+                    "Invalid input! Enter a number "
+                    "from the choices provided.", Fore.YELLOW)
+            print()

jarviscli/tests/test_tennis.py

@@ -0,0 +1,48 @@
+import unittest
+from tests import PluginTest
+from plugins.tennis import tennis
+from mock import patch, call
+import requests
+from packages.memory.memory import Memory
+
+
+class TennisTest(PluginTest):
+    """
+    Tests For Tennis Rankings Plugin
+    !!! test will be executed only if user has added his own API_KEY
+    """
+
+    def setUp(self):
+        self.test = self.load_plugin(tennis)
+        m = Memory("tennis.json")
+        self.unable_to_test_plugin = False
+        if m.get_data("API_KEY") is None:
+            self.unable_to_test_plugin = True
+        else:
+            self.headers = {"accept": "application/json"}
+
+    def test_get_atp_top10(self):
+        if self.unable_to_test_plugin:
+            return
+        with patch.object(requests, 'get', headers=self.headers) as get_mock:
+            self.test.get_api_key(self.jarvis_api)
+            self.test.process_option(self.jarvis_api, 'atp')
+            get_mock.assert_called_with(
+                "https://api.sportradar.com/tennis/trial/v3/en/rankings?"
+                "api_key=" + self.test.get_api_key(self.jarvis_api),
+                headers=self.headers)
+
+    def test_get_wta_top10(self):
+        if self.unable_to_test_plugin:
+            return
+        with patch.object(requests, 'get', headers=self.headers) as get_mock:
+            self.test.get_api_key(self.jarvis_api)
+            self.test.process_option(self.jarvis_api, 'wta')
+            get_mock.assert_called_with(
+                "https://api.sportradar.com/tennis/trial/v3/en/rankings?"
+                "api_key=" + self.test.get_api_key(self.jarvis_api),
+                headers=self.headers)
+
+
+if __name__ == '__main__':
+    unittest.main()