breezeway 0.0.1a1__tar.gz

breezeway-0.0.1a1/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Anthony DeGarimore
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

breezeway-0.0.1a1/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.3
+Name: breezeway
+Version: 0.0.1a1
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: httpx (>=0.28.1,<0.29.0)

breezeway-0.0.1a1/breezeway/__init__.py

@@ -0,0 +1,9 @@
+from .breezeway_client import BreezewayClient, AsyncBreezewayClient
+from .models.company import Department
+
+__all__ = ['BreezewayClient', 'AsyncBreezewayClient']
+
+# Package metadata
+__author__ = 'Anthony DeGarimore'
+__email__ = 'Anthony@DeGarimore.com'
+__licence__ = 'MIT'

breezeway-0.0.1a1/breezeway/breezeway_client.py

@@ -0,0 +1,80 @@
+from abc import ABC, abstractmethod
+from os import getenv
+from typing import List, Optional
+
+import httpx
+
+from .models.auth import JWTAuth
+from .models.company import Company, Subdepartment, Template
+
+
+class BaseBreezewayClient(ABC):
+    HEADERS = {'accept': 'application/json'}
+
+    def __init__(self, client_id: str, client_secret: str, base_url: str, company_id: Optional[int] = None):
+        base_url = base_url or 'https://api.breezeway.io'
+        client_id = client_id or getenv('BREEZEWAY_CLIENT_ID')
+        client_secret = client_secret or getenv('BREEZEWAY_CLIENT_SECRET')
+        if not client_id or not client_secret:
+            raise ValueError('client_id and client_secret are required either as parameters or environment variables '
+                             'BREEZEWAY_CLIENT_ID and BREEZEWAY_CLIENT_SECRET')
+        self.base_url: str = base_url.rstrip('/')
+        self._company_id: Optional[int] = int(company_id) if company_id else company_id
+        self.auth: httpx.Auth = JWTAuth(self.base_url, client_id, client_secret)
+
+    @abstractmethod
+    def _request(self, method: str, endpoint: str, payload: dict = None) -> dict:
+        pass
+
+    @property
+    def company_id(self) -> int:
+        if self._company_id:
+            return self._company_id
+        companies = self.companies()
+        if not companies:
+            raise RuntimeError('No companies found')
+        elif len(companies) > 1:
+            raise RuntimeError('Multiple companies found. '
+                               'You must specify a company id when initializing the client')
+        self._company_id = companies[0].id
+        return self._company_id
+
+    @company_id.setter
+    def company_id(self, value: int):
+        self._company_id = value
+
+    def companies(self) -> List[Company]:
+        endpoint = '/public/inventory/v1/companies'
+        return [Company.from_json(company) for company in self._request('GET', endpoint)]
+
+    def templates(self) -> List[Template]:
+        endpoint = 'public/inventory/v1/companies/templates'
+        payload = {'company_id': self.company_id}
+        return [Template.from_json(template) for template in self._request('GET', endpoint, payload)]
+
+    def subdepartments(self) -> List[Subdepartment]:
+        endpoint = 'public/inventory/v1/companies/subdepartments'
+        payload = {'company_id': self.company_id}
+        return [Subdepartment.from_json(subdepartment) for subdepartment in self._request('GET', endpoint, payload)]
+
+
+class BreezewayClient(BaseBreezewayClient):
+    def __init__(self, client_id=None, client_secret=None, base_url=None, company_id: Optional[int] = None):
+        super().__init__(client_id, client_secret, base_url, company_id)
+        self.client = httpx.Client(auth=self.auth, base_url=self.base_url, headers=self.HEADERS)
+
+    def _request(self, method: str, endpoint: str, payload: dict = None) -> dict:
+        resp = self.client.request(method, endpoint, json=payload)
+        resp.read()
+        return resp.json()
+
+
+class AsyncBreezewayClient(BaseBreezewayClient):
+    def __init__(self, client_id=None, client_secret=None, base_url=None, company_id: Optional[int] = None):
+        super().__init__(client_id, client_secret, base_url, company_id)
+        self.client = httpx.AsyncClient(auth=self.auth, base_url=self.base_url, headers=self.HEADERS)
+
+    async def _request(self, method: str, endpoint: str, payload: dict = None) -> dict:
+        resp = await self.client.request(method, endpoint, json=payload)
+        await resp.aread()
+        return resp.json()

breezeway-0.0.1a1/breezeway/models/auth.py

