Fix Pylint errors

Author: pitbulk

.coveralls.yml

@@ -0,0 +1,3 @@
+service_name: travis-ci
+
+src_dir: src

.gitignore

@@ -18,6 +18,7 @@ __pycache_
 /dist
 /venv
 .coverage
+.pypirc
 
 *.key
 *.crt

.travis.yml

@@ -12,6 +12,7 @@ install:
 script: 
   - 'coverage run --source=src/onelogin/saml2 --rcfile=tests/coverage.rc setup.py test'
   - 'coverage report -m --rcfile=tests/coverage.rc'
+  - 'pylint src/onelogin/saml2 --rcfile=tests/pylint.rc'
   - 'pep8 tests/src/OneLogin/saml2_tests/*.py demo-flask/*.py demo-django/*.py src/onelogin/saml2/*.py --config=tests/pep8.rc'
   - 'pyflakes src/onelogin/saml2 demo-django demo-flask tests/src/OneLogin/saml2_tests'
 

setup.py

@@ -41,4 +41,5 @@
             'coveralls==0.4.4',
         ),
     },
+    keywords='saml saml2 xmlsec django flask',
 )

src/onelogin/saml2/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+Add SAML support to your Python softwares using this library.
+Forget those complicated libraries and use that open source
+library provided and supported by OneLogin Inc.
+
+OneLogin's SAML Python toolkit let you build a SP (Service Provider)
+over your Python application and connect it to any IdP (Identity Provider).
+
+Supports:
+
+* SSO and SLO (SP-Initiated and IdP-Initiated).
+* Assertion and nameId encryption.
+* Assertion signature.
+* Message signature: AuthNRequest, LogoutRequest, LogoutResponses.
+* Enable an Assertion Consumer Service endpoint.
+* Enable a Single Logout Service endpoint.
+* Publish the SP metadata (which can be signed).
+"""

src/onelogin/saml2/auth.py

@@ -1,7 +1,15 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014, OneLogin, Inc.
-# All rights reserved.
+""" OneLogin_Saml2_Auth class
+
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+Main class of OneLogin's Python Toolkit.
+
+Initializes the SP SAML instance
+
+"""
 
 from base64 import b64encode
 from urllib import quote_plus
@@ -19,6 +27,14 @@
 
 
 class OneLogin_Saml2_Auth(object):
+    """
+
+    This class implements the SP SAML instance.
+
+    Defines the methods that you can invoke in your application in
+    order to add SAML support (initiates sso, initiates slo, processes a
+    SAML Response, a Logout Request or a Logout Response).
+    """
 
     def __init__(self, request_data, old_settings=None, custom_base_path=None):
         """

src/onelogin/saml2/authn_request.py

@@ -1,7 +1,13 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014, OneLogin, Inc.
-# All rights reserved.
+""" OneLogin_Saml2_Authn_Request class
+
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+AuthNRequest class of OneLogin's Python Toolkit.
+
+"""
 
 from base64 import b64encode
 from zlib import compress
@@ -10,7 +16,13 @@
 from onelogin.saml2.constants import OneLogin_Saml2_Constants
 
 
-class OneLogin_Saml2_Authn_Request:
+class OneLogin_Saml2_Authn_Request(object):
+    """
+
+    This class handles an AuthNRequest. It builds an
+    AuthNRequest object.
+
+    """
 
     def __init__(self, settings):
         """
@@ -62,15 +74,16 @@ def __init__(self, settings):
     <samlp:RequestedAuthnContext Comparison="exact">
         <saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport</saml:AuthnContextClassRef>
     </samlp:RequestedAuthnContext>
-</samlp:AuthnRequest>""" % {
-            'id': uid,
-            'provider_name': provider_name_str,
-            'issue_instant': issue_instant,
-            'destination': destination,
-            'assertion_url': sp_data['assertionConsumerService']['url'],
-            'entity_id': sp_data['entityId'],
-            'name_id_policy': name_id_policy_format,
-        }
+</samlp:AuthnRequest>""" % \
+            {
+                'id': uid,
+                'provider_name': provider_name_str,
+                'issue_instant': issue_instant,
+                'destination': destination,
+                'assertion_url': sp_data['assertionConsumerService']['url'],
+                'entity_id': sp_data['entityId'],
+                'name_id_policy': name_id_policy_format,
+            }
 
         self.__authn_request = request
 

src/onelogin/saml2/constants.py

@@ -1,10 +1,23 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014, OneLogin, Inc.
-# All rights reserved.
+""" OneLogin_Saml2_Constants class
 
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+Constants class of OneLogin's Python Toolkit.
+
+"""
+
+
+class OneLogin_Saml2_Constants(object):
+    """
+
+    This class defines all the constants that will be used
+    in the OneLogin's Python Toolkit.
+
+    """
 
-class OneLogin_Saml2_Constants:
     # Value added to the current time in time condition validations
     ALOWED_CLOCK_DRIFT = 300
 

src/onelogin/saml2/errors.py

@@ -1,10 +1,24 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014, OneLogin, Inc.
-# All rights reserved.
+""" OneLogin_Saml2_Error class
+
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+Error class of OneLogin's Python Toolkit.
+
+Defines common Error codes and has a custom initializator.
+
+"""
 
 
 class OneLogin_Saml2_Error(Exception):
+    """
+
+    This class implements a custom Exception handler.
+    Defines custom error codes.
+
+    """
 
     # Errors
     SETTINGS_FILE_NOT_FOUND = 0

src/onelogin/saml2/logout_request.py

@@ -1,7 +1,13 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2014, OneLogin, Inc.
-# All rights reserved.
+""" OneLogin_Saml2_Logout_Request class
+
+Copyright (c) 2014, OneLogin, Inc.
+All rights reserved.
+
+Logout Request class of OneLogin's Python Toolkit.
+
+"""
 
 from base64 import b64decode
 from defusedxml.lxml import fromstring
@@ -13,7 +19,14 @@
 from onelogin.saml2.utils import OneLogin_Saml2_Utils
 
 
-class OneLogin_Saml2_Logout_Request:
+class OneLogin_Saml2_Logout_Request(object):
+    """
+
+    This class handles a Logout Request.
+
+    Builds a Logout Response object and validates it.
+
+    """
 
     def __init__(self, settings):
         """
@@ -52,13 +65,14 @@ def __init__(self, settings):
     Destination="%(single_logout_url)s">
     <saml:Issuer>%(entity_id)s</saml:Issuer>
     %(name_id)s
-</samlp:LogoutRequest>""" % {
-            'id': uid,
-            'issue_instant': issue_instant,
-            'single_logout_url': idp_data['singleLogoutService']['url'],
-            'entity_id': sp_data['entityId'],
-            'name_id': name_id,
-        }
+</samlp:LogoutRequest>""" % \
+            {
+                'id': uid,
+                'issue_instant': issue_instant,
+                'single_logout_url': idp_data['singleLogoutService']['url'],
+                'entity_id': sp_data['entityId'],
+                'name_id': name_id,
+            }
 
         self.__logout_request = logout_request