forked from GetStream/stream-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient.py
More file actions
294 lines (246 loc) · 10.4 KB
/
client.py
File metadata and controls
294 lines (246 loc) · 10.4 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
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
from datetime import datetime
import json
import logging
import os
from httpsig.requests_auth import HTTPSignatureAuth
import jwt
import requests
from requests.adapters import HTTPAdapter
from stream import exceptions, serializer
from stream.signing import sign
from stream.utils import validate_feed_slug, validate_user_id
from requests import Request
logger = logging.getLogger(__name__)
class StreamClient(object):
base_url = 'https://api.stream-io-api.com/api/'
def __init__(self, api_key, api_secret, app_id, version='v1.0', timeout=6.0, base_url=None, location=None):
'''
Initialize the client with the given api key and secret
:param api_key: the api key
:param api_secret: the api secret
:param app_id: the app id
**Example usage**::
import stream
# initialize the client
client = stream.connect('key', 'secret')
# get a feed object
feed = client.feed('aggregated:1')
# write data to the feed
activity_data = {'actor': 1, 'verb': 'tweet', 'object': 1}
activity_id = feed.add_activity(activity_data)['id']
activities = feed.get()
feed.follow('flat:3')
activities = feed.get()
feed.unfollow('flat:3')
feed.remove_activity(activity_id)
'''
self.api_key = api_key
self.api_secret = api_secret
self.app_id = app_id
self.version = version
self.timeout = timeout
self.location = location
if os.environ.get('LOCAL'):
self.base_url = 'http://localhost:8000/api/'
self.timeout = 20
elif base_url is not None:
self.base_url = base_url
elif location is not None:
self.base_url = 'https://%s-api.stream-io-api.com/api/' % location
self.base_analytics_url = 'https://analytics.stream-io-api.com/analytics/'
self.session = requests.Session()
# TODO: turn this back on after we verify it doesnt retry on slower requests
self.session.mount(self.base_url, HTTPAdapter(max_retries=0))
self.auth = HTTPSignatureAuth(api_key, secret=api_secret)
def feed(self, feed_slug, user_id):
'''
Returns a Feed object
:param feed_slug: the slug of the feed
:param user_id: the user id
'''
from stream.feed import Feed
feed_slug = validate_feed_slug(feed_slug)
user_id = validate_user_id(user_id)
# generate the token
feed_id = '%s%s' % (feed_slug, user_id)
token = sign(self.api_secret, feed_id)
return Feed(self, feed_slug, user_id, token)
def get_default_params(self):
'''
Returns the params with the API key present
'''
params = dict(api_key=self.api_key)
return params
def get_default_header(self):
base_headers = {
'Content-type': 'application/json',
'X-Stream-Client': self.get_user_agent()
}
return base_headers
def get_full_url(self, relative_url):
url = self.base_url + self.version + '/' + relative_url
return url
def get_user_agent(self):
from stream import __version__
agent = 'stream-python-client-%s' % __version__
return agent
def _parse_response(self, response):
try:
parsed_result = serializer.loads(response.text)
except ValueError:
parsed_result = None
if parsed_result is None or parsed_result.get('exception') or response.status_code >= 500:
self.raise_exception(parsed_result, status_code=response.status_code)
return parsed_result
def _make_signed_request(self, method_name, relative_url, params=None, data=None):
params = params or {}
data = data or {}
serialized = None
headers = self.get_default_header()
headers['X-Api-Key'] = self.api_key
date_header = datetime.utcnow().strftime('%a, %d %b %Y %H:%M:%S GMT')
headers['Date'] = date_header
default_params = self.get_default_params()
default_params.update(params)
url = self.get_full_url(relative_url)
serialized = serializer.dumps(data)
method = getattr(self.session, method_name)
if method_name in ['post', 'put']:
serialized = serializer.dumps(data)
response = method(url, auth=self.auth, data=serialized, headers=headers,
params=default_params, timeout=self.timeout)
logger.debug('stream api call %s, headers %s data %s',
response.url, headers, data)
return self._parse_response(response)
def create_jwt_token(self, resource, action, feed_id=None, user_id=None):
'''
Setup the payload for the given resource, action, feed or user
and encode it using jwt
'''
payload = {
'action': action,
'resource': resource
}
if feed_id is not None:
payload['feed_id'] = feed_id
if user_id is not None:
payload['user_id'] = user_id
return jwt.encode(payload, self.api_secret).decode("utf-8")
def _make_request(self, method, relative_url, signature, params=None, data=None):
params = params or {}
data = data or {}
serialized = None
default_params = self.get_default_params()
default_params.update(params)
headers = self.get_default_header()
headers['Authorization'] = signature
headers['stream-auth-type'] = 'jwt'
url = self.get_full_url(relative_url)
if method.__name__ in ['post', 'put']:
serialized = serializer.dumps(data)
response = method(url, data=serialized, headers=headers,
params=default_params, timeout=self.timeout)
logger.debug('stream api call %s, headers %s data %s',
response.url, headers, data)
return self._parse_response(response)
def raise_exception(self, result, status_code):
'''
Map the exception code to an exception class and raise it
If result.exception and result.detail are available use that
Otherwise just raise a generic error
'''
from stream.exceptions import get_exception_dict
exception_class = exceptions.StreamApiException
def errors_from_fields(exception_fields):
result = []
if not isinstance(exception_fields, dict):
return exception_fields
for field, errors in exception_fields.items():
result.append('Field "%s" errors: %s' % (field, repr(errors)))
return result
if result is not None:
error_message = result['detail']
exception_fields = result.get('exception_fields')
if exception_fields is not None:
errors = []
if isinstance(exception_fields, list):
errors = [errors_from_fields(exception_dict) for exception_dict in exception_fields]
errors = [item for sublist in errors for item in sublist]
else:
errors = errors_from_fields(exception_fields)
error_message = '\n'.join(errors)
error_code = result.get('code')
exception_dict = get_exception_dict()
exception_class = exception_dict.get(
error_code, exceptions.StreamApiException)
else:
error_message = 'GetStreamAPI%s' % status_code
exception = exception_class(error_message, status_code=status_code)
raise exception
def post(self, *args, **kwargs):
'''
Shortcut for make request
'''
return self._make_request(self.session.post, *args, **kwargs)
def get(self, *args, **kwargs):
'''
Shortcut for make request
'''
return self._make_request(self.session.get, *args, **kwargs)
def delete(self, *args, **kwargs):
'''
Shortcut for make request
'''
return self._make_request(self.session.delete, *args, **kwargs)
def add_to_many(self, activity, feeds):
'''
Adds an activity to many feeds
:param activity: the activity data
:param feeds: the list of follows (eg. ['feed:1', 'feed:2'])
'''
data = {'activity': activity, 'feeds': feeds}
self._make_signed_request('post', 'feed/add_to_many/', data=data)
def follow_many(self, follows, activity_copy_limit=None):
'''
Creates many follows
:param follows: the list of follow relations
eg. [{'source': source, 'target': target}]
'''
params = None
if activity_copy_limit != None:
params = dict(activity_copy_limit=activity_copy_limit)
self._make_signed_request('post', 'follow_many/', params=params, data=follows)
def update_activities(self, activities):
'''
Update or create activities
'''
if not isinstance(activities, (list, tuple, set)):
raise TypeError('Activities parameter should be of type list')
auth_token = self.create_jwt_token('activities', '*', feed_id='*')
data = dict(activities=activities)
return self.post('activities/', auth_token, data=data)
def update_activity(self, activity):
'''
Update a single activity
'''
return self.update_activities([activity])
def create_redirect_url(self, target_url, user_id, events):
'''
Creates a redirect url for tracking the given events in the context
of an email using Stream's analytics platform. Learn more at
getstream.io/personalization
'''
# generate the JWT token
auth_token = self.create_jwt_token('redirect_and_track', '*', user_id=user_id)
# setup the params
params = dict(auth_type='jwt', authorization=auth_token, url=target_url)
params['api_key'] = self.api_key
params['events'] = json.dumps(events)
url = self.base_analytics_url + 'redirect/'
# we get the url from the prepare request, this skips issues with
# python's urlencode implementation
request = Request('GET', url, params=params)
prepared_request = request.prepare()
# validate the target url is valid
Request('GET', target_url).prepare()
return prepared_request.url