forked from Botts-Innovative-Research/OSHConnect-Python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcon_sys_api.py
More file actions
105 lines (84 loc) · 3.42 KB
/
con_sys_api.py
File metadata and controls
105 lines (84 loc) · 3.42 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
from typing import Union
from pydantic import BaseModel, HttpUrl, Field
from .endpoints import Endpoint
from .request_wrappers import post_request, put_request, get_request, delete_request
class ConnectedSystemAPIRequest(BaseModel):
url: HttpUrl = Field(None)
body: Union[dict, str] = Field(None)
params: dict = Field(None)
request_method: str = Field('GET')
headers: dict = Field(None)
auth: Union[tuple, None] = Field(None)
def make_request(self):
match self.request_method:
case 'GET':
return get_request(self.url, self.params, self.headers, self.auth)
case 'POST':
print(f'POST request: {self}')
return post_request(self.url, self.body, self.headers, self.auth)
case 'PUT':
print(f'PUT request: {self}')
return put_request(self.url, self.body, self.headers, self.auth)
case 'DELETE':
print(f'DELETE request: {self}')
return delete_request(self.url, self.params, self.headers, self.auth)
case _:
raise ValueError('Invalid request method')
class ConnectedSystemsRequestBuilder(BaseModel):
api_request: ConnectedSystemAPIRequest = Field(default_factory=ConnectedSystemAPIRequest)
base_url: HttpUrl = None
endpoint: Endpoint = Field(default_factory=Endpoint)
def with_api_url(self, url: HttpUrl):
self.api_request.url = url
return self
def with_server_url(self, server_url: HttpUrl):
self.base_url = server_url
return self
def build_url_from_base(self):
"""
Builds the full API endpoint URL from the base URL and the endpoint parameters that have been previously
provided.
"""
self.api_request.url = f'{self.base_url}/{self.endpoint.create_endpoint()}'
return self
def with_api_root(self, api_root: str):
"""
Optional: Set the API root for the request. This is useful if you want to use a different API root than the
default one (api).
:param api_root:
:return:
"""
self.endpoint.api_root = api_root
return self
def for_resource_type(self, resource_type: str):
self.endpoint.base_resource = resource_type
return self
def with_resource_id(self, resource_id: str):
self.endpoint.resource_id = resource_id
return self
def for_sub_resource_type(self, sub_resource_type: str):
self.endpoint.sub_component = sub_resource_type
return self
def with_secondary_resource_id(self, resource_id: str):
self.endpoint.secondary_resource_id = resource_id
return self
def with_request_body(self, request_body: str):
self.api_request.body = request_body
return self
def with_request_method(self, request_method: str):
self.api_request.request_method = request_method
return self
def with_headers(self, headers: dict = None):
# TODO: ensure headers can default if excluded
self.api_request.headers = headers
return self
def with_auth(self, uname: str, pword: str):
self.api_request.auth = (uname, pword)
return self
def build(self):
# convert endpoint to HttpUrl
return self.api_request
def reset(self):
self.api_request = ConnectedSystemAPIRequest()
self.endpoint = Endpoint()
return self