bogoexchange

python/README.md

@@ -2,13 +2,34 @@
 This directory contains various python scripts to make your life easier
 
 Makefile:
-	Use "make install-(script)" to install a specific script
-	Use "make install" to install all scripts
-	Check the script section in this readme to see more about the script
 
-cryptocheck.py
-	Checks the current price of bitcoin for you!
+- Use "make install-(script)" to install a specific script
+- Use "make install" to install all scripts
+- Check the script section in this readme to see more about the script
 
-	*TODO*
-	Add other crypto currencies
-	Add arguments such as range
+bogoexchange.py:
+Checks the current price of bitcoin for you, using a similar strategy to that of [bogosort](https://en.wikipedia.org/wiki/Bogosort)
+
+version: 1.0
+
+```
+usage: bogoexchange [-h] [-c {BTC,LTC,ETH,BCH}] [-r {US,EU,UK}]
+                    [--guess-again] [--nodelay] [-b] [--version]
+
+Determine crypto currency exchange rate following a bogosort approach!
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -c {BTC,LTC,ETH,BCH}, --crypto {BTC,LTC,ETH,BCH}
+                        Crypto currency to be exchanged
+  -r {US,EU,UK}, --region {US,EU,UK}
+                        Region of exchange
+  --guess-again         Keep running until the correct price is guessed
+  --nodelay             Do not delay in between printing out the next guess at
+                        the exchange rate.
+  -b                    Bound the bogo algorithm: -b: minor bounding -bb:
+                        slightly more bounding -bbb: Arguably too much
+                        bounding (Warning, this will reduce the bogoness of
+                        this program... you don't want to do that, do you?
+  --version             show program's version number and exit
+```	

python/cryptocheck/Makefile → python/bogoexchange/Makefile

@@ -8,7 +8,7 @@ all:
 	@echo "Invalid use of make, please use one of the given options"
 
 install:
-	install -m 557 btccheck.py $(BINDIR)/cryptocheck
+	install -m 557 bogoexchange.py $(BINDIR)/bogoexchange
 
 uninstall:
-	rm -f $(BINDIR)/cryptocheck
+	rm -f $(BINDIR)/bogoexchange

python/bogoexchange/bogoexchange.py

@@ -0,0 +1,215 @@
+#!/usr/bin/python3
+#coding: <utf-8>
+
+# A python script for (possibly) determining the current price of a crypto
+# currency, following a similar approach to bogosort
+import argparse
+import requests
+import random
+import time
+import sys
+
+API_URL = "https://api.gdax.com"
+crypto_list = ['BTC', 'LTC', 'ETH', 'BCH']
+region_dict = { 'US' : {'symbol' : '$', 'string' : 'USD'}, \
+				'UK' : {'symbol' : '£', 'string' : 'GBP'}, \
+				'EU' : {'symbol' : '€', 'string' : 'EUR'} }
+
+RED_TEXT 	= "\x1b[1;31;40m"
+GREEN_TEXT	= "\x1b[1;32;40m"
+END_COLOR	= "\x1b[0m"
+
+def _get_price(crypto='BTC', region='US'):
+	# determine exchange symbol for currency and region
+	exchange_symbol = crypto + '-' + region_dict[region]['string']
+	region_symbol = region_dict[region]['symbol']
+
+	r = requests.get(API_URL + '/products/' + exchange_symbol + '/book')
+	data = r.json()
+	try:
+		retVal = (float(data['bids'][0][0]), exchange_symbol, region_symbol)
+		return retVal
+	except:
+		return (None, exchange_symbol, region_symbol)
+
+# Parse the command line arguments and return them
+def _parse_args():
+	parser = argparse.ArgumentParser(description='Determine crypto currency exchange rate '\
+									'following a bogosort approach!')
+	parser.add_argument('-c', '--crypto', choices=crypto_list, default='BTC',
+	                    help='Crypto currency to be exchanged')
+	parser.add_argument('-r', '--region', choices=region_dict.keys(), default='US',
+	                    help='Region of exchange')
+	parser.add_argument('--guess-again', action='store_true', dest='guess_again',
+						help='Keep running until the correct price is guessed')
+	parser.add_argument('--nodelay', action='store_true', help='Do not delay in between printing out '\
+						'the next guess at the exchange rate.')
+	parser.add_argument('-b', action='count', dest='bound',
+						help='Bound the bogo algorithm: '\
+						'-b: minor bounding\n'\
+						'-bb: slightly more bounding\n'\
+						'-bbb: Arguably too much bounding\n'\
+						'(Warning, this will reduce the bogoness of this program... you don\'t '\
+						'want to do that, do you?')
+	parser.add_argument('--version', action='version', version='%(prog)s 1.0')
+
+
+	return parser.parse_args()
+
+
+# Used for maintaining price range and adjusting it accordingly
+class priceCheck:
+	__minPrice = 0.00
+	__maxPrice = 20000.00
+	__boundingLevel = 0
+	__price = 0.00
+	# upper and lower bound increments for -b
+	__upperBoundDec = 0
+	__lowerBoundInc = 0
+
+	# Set the range of allowable guesses
+	def __init__(self, minPrice=0.00, maxPrice=20000.00, bound=0, actual=0.00):
+		self.__minPrice=minPrice
+		self.__maxPrice=maxPrice
+		self.__upperBoundDec=int((maxPrice-actual)/1000)
+		self.__lowerBoundInc=int((actual-minPrice)/1000)
+		self.__bound=bound
+		self.__price=actual
+
+	# Update the range after a guess
+	# Return if update was successful or if needs to be redone
+	# False indicates no rerun needed, True means run again
+	def _update(self, guess):
+		retval = False
+		if (self.__bound == None):
+			return False
+		# Basic bounding
+		elif (self.__bound < 3):
+			tempMin = self.__minPrice
+			self.__minPrice = self.__minPrice + (self.__lowerBoundInc * pow(10, self.__bound - 1))
+			tempMax = self.__maxPrice
+			self.__maxPrice = self.__maxPrice - (self.__upperBoundDec * pow(10, self.__bound - 1))
+			# Reduce bounding range as we get closer to
+			if (self.valid() == -1):
+				self.__lowerBoundInc = self.__lowerBoundInc / 2
+				retval = True
+
+			if (self.valid() == 1):
+				self.__upperBoundDec = self.__upperBoundDec / 2
+				retval = True
+
+			if (retval):
+				self.__minPrice = tempMin
+				self.__maxPrice = tempMax
+
+		elif (self.__bound >= 3):
+			if (guess < self.__price):
+				self.__minPrice = guess
+			else:
+				self.__maxPrice = guess
+		return retval
+
+
+	# Check if a given price less than greater than or equal
+	# Return 1 if greater, 0 if equal, -1 if less
+	def check(self, guess):
+		ret = (str('%.2f' % (guess,)) == str('%.2f' % (self.__price,)))
+		if (ret):
+			return 0
+		elif (guess < self.__price):
+			ret = -1
+		else:
+			ret = 1
+		while(self._update(guess)):
+			pass
+		return ret
+
+	# Check if the given price is in the range
+	# return 1 if price above range, 0 if in range, -1 below range
+	def valid(self):
+		# check for equal values to prevent infinite loops
+		retMin = (str('%.2f' % (self.__minPrice,)) == str('%.2f' % (self.__price,)))
+		retMax = (str('%.2f' % (self.__maxPrice,)) == str('%.2f' % (self.__price,)))
+		if (self.__price > self.__maxPrice and retMax == False):
+			return 1
+		elif (self.__price < self.__minPrice and retMin == False):
+			return -1
+		else:
+			return 0
+
+	# Generate a guess for the price of the exchange
+	def guess_price(self):
+		# guess a dollar range within the given range
+		guess_dollar = random.randint(int(self.__minPrice),int(self.__maxPrice)) if \
+							(int(self.__minPrice) != int(self.__maxPrice)) else self.__maxPrice
+
+		# if same dollar amount, set the max cent value at the max
+		maxCents = self._get_cent_diff('max') if guess_dollar == int(self.__maxPrice) else 100
+		# if same dollar amount, set the min cent value at the min
+		minCents = self._get_cent_diff('min') if guess_dollar == int(self.__minPrice) else 0
+
+		guess_cents = random.randint(minCents, maxCents)
+
+		return float(guess_dollar) + (float(guess_cents) / 100.00)
+
+	# Get the difference in cents between two floats
+	def _get_cent_diff(self, val='max'):
+		if (val == 'max'):
+			a = self.__maxPrice
+		else:
+			a = self.__minPrice
+
+		tmp = str('%.2f' % (a - int(a),))
+		tmp = tmp[2:]
+		return int(tmp)
+
+	# Print the current range (Debuggin purposes)
+	def __repr__(self):
+		return "<PriceRange: %.2f - %.2f>\n<Price: %.2f>"\
+				% (self.__minPrice, self.__maxPrice, self.__price)
+
+
+# main, you know, the function that always runs!
+def __main__():
+
+	args = _parse_args()
+
+	# seed a guess
+	random.seed(int(time.time() * 100))
+
+	# get price as well as exchange_symbol and region_symbol for given currency and region
+	price, exchange_symbol, region_symbol = _get_price(region=args.region, crypto=args.crypto)
+	if (price == None):
+		print("That combination is not currently available for comparison")
+		return
+
+	PR = priceCheck(minPrice=0, maxPrice=20000.00, bound=args.bound, actual=price)
+	numGuesses = 0
+
+	while (args.guess_again or numGuesses == 0):
+
+		# guess a price
+		guess = PR.guess_price()
+		numGuesses = numGuesses + 1
+
+		if (PR.valid() == 0):
+			found = PR.check(guess)
+			print("%sThe current exchange of %s is%s: %s%.2f%s" % \
+					(RED_TEXT if found else GREEN_TEXT,\
+					exchange_symbol, " not" if found else "", region_symbol, guess,
+					END_COLOR))
+			if (found == 0):
+				print("This program took %d guesses to determine the exchange rate!" % (numGuesses,))
+				exit(0)
+			if (not args.nodelay):
+				for i in range(random.randint(1,20)):
+					print(".", end='', flush=True)
+					time.sleep(.1)
+				print("")
+
+		else:
+			print("Sorry, %s is not within the provided price range" % (exchange_symbol,))
+			exit(1)
+
+if __name__ == '__main__':
+	__main__()