From 6a246f058b657fe28dc1693a76c1e95c8e52e2bb Mon Sep 17 00:00:00 2001 From: Melanie Wang Date: Mon, 25 Jan 2021 16:38:23 -0500 Subject: [PATCH 1/5] Add fulfillment event class --- shopify/resources/__init__.py | 1 + shopify/resources/fulfillment_event.py | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 shopify/resources/fulfillment_event.py diff --git a/shopify/resources/__init__.py b/shopify/resources/__init__.py index 8f978535..803c5351 100644 --- a/shopify/resources/__init__.py +++ b/shopify/resources/__init__.py @@ -38,6 +38,7 @@ from .country import Country from .refund import Refund from .fulfillment import Fulfillment, FulfillmentOrders +from .fulfillment_event import FulfillmentEvent from .fulfillment_service import FulfillmentService from .carrier_service import CarrierService from .transaction import Transaction diff --git a/shopify/resources/fulfillment_event.py b/shopify/resources/fulfillment_event.py new file mode 100644 index 00000000..a7175c3f --- /dev/null +++ b/shopify/resources/fulfillment_event.py @@ -0,0 +1,22 @@ +from ..base import ShopifyResource + +class FulfillmentEvent(ShopifyResource): + _prefix_source = "/orders/$order_id/fulfillments/$fulfillment_id" + _singular = "event" + _plural = "events" + + @classmethod + def _prefix(cls, options={}): + order_id = options.get("order_id") + fulfillment_id = options.get('fulfillment_id') + if order_id: + return "%s/orders/%s/fulfillments/%s" % ( + cls.site, order_id, fulfillment_id) + else: + return cls.site + + def save(self): + status = self.attributes['status'] + if status not in ['label_printed', 'label_purchased', 'attempted_delivery', 'ready_for_pickup', 'picked_up', 'confirmed', 'in_transit', 'out_for_delivery', 'delivered', 'failure']: + raise AttributeError("Invalid status") + return super(ShopifyResource, self).save() From 2ec5c7fe2be4d40abc9fcdffdef6f39490f76f2a Mon Sep 17 00:00:00 2001 From: Melanie Wang Date: Wed, 27 Jan 2021 15:57:31 -0500 Subject: [PATCH 2/5] Add tests --- shopify/resources/fulfillment_event.py | 15 +++++++-------- test/fixtures/fulfillment_event.json | 22 ++++++++++++++++++++++ test/fulfillment_event_test.py | 22 ++++++++++++++++++++++ 3 files changed, 51 insertions(+), 8 deletions(-) create mode 100644 test/fixtures/fulfillment_event.json create mode 100644 test/fulfillment_event_test.py diff --git a/shopify/resources/fulfillment_event.py b/shopify/resources/fulfillment_event.py index a7175c3f..886e4598 100644 --- a/shopify/resources/fulfillment_event.py +++ b/shopify/resources/fulfillment_event.py @@ -1,19 +1,18 @@ from ..base import ShopifyResource class FulfillmentEvent(ShopifyResource): - _prefix_source = "/orders/$order_id/fulfillments/$fulfillment_id" - _singular = "event" - _plural = "events" + _prefix_source = "/orders/$order_id/fulfillments/$fulfillment_id/" + _singular = 'event' + _plural = 'events' @classmethod def _prefix(cls, options={}): order_id = options.get("order_id") fulfillment_id = options.get('fulfillment_id') - if order_id: - return "%s/orders/%s/fulfillments/%s" % ( - cls.site, order_id, fulfillment_id) - else: - return cls.site + event_id = options.get("event_id") + + return "%s/orders/%s/fulfillments/%s" % ( + cls.site, order_id, fulfillment_id) def save(self): status = self.attributes['status'] diff --git a/test/fixtures/fulfillment_event.json b/test/fixtures/fulfillment_event.json new file mode 100644 index 00000000..7115a158 --- /dev/null +++ b/test/fixtures/fulfillment_event.json @@ -0,0 +1,22 @@ +{ + "fulfillment_event": { + "id": 12584341209251, + "fulfillment_id": 2608403447971, + "status": "label_printed", + "message": null, + "happened_at": "2021-01-25T16:32:23-05:00", + "city": null, + "province": null, + "country": null, + "zip": null, + "address1": null, + "latitude": null, + "longitude": null, + "shop_id": 49144037539, + "created_at": "2021-01-25T16:32:23-05:00", + "updated_at": "2021-01-25T16:32:23-05:00", + "estimated_delivery_at": null, + "order_id": 2776493818019, + "admin_graphql_api_id": "gid://shopify/FulfillmentEvent/12584341209251" + } +} diff --git a/test/fulfillment_event_test.py b/test/fulfillment_event_test.py new file mode 100644 index 00000000..8cb16180 --- /dev/null +++ b/test/fulfillment_event_test.py @@ -0,0 +1,22 @@ +import shopify +from test.test_helper import TestCase +from pyactiveresource.activeresource import ActiveResource + +class FulFillmentEventTest(TestCase): + def setUp(self): + super(FulFillmentEventTest, self).setUp() + self.fake("orders/450789469/fulfillments/255858046/events", method='GET', body=self.load_fixture('fulfillment_event')) + + def test_get_fulfillment_event(self): + fulfillment_event = shopify.FulfillmentEvent.find(order_id='450789469', fulfillment_id='255858046') + self.assertEqual(1, len(fulfillment_event)) + + # def test_create_fulfillment_event(self): + + + def test_error_on_incorrect_status(self): + with self.assertRaises(AttributeError): + incorrect_status = 'asdf' + fulfillment_event = shopify.FulfillmentEvent.find(order_id='450789469', fulfillment_id='255858046') + fulfillment_event.status = incorrect_status + fulfillment_event.save() From a362f363010cc1b6cd11225a3cbdb90f47c03702 Mon Sep 17 00:00:00 2001 From: Paulina Khew Date: Thu, 28 Jan 2021 16:54:07 -0500 Subject: [PATCH 3/5] Clean up fulfillment_event_test.py --- test/fulfillment_event_test.py | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/test/fulfillment_event_test.py b/test/fulfillment_event_test.py index 8cb16180..18e4eefc 100644 --- a/test/fulfillment_event_test.py +++ b/test/fulfillment_event_test.py @@ -3,20 +3,18 @@ from pyactiveresource.activeresource import ActiveResource class FulFillmentEventTest(TestCase): - def setUp(self): - super(FulFillmentEventTest, self).setUp() - self.fake("orders/450789469/fulfillments/255858046/events", method='GET', body=self.load_fixture('fulfillment_event')) + def setUp(self): + super(FulFillmentEventTest, self).setUp() + self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='GET', body=self.load_fixture('fulfillment_event')) + self.fulfillment_event = shopify.FulfillmentEvent.find(order_id=2776493818019, fulfillment_id=2608403447971) - def test_get_fulfillment_event(self): - fulfillment_event = shopify.FulfillmentEvent.find(order_id='450789469', fulfillment_id='255858046') - self.assertEqual(1, len(fulfillment_event)) + def test_get_fulfillment_event(self): + self.assertEqual(1, len(self.fulfillment_event)) - # def test_create_fulfillment_event(self): + def test_create_fulfillment_event(self): + pass - - def test_error_on_incorrect_status(self): - with self.assertRaises(AttributeError): - incorrect_status = 'asdf' - fulfillment_event = shopify.FulfillmentEvent.find(order_id='450789469', fulfillment_id='255858046') - fulfillment_event.status = incorrect_status - fulfillment_event.save() + def test_error_on_incorrect_status(self): + with self.assertRaises(AttributeError): + self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='PUT', body=self.load_fixture('article'), headers={'Content-type': 'application/json'}) + self.fulfillment_event.save() From 8b986e97bc894987d7af2aeb9b5d585fbb41b81b Mon Sep 17 00:00:00 2001 From: Melanie Wang Date: Fri, 29 Jan 2021 13:15:12 -0500 Subject: [PATCH 4/5] Wrap up testing --- test/fulfillment_event_test.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/test/fulfillment_event_test.py b/test/fulfillment_event_test.py index 18e4eefc..1ba9a73e 100644 --- a/test/fulfillment_event_test.py +++ b/test/fulfillment_event_test.py @@ -3,18 +3,22 @@ from pyactiveresource.activeresource import ActiveResource class FulFillmentEventTest(TestCase): - def setUp(self): - super(FulFillmentEventTest, self).setUp() - self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='GET', body=self.load_fixture('fulfillment_event')) - self.fulfillment_event = shopify.FulfillmentEvent.find(order_id=2776493818019, fulfillment_id=2608403447971) - def test_get_fulfillment_event(self): - self.assertEqual(1, len(self.fulfillment_event)) + self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='GET', body=self.load_fixture('fulfillment_event')) + fulfillment_event = shopify.FulfillmentEvent.find(order_id=2776493818019, fulfillment_id=2608403447971) + self.assertEqual(1, len(fulfillment_event)) def test_create_fulfillment_event(self): - pass + self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='POST', body=self.load_fixture('fulfillment_event'), headers={'Content-type': 'application/json'}) + new_fulfillment_event = shopify.FulfillmentEvent({'order_id': '2776493818019', 'fulfillment_id': '2608403447971'}) + new_fulfillment_event.status = 'ready_for_pickup' + new_fulfillment_event.save() def test_error_on_incorrect_status(self): with self.assertRaises(AttributeError): - self.fake("orders/2776493818019/fulfillments/2608403447971/events", method='PUT', body=self.load_fixture('article'), headers={'Content-type': 'application/json'}) - self.fulfillment_event.save() + self.fake("orders/2776493818019/fulfillments/2608403447971/events/12584341209251", method='GET', body=self.load_fixture('fulfillment_event')) + incorrect_status = 'asdf' + fulfillment_event = shopify.FulfillmentEvent.find(12584341209251, order_id='2776493818019', fulfillment_id='2608403447971') + fulfillment_event.status = incorrect_status + fulfillment_event.save() + From 1e855a78fe39b28e1a9dade3fe38d7805d12e632 Mon Sep 17 00:00:00 2001 From: Melanie Wang Date: Fri, 29 Jan 2021 15:25:00 -0500 Subject: [PATCH 5/5] Update changelog --- CHANGELOG | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG b/CHANGELOG index 9a958f31..c5ce222d 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,5 @@ - Added support for Fulfillment.update_tracking ([#432](https://github.com/Shopify/shopify_python_api/pull/432)) +- Add FulfillmentEvent resource ([#454](https://github.com/Shopify/shopify_python_api/pull/454)) == Version 8.2.0 - [Feature] Add support for Dynamic API Versioning. When the library is initialized, it will now make a request to