add django restframework serializer for activities

[tbarbugli]

right now serializing enriched data is very complex and requires lot of knowledge of how DRF works (and probably some smart tricks to support nested data / dynamic model serialization).

We should write a basic serializer class to make this easier and write a few example for aggregated/notification and simple activity serialization.

eg.

"is_seen": false,
"is_read": false,
"group": "19931_2016-04-04",
"created_at": "2016-04-04T08:53:42.601",
"updated_at": "2016-04-04T11:33:26.140",
"id": "0bc8c85a-fa59-11e5-8080-800005683205",
"verb": "message",
"activities": [
    {
    "origin": null,
    "verb": "message",
    "time": "2016-04-04T11:33:26.140",
    "id": "0bc8c85a-fa59-11e5-8080-800005683205",
    "foreign_id": "chat.Message:6",
    "target": null,
    "to": [
    "notification:1"
    ],
"actor": "auth.User:1",
"object": "chat.Message:6"
}

[RubenSchmidt]

I solved it by doing the following:

property tag that returns the serializer class

@property
def activity_object_serializer_class(self):
    from .serializers import FooSerializer
    return FooSerializer

Then used this to serialize the enriched activities. Supports nesting.

@staticmethod
def get_serialized_object_or_str(obj):
        if hasattr(obj, 'activity_object_serializer_class'):
            obj = obj.activity_object_serializer_class(obj).data
        else:
            obj = str(obj)  # Could also raise exception here
        return obj

def serialize_activities(self, activities):
    for activity in activities:
        for a in activity['activities']:
            a['object'] = self.get_serialized_object_or_str(a['object'])
            # The actor is always a auth.User in our case
            a['actor'] = UserSerializer(a['actor']).data
    return activities

Don't know if you can use any of this but i thought i should post it anyway.

Thank you for a great service!

[X17]

@RubenSchmidt Hey does it work for aggregated feed?

I'd be very interested in any developments with this enhancement. I've already built out my rest API with DRF and was having a hard time integrating it with stream. Looking forward to any updates! Thanks!

[RubenSchmidt]

@X17 I am currently only using it for aggregated feed. I am actually not sure if it works properly with the other feeds.

[murdav]

Is there any news on this issue?

[aarcro]

Take a look at my PR: #67

[morenoh149]

bumping this. I'm currently trying to power inapp notifications with getstream and django-rest-framework. Any example of this would be very appreciated. Also if I can help in anyway please let me know!

[pterk]

Sorry, never got round to finishing this up but I did some experiments, maybe it will help?:

https://github.com/pterk/django_twitter/blob/master/stream_twitter/serializers.py
https://github.com/pterk/django_twitter/blob/master/stream_twitter/views.py#L141

[morenoh149]

I've made an so question and minimal drf api to try to solve this https://stackoverflow.com/questions/56435643/django-rest-framework-getstream-notifications

https://github.com/morenoh149/django-rest-framework-getstream

if anyone has ideas please let me know @pterk @aarcro @RubenSchmidt @tbarbugli