Add promotions. References #17

README.rst

@@ -30,6 +30,8 @@ Getting Started
 To get started with Sharpy, simply install it like you would any other python
 package
 
+.. code::
+
     pip install sharpy
 
 Optionally, you can also install `lxml <http://codespeak.net/lxml/>`_ on your
@@ -50,8 +52,19 @@ Code
 You can checkout and download Sharpy's latest code at `Github
 <https://github.com/saaspire/sharpy>`_.
 
+Installing elementtree for Development and Unit Testing
+=======================================================
+When trying to install elementtree, pip may report that there is no such package. If this happens to you, you can work around by downloading and installing it manually.
+
+.. code::
+
+    wget http://effbot.org/media/downloads/elementtree-1.2.6-20050316.zip
+    unzip elementtree-1.2.6-20050316.zip
+    cd elementtree-1.2.6-20050316/
+    pip install .
+
 TODOs
 =====
 
 * Flesh out the documentation to cover the full API.
-* Add support for the various filtering options in the `get_customers` call.
+* Add support for the various filtering options in the `get_customers` call.

sharpy/__init__.py

@@ -1 +1 @@
-VERSION = (0, 8)
+VERSION = (0, 9)

sharpy/parsers.py

@@ -328,4 +328,69 @@ def parse_subscription_item(self, item_element):
         item['modified_datetime'] = self.parse_datetime(item_element.findtext('modifiedDatetime'))
 
         return item
-
+
+
+class PromotionsParser(CheddarOutputParser):
+    '''
+    A utility class for parsing cheddar's xml output for promotions.
+    '''
+    def parse_xml(self, xml_str):
+        promotions = []
+        promotions_xml = XML(xml_str)
+        for promotion_xml in promotions_xml:
+            promotion = self.parse_promotion(promotion_xml)
+            promotions.append(promotion)
+
+        return promotions
+
+    def parse_promotion(self, promotion_element):
+        promotion = {}
+        promotion['id'] = promotion_element.attrib['id']
+        promotion['name'] = promotion_element.findtext('name')
+        promotion['description'] = promotion_element.findtext('description')
+        promotion['created_datetime'] = self.parse_datetime(promotion_element.findtext('createdDatetime'))
+
+        promotion['incentives'] = self.parse_incentives(promotion_element.find('incentives'))
+        promotion['coupons'] = self.parse_coupons(promotion_element.find('coupons'))
+
+        return promotion
+
+    def parse_incentives(self, incentives_element):
+        incentives = []
+
+        if incentives_element is not None:
+            for incentive_element in incentives_element:
+                incentives.append(self.parse_incentive(incentive_element))
+
+        return incentives
+
+    def parse_incentive(self, incentive_element):
+        incentive = {}
+
+        incentive['id'] = incentive_element.attrib['id']
+        incentive['type'] = incentive_element.findtext('type')
+        incentive['percentage'] = incentive_element.findtext('percentage')
+        incentive['months'] = incentive_element.findtext('months')
+        incentive['created_datetime'] = self.parse_datetime(incentive_element.findtext('createdDatetime'))
+
+        return incentive
+
+    def parse_coupons(self, coupons_element):
+        coupons = []
+
+        if coupons_element is not None:
+            for coupon_element in coupons_element:
+                coupons.append(self.parse_coupon(coupon_element))
+
+        return coupons
+
+    def parse_coupon(self, coupon_element):
+        coupon = {}
+
+        coupon['id'] = coupon_element.attrib['id']
+        coupon['code'] = coupon_element.attrib['code']
+        coupon['max_redemptions'] = coupon_element.findtext('maxRedemptions')
+        coupon['expiration_datetime'] = self.parse_datetime(coupon_element.findtext('expirationDatetime'))
+        coupon['created_datetime'] = self.parse_datetime(coupon_element.findtext('createdDatetime'))
+
+        return coupon

sharpy/product.py

@@ -7,7 +7,7 @@
 
 from sharpy.client import Client
 from sharpy.exceptions import NotFound
-from sharpy.parsers import PlansParser, CustomersParser
+from sharpy.parsers import PlansParser, CustomersParser, PromotionsParser
 
 class CheddarProduct(object):
 
@@ -263,8 +263,42 @@ def delete_all_customers(self):
             path='customers/delete-all/confirm/%d' % int(time()),
             method='POST'
         )
