Merge pull request #48 from SiftScience/jburnim_api_v204

Add support for Sift Science's version-204 API.

Author: jburnim

.travis.yml

@@ -8,4 +8,4 @@ install:
   - pip install -e .[test]
 # command to run tests
 script:
-  - python tests/client_test.py
+  - unit2

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2013-2014 Sift Science (https://siftscience.com)
+Copyright (c) 2013-2016 Sift Science (https://siftscience.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,17 @@
 # Sift Science Python Bindings ![TravisCI](https://travis-ci.org/SiftScience/sift-python.png?branch=master)
 
-Bindings for Sift Science's [Events](https://siftscience.com/resources/references/events-api.html), [Labels](https://siftscience.com/resources/references/labels-api.html), and [Score](https://siftscience.com/resources/references/score-api.html) APIs.
+Bindings for Sift Science's APIs -- including the
+[Events](https://siftscience.com/resources/references/events-api.html),
+[Labels](https://siftscience.com/resources/references/labels-api.html),
+and
+[Score](https://siftscience.com/resources/references/score-api.html)
+APIs.
+
 
 ## Installation
 
-Set up a virtual environment with virtualenv (otherwise you will need to
-make the pip calls as sudo):
+Set up a virtual environment with virtualenv (otherwise you will need
+to make the pip calls as sudo):
 
     virtualenv venv
     source venv/bin/activate
@@ -33,11 +39,19 @@ Python 3:
 
 ## Documentation
 
-Please see [here](https://siftscience.com/docs/api/python) for the most up-to-date documentation.
+Please see [here](https://siftscience.com/docs/api/python) for the
+most up-to-date documentation.
 
 ## Changelog
 
-Please see [the CHANGELOG](https://github.com/SiftScience/sift-python/blob/master/CHANGES.md) for a history of all changes. Note, that in v2.0.0.0, the API semantics were changed to raise an exception in the case of error to be more pythonic. Client code will need to be updated to catch `sift.client.ApiException` exceptions.
+Please see
+[the CHANGELOG](https://github.com/SiftScience/sift-python/blob/master/CHANGES.md)
+for a history of all changes.
+
+Note, that in v2.0.0.0, the API semantics were changed to raise an
+exception in the case of error to be more pythonic. Client code will
+need to be updated to catch `sift.client.ApiException` exceptions.
+
 
 ## Usage
 
@@ -47,11 +61,13 @@ Here's an example:
 
 import sift.client
 
-sift.api_key = '<your api key here>'
+sift.api_key = '<your API key here>'
+sift.account_id = '<your account ID here>'
 client = sift.Client()
 
 user_id = "23056"   # User ID's may only contain a-z, A-Z, 0-9, =, ., -, _, +, @, :, &, ^, %, !, $
 
+
 # Track a transaction event -- note this is a blocking call
 properties = {
   "$user_id" : user_id, 
@@ -89,26 +105,51 @@ except sift.client.ApiException:
 
 try:
   # Label the user with user_id 23056 as Bad with all optional fields
-  response = client.label(user_id,{ "$is_bad" : True, "$reasons" : ["$chargeback", ],
-                          "$description" : "Chargeback issued",
-                          "$source" : "Manual Review",
-                          "$analyst" : "analyst.name@your_domain.com"})
+  response = client.label(user_id, {
+    "$is_bad" : True,
+    "$abuse_type" : "payment_abuse",
+    "$description" : "Chargeback issued",
+    "$source" : "Manual Review",
+    "$analyst" : "analyst.name@your_domain.com"
+  })
 except sift.client.ApiException:
   # request failed
 
 
 # Remove a label from a user with user_id 23056
 try:
-  response = client.unlabel(user_id)
+  response = client.unlabel(user_id, abuse_type='content_abuse')
+except sift.client.ApiException:
+  # request failed
+
+
+# Get the status of a workflow run
+try:
+  response = client.get_workflow_status('my_run_id');
+except sift.client.ApiException:
+  # request failed
+
+
+# Get the latest decisions for a user
+try:
+  response = client.get_user_decisions('example_user');
+except sift.client.ApiException:
+  # request failed
+
+
+# Get the latest decisions for an order
+try:
+  response = client.get_order_decisions('example_order');
 except sift.client.ApiException:
   # request failed
 
 ```
 
+
 ## Testing
 
 Before submitting a change, make sure the following commands run without
 errors from the root dir of the repository:
 
-    PYTHONPATH=. python tests/client_test.py
-    PYTHONPATH=. python3 tests/client_test.py
+    python -m unittest discover
+    python3 -m unittest discover

setup.py

@@ -36,6 +36,7 @@
     extras_require={
         'test': [
             'mock >= 1.0.1',
+            'unittest2 >= 1, < 2',
         ],
     },
 

sift/__init__.py

@@ -1,2 +1,3 @@
 api_key = None
+account_id = None
 from .client import Client