forked from inveniosoftware/invenio-circulation
-
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.
- add view to handle loan actions with REST calls - closes inveniosoftware#26 Co-authored-by: Zacharias Zacharodimos <zacharias.zacharodimos@cern.ch> Co-authored-by: Christos Topaloudis <topless@gmail.com>
- Loading branch information
3 people
committed
Jul 23, 2018
1 parent
05b7400
commit 811b986
Showing
9 changed files
with
278 additions
and
104 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,13 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # Copyright (C) 2018 CERN. | ||
| # Copyright (C) 2018 RERO. | ||
| # | ||
| # Invenio-Circulation is free software; you can redistribute it and/or modify | ||
| # it under the terms of the MIT License; see LICENSE file for more details. | ||
|
|
||
| """Circulation exceptions.""" | ||
|
|
||
|
|
||
| class LoanActionError(Exception): | ||
| """Loan action error.""" |
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,126 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # Copyright (C) 2018 CERN. | ||
| # Copyright (C) 2018 RERO. | ||
| # | ||
| # Invenio-Circulation is free software; you can redistribute it and/or modify | ||
| # it under the terms of the MIT License; see LICENSE file for more details. | ||
|
|
||
| """Circulation views.""" | ||
|
|
||
| from copy import deepcopy | ||
|
|
||
| from flask import Blueprint, current_app, request | ||
| from invenio_db import db | ||
| from invenio_records_rest.utils import obj_or_import_string | ||
| from invenio_records_rest.views import \ | ||
| create_error_handlers as records_rest_error_handlers | ||
| from invenio_records_rest.views import pass_record | ||
| from invenio_rest import ContentNegotiatedMethodView | ||
| from invenio_rest.views import create_api_errorhandler | ||
| from transitions import MachineError | ||
|
|
||
| from invenio_circulation.errors import LoanActionError | ||
|
|
||
| HTTP_CODES = { | ||
| 'method_not_allowed': 405, | ||
| 'accepted': 202 | ||
| } | ||
|
|
||
|
|
||
| def create_error_handlers(blueprint): | ||
| """Create error handlers on blueprint.""" | ||
| blueprint.errorhandler(LoanActionError)(create_api_errorhandler( | ||
| status=HTTP_CODES['method_not_allowed'], message='Invalid loan action' | ||
| )) | ||
| records_rest_error_handlers(blueprint) | ||
|
|
||
|
|
||
| def build_blueprint_with_loan_actions(app): | ||
| """.""" | ||
| blueprint = Blueprint( | ||
| 'invenio_circulation', | ||
| __name__, | ||
| url_prefix='', | ||
| ) | ||
| create_error_handlers(blueprint) | ||
|
|
||
| endpoints = app.config.get('CIRCULATION_REST_ENDPOINTS', []) | ||
| transitions = app.config.get('CIRCULATION_LOAN_TRANSITIONS', []) | ||
|
|
||
| for endpoint, options in (endpoints or {}).items(): | ||
| options = deepcopy(options) | ||
|
|
||
| if 'record_serializers' in options: | ||
| serializers = options.get('record_serializers') | ||
| serializers = {mime: obj_or_import_string(func) | ||
| for mime, func in serializers.items()} | ||
| else: | ||
| serializers = {} | ||
|
|
||
| ctx = dict( | ||
| read_permission_factory=obj_or_import_string( | ||
| options.get('read_permission_factory_imp') | ||
| ), | ||
| create_permission_factory=obj_or_import_string( | ||
| options.get('create_permission_factory_imp') | ||
| ), | ||
| update_permission_factory=obj_or_import_string( | ||
| options.get('update_permission_factory_imp') | ||
| ), | ||
| delete_permission_factory=obj_or_import_string( | ||
| options.get('delete_permission_factory_imp') | ||
| ), | ||
| ) | ||
|
|
||
| loan_actions = LoanActionResource.as_view( | ||
| LoanActionResource.view_name.format(endpoint), | ||
| serializers=serializers, | ||
| ctx=ctx, | ||
| ) | ||
|
|
||
| distinct_actions = (transition['trigger'] for transition in | ||
| transitions) | ||
| url = '{0}/<any({1}):action>'.format( | ||
| options['item_route'], | ||
| ','.join(distinct_actions), | ||
| ) | ||
| blueprint.add_url_rule( | ||
| url, | ||
| view_func=loan_actions, | ||
| methods=['POST'], | ||
| ) | ||
|
|
||
| return blueprint | ||
|
|
||
|
|
||
| class LoanActionResource(ContentNegotiatedMethodView): | ||
| """Loan action resource.""" | ||
|
|
||
| view_name = '{0}_actions' | ||
|
|
||
| def __init__(self, serializers, ctx, *args, **kwargs): | ||
| """Constructor.""" | ||
| super(LoanActionResource, self).__init__( | ||
| serializers, | ||
| default_media_type=ctx.get('default_media_type'), | ||
| *args, | ||
| **kwargs | ||
| ) | ||
| for key, value in ctx.items(): | ||
| setattr(self, key, value) | ||
|
|
||
| @pass_record | ||
| def post(self, pid, record, action, **kwargs): | ||
| """Handle loan action.""" | ||
| params = request.get_json() | ||
|
|
||
| try: | ||
| # perform action on the current loan | ||
| getattr(record, action)(**params) | ||
| db.session.commit() | ||
| except MachineError as ex: | ||
| current_app.logger.exception(ex) | ||
| raise LoanActionError(ex) | ||
|
|
||
| return self.make_response(pid, record, HTTP_CODES['accepted']) |
Oops, something went wrong.