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
|
from collections import OrderedDict
import requests
from django.core.exceptions import ValidationError
from django.conf import settings
from django.core import serializers
from django.core.serializers.json import DjangoJSONEncoder
from django.db import models
try:
# Django <= 1.6 backwards compatibility
from django.utils import simplejson as json
except ImportError:
# Django >= 1.7
import json
from rest_hooks.utils import get_module, find_and_fire_hook, distill_model_event
from rest_hooks import signals
HOOK_EVENTS = getattr(settings, 'HOOK_EVENTS', None)
if HOOK_EVENTS is None:
raise Exception('You need to define settings.HOOK_EVENTS!')
if getattr(settings, 'HOOK_THREADING', True):
from rest_hooks.client import Client
client = Client()
else:
client = requests.Session()
AUTH_USER_MODEL = getattr(settings, 'AUTH_USER_MODEL', 'auth.User')
class AbstractHook(models.Model):
"""
Stores a representation of a Hook.
"""
created = models.DateTimeField(auto_now_add=True)
updated = models.DateTimeField(auto_now=True)
user = models.ForeignKey(AUTH_USER_MODEL, related_name='%(class)ss', on_delete=models.CASCADE)
event = models.CharField('Event', max_length=64, db_index=True)
target = models.URLField('Target URL', max_length=255)
class Meta:
abstract = True
def clean(self):
""" Validation for events. """
if self.event not in HOOK_EVENTS.keys():
raise ValidationError(
"Invalid hook event {evt}.".format(evt=self.event)
)
def dict(self):
return {
'id': self.id,
'event': self.event,
'target': self.target
}
def serialize_hook(self, instance):
"""
Serialize the object down to Python primitives.
By default it uses Django's built in serializer.
"""
if getattr(instance, 'serialize_hook', None) and callable(instance.serialize_hook):
return instance.serialize_hook(hook=self)
if getattr(settings, 'HOOK_SERIALIZER', None):
serializer = get_module(settings.HOOK_SERIALIZER)
return serializer(instance, hook=self)
# if no user defined serializers, fallback to the django builtin!
data = serializers.serialize('python', [instance])[0]
for k, v in data.items():
if isinstance(v, OrderedDict):
data[k] = dict(v)
if isinstance(data, OrderedDict):
data = dict(data)
return {
'hook': self.dict(),
'data': data,
}
def deliver_hook(self, instance, payload_override=None):
"""
Deliver the payload to the target URL.
By default it serializes to JSON and POSTs.
"""
payload = payload_override or self.serialize_hook(instance)
if getattr(settings, 'HOOK_DELIVERER', None):
deliverer = get_module(settings.HOOK_DELIVERER)
deliverer(self.target, payload, instance=instance, hook=self)
else:
client.post(
url=self.target,
data=json.dumps(payload, cls=DjangoJSONEncoder),
headers={'Content-Type': 'application/json'}
)
signals.hook_sent_event.send_robust(sender=self.__class__, payload=payload, instance=instance, hook=self)
return None
def __unicode__(self):
return u'{} => {}'.format(self.event, self.target)
class Hook(AbstractHook):
pass
##############
### EVENTS ###
##############
from django.db.models.signals import post_save, post_delete
from django.dispatch import receiver
from rest_hooks.signals import hook_event, raw_hook_event
get_opts = lambda m: m._meta.concrete_model._meta
@receiver(post_save, dispatch_uid='instance-saved-hook')
def model_saved(sender, instance,
created,
raw,
using,
**kwargs):
"""
Automatically triggers "created" and "updated" actions.
"""
opts = get_opts(instance)
model = '.'.join([opts.app_label, opts.object_name])
action = 'created' if created else 'updated'
distill_model_event(instance, model, action)
@receiver(post_delete, dispatch_uid='instance-deleted-hook')
def model_deleted(sender, instance,
using,
**kwargs):
"""
Automatically triggers "deleted" actions.
"""
opts = get_opts(instance)
model = '.'.join([opts.app_label, opts.object_name])
distill_model_event(instance, model, 'deleted')
@receiver(hook_event, dispatch_uid='instance-custom-hook')
def custom_action(sender, action,
instance,
user=None,
**kwargs):
"""
Manually trigger a custom action (or even a standard action).
"""
opts = get_opts(instance)
model = '.'.join([opts.app_label, opts.object_name])
distill_model_event(instance, model, action, user_override=user)
@receiver(raw_hook_event, dispatch_uid='raw-custom-hook')
def raw_custom_event(sender, event_name,
payload,
user,
send_hook_meta=True,
instance=None,
**kwargs):
"""
Give a full payload
"""
hooks = Hook.objects.filter(user=user, event=event_name)
for hook in hooks:
new_payload = payload
if send_hook_meta:
new_payload = {
'hook': hook.dict(),
'data': payload
}
hook.deliver_hook(instance, payload_override=new_payload)
|
