Add hypermedia API to replace XML-RPC and simple #4078
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
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,15 @@ | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| def includeme(config): | ||
| config.include(".routes") |
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,92 @@ | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| def includeme(config): | ||
| # Add a subdomain for the hypermedia api. | ||
| hypermedia = config.get_settings().get("hypermedia.domain") | ||
|
|
||
| config.add_route("api.spec", "/api/", read_only=True, domain=hypermedia) | ||
| config.add_route( | ||
| "api.views.projects", | ||
| "/api/projects/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.detail", | ||
| "/api/projects/{name}/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.detail.files", | ||
| "/api/projects/{name}/files/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.releases", | ||
| "/api/projects/{name}/releases/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.releases.detail", | ||
| "/api/projects/{name}/releases/{version}/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}/{version}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.releases.files", | ||
| "/api/projects/{name}/releases/{version}/files/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}/{version}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.projects.detail.roles", | ||
| "/api/projects/{name}/roles/", | ||
| factory="warehouse.packaging.models:ProjectFactory", | ||
| traverse="/{name}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| config.add_route( | ||
| "api.views.journals", "/api/journals/", read_only=True, domain=hypermedia | ||
| ) | ||
| # This is the JSON API equivalent of changelog_last_serial() | ||
| config.add_route( | ||
| "api.views.journals.latest", | ||
| "/api/journals/latest/", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) | ||
| # This is the JSON API equivalent of user_packages(user) | ||
| config.add_route( | ||
| "api.views.users.details.projects", | ||
| "/api/users/{user}/projects/", | ||
| factory="warehouse.accounts.models:UserFactory", | ||
| traverse="/{user}", | ||
| read_only=True, | ||
| domain=hypermedia, | ||
| ) |
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,195 @@ | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import datetime | ||
|
|
||
| from marshmallow import Schema, fields | ||
|
|
||
|
|
||
| class File(Schema): | ||
| filename = fields.Str() | ||
| packagetype = fields.Str() | ||
| python_version = fields.Str() | ||
| has_sig = fields.Bool(attribute="has_signature") | ||
|
There was a problem hiding this comment.
|
||
| comment_text = fields.Str() | ||
| md5_digest = fields.Str() | ||
| digests = fields.Method("get_digests") | ||
| size = fields.Int() | ||
| upload_time = fields.Function( | ||
| lambda obj: obj.upload_time.strftime("%Y-%m-%dT%H:%M:%S") | ||
|
There was a problem hiding this comment. Drive-by comment: You can use import datetime as dt
import pytz
from marshmallow import Schema, fields
class File(Schema):
upload_time = fields.DateTime(format="%Y-%m-%dT%H:%M:%S")
schema = File()
timezone_aware_dt = dt.datetime.utcnow()
timezone_aware_dt.replace(tzinfo=pytz.UTC)
print(schema.dump({'upload_time': timezone_aware_dt}))
# {'upload_time': '2018-06-01T13:29:25'}If you don't pass a format, the default behavior is to format as ISO8601. import datetime as dt
import pytz
from marshmallow import Schema, fields
class File(Schema):
upload_time = fields.DateTime()
schema = File()
timezone_aware_dt = dt.datetime.utcnow()
timezone_aware_dt.replace(tzinfo=pytz.UTC)
print(schema.dump({'upload_time': timezone_aware_dt}))
# {'upload_time': '2018-06-01T13:31:08.732522+00:00'}There was a problem hiding this comment. @merwok, we left out the timezone because that's what the JSON api does. However, the XML-RPC api does include a tz. I'll add tz to this field on the next push. |
||
| ) | ||
| url = fields.Method("get_detail_url") | ||
|
|
||
| def get_digests(self, obj): | ||
| return {"md5": obj.md5_digest, "sha256": obj.sha256_digest} | ||
|
|
||
| def get_detail_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url("packaging.file", path=obj.path) | ||
|
|
||
|
|
||
| class Release(Schema): | ||
| bugtrack_url = fields.Str(attribute="project.bugtrack_url") | ||
| classifiers = fields.List(fields.Str()) | ||
| docs_url = fields.Str(attribute="project.documentation_url") | ||
| downloads = fields.Method("get_downloads") | ||
| project_url = fields.Method("get_project_url") | ||
| url = fields.Method("get_release_url") | ||
| requires_dist = fields.List(fields.Str()) | ||
| files_url = fields.Method("get_files_url") | ||
|
|
||
| def get_files_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url( | ||
| "api.views.projects.releases.files", | ||
| name=obj.project.name, | ||
| version=obj.version, | ||
| ) | ||
|
|
||
| def get_project_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url("api.views.projects.detail", name=obj.project.name) | ||
|
|
||
| def get_release_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url( | ||
| "api.views.projects.releases.detail", | ||
| name=obj.project.name, | ||
| version=obj.version, | ||
| ) | ||
|
|
||
| def get_downloads(self, obj): | ||
| return {"last_day": -1, "last_week": -1, "last_month": -1} | ||
|
|
||
| class Meta: | ||
| fields = ( | ||
| "author", | ||
| "author_email", | ||
| "bugtrack_url", | ||
| "classifiers", | ||
| "description", | ||
| "description_content_type", | ||
| "docs_url", | ||
| "downloads", | ||
| "download_url", | ||
| "home_page", | ||
| "keywords", | ||
| "license", | ||
| "maintainer", | ||
| "maintainer_email", | ||
| "name", | ||
| "project_url", | ||
| "url", | ||
| "platform", | ||
| "requires_dist", | ||
| "requires_python", | ||
| "summary", | ||
| "version", | ||
| "files_url", | ||
| ) | ||
| ordered = True | ||
|
|
||
|
|
||
| class Project(Schema): | ||
| url = fields.Method("get_detail_url") | ||
| releases_url = fields.Method("get_releases_url") | ||
|
There was a problem hiding this comment. Drive-by comment: Since serializing URLs is a common usage, you might want to create a custom field. It could look something like class Project(Schema):
releases_url = RouteURL("api.views.projects.releases",
name="<normalized_name>")For an example of how this might be implemented, check out flask-marshmallow's equivalent: https://github.com/marshmallow-code/flask-marshmallow/blob/7e594dc89ba853946ef1593e9ac19850a5ec9d2a/flask_marshmallow/fields.py#L39 |
||
| latest_version_url = fields.Method("get_latest_version_url") | ||
| legacy_project_json = fields.Method("get_legacy_project_json") | ||
| roles_url = fields.Method("get_roles_url") | ||
| files_url = fields.Method("get_files_url") | ||
|
|
||
| def get_files_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url("api.views.projects.detail.files", name=obj.name) | ||
|
|
||
| def get_roles_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url( | ||
| "api.views.projects.detail.roles", name=obj.normalized_name | ||
| ) | ||
|
|
||
| def get_legacy_project_json(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url("legacy.api.json.project", name=obj.normalized_name) | ||
|
|
||
| def get_detail_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url("api.views.projects.detail", name=obj.normalized_name) | ||
|
|
||
| def get_latest_version_url(self, obj): | ||
| request = self.context.get("request") | ||
| if not obj.latest_version: | ||
| return None | ||
| return request.route_url( | ||
| "api.views.projects.releases.detail", | ||
| name=obj.name, | ||
| version=obj.latest_version[0], | ||
| ) | ||
|
|
||
| def get_releases_url(self, obj): | ||
| request = self.context.get("request") | ||
| return request.route_url( | ||
| "api.views.projects.releases", name=obj.normalized_name | ||
| ) | ||
|
|
||
| class Meta: | ||
| fields = ( | ||
| "name", | ||
| "normalized_name", | ||
| "latest_version_url", | ||
| "bugtrack_url", | ||
| "last_serial", | ||
| "url", | ||
| "releases_url", | ||
| "legacy_project_json", | ||
| "stable_version", | ||
| "created", | ||
| "roles_url", | ||
| "files_url", | ||
| ) | ||
|
|
||
|
|
||
| class Journal(Schema): | ||
| project_name = fields.Str(attribute="name") | ||
| timestamp = fields.Method("get_timestamp") | ||
| release_url = fields.Method("get_release_url") | ||
|
|
||
| def get_release_url(self, obj): | ||
| request = self.context.get("request") | ||
| if not obj.version: | ||
| return None | ||
| return request.route_url( | ||
| "api.views.projects.releases.detail", name=obj.name, version=obj.version | ||
| ) | ||
|
|
||
| def get_timestamp(self, obj): | ||
| return int(obj.submitted_date.replace(tzinfo=datetime.timezone.utc).timestamp()) | ||
|
|
||
| class Meta: | ||
| fields = ( | ||
| "project_name", | ||
| "release_url", | ||
| "version", | ||
| "timestamp", | ||
| "action", | ||
| "submitted_date", | ||
| ) | ||
|
|
||
|
|
||
| class Role(Schema): | ||
| role = fields.Str(attribute="role_name") | ||
| name = fields.Str(attribute="user.username") | ||
|
|
||
|
|
||
| class UserProjects(Schema): | ||
| role = fields.Str(attribute="role_name") | ||
| project = fields.Nested(Project(only=("name", "url"))) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is a dependency of apispec, it shouldn’t be in the
infile.