added test client for splitwise api

Author: esecules

.travis.yml

@@ -1,7 +1,8 @@
 language: python
 python:
-  - "2.7"
-# command to install dependencies
-install: "pip install -r setup/requirements.txt"
-# command to run tests
-script: "cd test; nosetests"
+- '2.7'
+install: pip install -r setup/requirements.txt
+script: cd test; nosetests
+before_install:
+- openssl aes-256-cbc -K $encrypted_2931867a4314_key -iv $encrypted_2931867a4314_iv
+  -in oauth_client.pkl.enc -out oauth_client.pkl -d

src/groupsplit.py

@@ -6,6 +6,7 @@
 import pickle
 import pprint
 import urllib
+import logging
 import optparse
 import requests
 import subprocess
@@ -15,6 +16,28 @@
 from pprint import pprint
 from datetime import datetime
 
+LOGGING_DISABELED = 100
+log_levels = [LOGGING_DISABELED, logging.CRITICAL, logging.ERROR,
+              logging.WARNING, logging.INFO, logging.DEBUG]
+# Adapted from:
+# https://docs.python.org/2/howto/logging.html#configuring-logging
+# create logger
+logger = logging.getLogger(__name__)
+
+# create console handler and set level to debug
+ch = logging.StreamHandler()
+ch.setLevel(logging.DEBUG)
+
+# create formatter
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+# add formatter to ch
+ch.setFormatter(formatter)
+
+# add ch to logger
+logger.addHandler(ch)
+logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
+
 def split(total, num_people):
     base = total * 100 // num_people / 100
     extra = total - num_people * base
@@ -23,9 +46,9 @@ def split(total, num_people):
     return base, extra
 
 class Splitwise:
-    def __init__(self):
-        if os.path.isfile("oauth_client.pkl"):
-            with open('oauth_client.pkl', 'rb') as oauth_pkl:
+    def __init__(self, options, args):
+        if os.path.isfile(options.api_client):
+            with open(options.api_client, 'rb') as oauth_pkl:
                 self.client = pickle.load(oauth_pkl)
         else:
             self.get_client()
@@ -99,44 +122,55 @@ def get_groups(self):
     def post_expense(self, uri):
         resp = self.api_call(uri, 'POST')
         if resp["errors"]:
-            print "URI:"
-            print uri
-            pprint(resp)
+            sys.stderr.write( "URI:")
+            sys.stderr.write(uri)
+            pprint(resp, stream=sys.stderr)
         else:
             sys.stdout.write(".")
             sys.stdout.flush()
 
+class CsvSettings():
+    def __init__(self, rows):
+        print "These are the first two rows of your csv"
+        print '\n'.join([str(t) for t in rows[0:2]])
+        print 'Colnum numbers start at 0'
+        self.date_col = input("Which column has the date?")
+        self.amount_col = input("Which column has the amount?")
+        self.desc_col = input("Which column has the description?")
+        self.has_title_row = raw_input("Does first row have titles? [Y/n]").lower() != 'n'
+        while True:
+            try:
+                self.local_currency = raw_input("What currency were these transactions made in?").upper()
+                test = Money("1.00", self.local_currency)  #pylint: disable=W0612
+            except ValueError as err:
+                print err
+                print "Try again..."
+            else:
+                break
+        self.remember = raw_input("Remember these settings? [Y/n]").lower() != 'n'
+    
+        if self.remember:
+            with open("csv_settings.pkl", "wb") as pkl:
+                pickle.dump(self, pkl)
+
 class SplitGenerator():
     def __init__(self, options, args, api):
-        self.api = api
         csv_file = args[0]
         group_name = args[1]
+        self.api = api
+        self.options = options
+        self.args = args
         with open(csv_file, 'rb') as csvfile:
             reader = csv.reader(csvfile)
             self.rows = [x for x in reader]