@@ -0,0 +1,67 @@
+import logging
+import time
+import typing
+
+import httpx
+from httpx import Request, Response
+
+
+class JWTAuth(httpx.Auth):
+    HEADERS = {'accept': 'application/json'}
+
+    def __init__(self, base_url: str, client_id: str, client_secret: str):
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.base_url = base_url
+        self._access_token = None
+        self._refresh_token = None
+        self._token_expires_at = 0
+
+    def build_authentication_request(self) -> httpx.Request:
+        url = self.base_url + '/public/auth/v1/'
+        payload = {
+            'client_id': self.client_id,
+            'client_secret': self.client_secret
+        }
+        return httpx.Request("POST", url, headers=self.HEADERS, json=payload)
+
+    def build_refresh_token_request(self) -> httpx.Request:
+        url = self.base_url + '/public/auth/v1/refresh'
+        headers = self.HEADERS | {'authorization': f'JWT {self._refresh_token}'}
+        return httpx.Request("POST", url, headers=headers)
+
+    def _update_tokens(self, response: httpx.Response):
+        response.raise_for_status()
+        body = response.json()
+        if not body or 'error' in body:
+            logging.error(f"Authentication failed\n\t{body['error'] if 'error' in body else body}")
+            raise RuntimeError('Authentication failed')
+        self._token_expires_at = time.time() + 86400
+        self._access_token = body['access_token']
+        self._refresh_token = body['refresh_token']
+
+    def sync_auth_flow(self, request: Request) -> typing.Generator[Request, Response, None]:
+        if self._token_expires_at < time.time():  # if token is expired
+            if self._refresh_token:
+                response = yield self.build_refresh_token_request()
+                response.read()
+                self._update_tokens(response)
+            else:
+                response = yield self.build_authentication_request()
+                response.read()
+                self._update_tokens(response)
+        request.headers['authorization'] = f'JWT {self._access_token}'
+        yield request
+
+    async def async_auth_flow(self, request: Request) -> typing.AsyncGenerator[Request, Response]:
+        if self._token_expires_at < time.time():  # if token is expired
+            if self._refresh_token:
+                response = yield self.build_refresh_token_request()
+                await response.aread()
+                self._update_tokens(response)
+            else:
+                response = yield self.build_authentication_request()
+                await response.aread()
+                self._update_tokens(response)
+        request.headers['authorization'] = f'JWT {self._access_token}'
+        yield request

breezeway-0.0.1a1/breezeway/models/base.py

@@ -0,0 +1,26 @@
+import json
+import logging
+from dataclasses import fields
+from typing import Type, TypeVar
+
+T = TypeVar('T', bound='BaseBreezewayModel')
+
+
+class BaseBreezewayModel:
+
+    @classmethod
+    def from_json(cls: Type[T], json_data: str | dict) -> T:
+        if isinstance(json_data, str):
+            json_data = json.loads(json_data)
+        field_names = {field.name for field in fields(cls)}
+        extra_keys = set(json_data.keys()) - field_names
+        if extra_keys:
+            logging.warning(f'Ignoring extra JSON values in {str(T)}: {extra_keys}')
+        filtered_data = {k: v for k, v in json_data.items() if k in field_names}
+        instance = cls(**filtered_data)
+        instance.convert_data_types()  # Call method to convert data types after JSON import
+        return instance
+
+    def convert_data_types(self):
+        """Method to convert data types after JSON import as needed. Add your implementation here."""
+        pass

breezeway-0.0.1a1/breezeway/models/company.py

@@ -0,0 +1,42 @@
+from dataclasses import dataclass
+from enum import Enum
+
+from breezeway.models.base import BaseBreezewayModel
+
+
+class Department(Enum):
+    HOUSEKEEPING = 'housekeeping'
+    INSPECTION = 'inspection'
+    MAINTENANCE = 'maintenance'
+
+    @property
+    def name(self) -> str:
+        return {
+            Department.HOUSEKEEPING: 'Cleaning',
+            Department.INSPECTION: 'Inspection',
+            Department.MAINTENANCE: 'Maintenance'
+        }[self]
+
+
+@dataclass
+class Company(BaseBreezewayModel):
+    id: int
+    name: str
+    reference_company_id: str | None = None
+
+
+@dataclass
+class Subdepartment(BaseBreezewayModel):
+    id: int
+    name: str
+
+
+@dataclass
+class Template(BaseBreezewayModel):
+    id: int
+    name: str
+    department: Department
+
+    def convert_data_types(self):
+        if not isinstance(self.department, Department):
+            self.department = Department(self.department)

breezeway-0.0.1a1/pyproject.toml

@@ -0,0 +1,10 @@
+[tool.poetry]
+name = "breezeway"
+version = "0.0.1a1"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = "^0.28.1"
+
+[build-system]
+requires = ["poetry-core"]