From ea6da1159b20523d7dbf6807a37df715acfa96c3 Mon Sep 17 00:00:00 2001 From: ipaullly Date: Tue, 6 Nov 2018 02:30:22 +0300 Subject: [PATCH 1/7] [starts #161737782] build model and view for parcels POST api --- app/api/v1/__init__.py | 4 +++- app/api/v1/models.py | 21 +++++++++++++++++++++ app/api/v1/views.py | 18 ++++++++++++++++-- 3 files changed, 40 insertions(+), 3 deletions(-) diff --git a/app/api/v1/__init__.py b/app/api/v1/__init__.py index af06015..62908e1 100644 --- a/app/api/v1/__init__.py +++ b/app/api/v1/__init__.py @@ -1,7 +1,9 @@ from flask import Blueprint from flask_restful import Api - +from .views import ParcelList version1 = Blueprint('v1', __name__, url_prefix="/api/v1") api = Api(version1) + +api.add_resource(ParcelList, '/parcels') \ No newline at end of file diff --git a/app/api/v1/models.py b/app/api/v1/models.py index e69de29..ca04c2f 100644 --- a/app/api/v1/models.py +++ b/app/api/v1/models.py @@ -0,0 +1,21 @@ + +parcels = [] + +class Parcels: + + def __init__(self): + self.db = parcels + + def create_order(self, item, pickup, dest, pricing): + payload = { + "id" : len(self.db) + 1, + "itemName" : item, + "pickupLocation" : pickup, + "destination" : dest, + "pricing" : pricing + } + self.db.append(payload) + + def order(self): + return self.db + \ No newline at end of file diff --git a/app/api/v1/views.py b/app/api/v1/views.py index 2842140..1ed81bc 100644 --- a/app/api/v1/views.py +++ b/app/api/v1/views.py @@ -1,12 +1,26 @@ from flask_restful import Resource from flask import make_response, jsonify, request +from .models import Parcels -class ParcelList(Resource): +class ParcelList(Resource, Parcels): + + def __init__(self): + self.order = Parcels() def post(self): - pass + data = request.get_json() + item = data['item'] + pickup = data['pickup'] + dest = data['dest'] + pricing = data['pricing'] + + self.order.create_order(item, pickup, dest, pricing) + return make_response(jsonify({ + "message" : "delivery order created successfully" + }), 201) + def get(self): pass From 26d00318e58b2fa11828f327c4afe0ede2de3dbb Mon Sep 17 00:00:00 2001 From: ipaullly Date: Tue, 6 Nov 2018 14:48:16 +0300 Subject: [PATCH 2/7] [starts #161748253] Create GET delivery order list --- app/api/v1/models.py | 2 +- app/api/v1/views.py | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/app/api/v1/models.py b/app/api/v1/models.py index ca04c2f..4a9dd80 100644 --- a/app/api/v1/models.py +++ b/app/api/v1/models.py @@ -16,6 +16,6 @@ def create_order(self, item, pickup, dest, pricing): } self.db.append(payload) - def order(self): + def order_list(self): return self.db \ No newline at end of file diff --git a/app/api/v1/views.py b/app/api/v1/views.py index 1ed81bc..153f45a 100644 --- a/app/api/v1/views.py +++ b/app/api/v1/views.py @@ -2,7 +2,7 @@ from flask import make_response, jsonify, request from .models import Parcels - +cancelled = 'cancel' class ParcelList(Resource, Parcels): def __init__(self): @@ -22,7 +22,12 @@ def post(self): }), 201) def get(self): - pass + resp = self.order.order_list() + return make_response(jsonify({ + "message" : "ok" + "Delivery Orders" : resp + }), 200) + class IndividualParcel(Resource): @@ -30,4 +35,5 @@ def get(self, id): pass def put(self, id): - pass \ No newline at end of file + pass + \ No newline at end of file From 67006a92b1723460c94a33d9d02a1ca24ef4da06 Mon Sep 17 00:00:00 2001 From: ipaullly Date: Wed, 7 Nov 2018 00:44:46 +0300 Subject: [PATCH 3/7] [starts #161766269]Build API to retrieve single order --- app/api/v1/__init__.py | 5 +++-- app/api/v1/models.py | 5 +++++ app/api/v1/views.py | 24 ++++++++++++++---------- 3 files changed, 22 insertions(+), 12 deletions(-) diff --git a/app/api/v1/__init__.py b/app/api/v1/__init__.py index 62908e1..a419e8f 100644 --- a/app/api/v1/__init__.py +++ b/app/api/v1/__init__.py @@ -1,9 +1,10 @@ from flask import Blueprint from flask_restful import Api -from .views import ParcelList +from .views import ParcelList, IndividualParcel version1 = Blueprint('v1', __name__, url_prefix="/api/v1") api = Api(version1) -api.add_resource(ParcelList, '/parcels') \ No newline at end of file +api.add_resource(ParcelList, '/parcels') +api.add_resource(IndividualParcel, '/parcels/') \ No newline at end of file diff --git a/app/api/v1/models.py b/app/api/v1/models.py index 4a9dd80..53b78ac 100644 --- a/app/api/v1/models.py +++ b/app/api/v1/models.py @@ -18,4 +18,9 @@ def create_order(self, item, pickup, dest, pricing): def order_list(self): return self.db + + def retrieve_single_order(self, parcelID): + order_by_id = [parc for parc in self.db if parc['id'] == parcelID][0] + return order_by_id + \ No newline at end of file diff --git a/app/api/v1/views.py b/app/api/v1/views.py index 153f45a..a4ebb90 100644 --- a/app/api/v1/views.py +++ b/app/api/v1/views.py @@ -2,11 +2,9 @@ from flask import make_response, jsonify, request from .models import Parcels -cancelled = 'cancel' -class ParcelList(Resource, Parcels): +order = Parcels() - def __init__(self): - self.order = Parcels() +class ParcelList(Resource): def post(self): data = request.get_json() @@ -15,16 +13,17 @@ def post(self): dest = data['dest'] pricing = data['pricing'] - self.order.create_order(item, pickup, dest, pricing) - + order.create_order(item, pickup, dest, pricing) + orders = order.db return make_response(jsonify({ - "message" : "delivery order created successfully" + "message" : "delivery order created successfully", + "orders" : orders }), 201) def get(self): - resp = self.order.order_list() + resp = order.order_list() return make_response(jsonify({ - "message" : "ok" + "message" : "ok", "Delivery Orders" : resp }), 200) @@ -32,7 +31,12 @@ def get(self): class IndividualParcel(Resource): def get(self, id): - pass + single = order.retrieve_single_order(id) + return make_response(jsonify({ + "message" : "Ok", + "order" : single + }), 200) + def put(self, id): pass From 37f0d14487b07c0cefe5cd431fd8b9d3f7efdf11 Mon Sep 17 00:00:00 2001 From: ipaullly Date: Wed, 7 Nov 2018 00:53:12 +0300 Subject: [PATCH 4/7] [finishes #161766269] Add class and methods docstrings --- app/api/v1/models.py | 13 ++++++++++++- app/api/v1/views.py | 18 +++++++++++++++--- 2 files changed, 27 insertions(+), 4 deletions(-) diff --git a/app/api/v1/models.py b/app/api/v1/models.py index 53b78ac..6e24a12 100644 --- a/app/api/v1/models.py +++ b/app/api/v1/models.py @@ -2,11 +2,16 @@ parcels = [] class Parcels: - + """ + Class with CRUD functionalities on the Parcels resource + """ def __init__(self): self.db = parcels def create_order(self, item, pickup, dest, pricing): + """ + instance method to generate new entry into delivery orders list + """ payload = { "id" : len(self.db) + 1, "itemName" : item, @@ -17,9 +22,15 @@ def create_order(self, item, pickup, dest, pricing): self.db.append(payload) def order_list(self): + """ + retrieves entire list of delivery orders + """ return self.db def retrieve_single_order(self, parcelID): + """ + retrive a single order by id + """ order_by_id = [parc for parc in self.db if parc['id'] == parcelID][0] return order_by_id diff --git a/app/api/v1/views.py b/app/api/v1/views.py index a4ebb90..6f0b6be 100644 --- a/app/api/v1/views.py +++ b/app/api/v1/views.py @@ -5,8 +5,13 @@ order = Parcels() class ParcelList(Resource): - + """ + class for Create order and retrieve list of orders API endpoints + """ def post(self): + """ + post method to add new order to list of orders + """ data = request.get_json() item = data['item'] pickup = data['pickup'] @@ -21,16 +26,23 @@ def post(self): }), 201) def get(self): + """ + get method to retrieve list of all orders + """ resp = order.order_list() return make_response(jsonify({ "message" : "ok", "Delivery Orders" : resp }), 200) - class IndividualParcel(Resource): - + """ + class for API endpoints for retrieving single order and cancelling particular order + """ def get(self, id): + """ + get method to retrieve order by id + """ single = order.retrieve_single_order(id) return make_response(jsonify({ "message" : "Ok", From 534a2b95ecfd2825889c8e540fe52dbb479d7f0b Mon Sep 17 00:00:00 2001 From: ipaullly Date: Wed, 7 Nov 2018 08:24:06 +0300 Subject: [PATCH 5/7] [starts #161773293] write passing test for POST new parcel order --- app/tests/__init__.py | 0 app/tests/test_create_parcel.py | 25 +++++++++++++++++++++++++ requirements.txt | 24 ++++++++++++++++++++++++ 3 files changed, 49 insertions(+) create mode 100644 app/tests/__init__.py create mode 100644 app/tests/test_create_parcel.py diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/tests/test_create_parcel.py b/app/tests/test_create_parcel.py new file mode 100644 index 0000000..fad3dcc --- /dev/null +++ b/app/tests/test_create_parcel.py @@ -0,0 +1,25 @@ +from .. import create_app +import unittest +import json + +class TestPracelCreation(unittest.TestCase): + def setUp(self): + create_app().testing = True + self.app = create_app().test_client() + self.data = { + "item" : "seven ballons", + "pickup" : "Biashara street", + "dest" : "Kikuyu town", + "pricing": "250 ksh" + } + + def test_POST_create_delivery_order(self): + response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') + result = json.loads(response.data) + self.assertEqual(response.status_code, 201) + self.assertIn('seven ballons', str(result)) + +# make the tests you have written executable + +if __name__ == "__main__": + unittest.main() \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index e69de29..5fa0e4c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,24 @@ +aniso8601==4.0.1 +astroid==2.0.4 +atomicwrites==1.2.1 +attrs==18.2.0 +Click==7.0 +Flask==1.0.2 +Flask-RESTful==0.3.6 +isort==4.3.4 +itsdangerous==1.1.0 +Jinja2==2.10 +lazy-object-proxy==1.3.1 +MarkupSafe==1.0 +mccabe==0.6.1 +more-itertools==4.3.0 +pkg-resources==0.0.0 +pluggy==0.8.0 +py==1.7.0 +pylint==2.1.1 +pytest==3.10.0 +pytz==2018.7 +six==1.11.0 +typed-ast==1.1.0 +Werkzeug==0.14.1 +wrapt==1.10.11 From 66c2c042568f94cb45f28ca46348c9c814369c26 Mon Sep 17 00:00:00 2001 From: ipaullly Date: Wed, 7 Nov 2018 09:02:27 +0300 Subject: [PATCH 6/7] [starts #161773596] write test for GET list of delivery orders --- app/tests/test_parcels.py | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 app/tests/test_parcels.py diff --git a/app/tests/test_parcels.py b/app/tests/test_parcels.py new file mode 100644 index 0000000..69510d2 --- /dev/null +++ b/app/tests/test_parcels.py @@ -0,0 +1,35 @@ +from .. import create_app +import unittest +import json + +class TestPracelCreation(unittest.TestCase): + def setUp(self): + create_app().testing = True + self.app = create_app().test_client() + self.data = { + "item" : "seven ballons", + "pickup" : "Biashara street", + "dest" : "Kikuyu town", + "pricing": "250 ksh" + } + + def test_POST_create_delivery_order(self): + response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') + result = json.loads(response.data) + self.assertEqual(response.status_code, 201) + self.assertIn('seven ballons', str(result)) + + def test_GET_delivery_orders_list(self): + """Test if API can retrieve a list of delivery orders""" + response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') + self.assertEqual(response.status_code, 201) + response = self.app.get('/api/v1/parcels', content_type='application/json') + self.assertEqual(response.status_code, 200) + result = json.loads(response.data) + self.assertIn('seven ballons', str(result)) + + +# make the tests you have written executable + +if __name__ == "__main__": + unittest.main() \ No newline at end of file From 101cd2c193b179e9c551ad1d531af7c9d6a1ca2b Mon Sep 17 00:00:00 2001 From: ipaullly Date: Wed, 7 Nov 2018 09:09:01 +0300 Subject: [PATCH 7/7] [finishes #161773596] add doctsrtings to test class --- app/tests/test_parcels.py | 13 ++++++++- app/tests/v1/__init__.py | 0 app/tests/{ => v1}/test_create_parcel.py | 0 app/tests/v1/test_parcels.py | 35 ++++++++++++++++++++++++ 4 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 app/tests/v1/__init__.py rename app/tests/{ => v1}/test_create_parcel.py (100%) create mode 100644 app/tests/v1/test_parcels.py diff --git a/app/tests/test_parcels.py b/app/tests/test_parcels.py index 69510d2..fa4c28c 100644 --- a/app/tests/test_parcels.py +++ b/app/tests/test_parcels.py @@ -3,7 +3,13 @@ import json class TestPracelCreation(unittest.TestCase): + """ + class for Parcels test case + """ def setUp(self): + """ + Initialize app and define test variables + """ create_app().testing = True self.app = create_app().test_client() self.data = { @@ -14,13 +20,18 @@ def setUp(self): } def test_POST_create_delivery_order(self): + """ + Test whether API can create a new delivery order via POSt request + """ response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') result = json.loads(response.data) self.assertEqual(response.status_code, 201) self.assertIn('seven ballons', str(result)) def test_GET_delivery_orders_list(self): - """Test if API can retrieve a list of delivery orders""" + """ + Test if API can retrieve a list of delivery orders + """ response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') self.assertEqual(response.status_code, 201) response = self.app.get('/api/v1/parcels', content_type='application/json') diff --git a/app/tests/v1/__init__.py b/app/tests/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/tests/test_create_parcel.py b/app/tests/v1/test_create_parcel.py similarity index 100% rename from app/tests/test_create_parcel.py rename to app/tests/v1/test_create_parcel.py diff --git a/app/tests/v1/test_parcels.py b/app/tests/v1/test_parcels.py new file mode 100644 index 0000000..69510d2 --- /dev/null +++ b/app/tests/v1/test_parcels.py @@ -0,0 +1,35 @@ +from .. import create_app +import unittest +import json + +class TestPracelCreation(unittest.TestCase): + def setUp(self): + create_app().testing = True + self.app = create_app().test_client() + self.data = { + "item" : "seven ballons", + "pickup" : "Biashara street", + "dest" : "Kikuyu town", + "pricing": "250 ksh" + } + + def test_POST_create_delivery_order(self): + response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') + result = json.loads(response.data) + self.assertEqual(response.status_code, 201) + self.assertIn('seven ballons', str(result)) + + def test_GET_delivery_orders_list(self): + """Test if API can retrieve a list of delivery orders""" + response = self.app.post('/api/v1/parcels', data=json.dumps(self.data), content_type='application/json') + self.assertEqual(response.status_code, 201) + response = self.app.get('/api/v1/parcels', content_type='application/json') + self.assertEqual(response.status_code, 200) + result = json.loads(response.data) + self.assertIn('seven ballons', str(result)) + + +# make the tests you have written executable + +if __name__ == "__main__": + unittest.main() \ No newline at end of file