-    
-    
-        if os.path.isfile("csv_settings.pkl"):
-            with open('csv_settings.pkl', 'rb') as f:
-                self = pickle.load(f)
-    
+
+        if os.path.isfile(options.csv_settings):
+            with open(options.csv_settings, 'rb') as f:
+                self.csv = pickle.load(f)
         else:
-            print "These are the first two rows of your csv"
-            print '\n'.join([str(t) for t in self.rows[0:2]])
-            print 'Colnum numbers start at 0'
-            self.date_col = input("Which column has the date?")
-            self.amount_col = input("Which column has the amount?")
-            self.desc_col = input("Which column has the description?")
-            self.has_title_row = raw_input("Does first row have titles? [Y/n]").lower() != 'n'
-            self.local_currency = raw_input("What currency were these transactions made in?").upper()
-            self.test = Money("1.00", self.local_currency)  #pylint: disable=W0612
-            self.remember = raw_input("Remember these settings? [Y/n]").lower() != 'n'
+            self.csv = CsvSettings(self.rows)
 
-        if self.remember:
-            with open("csv_settings.pkl", "wb") as pkl:
-                pickle.dump(self, pkl)
-    
-        if self.has_title_row:
+        if self.csv.has_title_row:
             self.rows = self.rows[1:]
 
         self.make_transactions()
@@ -145,10 +179,10 @@ def __init__(self, options, args, api):
         self.ask_for_splits()
 
     def make_transactions(self):
-        self.transactions = [{"date": datetime.strftime(datetime.strptime(r[self.date_col], "%m/%d/%y"), "%Y-%m-%dT%H:%M:%SZ"),
-                              "amount": -1 * Money(r[self.amount_col], self.local_currency),
-                              "desc": re.sub('\s+',' ', r[self.desc_col])}
-                             for r in self.rows if float(r[self.amount_col]) < 0]
+        self.transactions = [{"date": datetime.strftime(datetime.strptime(r[self.csv.date_col], "%m/%d/%y"), "%Y-%m-%dT%H:%M:%SZ"),
+                              "amount": -1 * Money(r[self.csv.amount_col], self.csv.local_currency),
+                              "desc": re.sub('\s+',' ', r[self.csv.desc_col])}
+                             for r in self.rows if float(r[self.csv.amount_col]) < 0]
 
     def get_group(self, name):
         num_found = 0
@@ -173,12 +207,12 @@ def get_group(self, name):
 
     def ask_for_splits(self):
         for t in self.transactions:
-            if raw_input("%s at %s $%s. Split? [y/N]" % (t['date'], t['desc'], t['amount'])).lower() == 'y':
+            if self.options.yes or raw_input("%s at %s $%s. Split? [y/N]" % (t['date'], t['desc'], t['amount'])).lower() == 'y':
                 self.splits.append(t)
 
     def __getitem__(self, index):
         s = self.splits[index]
-        one_cent = Money("0.01", self.local_currency)
+        one_cent = Money("0.01", self.csv.local_currency)
         num_people = len(self.members) + 1
         base, extra = split(s['amount'], num_people)
         params = {
@@ -187,28 +221,36 @@ def __getitem__(self, index):
             "description": s["desc"],
             "date": s["date"],
             "group_id": self.gid,
-            "currency_code": self.local_currency,
+            "currency_code": self.csv.local_currency,
             "users__0__user_id": self.api.get_id(),
             "users__0__paid_share": s["amount"].amount,
             "users__0__owed_share": base.amount,
         }
         for i in range(len(self.members)):
-            params['users__%s__user_id' % (i+1)] = sef.members[i]
+            params['users__%s__user_id' % (i+1)] = self.members[i]
             params['users__%s__paid_share' % (i+1)] = 0
