/
serializers.py
208 lines (153 loc) · 5.73 KB
/
serializers.py
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
# -*- coding: utf-8 -*-
"""Defines serializers for each of our models."""
from allauth.socialaccount.models import SocialAccount
from rest_framework import serializers
from readthedocs.builds.models import Build, BuildCommandResult, Version
from readthedocs.oauth.models import RemoteOrganization, RemoteRepository
from readthedocs.projects.models import Domain, Project
class ProjectSerializer(serializers.ModelSerializer):
canonical_url = serializers.ReadOnlyField(source='get_docs_url')
class Meta:
model = Project
fields = (
'id',
'name',
'slug',
'description',
'language',
'programming_language',
'repo',
'repo_type',
'default_version',
'default_branch',
'documentation_type',
'users',
'canonical_url',
)
class ProjectAdminSerializer(ProjectSerializer):
"""
Project serializer for admin only access.
Includes special internal fields that don't need to be exposed through the
general API, mostly for fields used in the build process
"""
features = serializers.SlugRelatedField(
many=True,
read_only=True,
slug_field='feature_id',
)
def get_environment_variables(self, obj):
return {
variable.name: variable.value
for variable in obj.environmentvariable_set.all()
}
class Meta(ProjectSerializer.Meta):
fields = ProjectSerializer.Meta.fields + (
'enable_epub_build',
'enable_pdf_build',
'conf_py_file',
'analytics_code',
'cdn_enabled',
'container_image',
'container_mem_limit',
'container_time_limit',
'install_project',
'use_system_packages',
'skip',
'requirements_file',
'python_interpreter',
'features',
'has_valid_clone',
'has_valid_webhook',
'show_advertising',
'environment_variables',
)
class VersionSerializer(serializers.ModelSerializer):
project = ProjectSerializer()
downloads = serializers.DictField(source='get_downloads', read_only=True)
class Meta:
model = Version
fields = (
'id',
'project',
'slug',
'identifier',
'verbose_name',
'active',
'built',
'downloads',
'type',
)
class VersionAdminSerializer(VersionSerializer):
"""Version serializer that returns admin project data."""
project = ProjectAdminSerializer()
class BuildCommandSerializer(serializers.ModelSerializer):
run_time = serializers.ReadOnlyField()
class Meta:
model = BuildCommandResult
exclude = ('')
class BuildSerializer(serializers.ModelSerializer):
"""Build serializer for user display, doesn't display internal fields."""
commands = BuildCommandSerializer(many=True, read_only=True)
project_slug = serializers.ReadOnlyField(source='project.slug')
version_slug = serializers.ReadOnlyField(source='version.slug')
docs_url = serializers.ReadOnlyField(source='version.get_absolute_url')
state_display = serializers.ReadOnlyField(source='get_state_display')
# Jsonfield needs an explicit serializer
# https://github.com/dmkoch/django-jsonfield/issues/188#issuecomment-300439829
config = serializers.JSONField(required=False)
class Meta:
model = Build
# `_config` should be excluded to avoid conflicts with `config`
exclude = ('builder', '_config')
class BuildAdminSerializer(BuildSerializer):
"""Build serializer for display to admin users and build instances."""
class Meta(BuildSerializer.Meta):
# `_config` should be excluded to avoid conflicts with `config`
exclude = ('_config',)
class SearchIndexSerializer(serializers.Serializer):
q = serializers.CharField(max_length=500)
project = serializers.CharField(max_length=500, required=False)
version = serializers.CharField(max_length=500, required=False)
page = serializers.CharField(max_length=500, required=False)
class DomainSerializer(serializers.ModelSerializer):
project = ProjectSerializer()
class Meta:
model = Domain
fields = (
'id',
'project',
'domain',
'canonical',
'machine',
'cname',
)
class RemoteOrganizationSerializer(serializers.ModelSerializer):
class Meta:
model = RemoteOrganization
exclude = ('json', 'email', 'users')
class RemoteRepositorySerializer(serializers.ModelSerializer):
"""Remote service repository serializer."""
organization = RemoteOrganizationSerializer()
matches = serializers.SerializerMethodField()
class Meta:
model = RemoteRepository
exclude = ('json', 'users')
def get_matches(self, obj):
request = self.context['request']
if request.user is not None and request.user.is_authenticated:
return obj.matches(request.user)
class ProviderSerializer(serializers.Serializer):
id = serializers.CharField(max_length=20)
name = serializers.CharField(max_length=20)
class SocialAccountSerializer(serializers.ModelSerializer):
username = serializers.SerializerMethodField()
avatar_url = serializers.URLField(source='get_avatar_url')
provider = ProviderSerializer(source='get_provider')
class Meta:
model = SocialAccount
exclude = ('extra_data',)
def get_username(self, obj):
return (
obj.extra_data.get('username') or obj.extra_data.get('login')
# FIXME: which one is GitLab?
)