Fix typographical errors in docstring

pitbulk · pitbulk · commit fdb40e29a6cf · 2016-07-31T19:45:51.000+02:00
diff --git a/src/onelogin/saml2/auth.py b/src/onelogin/saml2/auth.py
@@ -30,7 +30,7 @@ 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
+    order to add SAML support (initiates SSO, initiates SLO, processes a
     SAML Response, a Logout Request or a Logout Response).
     """
 
@@ -82,7 +82,7 @@ def process_response(self, request_id=None):
         """
         Process the SAML Response sent by the IdP.
 
-        :param request_id: Is an optional argumen. Is the ID of the AuthNRequest sent by this SP to the IdP.
+        :param request_id: Is an optional argument. Is the ID of the AuthNRequest sent by this SP to the IdP.
         :type request_id: string
 
         :raises: OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND, when a POST with a SAMLResponse is not found
@@ -174,14 +174,14 @@ def process_slo(self, keep_local_session=False, request_id=None, delete_session_
 
     def redirect_to(self, url=None, parameters={}):
         """
-        Redirects the user to the url past by parameter or to the url that we defined in our SSO Request.
+        Redirects the user to the URL passed by parameter or to the URL that we defined in our SSO Request.
 
         :param url: The target URL to redirect the user
         :type url: string
-        :param parameters: Extra parameters to be passed as part of the url
+        :param parameters: Extra parameters to be passed as part of the URL
         :type parameters: dict
 
-        :returns: Redirection url
+        :returns: Redirection URL
         """
         if url is None and 'RelayState' in self.__request_data['get_data']:
             url = self.__request_data['get_data']['RelayState']
@@ -268,16 +268,16 @@ def login(self, return_to=None, force_authn=False, is_passive=False, set_nameid_
         :param return_to: Optional argument. The target URL the user should be redirected to after login.
         :type return_to: string
 
-        :param force_authn: Optional argument. When true the AuthNReuqest will set the ForceAuthn='true'.
+        :param force_authn: Optional argument. When true the AuthNRequest will set the ForceAuthn='true'.
         :type force_authn: bool
 
-        :param is_passive: Optional argument. When true the AuthNReuqest will set the Ispassive='true'.
+        :param is_passive: Optional argument. When true the AuthNRequest will set the Ispassive='true'.
         :type is_passive: bool
 
-        :param set_nameid_policy: Optional argument. When true the AuthNReuqest will set a nameIdPolicy element.
+        :param set_nameid_policy: Optional argument. When true the AuthNRequest will set a nameIdPolicy element.
         :type set_nameid_policy: bool
 
-        :returns: Redirection url
+        :returns: Redirection URL
         :rtype: string
         """
         authn_request = OneLogin_Saml2_Authn_Request(self.__settings, force_authn, is_passive, set_nameid_policy)
@@ -311,7 +311,7 @@ def logout(self, return_to=None, name_id=None, session_index=None, nq=None):
         :param nq: IDP Name Qualifier
         :type: string
 
-        :returns: Redirection url
+        :returns: Redirection URL
         """
         slo_url = self.get_slo_url()
         if slo_url is None:
@@ -343,7 +343,7 @@ def logout(self, return_to=None, name_id=None, session_index=None, nq=None):
 
     def get_sso_url(self):
         """
-        Gets the SSO url.
+        Gets the SSO URL.
 
         :returns: An URL, the SSO endpoint of the IdP
         :rtype: string
@@ -353,7 +353,7 @@ def get_sso_url(self):
 
     def get_slo_url(self):
         """
-        Gets the SLO url.
+        Gets the SLO URL.
 
         :returns: An URL, the SLO endpoint of the IdP
         :rtype: string
diff --git a/src/onelogin/saml2/authn_request.py b/src/onelogin/saml2/authn_request.py
@@ -29,13 +29,13 @@ def __init__(self, settings, force_authn=False, is_passive=False, set_nameid_pol
         :param settings: OSetting data
         :type settings: OneLogin_Saml2_Settings
 
-        :param force_authn: Optional argument. When true the AuthNReuqest will set the ForceAuthn='true'.
+        :param force_authn: Optional argument. When true the AuthNRequest will set the ForceAuthn='true'.
         :type force_authn: bool
 
-        :param is_passive: Optional argument. When true the AuthNReuqest will set the Ispassive='true'.
+        :param is_passive: Optional argument. When true the AuthNRequest will set the Ispassive='true'.
         :type is_passive: bool
 
-        :param set_nameid_policy: Optional argument. When true the AuthNReuqest will set a nameIdPolicy element.
+        :param set_nameid_policy: Optional argument. When true the AuthNRequest will set a nameIdPolicy element.
         :type set_nameid_policy: bool
         """
         self.__settings = settings
diff --git a/src/onelogin/saml2/idp_metadata_parser.py b/src/onelogin/saml2/idp_metadata_parser.py
@@ -21,13 +21,13 @@
 
 class OneLogin_Saml2_IdPMetadataParser(object):
     """
-    A class that contains methods to obtain and parse metadata from IdP
+    A class that contain methods related to obtaining and parsing metadata from IdP
     """
 
     @staticmethod
     def get_metadata(url):
         """
-        Get the metadata XML from the provided URL
+        Gets the metadata XML from the provided URL
         :param url: Url where the XML of the Identity Provider Metadata is published.
         :type url: string
         :returns: metadata XML
@@ -54,7 +54,7 @@ def get_metadata(url):
     @staticmethod
     def parse_remote(url, **kwargs):
         """
-        Get the metadata XML from the provided URL and parse it, returning a dict with extracted data
+        Gets the metadata XML from the provided URL and parse it, returning a dict with extracted data
         :param url: Url where the XML of the Identity Provider Metadata is published.
         :type url: string
         :returns: settings dict with extracted data
@@ -69,14 +69,14 @@ def parse(
             required_sso_binding=OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT,
             required_slo_binding=OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT):
         """
-        Parse the Identity Provider metadata and return a dict with extracted data.
+        Parses the Identity Provider metadata and return a dict with extracted data.
 
         If there are multiple <IDPSSODescriptor> tags, parse only the first.
 
-        Parse only those SSO endpoints with the same binding as given by
+        Parses only those SSO endpoints with the same binding as given by
         the `required_sso_binding` parameter.
 
-        Parse only those SLO endpoints with the same binding as given by
+        Parses only those SLO endpoints with the same binding as given by
         the `required_slo_binding` parameter.
 
         If the metadata specifies multiple SSO endpoints with the required
diff --git a/src/onelogin/saml2/logout_request.py b/src/onelogin/saml2/logout_request.py
@@ -99,7 +99,7 @@ def __init__(self, settings, request=None, name_id=None, session_index=None, nq=
 
     def get_request(self, deflate=True):
         """
-        Returns the Logout Request defated, base64encoded
+        Returns the Logout Request deflated, base64encoded
         :param deflate: It makes the deflate process optional
         :type: bool
         :return: Logout Request maybe deflated and base64 encoded
@@ -214,7 +214,7 @@ def get_session_indexes(request):
 
     def is_valid(self, request_data):
         """
-        Checks if the Logout Request recieved is valid
+        Checks if the Logout Request received is valid
         :param request_data: Request Data
         :type request_data: dict
 
@@ -278,6 +278,6 @@ def is_valid(self, request_data):
 
     def get_error(self):
         """
-        After execute a validation process, if fails this method returns the cause
+        After executing a validation process, if it fails this method returns the cause
         """
         return self.__error
diff --git a/src/onelogin/saml2/logout_response.py b/src/onelogin/saml2/logout_response.py
@@ -84,7 +84,7 @@ def is_valid(self, request_data, request_id=None):
 
                 security = self.__settings.get_security_data()
 
-                # Check if the InResponseTo of the Logout Response matchs the ID of the Logout Request (requestId) if provided
+                # Check if the InResponseTo of the Logout Response matches the ID of the Logout Request (requestId) if provided
                 in_response_to = self.document.get('InResponseTo', None)
                 if request_id is not None and in_response_to and in_response_to != request_id:
                     raise Exception('The InResponseTo of the Logout Response: %s, does not match the ID of the Logout request sent by the SP: %s' % (in_response_to, request_id))
@@ -163,6 +163,6 @@ def get_response(self, deflate=True):
 
     def get_error(self):
         """
-        After execute a validation process, if fails this method returns the cause
+        After executing a validation process, if it fails this method returns the cause
         """
         return self.__error
diff --git a/src/onelogin/saml2/metadata.py b/src/onelogin/saml2/metadata.py
@@ -217,7 +217,7 @@ def __add_x509_key_descriptors(root, cert, signing):
     @staticmethod
     def add_x509_key_descriptors(metadata, cert=None):
         """
-        Adds the x509 descriptors (sign/encriptation) to the metadata
+        Adds the x509 descriptors (sign/encryption) to the metadata
         The same cert will be used for sign/encrypt
 
         :param metadata: SAML Metadata XML
diff --git a/src/onelogin/saml2/response.py b/src/onelogin/saml2/response.py
@@ -527,6 +527,6 @@ def __decrypt_assertion(self, xml):
 
     def get_error(self):
         """
-        After execute a validation process, if fails this method returns the cause
+        After executing a validation process, if it fails this method returns the cause
         """
         return self.__error
diff --git a/src/onelogin/saml2/settings.py b/src/onelogin/saml2/settings.py
@@ -122,7 +122,7 @@ def __init__(self, settings=None, custom_base_path=None, sp_validation_only=Fals
 
     def __load_paths(self, base_path=None):
         """
-        Sets the paths of the different folders
+        Set the paths of the different folders
         """
         if base_path is None:
             base_path = dirname(dirname(dirname(__file__)))
diff --git a/src/onelogin/saml2/utils.py b/src/onelogin/saml2/utils.py
@@ -90,7 +90,7 @@ def decode_base64_and_inflate(value, ignore_zip=False):
     @staticmethod
     def deflate_and_base64_encode(value):
         """
-        Deflates and the base64 encodes a string
+        Deflates and then base64 encodes a string
         :param value: The string to deflate and encode
         :type value: string
         :returns: The deflated and encoded string
@@ -103,13 +103,13 @@ def format_cert(cert, heads=True):
         """
         Returns a x509 cert (adding header & footer if required).
 
-        :param cert: A x509 unformated cert
+        :param cert: A x509 unformatted cert
         :type: string
 
         :param heads: True if we want to include head and footer
         :type: boolean
 
-        :returns: Formated cert
+        :returns: Formatted cert
         :rtype: string
         """
         x509_cert = cert.replace('\x0D', '')
@@ -519,16 +519,16 @@ def calculate_x509_fingerprint(x509_cert, alg='sha1'):
     @staticmethod
     def format_finger_print(fingerprint):
         """
-        Formates a fingerprint.
+        Formats a fingerprint.
 
         :param fingerprint: fingerprint
         :type: string
 
-        :returns: Formated fingerprint
+        :returns: Formatted fingerprint
         :rtype: string
         """
-        formated_fingerprint = fingerprint.replace(':', '')
-        return formated_fingerprint.lower()
+        formatted_fingerprint = fingerprint.replace(':', '')
+        return formatted_fingerprint.lower()
 
     @staticmethod
     def generate_name_id(value, sp_nq, sp_format, cert=None, debug=False, nq=None):
@@ -723,7 +723,7 @@ def validate_sign(xml, cert=None, fingerprint=None, fingerprintalg='sha1', valid
         :param xml: The element we should validate
         :type: string | Document
 
-        :param cert: The pubic cert
+        :param cert: The public cert
         :type: string
 
         :param fingerprint: The fingerprint of the public cert
@@ -772,7 +772,7 @@ def validate_metadata_sign(xml, cert=None, fingerprint=None, fingerprintalg='sha
         :param xml: The element we should validate
         :type: string | Document
 
-        :param cert: The pubic cert
+        :param cert: The public cert
         :type: string
 
         :param fingerprint: The fingerprint of the public cert
@@ -825,7 +825,7 @@ def validate_node_sign(signature_node, elem, cert=None, fingerprint=None, finger
         :param xml: The element we should validate
         :type: Document
 
-        :param cert: The pubic cert
+        :param cert: The public cert
         :type: string
 
         :param fingerprint: The fingerprint of the public cert
@@ -903,7 +903,7 @@ def sign_binary(msg, key, algorithm=xmlsec.Transform.RSA_SHA1, debug=False):
     @staticmethod
     def validate_binary_sign(signed_query, signature, cert=None, algorithm=OneLogin_Saml2_Constants.RSA_SHA1, debug=False):
         """
-        Validates signed bynary data (Used to validate GET Signature).
+        Validates signed binary data (Used to validate GET Signature).
 
         :param signed_query: The element we should validate
         :type: string
@@ -912,7 +912,7 @@ def validate_binary_sign(signed_query, signature, cert=None, algorithm=OneLogin_
         :param signature: The signature that will be validate
         :type: string
 
-        :param cert: The pubic cert
+        :param cert: The public cert
         :type: string
 
         :param algorithm: Signature algorithm
