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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# 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.
import typing as ty
import uuid
from openstack import resource
class Message(resource.Resource):
# FIXME(anyone): The name string of `location` field of Zaqar API response
# is lower case. That is inconsistent with the guide from API-WG. This is
# a workaround for this issue.
location = resource.Header("location")
resources_key = 'messages'
base_path = '/queues/%(queue_name)s/messages'
# capabilities
allow_create = True
allow_list = True
allow_fetch = True
allow_delete = True
_query_mapping = resource.QueryParameters("echo", "include_claimed")
# Properties
#: The value in second to specify how long the message has been
#: posted to the queue.
age = resource.Body("age")
#: A dictionary specifies an arbitrary document that constitutes the
#: body of the message being sent.
body = resource.Body("body")
#: An uri string describe the location of the message resource.
href = resource.Body("href")
#: The value in seconds to specify how long the server waits before
#: marking the message as expired and removing it from the queue.
ttl = resource.Body("ttl")
#: The name of target queue message is post to or got from.
queue_name = resource.URI("queue_name")
#: The ID to identify the client accessing Zaqar API. Must be specified
#: in header for each API request.
client_id = resource.Header("Client-ID")
#: The ID to identify the project accessing Zaqar API. Must be specified
#: in case keystone auth is not enabled in Zaqar service.
project_id = resource.Header("X-PROJECT-ID")
# FIXME(stephenfin): This is actually a query arg but we need it for
# deletions and resource.delete doesn't respect these currently
claim_id: ty.Optional[str] = None
def post(self, session, messages):
request = self._prepare_request(requires_id=False, prepend_key=True)
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
request.body = {'messages': messages}
response = session.post(
request.url, json=request.body, headers=request.headers
)
return response.json()['resources']
@classmethod
def list(cls, session, paginated=True, base_path=None, **params):
"""This method is a generator which yields message objects.
This is almost the copy of list method of resource.Resource class.
The only difference is the request header now includes `Client-ID`
and `X-PROJECT-ID` fields which are required by Zaqar v2 API.
"""
more_data = True
if base_path is None:
base_path = cls.base_path
uri = base_path % params
headers = {
"Client-ID": params.get('client_id', None) or str(uuid.uuid4()),
"X-PROJECT-ID": params.get('project_id', None)
or session.get_project_id(),
}
query_params = cls._query_mapping._transpose(params, cls)
while more_data:
resp = session.get(uri, headers=headers, params=query_params)
resp = resp.json()
resp = resp[cls.resources_key]
if not resp:
more_data = False
yielded = 0
new_marker = None
for data in resp:
value = cls.existing(**data)
new_marker = value.id
yielded += 1
yield value
if not paginated:
return
if "limit" in query_params and yielded < query_params["limit"]:
return
query_params["limit"] = yielded
query_params["marker"] = new_marker
def fetch(
self,
session,
requires_id=True,
base_path=None,
error_message=None,
skip_cache=False,
**kwargs,
):
request = self._prepare_request(
requires_id=requires_id, base_path=base_path
)
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
response = session.get(
request.url, headers=headers, skip_cache=skip_cache
)
self._translate_response(response)
return self
def delete(
self, session, error_message=None, *, microversion=None, **kwargs
):
request = self._prepare_request()
headers = {
"Client-ID": self.client_id or str(uuid.uuid4()),
"X-PROJECT-ID": self.project_id or session.get_project_id(),
}
request.headers.update(headers)
# For Zaqar v2 API requires client to specify claim_id as query
# parameter when deleting a message that has been claimed, we
# rebuild the request URI if claim_id is not None.
if self.claim_id:
request.url += f'?claim_id={self.claim_id}'
response = session.delete(request.url, headers=headers)
self._translate_response(response, has_body=False)
return self
|
