refactor: rename API to rpc, and classes from {X}API to {X}RPCAPI to clarify naming.

pyasic/rpc/unknown.py

@@ -0,0 +1,97 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  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 pyasic.rpc import BaseMinerRPCAPI
+
+
+class UnknownRPCAPI(BaseMinerRPCAPI):
+    """An abstraction of an API for a miner which is unknown.
+
+    This class is designed to try to be an intersection of as many miner APIs
+    and API commands as possible (API ⋂ API), to ensure that it can be used
+    with as many APIs as possible.
+    """
+
+    def __init__(self, ip, api_ver: str = "0.0.0", port: int = 4028):
+        super().__init__(ip, port)
+        self.api_ver = api_ver
+
+    async def asccount(self) -> dict:
+        return await self.send_command("asccount")
+
+    async def asc(self, n: int) -> dict:
+        return await self.send_command("asc", parameters=n)
+
+    async def devdetails(self) -> dict:
+        return await self.send_command("devdetails")
+
+    async def devs(self) -> dict:
+        return await self.send_command("devs")
+
+    async def edevs(self, old: bool = False) -> dict:
+        if old:
+            return await self.send_command("edevs", parameters="old")
+        else:
+            return await self.send_command("edevs")
+
+    async def pools(self) -> dict:
+        return await self.send_command("pools")
+
+    async def summary(self) -> dict:
+        return await self.send_command("summary")
+
+    async def stats(self) -> dict:
+        return await self.send_command("stats")
+
+    async def version(self) -> dict:
+        return await self.send_command("version")
+
+    async def estats(self) -> dict:
+        return await self.send_command("estats")
+
+    async def check(self) -> dict:
+        return await self.send_command("check")
+
+    async def coin(self) -> dict:
+        return await self.send_command("coin")
+
+    async def lcd(self) -> dict:
+        return await self.send_command("lcd")
+
+    async def switchpool(self, n: int) -> dict:
+        # BOS has not implemented this yet, they will in the future
+        raise NotImplementedError
+        # return await self.send_command("switchpool", parameters=n)
+
+    async def enablepool(self, n: int) -> dict:
+        # BOS has not implemented this yet, they will in the future
+        raise NotImplementedError
+        # return await self.send_command("enablepool", parameters=n)
+
+    async def disablepool(self, n: int) -> dict:
+        # BOS has not implemented this yet, they will in the future
+        raise NotImplementedError
+        # return await self.send_command("disablepool", parameters=n)
+
+    async def addpool(self, url: str, username: str, password: str) -> dict:
+        # BOS has not implemented this yet, they will in the future
+        raise NotImplementedError
+        # return await self.send_command("addpool", parameters=f"{url},{username},{password}")
+
+    async def removepool(self, n: int) -> dict:
+        # BOS has not implemented this yet, they will in the future
+        raise NotImplementedError
+        # return await self.send_command("removepool", parameters=n)