Updated examples

README.rst

@@ -45,19 +45,25 @@ Some examples of ``@route`` and ``BlueprintBundle`` + ``Journey``
     
     from flask import Blueprint
     from flask_journey import route
-    from .db import create_user, get_user
+
+    from .services import create_user, get_user, update_user
     from .schemas import user, users, query
 
     bp = Blueprint('users', __name__)
 
     @route(bp, '/', methods=['GET'], _query=query, marshal_with=users)
-    def get_many(_query):
+    def get_users(_query):
         return get_users(_query.data)
 
 
     @route(bp, '/', methods=['POST'], _body=user, marshal_with=user)
-        def create(_body):
-            return create_user(_body.data)            
+    def create_user(_body):
+        return create_user(_body.data)
+
+
+    @route(bp, '/<user_id>', methods=['PUT'], _body=user, marshal_with=user)
+    def update_user(user_id, _body):
+        return update_user(user_id, _body.data)
 
 
 BlueprintBundle
@@ -115,5 +121,5 @@ Created by Robert Wikman <rbw@vault13.org> in 2018
 
 JetBrains
 ---------
-Thank you `Jetbrains <http://www.jetbrains.com>`_ for creating pycharm and for providing me with free licenses
+Thank you `Jetbrains <http://www.jetbrains.com>`_ for creating pycharm and providing me with free licenses
 

docs/index.rst

@@ -87,23 +87,25 @@ However, functions decorated with ``flask_journey.route`` can of course, just as
 
     from flask import Blueprint
     from flask_journey import route
-    from db import create_user, get_user
 
+    from .services import create_user, get_user, update_user
     from .schemas import user, users, query
 
     bp = Blueprint('users', __name__)
 
     @route(bp, '/', methods=['GET'], _query=query, marshal_with=users)
-    def get_many(_query=None):
+    def get_users(_query):
         return get_users(_query.data)
 
 
     @route(bp, '/', methods=['POST'], _body=user, marshal_with=user)
-    def create(_body=None):
+    def create_user(_body):
         return create_user(_body.data)
 
 
-
+    @route(bp, '/<user_id>', methods=['PUT'], _body=user, marshal_with=user)
+    def update_user(user_id, _body):
+        return update_user(user_id, _body.data)
 
 Blueprints
 ==========
@@ -127,18 +129,15 @@ There are various benefits of using the Journey BlueprintBundle, and in most cas
     from .users import bp as users
     from .groups import bp as groups
     from .companies import bp as companies
-    from .new_feature import bp as new_feature
+    from .stuff import bp as stuff
 
     v1 = BlueprintBundle(path='/api/v1', description="API v1, stable")
     v1.attach_bp(users, description='Users CRUD')
     v1.attach_bp(groups)
     v1.attach_bp(companies, description='Companies API')
 
-    v2 = BlueprintBundle(path='/api/v2', description="API v2, beta")
-    v2.attach_bp(users, description='Users CRUD')
-    v2.attach_bp(groups)
-    v2.attach_bp(companies, description='Companies API')
-    v2.attach_bp(new_feature)
+    other = BlueprintBundle(path='/other')
+    other.attach_bp(stuff)
 
 
 Importing bundles
@@ -151,12 +150,12 @@ Importing and registering bundles (along with blueprints) is easy as pie:
     # file: api/__init__.py
 
     from flask import Flask
-    from .bundles import v1, v2
+    from .bundles import v1, other
 
     app = Flask(__name__)
     journey = Journey()
     journey.attach_bundle(v1)
-    journey.attach_bundle(v2)
+    journey.attach_bundle(other)
     journey.init_app(app)
 
 

examples/full/README.rst

@@ -3,13 +3,12 @@ Full example
 
 This example shows how a structured Flask application can utilize the Flask-Journey extension for:
 
-- Simple route / blueprint management
-- Deserialization
-- Validation
-- Marshalling
+- blueprint management
+- (de)serialization
+- validation
 
 
-Note that the **routes** endpoint uses the regular ``route`` decorator from ``flask.Blueprint``. This is intentional to show that Flask-Journey works seamlessly with vanilla Flask blueprints.
+Note that the **routes view** uses the regular ``route`` decorator from ``flask.Blueprint``. This is intentional to show that Flask-Journey works seamlessly with vanilla Flask blueprints.
 
 
 Preparations
@@ -28,8 +27,6 @@ Start the server using the manager::
 $ python manage.py runserver
 
 
-Test it out *now* with a user-agent!
-
 ============================== ============== ================
 Name                           Default value  Description
 ============================== ============== ================

examples/full/app/api/pilots/services.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+
+from app.fake_data.pilots import data
+
+
+def get_pilots(name=None):
+    if name:
+        return [x for x in data if x['name'] == name]
+
+    return data
+
+
+def get_pilot(pilot_id):
+    return next((x for x in data if x['id'] == int(pilot_id)), {})

examples/full/app/api/pilots/views.py

@@ -3,8 +3,7 @@
 from flask import Blueprint
 from flask_journey import route
 
-from app.fake_data.pilots import get_pilots, get_pilot
-
+from .services import get_pilots, get_pilot
 from .schemas import pilot, pilots, query
 
 

examples/full/app/api/planes/services.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+from app.fake_data.planes import data
+
+
+def get_planes(min_wings=None):
+    return [x for x in data if x['wings'] >= min_wings]
+
+
+def get_plane(plane_id):
+    return next((x for x in data if x['id'] == int(plane_id)), {})
+
+
+def create_plane(plane):
+    data.append(plane)
+    return plane
+
+
+def update_plane(plane_id, plane):
+    if not get_plane(plane_id):
+        return {}
+    else:
+        for i, item in enumerate(data):
+            if item['id'] == int(plane_id):
+                data[i] = plane
+
+    return plane
+
+
+def delete_plane(plane_id):
+    deleted = False
+    for i, item in enumerate(data):
+        if item['id'] == int(plane_id):
+            deleted = True
+            del data[i]
+
+    return {'success': deleted}

examples/full/app/api/planes/views.py

@@ -3,8 +3,7 @@
 from flask import Blueprint, jsonify
 from flask_journey import route
 
-from app.fake_data.planes import get_plane, get_planes, create_plane, update_plane, delete_plane
-
+from .services import get_plane, get_planes, create_plane, update_plane, delete_plane
 from .schemas import plane, planes, query
 
 

examples/full/app/fake_data/pilots.py

@@ -12,14 +12,3 @@
         'name': 'Jerry',
     },
 ]
-
-
-def get_pilots(name=None):
-    if name:
-        return [x for x in data if x['name'] == name]
-
-    return data
-
-
-def get_pilot(pilot_id):
-    return next((x for x in data if x['id'] == int(pilot_id)), {})

examples/full/app/fake_data/planes.py

@@ -15,37 +15,3 @@
         'wings': 2,
     },
 ]
-
-
-def get_planes(min_wings=None):
-    return [x for x in data if x['wings'] >= min_wings]
-
-
-def get_plane(plane_id):
-    return next((x for x in data if x['id'] == int(plane_id)), {})
-
-
-def create_plane(plane):
-    data.append(plane)
-    return plane
-
-
-def update_plane(plane_id, plane):
-    if not get_plane(plane_id):
-        return {}
-    else:
-        for i, item in enumerate(data):
-            if item['id'] == int(plane_id):
-                data[i] = plane
-
-    return plane
-
-
-def delete_plane(plane_id):
-    deleted = False
-    for i, item in enumerate(data):
-        if item['id'] == int(plane_id):
-            deleted = True
-            del data[i]
-
-    return {'success': deleted}