Add support for fulfilling an order

Author: skullydazed

squarespace.py

@@ -1,4 +1,6 @@
 import logging
+from time import strftime, gmtime
+
 import requests
 
 
@@ -21,10 +23,11 @@ class Squarespace(object):
         The version of the Squarespace API to target. If you change this
         without making any code changes you may break this library.
     """
-    def __init__(self, api_key, api_baseurl=api_baseurl, api_version=api_version):
+    def __init__(self, api_key, api_baseurl=api_baseurl, api_version=api_version, tracking_baseurl='https://tools.usps.com/go/TrackConfirmAction?tLabels='):
         self.api_key = api_key
         self.api_baseurl = api_baseurl
         self.api_version = api_version
+        self.tracking_baseurl = tracking_baseurl
 
         # Setup our HTTP session
         self.http = requests.Session()
@@ -48,6 +51,16 @@ def useragent(self, agent_string):
         self._useragent = agent_string
         self.http.headers.update({'User-Agent': self._useragent})
 
+    def post(self, path, object):
+        """Post an `object` to the Squarespace API.
+
+        :object:
+            A dictionary containing JSON compatible key/value combinations.
+        """
+        url = '%s/%s/%s' % (self.api_baseurl, self.api_version, path)
+        logging.debug('url:%s object:%s', url, object)
+        return self.process_request(self.http.post(url, json=object))
+
     def get(self, path, args=None):
         """Retrieve an endpoint from the Squarespace API.
         """
@@ -56,8 +69,11 @@ def get(self, path, args=None):
 
         url = '%s/%s/%s' % (self.api_baseurl, self.api_version, path)
         logging.debug('url:%s args:%s', url, args)
-        request = self.http.get(url, params=args)
+        return self.process_request(self.http.get(url, params=args))
 
+    def process_request(self, request):
+        """Process a request and return the data.
+        """
         if request.status_code in [200, 201]:
             return request.json()
         elif request.status_code == 204:
@@ -113,3 +129,31 @@ def all_orders(self):
 
         return orders
 
+    def fulfill(self, order_id, tracking_number, carrier_name, service_name, tracking_baseurl=None):
+        """Mark an order as shipped.
+
+        :param tracking_number:
+            The shipping carrier's tracking number.
+        :param carrier_name:
+            The name of the shipping carrier, EG 'USPS'.
+        :param service_name:
+            The shipping service used, EG "First Class Package"
+        """
+        if not tracking_baseurl:
+            tracking_baseurl = self.tracking_baseurl
+
+        uri = 'orders/%s/fulfillments' % order_id
+        fulfillment = {
+            "shouldSendNotification": True,
+            "shipments": [
+                {
+                    'shipDate': strftime('%Y-%m-%dT%H:%M:%SZ', gmtime()),
+                    "carrierName": carrier_name,
+                    "service": service_name,
+                    "trackingNumber": tracking_number,
+                    "trackingUrl": tracking_baseurl + tracking_number
+                }
+            ]
+        }
+
+        return self.post(uri, fulfillment)

test_squarespace_api.py

@@ -31,9 +31,34 @@ def test_squarespace_api_pagination():
 
     store = Squarespace(api_key)
     orders = store.orders()
-    assert len(orders) == 20
+    assert len(orders) == 50
     next = store.next_page()
     assert len(next) > 0
     assert orders[0]['id'] != orders[1]['id']
     return True
 
+def test_squarespace_api_fulfillment():
+    """Test fulfillment. This requires both an `api_key` and an `order_info`
+    file.
+
+    `api_key`:
+        A file containing only the squarespace API key.
+
+    `order_info`:
+        A file containing a single line consisting of:
+        `order_id`,`tracking_number`
+    """
+    open_order = open('order_info').read().strip() if exists('order_info') else None
+
+    if not api_key:
+        logging.warning('Missing "api_key" file.')
+        return True
+
+    if not open_order:
+        logging.warning('Missing "order_info" file.')
+        return True
+
+    order_id, tracking_number = open_order.split(',', 2)
+
+    store = Squarespace(api_key)
+    return store.fulfill(order_id, tracking_number, 'USPS', 'First Class')