initial import of eventfabric lib

Author: marianoguerra

.gitignore

@@ -0,0 +1,2 @@
+__pycache__
+*.pyc

README.rest

@@ -0,0 +1,57 @@
+Event Fabric API Client
+=======================
+
+Python 2 and 3 implementation of Event Fabric API to send events.
+
+Setup
+-----
+
+The library dependes on the `Requests <http://docs.python-requests.org/en/latest/>`_ HTTP library, install it with::
+
+    pip install requests
+
+Usage
+-----
+
+see the examples folder for more usage examples
+
+::
+
+    # import the library
+    >>> import eventfabric as ef
+
+    # create a client instance specifying username and password
+    >>> client = ef.Client("username", "password")
+
+    # authenticate, should return True and 200, if not there was an error
+    >>> client.login()
+    (True, <Response [200]>)
+
+    # create an event instance
+
+    # the first parameter is a free form JSON
+    # value that contains information about the event
+
+    # the second is the name of the channel where that event will go to
+
+    # the channel is used to subscribe to a stream of events with the same
+    # channel id
+    >>> event1 = ef.Event({"name": "Bob", "count": 10}, "my.channel")
+
+    # send the event, it should return True and 201, if not there was an error,
+    # make sure to check for authentication errors on long running agents to
+    # reauthenticate in case your credentials expire
+    >>> client.send_event(event1)
+    (True, <Response [201]>)
+
+Test
+----
+
+::
+
+    python tests/eventfabric_tests.py
+
+License
+-------
+
+MIT

eventfabric.py

@@ -0,0 +1,79 @@
+"""Event Fabric API Client Library"""
+from __future__ import print_function
+
+import sys
+import json
+
+try:
+    import requests
+except ImportError:
+    print("Couldn't import requests library")
+    print("Install it with 'pip install requests' and try again")
+    sys.exit(-1)
+
+class Client(object):
+    """API Client"""
+    def __init__(self, username, password,
+            root_url="https://event-fabric.com/api/"):
+        self.root_url = root_url if root_url.endswith("/") else root_url + "/"
+        self.username = username
+        self.password = password
+        self.cookies = None
+
+    def login(self, requester=requests.post):
+        """login to the service with the specified credentials, return a tuple
+        with a boolean specifying if the login was successful and the response
+        object"""
+        headers = {'content-type': 'application/json'}
+        response = requester(self.endpoint("session"),
+                data=json.dumps(self.credentials), headers=headers)
+
+        self.cookies = response.cookies
+
+        status_ok = response.status_code in (200, 201)
+        return status_ok, response
+
+    @property
+    def credentials(self):
+        """get credentials information"""
+        return {
+                "username": self.username,
+                "password": self.password
+        }
+
+    def endpoint(self, path):
+        """return the service endpoint for path"""
+        return self.root_url + path
+
+    def send_event(self, event, requester=requests.post):
+        """send event to server, return a tuple with a boolean specifying if
+        the login was successful and the response object"""
+ 
+        headers = {'content-type': 'application/json'}
+        response = requester(self.endpoint("event"),
+                data=json.dumps(event.json), cookies=self.cookies,
+                headers=headers)
+
+        status_ok = response.status_code in (200, 201)
+        return status_ok, response
+
+class Event(object):
+    """an object representing an event to be sent to the server,
+    
+    value is a free form json value that contains the information from
+    the event.
+    channel is a string with the name that identifies this kind of events
+    username is the logged in username"""
+
+    def __init__(self, value, channel):
+
+        self.value = value
+        self.channel = channel
+
+    @property
+    def json(self):
+        """return a json representation of the object"""
+        return {"value": self.value, "channel": self.channel}
+
+    def __str__(self):
+        return json.dumps(self.json)

tests/eventfabric_tests.py

@@ -0,0 +1,90 @@
+"tests for event fabric API"
+import os
+import sys
+import json
+import unittest
+
+TEST_DIR = os.path.dirname(__file__)
+BASE_DIR = os.path.join(TEST_DIR, '..')
+sys.path.append(BASE_DIR)
+
+import eventfabric as ef
+
+class FakeResponse(object):
+    "fake response object"
+    def __init__(self, status_code=200, cookies=None):
+        self.status_code = status_code
+        self.cookies = cookies
+
+def fake_post(storage, return_value):
+    "build a fake post function"
+    def fun(*args, **kwargs):
+        "receives and stores all args, returns return_value"
+        storage.append((args, kwargs))
+        return return_value
+
+    return fun
+
+
+class TestEventFabric(unittest.TestCase):
+    "tests event fabric api"
+
+    def test_client_creation(self):
+        "test that the client is created and parameters are set correctly"
+        client = ef.Client("username", "password",
+                "http://localhost:8080/ef/api")
+        self.assertEqual(client.username, "username")
+        self.assertEqual(client.password, "password")
+        self.assertEqual(client.root_url, "http://localhost:8080/ef/api/")
+        self.assertEqual(client.cookies, None)
+        self.assertEqual(client.credentials["username"], "username")
+        self.assertEqual(client.credentials["password"], "password")
+
+    def test_endpoint(self):
+        "tests that endpoints are created correctly"
+        client = ef.Client("username", "password",
+                "http://localhost:8080/ef/api")
+        self.assertEqual(client.endpoint("session"),
+                "http://localhost:8080/ef/api/session")
+
+    def test_login(self):
+        client = ef.Client("username", "password",
+                "http://localhost:8080/ef/api")
+        storage = []
+        requester = fake_post(storage, FakeResponse(200, "cookies!"))
+        status, response = client.login(requester)
+        args, kwargs = storage.pop()
+        endpoint = args[0]
+        data_arg = kwargs["data"]
+        headers = kwargs["headers"]
+
+        self.assertTrue(status) 
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.cookies, "cookies!")
+        self.assertEqual(response.cookies, client.cookies)
+        self.assertEqual(data_arg, json.dumps(client.credentials))
+        self.assertEqual(headers["content-type"], "application/json")
+        self.assertEqual(endpoint, "http://localhost:8080/ef/api/session")
+
+    def test_send_event(self):
+        client = ef.Client("username", "password",
+                "http://localhost:8080/ef/api")
+        storage = []
+        requester = fake_post(storage, FakeResponse(201))
+        data = {"name": "bob", "count": 10}
+        channel = "my.channel"
+        event = ef.Event(data, channel)
+        status, response = client.send_event(event, requester)
+        args, kwargs = storage.pop()
+        endpoint = args[0]
+        data_arg = kwargs["data"]
+        headers = kwargs["headers"]
+
+        self.assertTrue(status) 
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(data_arg, json.dumps(event.json))
+        self.assertEqual(headers["content-type"], "application/json")
+        self.assertEqual(endpoint, "http://localhost:8080/ef/api/event")
+
+if __name__ == '__main__':
+    unittest.main()