-            params['users__%s__owed_share' % (i+1)] = (base + one_cent).amount if extra else base.amount
+            params['users__%s__owed_share' % (i+1)] = (base + one_cent).amount if extra.amount > 0 else base.amount
             extra -= one_cent
         paramsStr = urllib.urlencode(params)
         return "https://secure.splitwise.com/api/v3.0/create_expense?%s" % (paramsStr)
 
 
 def main():
     parser = optparse.OptionParser()
-    parser.add_option('-v', '--verbose', default=False, dest='verbose')
+    parser.add_option('-v', '--verbosity', default=2, dest='verbosity', help='change the logging level (0 - 6) default: 2')
+    parser.add_option('-y','',default=False, action='store_true', dest='yes', help='split all transactions in csv without confirmation')
+    parser.add_option('-d', '--dryrun', default=False, action='store_true', dest='dryrun', help='prints requests instead of sending them')
+    parser.add_option('', '--csv-settings', default='csv_settings.pkl', dest='csv_settings', help='supply different csv_settings object (for testing mostly)')
+    parser.add_option('', '--api-client', default='oauth_client.pkl', dest='api_client', help='supply different splitwise api client (for testing mostly)')
     options, args = parser.parse_args()
-    splitwise = Splitwise()
+    logger.setLevel(log_levels[options.verbosity])
+    splitwise = Splitwise(options, args)
     split_gen = SplitGenerator(options, args, splitwise)
     print "Uploading splits"
     for uri in split_gen:
+        if options.dryrun:
+            print uri
+            continue
         splitwise.post_expense(uri)
     sys.stdout.write("\n")
     sys.stdout.flush()

test/.gitignore

@@ -0,0 +1,4 @@
+*~
+*.pyc
+consumer_oauth.json
+oauth_client.pkl

test/oauth_client.pkl.enc

@@ -1,5 +1,6 @@
 import unittest
 import sys
+import subprocess
 from money import Money
 sys.path.append("../src")
 from groupsplit import split
@@ -10,8 +11,23 @@ def test_splits(self):
             {"amount": "1.00", "ppl": 2, "expect": ("0.50","0.00")},
             {"amount": "1.00", "ppl": 3, "expect": ("0.33", "0.01")},
             {"amount": "12.97", "ppl": 5, "expect": ("2.59", "0.02")},
-            {"amount": "52000", "ppl": 3, "expect": ("17333.33", "0.01")},
+            {"amount": "52000.00", "ppl": 3, "expect": ("17333.33", "0.01")},
+            {"amount": "1050.00", "ppl": 3, "expect": ("350.00", "0.00")},
         ]
         for case in cases:
             expect = (Money(case['expect'][0], "CAD"), Money(case['expect'][1], "CAD"))
             self.assertEqual(expect, split(Money(case['amount'], "CAD"), case['ppl']))
+
+class SystemTests(unittest.TestCase):
+    def test_group_of_2(self):
+        proc = subprocess.Popen(['python', '../src/groupsplit.py', 'transactions.csv', 'group_of_2',
+                                 '--csv-settings=csv_settings.pkl', '--api-client=oauth_client.pkl',
+                                 '-y'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        stdout, stderr = proc.communicate()
+        self.assertEqual(stderr, '')
+    def test_group_of_3(self):
+        proc = subprocess.Popen(['python', '../src/groupsplit.py', 'transactions.csv', 'group_of_3',
+                                 '--csv-settings=csv_settings.pkl', '--api-client=oauth_client.pkl',
+                                 '-y'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        stdout, stderr = proc.communicate()
+        self.assertEqual(stderr, '')

test/testSplit.py

@@ -0,0 +1,6 @@
+7/5/16,-1.56,-,"POS Purchase","Test1"
+7/5/16,134.12,-,"Deposit","Deposit should be ignored"
+7/4/16,-1050.00,-,"POS Purchase","Big purchase"
+7/2/16,-5.45,-,"POS Purchase","Test2"
+7/2/16,-10.98,-,"POS Purchase","Test3"
+6/30/16,-46.31,-,"POS Purchase","Test4"