-
-
+
+    def get_all_promotions(self):
+        '''
+        Returns all promotions.
+        https://cheddargetter.com/developers#promotions
+        '''
+        promotions = []
+
+        try:
+            response = self.client.make_request(path='promotions/get')
+        except NotFound:
+            response = None
+
+        if response:
+            promotions_parser = PromotionsParser()
+            promotions_data = promotions_parser.parse_xml(response.content)
+            promotions = [Promotion(**promotion_data) for promotion_data in promotions_data]
+
+        return promotions
+
+    def get_promotion(self, code):
+        '''
+        Get the promotion with the specified coupon code.
+        https://cheddargetter.com/developers#single-promotion
+        '''
+
+        response = self.client.make_request(
+            path='promotions/get',
+            params={'code': code},
+        )
+        promotion_parser = PromotionsParser()
+        promotion_data = promotion_parser.parse_xml(response.content)
+
+        return Promotion(**promotion_data[0])
+
+
 class PricingPlan(object):
 
     def __init__(self, name, code, id, description, is_active, is_free,
@@ -576,12 +610,12 @@ def __init__(self, id, gateway_token, cc_first_name, cc_last_name,
 
         super(Subscription, self).__init__()
 
-    def load_data(self, id, gateway_token, cc_first_name, cc_last_name, \
-                 cc_company, cc_country, cc_address, cc_city, cc_state, \
-                 cc_zip, cc_type, cc_last_four, cc_expiration_date, customer,\
-                 cc_email=None, canceled_datetime=None ,created_datetime=None, \
-                 plans=None, invoices=None, items=None, gateway_account=None, \
-                 cancel_reason=None, cancel_type=None, redirect_url=None):
+    def load_data(self, id, gateway_token, cc_first_name, cc_last_name,
+                  cc_company, cc_country, cc_address, cc_city, cc_state,
+                  cc_zip, cc_type, cc_last_four, cc_expiration_date, customer,
+                  cc_email=None, canceled_datetime=None ,created_datetime=None,
+                  plans=None, invoices=None, items=None, gateway_account=None,
+                  cancel_reason=None, cancel_type=None, redirect_url=None):
 
         self.id = id
         self.gateway_token = gateway_token
@@ -764,5 +798,36 @@ def set(self, quantity):
         )
 
         return self.subscription.customer.load_data_from_xml(response.content)
-
-
+
+
+class Promotion(object):
+    def __init__(self, id=None, code=None, name=None, description=None,
+                 created_datetime=None, incentives=None, coupons=None):
+
+        self.load_data(code=code, id=id, name=name, description=description,
+                       created_datetime=created_datetime,
+                       incentives=incentives, coupons=coupons)
+
+        super(Promotion, self).__init__()
+
+    def __repr__(self):
+        return u'Promotion: %s (%s)' % (self.name, self.code,)
+
+    def __unicode__(self):
+        return u'{0} ({1})'.format(self.name, self.code)
+
+    def load_data(self, id=None, code=None, name=None, description=None,
+                  created_datetime=None, incentives=None, coupons=None):
+
+        self.code = code
+        self.id = id
+        self.name = name
+        self.description = description
+        self.created = created_datetime
+
+        self.incentives = incentives
+        self.coupons = coupons
+
+        # Bring coupon code up to parent promotion
+        if self.code is None and self.coupons and len(self.coupons) > 0:
+            self.code = self.coupons[0].get('code')

tests/client_tests.py

@@ -93,8 +93,9 @@ def test_make_request_access_denied(self):
         client = self.get_client(username=bad_username)
         client.make_request(path)
 
-    @raises(BadRequest)
+    @raises(NotFound)
     def test_make_request_bad_request(self):
+        """ Attempt to grab the plans without adding /get to the url. """
         path = 'plans'
         client = self.get_client()
         client.make_request(path)
@@ -104,7 +105,7 @@ def test_make_request_not_found(self):
         path = 'things-which-dont-exist'
         client = self.get_client()
         client.make_request(path)
-        
+
     @clear_users
     def test_post_request(self):
         path = 'customers/new'
@@ -118,7 +119,6 @@ def test_post_request(self):
         client = self.get_client()
         client.make_request(path, data=data)
 
-
     def generate_error_response(self, auxcode=None, path=None, params=None, **overrides):
         '''
         Creates a request to cheddar which should return an error
@@ -244,7 +244,9 @@ def test_format_datetime_with_now(self):
 
     @clear_users
     def test_chedder_update_customer_error(self):
-        # Overriding the zipcode so a customer actually gets created
+        """
+        Test overriding the zipcode so a customer actually gets updated.
+        """
         overrides = {
             'subscription[ccZip]': 12345
         }