forked from ZcashFoundation/zebra
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
A Series is an ordered list of zPages (ZcashFoundation#169)
- Loading branch information
Showing
21 changed files
with
765 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Generated by Django 3.2.12 on 2023-06-28 02:58 | ||
|
||
from django.db import migrations, models | ||
|
||
|
||
class Migration(migrations.Migration): | ||
|
||
dependencies = [ | ||
('events', '0008_alter_event_receiving_user'), | ||
] | ||
|
||
operations = [ | ||
migrations.AlterField( | ||
model_name='event', | ||
name='type', | ||
field=models.CharField(choices=[['AISCORE_COMMENT', 'AISCORE_COMMENT'], ['MADE_COMMENT', 'MADE_COMMENT'], ['NEW_REPLY', 'NEW_REPLY'], ['PAGE_UPDATE', 'PAGE_UPDATE'], ['DONATION_RECEIVED', 'DONATION_RECEIVED'], ['DONATION_SENT', 'DONATION_SENT'], ['SUBSCRIPTION_RECEIVED', 'SUBSCRIPTION_RECEIVED'], ['SUBSCRIPTION_SENT', 'SUBSCRIPTION_SENT']], max_length=32), | ||
), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Generated by Django 3.2.12 on 2023-06-28 02:58 | ||
|
||
from django.conf import settings | ||
from django.db import migrations, models | ||
import django.db.models.deletion | ||
import uuid | ||
|
||
|
||
class Migration(migrations.Migration): | ||
|
||
dependencies = [ | ||
('g12f', '0069_creator_strikes'), | ||
] | ||
|
||
operations = [ | ||
migrations.CreateModel( | ||
name='PageOrder', | ||
fields=[ | ||
('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)), | ||
('order', models.PositiveIntegerField()), | ||
('page', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='g12f.zpage')), | ||
], | ||
options={ | ||
'ordering': ['order'], | ||
}, | ||
), | ||
migrations.CreateModel( | ||
name='Series', | ||
fields=[ | ||
('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)), | ||
('name', models.CharField(max_length=200)), | ||
('slug', models.SlugField(editable=False, max_length=200)), | ||
('created_at', models.DateTimeField(auto_now_add=True)), | ||
('updated_at', models.DateTimeField(auto_now=True)), | ||
('creator', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), | ||
('pages', models.ManyToManyField(through='g12f.PageOrder', to='g12f.zPage')), | ||
], | ||
options={ | ||
'unique_together': {('slug', 'creator')}, | ||
}, | ||
), | ||
migrations.AddField( | ||
model_name='pageorder', | ||
name='series', | ||
field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='g12f.series'), | ||
), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Generated by Django 3.2.12 on 2023-06-29 07:24 | ||
|
||
from django.db import migrations | ||
|
||
|
||
class Migration(migrations.Migration): | ||
|
||
dependencies = [ | ||
('g12f', '0070_auto_20230628_0258'), | ||
] | ||
|
||
operations = [ | ||
migrations.AlterModelOptions( | ||
name='series', | ||
options={'verbose_name_plural': "Series'"}, | ||
), | ||
migrations.AlterUniqueTogether( | ||
name='series', | ||
unique_together=set(), | ||
), | ||
migrations.RemoveField( | ||
model_name='series', | ||
name='slug', | ||
), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Generated by Django 3.2.12 on 2023-07-02 00:58 | ||
|
||
from django.db import migrations, models | ||
|
||
|
||
class Migration(migrations.Migration): | ||
|
||
dependencies = [ | ||
('g12f', '0071_auto_20230629_0724'), | ||
] | ||
|
||
operations = [ | ||
migrations.AddField( | ||
model_name='creator', | ||
name='updated_at', | ||
field=models.DateTimeField(auto_now=True), | ||
), | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
""" | ||
A Series is an ordered collection of zPages. | ||
""" | ||
|
||
from django.db import models | ||
from dj.apps.g12f.models import zPage, Creator | ||
import uuid | ||
|
||
|
||
class Series(models.Model): | ||
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) | ||
name = models.CharField(max_length=200) | ||
pages = models.ManyToManyField(zPage, through='PageOrder') | ||
creator = models.ForeignKey(Creator, on_delete=models.CASCADE) | ||
created_at = models.DateTimeField(auto_now_add=True) | ||
updated_at = models.DateTimeField(auto_now=True) | ||
|
||
class Meta: | ||
verbose_name_plural = "Series'" | ||
|
||
def __str__(self): | ||
return self.name | ||
|
||
|
||
class PageOrder(models.Model): | ||
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) | ||
page = models.ForeignKey(zPage, on_delete=models.CASCADE) | ||
series = models.ForeignKey(Series, on_delete=models.CASCADE) | ||
order = models.PositiveIntegerField() | ||
|
||
class Meta: | ||
ordering = ['order'] | ||
|
||
def __str__(self): | ||
return f"{self.page} in {self.series} at position {self.order}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
from rest_framework import serializers | ||
from dj.apps.g12f.models import Series, PageOrder, zPage | ||
|
||
|
||
class zPageSerializer(serializers.ModelSerializer): | ||
class Meta: | ||
model = zPage | ||
fields = ['free2zaddr', 'title'] | ||
|
||
|
||
class PageOrderSerializer(serializers.ModelSerializer): | ||
page = zPageSerializer() | ||
|
||
class Meta: | ||
model = PageOrder | ||
fields = ['page', 'order'] | ||
|
||
def to_internal_value(self, data): | ||
# This method will convert the incoming JSON (which uses the free2zaddr) | ||
# to the Django internal Python data type (which uses the zPage instance). | ||
page_data = data.get('page') | ||
page = zPage.objects.get(free2zaddr=page_data.get('free2zaddr')) | ||
return {'page': page, 'order': data.get('order')} | ||
|
||
|
||
class SeriesEditSerializer(serializers.ModelSerializer): | ||
""" | ||
For editing the order of zPages in a Series and the name of the Series. | ||
""" | ||
pageorder_set = PageOrderSerializer(many=True) | ||
|
||
class Meta: | ||
model = Series | ||
fields = [ | ||
'id', 'name', 'pageorder_set', 'creator', | ||
'created_at', 'updated_at', | ||
] | ||
read_only_fields = [ | ||
'id', 'creator', 'created_at', 'updated_at', | ||
] | ||
|
||
def save(self, **kwargs): | ||
# Capture the incoming request object | ||
self.context['request'] = kwargs.pop('request', None) | ||
return super().save(**kwargs) | ||
|
||
def create(self, validated_data): | ||
pages_data = validated_data.pop('pageorder_set') | ||
series = Series.objects.create( | ||
creator=self.context['request'].user, | ||
**validated_data, | ||
) | ||
for page_data in pages_data: | ||
PageOrder.objects.create(series=series, **page_data) | ||
return series | ||
|
||
def update(self, instance, validated_data): | ||
instance.pageorder_set.all().delete() | ||
pages_data = validated_data.pop('pageorder_set') | ||
for page_data in pages_data: | ||
page = page_data.get('page') | ||
# Check if the zPage is already in another series | ||
page.pageorder_set.all().delete() | ||
# Add the zPage to the new series | ||
PageOrder.objects.create( | ||
series=instance, page=page, order=page_data.get('order') | ||
) | ||
return super().update(instance, validated_data) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
from django.urls import path, include | ||
from rest_framework.routers import DefaultRouter | ||
|
||
from dj.apps.g12f.views.series import ( | ||
MySeriesViewSet, zPageClearView, ZPageSeriesViewSet | ||
) | ||
|
||
router = DefaultRouter() | ||
router.register(r'series/mine', MySeriesViewSet, basename='series_mine') | ||
|
||
urlpatterns = [ | ||
path('', include(router.urls)), | ||
path('series/clear-zpage/', zPageClearView.as_view(), | ||
name='series_clear_zpage'), | ||
path('zpage/<str:free2zaddr>/series/', | ||
ZPageSeriesViewSet.as_view({'get': 'retrieve'}), | ||
name='zpage_series'), | ||
|
||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.