Merge pull request #93 from recurly/use_invoice_settings_fields

Read and Write custom invoice notes from API

Author: cbarton

CHANGELOG

@@ -1,5 +1,7 @@
 ## Unreleased
 
+- Added ability to read and write invoice notes
+
 ## Version 2.2.6 October 31, 2014
 
 - Bug fix: `subscription.invoice` now returns the invoice for subscription

recurly/__init__.py

@@ -174,11 +174,16 @@ def charge(self, charge):
         url = urljoin(self._url, '%s/adjustments' % self.account_code)
         return charge.post(url)
 
-    def invoice(self):
+    def invoice(self, **kwargs):
         """Create an invoice for any outstanding adjustments this account has."""
         url = urljoin(self._url, '%s/invoices' % self.account_code)
 
-        response = self.http_request(url, 'POST')
+        if kwargs:
+            response = self.http_request(url, 'POST', Invoice(**kwargs), {'Content-Type':
+                'application/xml; charset=utf-8'})
+        else:
+            response = self.http_request(url, 'POST')
+
         if response.status != 201:
             self.raise_http_error(response)
 
@@ -439,8 +444,18 @@ class Invoice(Resource):
         'created_at',
         'line_items',
         'transactions',
+        'terms_and_conditions',
+        'customer_notes',
     )
 
+    blacklist_attributes = (
+        'currency',
+    )
+
+    def serializable_attributes(self):
+        return [attr for attr in self.attributes if attr not in
+                self.blacklist_attributes]
+
     @classmethod
     def all_open(cls, **kwargs):
         """Return a `Page` of open invoices.
@@ -531,7 +546,9 @@ class Subscription(Resource):
         'collection_method',
         'po_number',
         'first_renewal_date',
-        'bulk'
+        'bulk',
+        'terms_and_conditions',
+        'customer_notes',
     )
     sensitive_attributes = ('number', 'verification_value', 'bulk')
 

recurly/resource.py

@@ -227,6 +227,13 @@ class Resource(object):
     even though this `Resource` class has no ``currency`` attribute of
     its own."""
 
+    def serializable_attributes(self):
+        """ Attributes to be serialized in a ``POST`` or ``PUT`` request.
+        Returns all attributes by default. Can be overriden on the child class.
+        """
+
+        return self.attributes
+
     def __init__(self, **kwargs):
         try:
             self.attributes.index('currency') # Test for currency attribute,
@@ -673,7 +680,7 @@ def raise_http_error(cls, response):
     def to_element(self):
         """Serialize this `Resource` instance to an XML element."""
         elem = ElementTree.Element(self.nodename)
-        for attrname in self.attributes:
+        for attrname in self.serializable_attributes():
             # Only use values that have been loaded into the internal
             # __dict__. For retrieved objects we look into the XML response at
             # access time, so the internal __dict__ contains only the elements

tests/fixtures/invoice/invoiced-with-optionals.xml

@@ -0,0 +1,30 @@
+POST https://api.recurly.com/v2/accounts/invoicemock/invoices HTTP/1.1
+Accept: application/xml
+Authorization: Basic YXBpa2V5Og==
+User-Agent: recurly-python/{version}
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<invoice>
+  <terms_and_conditions>Some Terms and Conditions</terms_and_conditions>
+  <customer_notes>Some Customer Notes</customer_notes>
+</invoice>
+
+HTTP/1.1 201 Created
+Content-Type: application/xml; charset=utf-8
+Location: https://api.recurly.com/v2/invoices/4ba1531325014b4f969cd13676f514d8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<invoice href="https://api.recurly.com/v2/invoices/4ba1531325014b4f969cd13676f514d8">
+  <uuid>4ba1531325014b4f969cd13676f514d8</uuid>
+  <account_code>invoicemock</account_code>
+  <amount_in_cents>
+    <USD type="integer">1000</USD>
+  </amount_in_cents>
+  <terms_and_conditions>Some Terms and Conditions</terms_and_conditions>
+  <customer_notes>Some Customer Notes</customer_notes>
+  <start_date type="datetime">2009-11-03T23:27:46-08:00</start_date>
+  <end_date type="datetime"></end_date>
+  <description>test charge</description>
+  <created_at type="datetime">2009-11-03T23:27:46-08:00</created_at>
+</invoice>

tests/fixtures/subscription/error-no-billing-info.xml

@@ -10,6 +10,8 @@ Content-Type: application/xml; charset=utf-8
   <unit_amount_in_cents type="integer">1000</unit_amount_in_cents>
   <currency>USD</currency>
   <bulk type="boolean">true</bulk>
+  <terms_and_conditions>Some Terms and Conditions</terms_and_conditions>
+  <customer_notes>Some Customer Notes</customer_notes>
 </subscription>
 
 HTTP/1.1 400 Bad Request

tests/fixtures/subscription/subscribed.xml

@@ -10,6 +10,8 @@ Content-Type: application/xml; charset=utf-8
   <unit_amount_in_cents type="integer">1000</unit_amount_in_cents>
   <currency>USD</currency>
   <bulk type="boolean">true</bulk>
+  <terms_and_conditions>Some Terms and Conditions</terms_and_conditions>
+  <customer_notes>Some Customer Notes</customer_notes>
 </subscription>
 
 HTTP/1.1 201 Created
@@ -36,6 +38,8 @@ Location: https://api.recurly.com/v2/subscriptions/12345678901234567890123456789
   <current_period_ends_at type="datetime">2010-07-27T07:00:00Z</current_period_ends_at>
   <trial_started_at nil="nil"></trial_started_at>
   <trial_ends_at nil="nil"></trial_ends_at>
+  <terms_and_conditions>Some Terms and Conditions</terms_and_conditions>
+  <customer_notes>Some Customer Notes</customer_notes>
   <subscription_add_ons type="array">
   </subscription_add_ons>
   <a name="cancel" href="https://api.recurly.com/v2/subscriptions/123456789012345678901234567890ab/cancel" method="put"/>

tests/test_resources.py

@@ -541,6 +541,19 @@ def test_invoice(self):
             invoice = account.invoices()[0]
             self.assertEqual(invoice.tax_type, 'usst')
 
+    def test_invoice_with_optionals(self):
+        account = Account(account_code='invoice%s' % self.test_id)
+        with self.mock_request('invoice/account-created.xml'):
+            account.save()
+
+        with self.mock_request('invoice/invoiced-with-optionals.xml'):
+            invoice = account.invoice(terms_and_conditions='Some Terms and Conditions',
+                    customer_notes='Some Customer Notes')
+
+        self.assertEqual(type(invoice), recurly.Invoice)
+        self.assertEqual(invoice.terms_and_conditions, 'Some Terms and Conditions')
+        self.assertEqual(invoice.customer_notes, 'Some Customer Notes')
+
     def test_build_invoice(self):
         account = Account(account_code='invoice%s' % self.test_id)
         with self.mock_request('invoice/account-created.xml'):
@@ -675,7 +688,9 @@ def test_subscribe(self):
                     plan_code='basicplan',
                     currency='USD',
                     unit_amount_in_cents=1000,
-                    bulk=True
+                    bulk=True,
+                    terms_and_conditions='Some Terms and Conditions',
+                    customer_notes='Some Customer Notes'
                 )
 
                 with self.mock_request('subscription/error-no-billing-info.xml'):