Merge pull request #15 from hellofresh/feature-update-events-api

Update events api

Author: aleksandrzhiliaev

.travis.yml

@@ -0,0 +1,14 @@
+language: python
+python:
+  - "2.7"
+  - "3.3"
+  - "3.4"
+  - "3.5"
+  - "3.6"
+
+install:
+  - make build
+
+script:
+  - make test
+  - codecov

Makefile

@@ -1,29 +1,17 @@
-VENV?=env
-
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  test       to run unit tests"
-	@echo "  build      to build the working virtual environment, and to install requirements for development"
-	@echo "  clean      to remove the created virtualenv folder"
+	@echo "  build      to install requirements for development"
 
-build: clean virtualenv requirements test-requirments
+build: requirements test-requirements
 
 test: unittests
 
 unittests:
-	PYTHONPATH=$(CURDIR)/src nosetests -d -w tests/unit -v
-
-functionaltests:
-	PYTHONPATH=$(CURDIR)/src nosetests -d -w tests/functional -v
-
-virtualenv:
-	virtualenv $(CURDIR)/$(VENV)
-
-clean:
-	rm -rf $(CURDIR)/$(VENV)
+	PYTHONPATH=$(CURDIR) nosetests -d -w tests -v --with-coverage --cover-package ./crossengage
 
 requirements:
-	$(CURDIR)/$(VENV)/bin/pip install -r requirements.txt
+	pip install -r requirements.txt
 
-test-requirments:
-	$(CURDIR)/$(VENV)/bin/pip install -r dev-requirements.txt
+test-requirements:
+	pip install -r test-requirements.txt

README.md

@@ -5,9 +5,30 @@
 </p>
 
 # crossengage-python-client
-Python client for Crossengage's API
+[![Build Status](https://travis-ci.org/hellofresh/crossengage-python-client.svg?branch=master)](https://travis-ci.org/hellofresh/crossengage-python-client)
+[![codecov](https://codecov.io/gh/hellofresh/crossengage-python-client/branch/master/graph/badge.svg)](https://codecov.io/gh/hellofresh/crossengage-python-client)
+
+Python client for [Crossengage's API](https://docs.crossengage.io)
+
+Library supports next methods:
+
+**User profile management**
+ - `update_user(self, user)`
+ - `delete_user(self, user)`
+ - `delete_user_by_xng_id(self, user)`
+
+**User attributes management**
+- `add_user_attribute(self, attribute_name, attribute_type, nested_type)`
+- `add_nested_user_attribute(self, parent_name, attribute_name, attribute_type)`
+- `list_user_attributes(self, offset, limit)`
+- `delete_user_attribute(self, attribute_id)`
+
+**Bulk user management**
+- `batch_process(self, delete_list=[], update_list=[])`
+
+**Events management**
+- `send_events(self, events, email=None, user_id=None, business_unit=None)`
 
-[ ![Codeship build](https://codeship.com/projects/c70724e0-f905-0133-a8ad-268d110da048/status?branch=master)](https://codeship.com/projects/151121)
 ### Owner
 [Alexander Zhilyaev](mailto:azh@hellofresh.com)
 
@@ -51,4 +72,4 @@ For more examples, check `examples.py`.
 
 To run the unit tests, make sure you have the [nose](http://nose.readthedocs.org/) module instaled and run the following from the repository root directory:
 
-`$ nosetests`
+`$ make build && make test`

crossengage/client.py

@@ -2,7 +2,6 @@
 import logging
 
 import requests
-
 from requests.exceptions import RequestException
 
 
@@ -83,6 +82,7 @@ def update_user(self, user):
     def update_users_bulk(self, users):
         # type: (list) -> dict
         """
+        Warning! Deprecated method, use batch_process instead.
         Create / Update User bulk.
         :param users: list of user dicts [(email, id, firstName, lastName, birthday, createdAt, gender)]
         :return: json dict response
@@ -167,19 +167,18 @@ def delete_user_attribute(self, attribute_id):
         payload = {}
         return self.__create_request(payload, self.REQUEST_DELETE)
 
-    def send_events(self, events, email=None, external_id=None, business_unit=None):
-        # type: (dict), (list) -> dict
+    def send_events(self, events, email=None, user_id=None, business_unit=None):
         """
         Send up to 50 events for a given user.
         :param email: user email
         :param events: list of event payloads
         :param business_unit: businessUnit of user in crossengage
-        :param external_id: id of user in crossengage
+        :param user_id: id of user in your database
         :return: json dict response, for example: {"status_code": 200}
         """
-        self.request_url = self.API_URL + self.EVENTS_ENDPOINT
+        self.request_url = "{}{}".format(self.API_URL, self.EVENTS_ENDPOINT)
 
-        if email is None and external_id is None:
+        if email is None and user_id is None:
             raise ValueError('email or external_id required for sending events')
 
         payload = {
@@ -189,8 +188,8 @@ def send_events(self, events, email=None, external_id=None, business_unit=None):
         if email is not None:
             payload['email'] = email
 
-        if external_id is not None:
-            payload['externalId'] = external_id
+        if user_id is not None:
+            payload['id'] = user_id
 
         if business_unit is not None:
             payload['businessUnit'] = business_unit
@@ -283,16 +282,19 @@ def __create_request(self, payload, request_type):
 
         except RequestException as e:
             # handle all requests HTTP exceptions
-            response = {'success': False, 'errors': {'connection_error': e.message}}
+            response = {'success': False, 'errors': {'connection_error': str(e)}}
         except Exception as e:
             # handle all exceptions which can be on API side
-            response = {'success': False, 'errors': {'client_error': e.message + '. Response: ' + r.text}}
+            response = {'success': False, 'errors': {'client_error': str(e)}}
 
         if 'status_code' not in response:
             response['status_code'] = 0
 
         if response['status_code'] == 500:
             response['success'] = False
-            response['errors'] = {'server_error': response['message']}
+            response['errors'] = {'server_error': 'error on crossengage side'}
+
+        if response['status_code'] > 202:
+            response['success'] = False
 
         return response

dev-requirements.txt test-requirements.txtdev-requirements.txt renamed to test-requirements.txt

@@ -1,3 +1,4 @@
 unittest2
 mock
-nose
+nose
+codecov