Merge pull request #12 from yaqwsx/master

Add support for Expenses

Author: farin

fakturoid/api.py

@@ -5,7 +5,7 @@
 
 import requests
 
-from fakturoid.models import Account, Subject, Invoice, Generator, Message
+from fakturoid.models import Account, Subject, Invoice, Generator, Message, Expense
 from fakturoid.paging import ModelList
 
 __all__ = ['Fakturoid']
@@ -31,6 +31,7 @@ def __init__(self, slug, email, api_key, user_agent=None):
             Account: AccountApi(self),
             Subject: SubjectsApi(self),
             Invoice: InvoicesApi(self),
+            Expense: ExpensesApi(self),
             Generator: GeneratorsApi(self),
             Message: MessagesApi(self),
         }
@@ -89,6 +90,18 @@ def invoices(self, mapi, *args, **kwargs):
     def fire_invoice_event(self, mapi, id, event, **kwargs):
         return mapi.fire(id, event, **kwargs)
 
+    @model_api(Expense)
+    def expense(self, mapi, id):
+        return mapi.load(id)
+
+    @model_api(Expense)
+    def expenses(self, mapi, *args, **kwargs):
+        return mapi.find(*args, **kwargs)
+
+    @model_api(Expense)
+    def fire_expense_event(self, mapi, id, event, **kwargs):
+        return mapi.fire(id, event, **kwargs)
+
     @model_api(Generator)
     def generator(self, mapi, id):
         return mapi.load(id)
@@ -308,6 +321,68 @@ def find(self, proforma=None, subject_id=None, since=None, updated_since=None, n
         return ModelList(self, endpoint, params)
 
 
+class ExpensesApi(CrudModelApi):
+    """If number argument is givent returms single Expense object (or None),
+    otherwise iterable list of expenses are returned.
+    """
+    model_type = Expense
+    endpoint = 'expenses'
+
+    STATUSES = ['open', 'overdue', 'paid']
+    EVENTS = ['remove_payment', 'deliver', 'pay', 'lock', 'unlock']
+    EVENT_ARGS = {
+        'pay': {'paid_on', 'paid_amount', 'variable_symbol', 'bank_account_id'}
+    }
+
+    def fire(self, expense_id, event, **kwargs):
+        if not isinstance(expense_id, int):
+            raise TypeError('expense_id must be int')
+        if event not in self.EVENTS:
+            raise ValueError('invalid event, expected one of {0}'.format(', '.join(self.EVENTS)))
+
+        allowed_args = self.EVENT_ARGS.get(event, set())
+        if not set(kwargs.keys()).issubset(allowed_args):
+            msg = "invalid event arguments, only {0} can be used with {1}".format(', '.join(allowed_args), event)
+            raise ValueError(msg)
+
+        params = {'event': event}
+        params.update(kwargs)
+
+        if 'paid_on' in params:
+            if not isinstance(params['paid_on'], date):
+                raise TypeError("'paid_on' argument must be date")
+            params['paid_on'] = params['paid_on'].isoformat()
+
+        self.session._post('expenses/{0}/fire'.format(expense_id), {}, params=params)
+
+    def find(self, subject_id=None, since=None, updated_since=None, number=None, status=None, custom_id=None, variable_symbol=None):
+        params = {}
+        if subject_id:
+            if not isinstance(subject_id, int):
+                raise TypeError("'subject_id' parameter must be int")
+            params['subject_id'] = subject_id
+        if since:
+            if not isinstance(since, (datetime, date)):
+                raise TypeError("'since' parameter must be date or datetime")
+            params['since'] = since.isoformat()
+        if updated_since:
+            if not isinstance(updated_since, (datetime, date)):
+                raise TypeError("'updated_since' parameter must be date or datetime")
+            params['updated_since'] = updated_since.isoformat()
+        if number:
+            params['number'] = number
+        if custom_id:
+            params['custom_id'] = custom_id
+        if status:
+            if status not in self.STATUSES:
+                raise ValueError('invalid invoice status, expected one of {0}'.format(', '.join(self.STATUSES)))
+            params['status'] = status
+        if variable_symbol:
+            params['variable_symbol'] = variable_symbol
+
+        return ModelList(self, self.endpoint, params)
+
+
 class GeneratorsApi(CrudModelApi):
     model_type = Generator
     endpoint = 'generators'

fakturoid/models.py

@@ -5,7 +5,8 @@
 
 from fakturoid import six
 
-__all__ = ['Account', 'Subject', 'InvoiceLine', 'Invoice', 'Generator', 'Message']
+__all__ = ['Account', 'Subject', 'InvoiceLine', 'Invoice', 'Generator',
+           'Message', 'Expense']
 
 
 class Model(six.UnicodeMixin):
@@ -160,6 +161,27 @@ def __unicode__(self):
         return self.number
 
 
+class Expense(AbstractInvoice):
+    """See http://docs.fakturoid.apiary.io/ for complete field reference."""
+    number = None
+
+    class Meta:
+        readonly = [
+            'id', 'supplier_name', 'supplier_street', 'supplier_city',
+            'supplier_zip', 'supplier_country', 'supplier_registration_no',
+            'supplier_vat_no', 'status', 'paid_on', 'subtotal', 'total',
+            'native_subtotal', 'native_total', 'html_url', 'url', 'subject_url',
+            'created_at', 'updated_at'
+        ]
+        decimal = [
+            'exchange_rate', 'subtotal', 'total',
+            'native_subtotal', 'native_total'
+        ]
+
+    def __unicode__(self):
+        return self.number
+
+
 class Generator(AbstractInvoice):
     """See http://docs.fakturoid.apiary.io/ for complete field reference."""
     name = None