working on unittests

Author: tehtbl

.gitignore

@@ -101,4 +101,5 @@ ENV/
 .mypy_cache/
 
 test.py
-.idea/**
+.idea/
+secrets.yml

README.md

@@ -1,6 +1,8 @@
 # python-ctapi
 
-Python Interface for [CoinTracking.info API](https://cointracking.info/api/api.php)
+Python interface for [CoinTracking.info API](https://cointracking.info/api/api.php).
+
+I am not associated -- use at your own risk!
 
 # Requirements:
 
@@ -41,10 +43,15 @@ print api.getGroupedBalance()
 print api.getGains()
 ```
 
+# Running Tests
+```
+venv/bin/python -m unittest -v ctapi.test.ctapi_tests
+```
+
 # Contribute
 Do you have an idea or found a bug in python-ctapi? Please file an issue and make a PR! :)
 
-## Support
+## Support Me
 If you like the API and wanna support its developer, use the following referral link when registering at cointracking: https://cointracking.info?ref=T161519
 
 

ctapi/__init__.py

@@ -0,0 +1 @@
+from .ctapi import *

ctapi/ctapi.py

@@ -31,14 +31,23 @@
 
 URI_API = 'https://cointracking.info/api/v1/'
 
-
+#
+# API object
+#
 class CTAPI(object):
-    """ requesting CoinTracking API with API key and API secret """
+    """
+    requesting CoinTracking API with API key and API secret
+
+    Documentation: https://cointracking.info/api/api.php
+    """
 
     #
     # init
     #
-    def __init__(self, api_key='', api_secret='', debug=False):
+    def __init__(self, api_key=None, api_secret=None, debug=False):
+        # if not self.api_key or not self.api_secret:
+
+
         self.api_key = api_key
         self.api_secret = api_secret
         self.debug = debug
@@ -57,7 +66,11 @@ def __init__(self, api_key='', api_secret='', debug=False):
     # encode parameters for url
     #
     def _encode_params_url(self, params):
-        """ TODO """
+        """
+        encoding URL parameters
+
+        :params: Request parameters to be encoded
+        """
 
         encoded_string = ''
 
@@ -73,7 +86,13 @@ def _encode_params_url(self, params):
     # make query to API
     #
     def _api_query(self, method, params={}):
-        """ TODO """
+        """
+        Queries CoinTracking.info
+
+        :method: Request method
+        :params: Request parameters
+        :return: JSON response from Bittrex
+        """
 
         global URI_API
 
@@ -82,14 +101,20 @@ def _api_query(self, method, params={}):
             'nonce': '%d' % int(time.time() * 10),
         })
 
+        if not self.api_secret:
+            return {
+                'success': False,
+                'message': 'no valid secret key',
+            }
+
         params_string = self._encode_params_url(params)
         params_signed = hmac.new(self.api_secret.encode(), msg=params_string.encode(), digestmod=hashlib.sha512).hexdigest()
 
         hdrs = {
             'Key': self.api_key,
             'Sign': params_signed,
             'Connection': 'close',
-            'User-Agent': 'python-cointracking-api/%s (https://github.com/tbl42/python-ctapi)' % (__version__),
+            'User-Agent': 'python-ctapi/%s (https://github.com/tbl42/python-ctapi)' % (__version__),
         }
 
         logger.debug("="*30)
@@ -108,7 +133,7 @@ def _api_query(self, method, params={}):
             ret_json = r.json()
 
             return {
-                'success': True,
+                'success': ret_json['success'],
                 'result': ret_json
             }
         except:
@@ -125,61 +150,90 @@ def _api_query(self, method, params={}):
     # getTrades
     #
     def getTrades(self, **args):
-        """ TODO: desc """
+        """
+        Used to get all your CoinTracking trades and transactions.
+        Similar to the Trade List at https://cointracking.info/trades_full.php
+        """
+
         params = {
             'limit': 5,
             'order': 'DESC',
         }
         params.update(args)
+
         return self._api_query('getTrades', params)
 
     #
     # getBalance
     #
     def getBalance(self):
-        """ TODO: desc """
+        """
+        Used to get your current CoinTracking account and coin balance.
+        Similar to the Current Balance at https://cointracking.info/current_balance.php
+        """
+
         return self._api_query('getBalance')
 
     #
     # getHistoricalSummary
     #
     def getHistoricalSummary(self, **args):
-        """ TODO: desc """
+        """
+        Used to get all historical values for all your coins, currencies, commodities, and the total account value.
+        Similar to the Daily Balance at https://cointracking.info/overview.php or the Trade Statistics at https://cointracking.info/stats.php
+        """
+
         params = {
             'btc': 0,
         }
         params.update(args)
+
         return self._api_query('getHistoricalSummary', params)
 
     #
     # getHistoricalCurrency
     #
     def getHistoricalCurrency(self, **args):
-        """ TODO: desc """
+        """
+        Used to get all historical amounts and values for a specific currency/coin or for all currencies/coins.
+        Similar to the Daily Balance at https://cointracking.info/overview.php or the Trade Statistics at https://cointracking.info/stats.php
+        """
+
         params = {
             'currency': 'ETH',
         }
         params.update(args)
+
         return self._api_query('getHistoricalCurrency', params)
 
     #
     # getGroupedBalance
     #
     def getGroupedBalance(self, **args):
-        """ TODO: desc """
+        """
+        Used to get the current balance grouped by exchange, trade-group or transaction type.
+        Similar to the Balance by Exchange at https://cointracking.info/balance_by_exchange.php
+        """
+
         params = {
             'group': 'exchange',
         }
         params.update(args)
+
         return self._api_query('getGroupedBalance', params)
 
     #
     # getGains
     #
     def getGains(self, **args):
-        """ TODO: desc """
+        """
+        Used to get Returns your current realized and unrealized gains data.
+        Similar to the Realized and Unrealized Gains at https://cointracking.info/gains.php
+        """
+
         params = {
             'method': 'FIFO',
         }
         params.update(args)
+
         return self._api_query('getGains', params)

ctapi/test/__init__.py

@@ -0,0 +1,82 @@
+import json
+import yaml
+import unittest
+
+from ctapi import CTAPI
+
+try:
+    open("secrets.yml").close()
+    IS_CI_ENV = False
+except Exception:
+    IS_CI_ENV = True
+
+# def test_basic_response(unit_test, result, method_name):
+#     unit_test.assertTrue(result['success'], "{0:s} failed".format(method_name))
+#     unit_test.assertTrue(result['message'] is not None, "message not present in response")
+#     unit_test.assertTrue(result['result'] is not None, "result not present in response")
+
+
+# {'result': {u'error_msg': u'ERROR: Sign is not correct', u'method': u'getBalance', u'success': 0, u'error': u'SIGN_INCORRECT'}, 'success': True}
+# {'result': {u'error_msg': u'ERROR: API Key not set', u'method': u'getBalance', u'success': 0, u'error': u'KEY_MISSING'}, 'success': True}
+# {'result': {u'error_msg': u'ERROR: Sign is not correct', u'method': u'getBalance', u'success': 0, u'error': u'SIGN_INCORRECT'}, 'success': True}
+
+def test_auth_basic_failures(unit_test, result, test_type):
+    pass
+
+    # unit_test.assertFalse(result['success'], "{0:s} failed".format(test_type))
+    # unit_test.assertTrue('invalid' in str(result['message']).lower(), "{0:s} failed response message".format(test_type))
+    # unit_test.assertIsNone(result['result'], "{0:s} failed response result not None".format(test_type))
+
+
+@unittest.skipIf(IS_CI_ENV, 'no account secrets uploaded in CI envieonment, TODO')
+class TestCoinTrackingAPIBasicTests(unittest.TestCase):
+    """
+    Integration tests for the CoinTracking API
+
+      * These will fail in the absence of an internet connection or if CoinTracking API goes down
+      * They require a valid API key and secret issued by CoinTracking
+      * They also require the presence of a JSON file called secrets.yml
+
+    It is structured as such:
+    ---
+    key: '123'
+    secret: '456'
+    """
+
+    def setUp(self):
+        with open("secrets.yml") as f:
+            self.secrets = yaml.load(f)
+            f.close()
+
+        # self.api = CTAPI(secrets['key'], secrets['secret'], debug=True)
+        self.api = CTAPI(self.secrets['key'], self.secrets['secret'])
+
+    def test_handles_invalid_key_or_secret(self):
+        self.api = CTAPI('invalidkey', self.secrets['secret'])
+        actual = self.api.getBalance()
+        self.assertFalse(actual['success'], 'Invalid key, valid secret')
+
+        self.api = CTAPI(None, self.secrets['secret'])
+        actual = self.api.getBalance()
+        self.assertFalse(actual['success'], 'None key, valid secret')
+
+        self.api = CTAPI(self.secrets['key'], 'invalidsecret')
+        actual = self.api.getBalance()
+        self.assertFalse(actual['success'], 'valid key, invalid secret')
+
+        self.api = CTAPI(self.secrets['key'], None)
+        actual = self.api.getBalance()
+        self.assertFalse(actual['success'], 'valid key, None secret')
+
+        self.api = CTAPI('invalidkey', 'invalidsecret')
+        actual = self.api.getBalance()
+        self.assertFalse(actual['success'], 'invalid key, invalid secret')
+
+    # def test_get_balances(self):
+    #     actual = self.bittrex.get_balances()
+    #     test_basic_response(self, actual, "get_balances")
+    #     self.assertTrue(isinstance(actual['result'], list), "result is not a list")
+
+
+if __name__ == '__main__':
+    unittest.main()