DP-311: Add new list invoices endpoint (#9)

* Add new list invoices endpoint

* Python 2.7 didn't agree...

Author: pkopac

README.md

@@ -187,6 +187,7 @@ import chartmogul
 
 chartmogul.Invoice.create(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', data={})
 chartmogul.Invoice.all(config, uuid='cus_5915ee5a-babd-406b-b8ce-d207133fb4cb', page=2, per_page=10)
+chartmogul.Invoice.all(config, customer_uuid='cus_f466e33d-ff2b-4a11-8f85-417eb02157a7', external_id='INV0001')
 ```
 
 #### [Transactions](https://dev.chartmogul.com/docs/transactions)

chartmogul/__init__.py

@@ -29,7 +29,7 @@
 """
 
 __title__ = 'chartmogul'
-__version__ = '1.1.1'
+__version__ = '1.1.2'
 __build__ = 0x000000
 __author__ = 'ChartMogul Ltd'
 __license__ = 'MIT'

chartmogul/api/invoice.py

@@ -39,6 +39,7 @@ class Invoice(Resource):
 
     class _Schema(Schema):
         uuid = fields.String()
+        customer_uuid = fields.String(allow_none=True)
         external_id = fields.String(allow_none=True)
         date = fields.DateTime()
         due_date = fields.DateTime(allow_none=True)
@@ -51,3 +52,16 @@ def make(self, data):
             return Invoice(**data)
 
     _schema = _Schema(strict=True)
+
+    @classmethod
+    def all(cls, config, **kwargs):
+        """
+        Actually uses two different endpoints, where it dispatches the call depends on whether
+        customer uuid is given with the old parameter name ('uuid') or not.
+        """
+        if 'uuid' in kwargs:
+            return super(Invoice, cls).all(config, **kwargs)
+        else:
+            return cls.all_any(config, **kwargs)
+
+Invoice.all_any = Invoice._method('all', 'get', '/invoices')

test/api/test_invoice.py

@@ -145,6 +145,61 @@
     ]
 }
 
+newInvoiceListExample = """
+{
+  "invoices": [
+    {
+      "uuid": "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9",
+      "customer_uuid": "cus_f466e33d-ff2b-4a11-8f85-417eb02157a7",
+      "external_id": "INV0001",
+      "date": "2015-11-01T00:00:00.000Z",
+      "due_date": "2015-11-15T00:00:00.000Z",
+      "currency": "USD",
+      "line_items": [
+        {
+          "uuid": "li_d72e6843-5793-41d0-bfdf-0269514c9c56",
+          "external_id": null,
+          "type": "subscription",
+          "subscription_uuid": "sub_e6bc5407-e258-4de0-bb43-61faaf062035",
+          "plan_uuid": "pl_eed05d54-75b4-431b-adb2-eb6b9e543206",
+          "prorated": false,
+          "service_period_start": "2015-11-01T00:00:00.000Z",
+          "service_period_end": "2015-12-01T00:00:00.000Z",
+          "amount_in_cents": 5000,
+          "quantity": 1,
+          "discount_code": "PSO86",
+          "discount_amount_in_cents": 1000,
+          "tax_amount_in_cents": 900,
+          "account_code": null
+        },
+        {
+          "uuid": "li_0cc8c112-beac-416d-af11-f35744ca4e83",
+          "external_id": null,
+          "type": "one_time",
+          "description": "Setup Fees",
+          "amount_in_cents": 2500,
+          "quantity": 1,
+          "discount_code": "PSO86",
+          "discount_amount_in_cents": 500,
+          "tax_amount_in_cents": 450,
+          "account_code": null
+        }
+      ],
+      "transactions": [
+        {
+          "uuid": "tr_879d560a-1bec-41bb-986e-665e38a2f7bc",
+          "external_id": null,
+          "type": "payment",
+          "date": "2015-11-05T00:14:23.000Z",
+          "result": "successful"
+        }
+      ]
+    }
+  ],
+  "current_page": 1,
+  "total_pages": 1
+}
+"""
 
 class InvoiceTestCase(unittest.TestCase):
     """
@@ -192,4 +247,38 @@ def test_list_has_customer_uuid(self, mock_requests):
         # Struct too complex to do 1:1 comparison
         self.assertTrue(isinstance(result, Invoice._many))
         self.assertEqual(len(result.invoices), 1)
+        self.assertTrue(isinstance(result.invoices[0], Invoice))
+        self.assertEqual(result.invoices[0].uuid, "inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9")
         self.assertEqual(result.customer_uuid, 'UUID')
+
+    @requests_mock.mock()
+    def test_new_list(self, mock_requests):
+
+        mock_requests.register_uri(
+            'GET',
+            ("https://api.chartmogul.com/v1/invoices"
+            "?external_id=INV0001&customer_uuid=cus_f466e33d-ff2b-4a11-8f85-417eb02157a7"),
+            request_headers={'Authorization': 'Basic dG9rZW46c2VjcmV0'},
+            headers={'Content-Type': 'application/json'},
+            status_code=200,
+            text=newInvoiceListExample
+        )
+
+        config = Config("token", "secret")  # is actually checked in mock
+        result = Invoice.all(config,
+                             customer_uuid='cus_f466e33d-ff2b-4a11-8f85-417eb02157a7',
+                             external_id='INV0001').get()
+
+        self.assertEqual(mock_requests.call_count, 1, "expected call")
+        cu = []
+        cu.append('cus_f466e33d-ff2b-4a11-8f85-417eb02157a7')
+        ei = []
+        ei.append('inv0001')
+        self.assertEqual(mock_requests.last_request.qs, {'customer_uuid': cu,'external_id': ei})
+        # Struct too complex to do 1:1 comparison
+        self.assertTrue(isinstance(result, Invoice._many))
+        self.assertEqual(len(result.invoices), 1)
+
+        self.assertEqual(result.invoices[0].customer_uuid, 'cus_f466e33d-ff2b-4a11-8f85-417eb02157a7')
+        self.assertEqual(result.current_page, 1)
+        self.assertEqual(result.total_pages, 1)