Merge pull request #1 from databox/patch-patchage-01

Patch Patchage 01

Author: otobrglez

.env

@@ -0,0 +1,2 @@
+workon databox-python 
+

.gitignore

@@ -0,0 +1,59 @@
+# Source: https://github.com/github/gitignore/blob/master/Python.gitignore
+*.xml
+*.pid
+.idea/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/

.travis.yml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - "2.7"
+install:
+  - "pip install ."
+  - "pip install -r requirements.txt"
+script:
+  - python -m unittest discover -v

README.md

@@ -1,39 +1,71 @@
-Databox bindings for Python
-===========================
+# Databox bindings for Python
 
-Setup
------
+## Setup
 
 You can install this package by cloning this directory and running:
 
    ```$ python setup.py install```
 
-Getting Databox access tokens
------------------------------
+## Getting Databox access tokens
 
 When in Databox Designer go to Account > Access tokens, then either create a new token or get already existing one.
 
+## Using the Databox Python library
+
+To use databox-python libary you have to pass access token to client. You can do this when initialising `Client` or by setting `DATABOX_PUSH_TOKEN` environment variable.
+
+Using `Client` and `push` to push data directly:
 
-Using the Databox Python library
---------------------------------
 ```python
+from databox import Client
 
-    from databox import PushClient
+client = Client('<access token>')
+client.push('sales.total', 1447.0)
+client.push('orders.total', 32, date='2015-01-01 09:00:00')
+```
 
-    # instantiate PushClient
-    client = PushClient('<access token>')
+Inserting multiple matrices with one `insert_all`:
 
-    # push metric "answer1" with value 42 for today
-    client.add(42, "answer1")
+```python
+client.insert_all([
+    {'key': 'temp.boston', 'value': 51},
+    {'key': 'temp.boston', 'value': 49, 'date': '2015-01-01 17:00:00'},
+    {'key': 'sales.total', 'value': 3000},
+])
+```
 
-    # push metric "answer1" with value 42 for any other day
-    client.add(42, "answer1", "2015-05-01 10:10:10")
+Retriving information from last push with `last_push`:
+```python
+print client.last_push()
+```
 
-    # send to Databox
-    print client.send()
+Libary can be used with shorthand methods: 
 
-    # get last push
-    print client.lastPush()
+
+```python
+from databox import push, insert_all, last_push
+
+push('sales.total', 1448.9)
+print last_push(token)
 ```
 
-Check working sample in [sample1.py](/sample1.py) file
+## Development and testing
+
+Using virtualenv:
+
+    mkvirtualenv --no-site-packages databox-python
+    workon databox-python
+    pip install --upgrade -r requirements.txt
+    
+Running test suite with unittest:
+
+    python -munittest discover -p -t . 'test*' -v
+
+## Authors and contributions
+
+- [Vlada Petrović](https://github.com/VladaPetrovic)
+- [Oto Brglez](https://github.com/otobrglez)
+
+## Licence
+
+- [MIT](LICENSE.txt)

databox test/__init__.py

@@ -0,0 +1,69 @@
+import unittest
+from databox import *
+from pprint import pprint as pp
+
+
+def mock_push_json(data=None, path='/'):
+    return {'status': 'ok'}
+
+
+class TestPush(unittest.TestCase):
+    def setUp(self):
+        self.databox_push_token = "adxg1kq5a4g04k0wk0s4wkssow8osw84"
+        self.client = Client(self.databox_push_token)
+
+        self.original_push_json = self.client._push_json
+        self.client._push_json = mock_push_json
+
+    def test_push(self):
+        assert self.client.push("templj", 10.0) is True
+        assert self.client.push("templj", 12.0, date="2015-01-01 09:00:00") is True
+
+    def test_push_validation(self):
+        self.assertRaises(
+            Client.KPIValidationException,
+            lambda: self.client.push(None, None)
+        )
+
+    def test_insert_all(self):
+        assert self.client.insert_all([
+            {'key': 'templj', 'value': 83.3},
+            {'key': 'templj', 'value': 83.3, 'date': "2015-01-01 09:00:00"},
+            {'key': 'templj', 'value': 12.3},
+        ]) is True
+
+        self.assertRaises(
+            Client.KPIValidationException,
+            lambda: self.client.insert_all([
+                {'value': 83.3},
+                {'key': 'templj', 'value': 83.3, 'date': "2015-01-01 09:00:00"},
+                {'key': 'templj', 'value': 12.3},
+            ])
+        )
+
+    def test_last_push(self):
+        self.client._push_json = lambda data=None, path='/': {
+            'err': [],
+            'no_err': 0
+        }
+
+        assert self.client.last_push()['err'] == []
+
+    def test_short(self):
+        Client._push_json = mock_push_json
+
+        assert push("templj", 22, token=self.databox_push_token) is True
+
+        assert insert_all([
+            {
+                'key': 'templj',
+                'value': 83.3
+            },
+        ], token=self.databox_push_token) is True
+
+        Client._push_json = lambda data=None, path='/': {
+            'err': [],
+            'no_err': 0
+        }
+
+        assert last_push(token=self.databox_push_token)['err'] == []

databox test/test_push.py

@@ -1,11 +1,80 @@
-# Databox Python bindings
-# Authors:
-# Vlada Petrovic <[email protected]>
-
-__package_name__ = 'databox'
-__version__ = '0.1'
-__author__ = 'Vlada Petrovic'
-__author_email__ = '[email protected]'
-__description__ = (
-    '''Push metrics to Databox. ''')
-__url__ = 'https://github.com/databox/databox-python'
+import requests
+from requests.auth import HTTPBasicAuth
+from os import getenv
+from json import dumps as json_dumps
+
+
+class Client(object):
+    push_token = None
+    push_host = 'https://push2new.databox.com'
+
+    class MissingToken(Exception):
+        pass
+
+    class KPIValidationException(Exception):
+        pass
+
+    def __init__(self, token=None):
+        self.push_token = token
+        if self.push_token is None:
+            self.push_token = getenv('DATABOX_PUSH_TOKEN', None)
+
+        if self.push_token is None:
+            raise self.MissingToken('Push token is missing!')
+
+        self.push_host = getenv('DATABOX_PUSH_HOST', self.push_host)
+
+    def process_kpi(self, **args):
+        key = args.get('key', None)
+        if key is None:
+            raise self.KPIValidationException('Missing "key"')
+
+        value = args.get('value', None)
+        if value is None:
+            raise self.KPIValidationException('Missing "value"')
+
+        item = {("$%s" % args['key']): args['value']}
+
+        date = args.get('date', None)
+        if date is not None:
+            item['date'] = date
+
+        return item
+
+    def _push_json(self, data=None, path="/"):
+        if data is not None:
+            data = json_dumps(data)
+
+        response = requests.post(
+            self.push_host + path,
+            auth=HTTPBasicAuth(self.push_token, ''),
+            headers={'Content-Type': 'application/json'},
+            data=data
+        )
+
+        return response.json()
+
+    def push(self, key, value, date=None):
+        return self._push_json({
+            'data': [self.process_kpi(key=key, value=value, date=date)]
+        })['status'] == 'ok'
+
+    def insert_all(self, rows):
+        return self._push_json({
+            'data': [self.process_kpi(**row) for row in rows]
+        })['status'] == 'ok'
+
+    def last_push(self):
+        return self._push_json(path='/lastpushes/1')
+
+
+def push(key, value, date=None, token=None):
+    return Client(token).push(key, value, date)
+
+
+def insert_all(rows=[], token=None):
+    return Client(token).insert_all(rows)
+
+
+def last_push(token=None):
+    return Client(token).last_push()