From 37cc29fad707f48447d9bec743d663c8521450db Mon Sep 17 00:00:00 2001
From: Felipe Martin <fmartingr@me.com>
Date: Sun, 21 Jul 2013 16:25:58 +0200
Subject: [PATCH] Cleaned some code/gitignore and commented the classes

---
 .gitignore |  3 +++
 yubikey.py | 24 +++++++++++++++++-------
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9a8364e..c4ea7aa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,6 @@
 .c9revisions/
 tests.py
 *.pyc
+build/
+dist/
+*.egg-info
diff --git a/yubikey.py b/yubikey.py
index b81d590..5e27a4f 100644
--- a/yubikey.py
+++ b/yubikey.py
@@ -8,6 +8,10 @@ import requests
 
 
 class YubicoWS(object):
+    """
+    Yubico Web Service class that interacts with the Yubico API
+    """
+
     register_ws = 'https://upgrade.yubico.com/getapikey/?format=json'
     api_ws = None
 
@@ -152,6 +156,10 @@ class YubicoWS(object):
 
 
 class Yubikey(object):
+    """
+    Yubikey object wrapper
+    """
+
     id = None
     key = None
     prefix = None
@@ -197,7 +205,11 @@ class Yubikey(object):
             self.prefix = str.lower(otp[:-32])
 
 
+###
+# Custom exceptions
+###
 class YubicoWSError(Exception):
+    "Web service error. Defined by yubico documentation."
     def __init__(self, message=None):
         self.msg = "Web Service responded with an error: %s" % message
 
@@ -206,17 +218,15 @@ class YubicoWSError(Exception):
 
 
 class YubicoWSInvalidResponse(Exception):
+    "Exception if the web service answers without same otp/nonce parameters"
     msg = 'Response from the server is invalid'
 
 
-class WSResponseError(Exception):
-    def __str__(self):
-        return repr(self.msg)
+class YubicoWSResponseBadSignature(Exception):
+    "Exception if the web service answers with a invalid signature"
+    pass
 
 
 class OTPIncorrectFormat(Exception):
-    pass
-
-
-class YubicoWSResponseBadSignature(Exception):
+    "Exception raised if the OTP provided is incorrect"
     pass