-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathincentives.py
More file actions
363 lines (298 loc) · 12.7 KB
/
incentives.py
File metadata and controls
363 lines (298 loc) · 12.7 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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
import json
from syncano.exceptions import SyncanoValidationError
from . import fields
from .base import Model
from .instances import Instance
from .manager import ScriptEndpointManager, ScriptManager
from .mixins import RenameMixin
class RuntimeChoices(object):
"""
Store available Script runtimes;
"""
PYTHON = 'python'
PYTHON_V4_2 = 'python_library_v4.2' # python old library;
PYTHON_V5_0 = 'python_library_v5.0' # python >5.0 library not backward compatible;
NODEJS = 'nodejs'
NODEJS_V0_4 = 'nodejs_library_v0.4' # nodejs old library;
NODEJS_V1_0 = 'nodejs_library_v1.0' # nodejs >1.0 library, not backward compatible;
GOLANG = 'golang'
SWIFT = 'swift'
PHP = 'php'
RUBY = 'ruby'
class Script(Model):
"""
OO wrapper around scripts `link <http://docs.syncano.com/docs/snippets-scripts>`_.
:ivar label: :class:`~syncano.models.fields.StringField`
:ivar description: :class:`~syncano.models.fields.StringField`
:ivar source: :class:`~syncano.models.fields.StringField`
:ivar runtime_name: :class:`~syncano.models.fields.ChoiceField`
:ivar config: :class:`~syncano.models.fields.Field`
:ivar links: :class:`~syncano.models.fields.HyperlinkedField`
:ivar created_at: :class:`~syncano.models.fields.DateTimeField`
:ivar updated_at: :class:`~syncano.models.fields.DateTimeField`
.. note::
**Script** has special method called ``run`` which will execute attached source code::
>>> Script.please.run('instance-name', 1234)
>>> Script.please.run('instance-name', 1234, payload={'variable_one': 1, 'variable_two': 2})
>>> Script.please.run('instance-name', 1234, payload='{"variable_one": 1, "variable_two": 2}')
or via instance::
>>> s = Script.please.get('instance-name', 1234)
>>> s.run()
>>> s.run(variable_one=1, variable_two=2)
"""
label = fields.StringField(max_length=80, required=False)
description = fields.StringField(required=False)
source = fields.StringField()
runtime_name = fields.StringField()
config = fields.JSONField(required=False)
links = fields.LinksField()
created_at = fields.DateTimeField(read_only=True, required=False)
updated_at = fields.DateTimeField(read_only=True, required=False)
traces = fields.RelatedManagerField('ScriptTrace')
please = ScriptManager()
class Meta:
parent = Instance
name = 'Script'
plural_name = 'Scripts'
endpoints = {
'detail': {
'methods': ['put', 'get', 'patch', 'delete'],
'path': '/snippets/scripts/{id}/',
},
'list': {
'methods': ['post', 'get'],
'path': '/snippets/scripts/',
},
'run': {
'methods': ['post'],
'path': '/snippets/scripts/{id}/run/',
},
}
def run(self, **payload):
"""
Usage::
>>> s = Script.please.get('instance-name', 1234)
>>> s.run()
>>> s.run(variable_one=1, variable_two=2)
"""
from .traces import ScriptTrace
if self.is_new():
raise SyncanoValidationError('Method allowed only on existing model.')
properties = self.get_endpoint_data()
http_method = 'POST'
endpoint = self._meta.resolve_endpoint('run', properties, http_method)
connection = self._get_connection(**payload)
request = {
'data': {
'payload': json.dumps(payload)
}
}
response = connection.request(http_method, endpoint, **request)
response.update({'instance_name': self.instance_name, 'script_id': self.id})
return ScriptTrace(**response)
class Schedule(Model):
"""
OO wrapper around script schedules `link <http://docs.syncano.com/docs/schedules>`_.
:ivar label: :class:`~syncano.models.fields.StringField`
:ivar script: :class:`~syncano.models.fields.IntegerField`
:ivar interval_sec: :class:`~syncano.models.fields.IntegerField`
:ivar crontab: :class:`~syncano.models.fields.StringField`
:ivar payload: :class:`~syncano.models.fields.HyperliStringFieldnkedField`
:ivar created_at: :class:`~syncano.models.fields.DateTimeField`
:ivar scheduled_next: :class:`~syncano.models.fields.DateTimeField`
:ivar links: :class:`~syncano.models.fields.HyperlinkedField`
"""
label = fields.StringField(max_length=80)
script = fields.IntegerField(label='script id')
interval_sec = fields.IntegerField(read_only=False, required=False)
crontab = fields.StringField(max_length=40, required=False)
payload = fields.StringField(required=False)
timezone = fields.StringField(required=False)
created_at = fields.DateTimeField(read_only=True, required=False)
scheduled_next = fields.DateTimeField(read_only=True, required=False)
links = fields.LinksField()
traces = fields.RelatedManagerField('ScheduleTraces')
class Meta:
parent = Instance
endpoints = {
'detail': {
'methods': ['put', 'get', 'patch', 'delete'],
'path': '/schedules/{id}/',
},
'list': {
'methods': ['post', 'get'],
'path': '/schedules/',
}
}
class Trigger(Model):
"""
OO wrapper around triggers `link <http://docs.syncano.com/docs/triggers>`_.
:ivar label: :class:`~syncano.models.fields.StringField`
:ivar script: :class:`~syncano.models.fields.IntegerField`
:ivar class_name: :class:`~syncano.models.fields.StringField`
:ivar signal: :class:`~syncano.models.fields.ChoiceField`
:ivar links: :class:`~syncano.models.fields.HyperlinkedField`
:ivar created_at: :class:`~syncano.models.fields.DateTimeField`
:ivar updated_at: :class:`~syncano.models.fields.DateTimeField`
"""
SIGNAL_CHOICES = (
{'display_name': 'post_update', 'value': 'post_update'},
{'display_name': 'post_create', 'value': 'post_create'},
{'display_name': 'post_delete', 'value': 'post_delete'},
)
label = fields.StringField(max_length=80)
script = fields.IntegerField(label='script id')
class_name = fields.StringField(label='class name', mapping='class')
signal = fields.ChoiceField(choices=SIGNAL_CHOICES)
links = fields.LinksField()
created_at = fields.DateTimeField(read_only=True, required=False)
updated_at = fields.DateTimeField(read_only=True, required=False)
traces = fields.RelatedManagerField('TriggerTrace')
class Meta:
parent = Instance
endpoints = {
'detail': {
'methods': ['put', 'get', 'patch', 'delete'],
'path': '/triggers/{id}/',
},
'list': {
'methods': ['post', 'get'],
'path': '/triggers/',
}
}
class ScriptEndpoint(Model):
"""
OO wrapper around script endpoints `link <http://docs.syncano.com/docs/codebox-sockets>`_.
:ivar name: :class:`~syncano.models.fields.SlugField`
:ivar script: :class:`~syncano.models.fields.IntegerField`
:ivar links: :class:`~syncano.models.fields.HyperlinkedField`
.. note::
**ScriptEndpoint** has special method called ``run`` which will execute related script::
>>> ScriptEndpoint.please.run('instance-name', 'script-name')
>>> ScriptEndpoint.please.run('instance-name', 'script-name', payload={'variable_one': 1,
'variable_two': 2})
>>> ScriptEndpoint.please.run('instance-name', 'script-name',
payload="{\"variable_one\": 1, \"variable_two\": 2}")
or via instance::
>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.run()
>>> se.run(variable_one=1, variable_two=2)
"""
name = fields.SlugField(max_length=50, primary_key=True)
script = fields.IntegerField(label='script id')
public = fields.BooleanField(required=False, default=False)
public_link = fields.ChoiceField(required=False, read_only=True)
links = fields.LinksField()
traces = fields.RelatedManagerField('ScriptEndpointTrace')
please = ScriptEndpointManager()
class Meta:
parent = Instance
endpoints = {
'detail': {
'methods': ['put', 'get', 'patch', 'delete'],
'path': '/endpoints/scripts/{name}/',
},
'list': {
'methods': ['post', 'get'],
'path': '/endpoints/scripts/',
},
'run': {
'methods': ['post'],
'path': '/endpoints/scripts/{name}/run/',
},
'reset': {
'methods': ['post'],
'path': '/endpoints/scripts/{name}/reset_link/',
},
'public': {
'methods': ['get'],
'path': '/endpoints/scripts/p/{public_link}/{name}/',
}
}
def run(self, cache_key=None, **payload):
"""
Usage::
>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.run()
>>> se.run(variable_one=1, variable_two=2)
"""
from .traces import ScriptEndpointTrace
if self.is_new():
raise SyncanoValidationError('Method allowed only on existing model.')
properties = self.get_endpoint_data()
http_method = 'POST'
endpoint = self._meta.resolve_endpoint('run', properties, http_method)
connection = self._get_connection(**payload)
params = {}
if cache_key is not None:
params = {'cache_key': cache_key}
kwargs = {'data': payload}
if params:
kwargs.update({'params': params})
response = connection.request(http_method, endpoint, **kwargs)
if isinstance(response, dict) and 'result' in response and 'stdout' in response['result']:
response.update({'instance_name': self.instance_name,
'script_name': self.name})
return ScriptEndpointTrace(**response)
# if script is a custom one, return result 'as-it-is';
return response
def reset_link(self):
"""
Usage::
>>> se = ScriptEndpoint.please.get('instance-name', 'script-name')
>>> se.reset_link()
"""
properties = self.get_endpoint_data()
http_method = 'POST'
endpoint = self._meta.resolve_endpoint('reset', properties, http_method)
connection = self._get_connection()
response = connection.request(http_method, endpoint)
self.public_link = response['public_link']
class ResponseTemplate(RenameMixin, Model):
"""
OO wrapper around templates.
:ivar name: :class:`~syncano.models.fields.StringField`
:ivar content: :class:`~syncano.models.fields.StringField`
:ivar content_type: :class:`~syncano.models.fields.StringField`
:ivar context: :class:`~syncano.models.fields.JSONField`
:ivar links: :class:`~syncano.models.fields.HyperlinkedField`
:ivar created_at: :class:`~syncano.models.fields.DateTimeField`
:ivar updated_at: :class:`~syncano.models.fields.DateTimeField`
"""
name = fields.StringField(max_length=64)
content = fields.StringField(label='content')
content_type = fields.StringField(label='content type')
context = fields.JSONField(label='context')
links = fields.LinksField()
created_at = fields.DateTimeField(read_only=True, required=False)
updated_at = fields.DateTimeField(read_only=True, required=False)
class Meta:
parent = Instance
endpoints = {
'detail': {
'methods': ['put', 'get', 'patch', 'delete'],
'path': '/snippets/templates/{name}/',
},
'list': {
'methods': ['post', 'get'],
'path': '/snippets/templates/',
},
'render': {
'methods': ['post'],
'path': '/snippets/templates/{name}/render/',
},
}
def render(self, context=None):
context = context or {}
properties = self.get_endpoint_data()
http_method = 'POST'
endpoint = self._meta.resolve_endpoint('render', properties, http_method)
connection = self._get_connection()
return connection.request(http_method, endpoint, data={'context': context})
def rename(self, new_name):
rename_path = self.links.rename
data = {'new_name': new_name}
connection = self._get_connection()
response = connection.request('POST', rename_path, data=data)
self.to_python(response)
return self