invoiceninja.py

# -*- coding: utf8 -*-
#
# Copyright (C) 2016 Scifabric LTD.
#
# PyBossa is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# PyBossa is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this software.  If not, see <http://www.gnu.org/licenses/>.

import requests
import datetime
from dateutil.relativedelta import relativedelta


class invoiceNinja(object):
    """Class for handling Invoice Ninja API."""

    def __init__(self, token, url='https://app.invoiceninja.com/api/v1/'):
        """Add Invoice Ninja token."""

        self.token = token
        self.url = url
        self.headers = {'X-Ninja-Token': self.token}
        self.static = self.get_static_data()
        self.client = None
        self.invoice = None

    def get_static_data(self):
        """Get static data from Invoice Ninja."""
        res = requests.get(self.url + 'static', headers=self.headers)
        if res.status_code == 200:
            return res.json()['data']

    def exists_client(self, client):
        """Return True if client exists."""
        suburl = 'clients?email=' + client['contact']['email']
        res = requests.get(self.url + suburl, json=client, headers=self.headers)
        if res.status_code == 200:
            data = res.json()
            if len(data['data']) > 0:
                if (len(data['data']) >= 1) and (data['data'][0]['is_deleted'] == True):
                    return False
                d = dict()
                d['data'] = data['data'][0]
                self.client = d
                return d
            else:
                return False
        return False

    def create_client(self, client):
        """Create a client in Invoice Ninja."""
        client_data = self.exists_client(client)
        if not client_data:
            res = requests.post(self.url + 'clients', json=client, headers=self.headers)
            if res.status_code == 200:
                self.client = res.json()
                return self.client
            else:
                return res.json()
        else:
            return client_data

    def create_invoice(self, product):
        """Create an invoice for a client."""
        product['client_id'] = self.client['data']['id']
        res = requests.post(self.url + 'invoices?include=invitations', json=product,
                            headers=self.headers)
        if res.status_code == 200:
            self.invoice = res.json()
            return self.invoice
        else:
            return res.json()

    def create_recurring_invoice(self, product):
        """Create a recurring invoice for a client."""

        product['is_recurring'] = True
        product['client_id'] = self.client['data']['id']
        product['auto_bill'] = True

        today = datetime.datetime.now().date()
        product['start_date'] = today.isoformat()

        if product['recurring'] == 'monthly':
            end_date = (today + datetime.timedelta(days=365)).isoformat()
            end_date = (today + relativedelta(months=1)).isoformat()
            product['end_date'] = end_date
            product['frequency_id'] = self.get_frequency_id('monthly')

        if product['recurring'] == 'annually':
            end_date = (today + relativedelta(years=1)).isoformat()
            product['end_date'] = end_date
            product['frequency_id'] = self.get_frequency_id('annually')

        del product['recurring']

        res = requests.post(self.url + 'invoices?include=invitations', json=product,
                            headers=self.headers)
        if res.status_code == 200:
            self.invoice = res.json()
            return self.invoice
        else:
            return res.json()


    def checkout(self, client, product): # pragma: no cover
        """Create a client and an invoice for the client."""
        self.create_client(client)
        self.create_invoice(product)

    def get_frequency_id(self, name):
        """Return frequency ID for name."""
        for f in self.static['frequencies']:
            if f['name'].lower() == name.lower():
                return f['id']