added webhook creation method and example (#62)

* bump version, include webhook example, add webhook class

* Update `example/tracking.py`

* Update `api_requestor.py`

cleaner empty request body check (from 204 DELETE).

Author: jfriedr

examples/tracking.py

@@ -23,7 +23,24 @@
 tracking = shippo.Track.get_status(carrier_token, tracking_number)
 print(tracking)
 
-# Registering a tracking webhook
+# Create a webhook endpoint (FYI-basic auth not supported) 
+# For a full list of Webhook Event Types see https://goshippo.com/docs/webhooks/
+new_webhook_response = shippo.Webhook.create(url='https://exampledomain.com',event='all') 
+print(new_webhook_response)
+
+# list webhook(s)
+webhook_list = shippo.Webhook.list_webhooks()
+print(webhook_list)
+
+# remove all webhooks
+for webhook in webhook_list['results']:
+    print("about to delete webhook {}".format(webhook['object_id']))
+    webhook_remove = shippo.Webhook.delete(object_id=webhook['object_id'])
+    # print empty 204 status
+    print(webhook_remove)
+
+
+# Registering a tracking number for webhook
 webhook_response = shippo.Track.create(
     carrier=carrier_token,
     tracking_number=tracking_number,

shippo/__init__.py

@@ -11,4 +11,5 @@
     Shipment,
     Track,
     Transaction,
+    Webhook,
 )

shippo/api_requestor.py

@@ -162,7 +162,9 @@ def interpret_response(self, rbody, rcode):
         try:
             if hasattr(rbody, 'decode'):
                 rbody = rbody.decode('utf-8')
-            resp = util.json.loads(rbody)
+                if rbody == '':
+                    rbody = '{"msg": "empty_response"}'
+                resp = util.json.loads(rbody)                
         except Exception:
             raise error.APIError(
                 "Invalid response body from API: %s "

shippo/resource.py

@@ -231,6 +231,15 @@ def update(cls, object_id, api_key=None, **params):
         response, api_key = requestor.request('put', url, params)
         return convert_to_shippo_object(response, api_key)
 
+    @classmethod
+    def remove(cls, object_id, api_key=None, **params):
+        object_id = object_id
+        extn = urllib.parse.quote_plus(object_id)
+        requestor = api_requestor.APIRequestor(api_key)
+        url = cls.class_url() + extn
+        response, api_key = requestor.request('delete', url, params)
+        return "Deleted the webhook"
+
 
 # ---- API objects ----
 
@@ -364,6 +373,66 @@ class CarrierAccount(CreateableAPIResource, ListableAPIResource, FetchableAPIRes
     def class_url(cls):
         return "v1/carrier_accounts/"
 
+class Webhook(CreateableAPIResource, ListableAPIResource, FetchableAPIResource, UpdateableAPIResource):
+    """
+    retrieve, update and delete webhooks for a Shippo account programmatically. The same functionality is already exposed in the Shippo dashboard at https://app.goshippo.com/api/.
+
+    To add both a webhook and track a url at the same see the shippo.Track.create function.
+    """
+
+    @classmethod
+    def class_url(cls):
+        cls_name = cls.class_name()
+        return "v1/%ss/" % (cls_name,)
+
+    @classmethod
+    def list_webhooks(cls, api_key=None, **params):
+        """List all the webhooks associated with the account"""
+        return super(Webhook, cls).all(api_key, **params)
+
+    @classmethod
+    def create(cls, api_key=None, **params):
+        """Create a Webhook to push events from Shippo (i.e tracking,transations)
+
+        Arguments:
+            **params
+                url (str) -- url of your webhook (make sure it is not behind basic auth.
+                                  endpoint must return 200 when it receives a POST  
+                event (str) -- any valid webhook event as listed here https://goshippo.com/docs/webhooks.
+                is_test (str) -- set the webhook object to test or live mode
+        Keyword Arguments:
+            api_key (str) -- an api key, if not specified here it will default to the key
+                             set in your environment var or by shippo.api_key = "..."
+
+        Returns:
+            (ShippoObject) -- The server response
+        """
+
+        return super(Webhook, cls).create(api_key, **params)
+        
+    @classmethod
+    def update_webhook(cls,object_id, api_key=None, **params):
+        """ 
+            Update webhook's url, is_test, and/or event
+        """
+        return super(Webhook, cls).update(api_key, **params)
+
+    @classmethod
+    def delete(cls, object_id,api_key=None, **params):
+        """ Remove webhook
+
+        Arguments:
+            object_id (str) -- object_id of webhook
+        Keyword Arguments:
+            api_key (str) -- an api key, if not specified here it will default to the key
+                             set in your environment var or by shippo.api_key = "..."
+
+        Returns:
+            (ShippoObject) -- The server response
+        """
+        return super(Webhook, cls).remove(object_id,api_key, **params)
+
+
 
 class Track(CreateableAPIResource):
     """

shippo/version.py

@@ -1 +1 @@
-VERSION = '2.0.0'
+VERSION = '2.0.1'