Move package under picketapi

Author: devstein

poetry.lock

@@ -4,14 +4,19 @@ version = "0.1.0"
 description = "The official Python library for the Picket API (https://picketapi.com/)"
 authors = ["Devin Stein <[email protected]>"]
 readme = "README.md"
+packages = [
+    { include = "picketapi", from = "src" },
+]
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.7"
 requests = "^2.28.1"
 
 
 [tool.poetry.group.dev.dependencies]
 black = "^22.10.0"
+pytest = "^7.2.0"
+responses = "^0.22.0"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -0,0 +1,2 @@
+# expose Picket as a top-level import
+from .picket import *

src/picketapi/__init__.py

@@ -0,0 +1,8 @@
+class PicketAPIException(Exception):
+    def __init__(self, msg: str, code: str):
+        super().__init__(msg)
+        self.msg = msg
+        self.code = code
+
+    def __str__(self):
+        return self.msg

src/picketapi/exceptions.py

@@ -0,0 +1,11 @@
+def is_successful_status_code(status_code: int) -> bool:
+    return status_code >= 200 and status_code < 300
+
+
+def snake_to_camel(name: str) -> str:
+    parts = name.split("_")
+    return "".join(word if idx == 0 else word.title() for idx, word in enumerate(parts))
+
+
+def snake_to_camel_keys(d: dict) -> dict:
+    return {snake_to_camel(k): v for k, v in d.items()}

src/picketapi/helpers.py

@@ -1,80 +1,22 @@
 import os
 
-from dataclasses import dataclass
-from typing import Dict
-
 import requests
 from requests.auth import HTTPBasicAuth
 from requests.exceptions import JSONDecodeError
 
+from .exceptions import PicketAPIException
+from .helpers import is_successful_status_code, snake_to_camel_keys
+from .types import (
+    NonceResponse,
+    AuthorizedUser,
+    AuthResponse,
+    TokenOwnershipResponse,
+)
+
 API_VERSION = "v1"
 API_BASE_URL = os.path.join("https://picketapi.com/api/", API_VERSION)
 
 
-def is_successful_status_code(status_code):
-    return status_code >= 200 and status_code < 300
-
-
-class PicketAPIException(Exception):
-    def __init__(self, msg: str, code: str):
-        super().__init__(msg)
-        self.msg = msg
-        self.code = code
-
-    def __str__(self):
-        return self.msg
-
-
-@dataclass
-class NonceResponse:
-    nonce: str
-    statement: str
-    format: str
-
-    @classmethod
-    def from_dict(cls, d):
-        return cls(d["nonce"], d["statement"], d["format"])
-
-
-TokenBalances = Dict[str, Dict[str, str]]
-
-
-@dataclass
-class AuthorizedUser:
-    chain: str
-    wallet_address: str
-    display_name: str
-    token_balances: TokenBalances
-
-    @classmethod
-    def from_dict(cls, d):
-        return cls(
-            d["chain"], d["wallet_address"], d["display_name"], d["token_balances"]
-        )
-
-
-@dataclass
-class AuthResponse:
-    access_token: str
-    user: AuthorizedUser
-
-    @classmethod
-    def from_dict(cls, d):
-        user = AuthorizedUser.from_dict(d["user"])
-        return cls(d["accessToken"], user)
-
-
-@dataclass
-class TokenOwnershipResponse:
-    allowed: bool
-    walletAddress: str
-    token_balances: TokenBalances
-
-    @classmethod
-    def from_dict(cls, d):
-        return cls(d["allowed"], d["walletAddress"], d["token_balances"])
-
-
 class Picket:
     def __init__(self, api_key: str, **kwargs):
         self.api_key = api_key
@@ -93,14 +35,20 @@ def post_request(self, path: str, **kwargs):
         auth = HTTPBasicAuth(self.api_key, "")
         headers = self.headers()
 
-        req = requests.post(url, auth=auth, headers=headers, data=kwargs)
+        # transform keys to camelCase
+        req = requests.post(
+            url, auth=auth, headers=headers, json=snake_to_camel_keys(kwargs)
+        )
         try:
             data = req.json()
         except JSONDecodeError:
             raise Exception(req.text)
 
         if not is_successful_status_code(req.status_code):
-            raise PicketAPIException(data["msg"], data["code"])
+            if "msg" not in data:
+                raise Exception(data)
+            # msg is required, code is optional
+            raise PicketAPIException(data["msg"], data.get("code", None))
 
         return data
 

src/picket.py src/picketapi/picket.pysrc/picket.py renamed to src/picketapi/picket.py

@@ -0,0 +1,51 @@
+from dataclasses import dataclass
+from typing import Dict
+
+
+@dataclass
+class NonceResponse:
+    nonce: str
+    statement: str
+    format: str
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(d["nonce"], d["statement"], d["format"])
+
+
+TokenBalances = Dict[str, Dict[str, str]]
+
+
+@dataclass
+class AuthorizedUser:
+    chain: str
+    wallet_address: str
+    display_address: str
+    token_balances: TokenBalances
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(
+            d["chain"], d["walletAddress"], d["displayAddress"], d["tokenBalances"]
+        )
+
+
+@dataclass
+class AuthResponse:
+    access_token: str
+    user: AuthorizedUser
+
+    @classmethod
+    def from_dict(cls, d):
+        user = AuthorizedUser.from_dict(d["user"])
+        return cls(d["accessToken"], user)
+
+
+@dataclass
+class TokenOwnershipResponse:
+    allowed: bool
+    token_balances: TokenBalances
+
+    @classmethod
+    def from_dict(cls, d):
+        return cls(d["allowed"], d["tokenBalances"])