Merge pull request #222 from TotallyNotRobots/cmc-one-convert

Change CMC api calls to use 1 conversion by default

Author: linuxdaemon

plugins/cryptocurrency.py

@@ -470,6 +470,7 @@ def __init__(
         api_url: str = "https://pro-api.coinmarketcap.com/v1/",
     ) -> None:
         self.api_key = api_key
+        self.show_btc = False
         self.api_url = URL(api_url)
         self.cache = Cache()
 
@@ -491,10 +492,13 @@ def get_quote(self, symbol: str, currency: str = "USD") -> CryptoCurrency:
         if currency not in self.get_fiat_currency_map().symbols:
             raise UnknownFiatCurrencyError(currency)
 
+        if self.show_btc:
+            convert = "{},BTC".format(currency)
+        else:
+            convert = currency
+
         data = self.request(
-            "cryptocurrency/quotes/latest",
-            symbol=symbol.upper(),
-            convert="{},BTC".format(currency),
+            "cryptocurrency/quotes/latest", symbol=symbol.upper(), convert=convert,
         ).data.cast_to(QuoteRequestResponse)
         _, out = data.data.popitem()
         return out
@@ -534,10 +538,20 @@ def check(self, response: APIResponse) -> None:
 api = CoinMarketCapAPI()
 
 
+def get_plugin_config(conf, name, default):
+    try:
+        return conf["plugins"]["cryptocurrency"][name]
+    except LookupError:
+        return default
+
+
 @hook.onload
 def init_api(bot):
     api.api_key = bot.config.get_api_key("coinmarketcap")
 
+    # Enabling this requires a paid CoinMarketCap API plan
+    api.show_btc = get_plugin_config(bot.config, "show_btc", False)
+
 
 class Alias:
     __slots__ = ("name", "cmds")
@@ -597,7 +611,6 @@ def crypto_command(text, event):
         raise
 
     quote = data.quote[currency]
-    btc_quote = data.quote["BTC"]
     change = quote.percent_change_24h
     if change > 0:
         change_str = "$(dark_green)+{}%$(clear)".format(change)
@@ -608,15 +621,15 @@ def crypto_command(text, event):
 
     currency_sign = api.get_currency_sign(currency)
 
+    if api.show_btc:
+        btc_quote = data.quote["BTC"]
+        btc = "- {:,.7f} BTC ".format(btc_quote.price)
+    else:
+        btc = ""
+
     return colors.parse(
-        "{} ({}) // $(orange){}{:,.2f}$(clear) {} - {:,.7f} BTC // {} change".format(
-            data.symbol,
-            data.slug,
-            currency_sign,
-            quote.price,
-            currency,
-            btc_quote.price,
-            change_str,
+        ("{} ({}) // $(orange){}{:,.2f}$(clear) {} " + btc + "// {} change").format(
+            data.symbol, data.slug, currency_sign, quote.price, currency, change_str,
         )
     )
 

tests/plugin_tests/test_cryptocurrency.py

@@ -54,11 +54,13 @@ def init_response(
     error_msg=None,
     check_api_key=False,
     pct_change=18.9,
+    show_btc=True,
 ):
     if check_api_key:
         cryptocurrency.init_api(bot.get())
 
     cryptocurrency.api.cache.clear()
+    cryptocurrency.api.show_btc = show_btc
     now = datetime.now()
 
     iso_fmt = "%Y-%m-%dT%H:%M:%S.%f%z"
@@ -122,15 +124,6 @@ def init_response(
                 "last_updated": (now - timedelta(hours=1)).strftime(iso_fmt),
                 "tags": [],
                 "quote": {
-                    "BTC": {
-                        "price": 2,
-                        "volume_24h": 5,
-                        "market_cap": 97,
-                        "percent_change_1h": 12.5,
-                        "percent_change_24h": 17.4,
-                        "percent_change_7d": 54.1,
-                        "last_updated": (now - timedelta(minutes=6)).strftime(iso_fmt),
-                    },
                     "USD": {
                         "price": 50000000000,
                         "volume_24h": 20,
@@ -143,6 +136,17 @@ def init_response(
                 },
             },
         }
+        if show_btc:
+            response_data["1"]["quote"]["BTC"] = {
+                "price": 2,
+                "volume_24h": 5,
+                "market_cap": 97,
+                "percent_change_1h": 12.5,
+                "percent_change_24h": 17.4,
+                "percent_change_7d": 54.1,
+                "last_updated": (now - timedelta(minutes=6)).strftime(iso_fmt),
+            }
+
         data = {
             "status": {
                 "timestamp": now.strftime(iso_fmt),
@@ -158,14 +162,16 @@ def init_response(
         mock_requests.add(
             MatchAPIKey(
                 "GET",
-                "https://pro-api.coinmarketcap.com/v1/cryptocurrency/quotes/latest?symbol=BTC&convert=USD%2CBTC",
+                "https://pro-api.coinmarketcap.com/v1/cryptocurrency/quotes/latest?symbol=BTC&convert=USD"
+                + ("%2CBTC" if show_btc else ""),
                 api_key="APIKEY" if check_api_key else None,
                 json=data,
             )
         )
 
 
 def test_api(mock_requests, mock_api_keys):
+    bot.config["plugins"] = {}
     init_response(mock_requests, check_api_key=True)
 
     result = cryptocurrency.api.get_quote("BTC", "USD")
@@ -334,9 +340,23 @@ def test_btc_alias_no_change(mock_requests):
     res = _run_alias()
 
     assert res == [
-        HookResult(
-            return_type="return",
-            value="BTC (bitcoin) // \x0307$50,000,000,000.00\x0f USD - 2.0000000 BTC // 0% change",
+        (
+            "return",
+            "BTC (bitcoin) // \x0307$50,000,000,000.00\x0f USD - 2.0000000 BTC // 0% change",
+        )
+    ]
+
+
+def test_no_show_btc(mock_requests):
+    show_btc = cryptocurrency.get_plugin_config({}, "show_btc", False)
+    init_response(mock_requests, show_btc=show_btc)
+
+    res = _run_alias()
+
+    assert res == [
+        (
+            "return",
+            "BTC (bitcoin) // \x0307$50,000,000,000.00\x0f USD // \x0303+18.9%\x0f change",
         )
     ]