Update docs

Author: pitbulk

README.md

@@ -619,6 +619,12 @@ target_url = 'https://example.com'
 auth.logout(return_to=target_url)
 ```
 
+Also there are 2 optional parameters that can be set:
+
+* name_id. That will be used to build the LogoutRequest. If not name_id parameter is set and the auth object processed a 
+SAML Response with a NameId, then this NameId will be used.
+* session_index. SessionIndex that identifies the session of the user.
+
 ####Example of a view that initiates the SSO request and handles the response (is the acs target)####
 
 We can code a unique file that initiates the SSO process, handle the response, get the attributes, initiate the slo and processes the logout response.

docs/saml2/_modules/saml2/auth.html

@@ -280,13 +280,16 @@ <h1>Source code for saml2.auth</h1><div class="highlight"><pre>
             <span class="n">parameters</span><span class="p">[</span><span class="s">&#39;Signature&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">build_request_signature</span><span class="p">(</span><span class="n">saml_request</span><span class="p">,</span> <span class="n">parameters</span><span class="p">[</span><span class="s">&#39;RelayState&#39;</span><span class="p">])</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_sso_url</span><span class="p">(),</span> <span class="n">parameters</span><span class="p">)</span>
 </div>
-<div class="viewcode-block" id="OneLogin_Saml2_Auth.logout"><a class="viewcode-back" href="../../saml2.html#saml2.auth.OneLogin_Saml2_Auth.logout">[docs]</a>    <span class="k">def</span> <span class="nf">logout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">return_to</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+<div class="viewcode-block" id="OneLogin_Saml2_Auth.logout"><a class="viewcode-back" href="../../saml2.html#saml2.auth.OneLogin_Saml2_Auth.logout">[docs]</a>    <span class="k">def</span> <span class="nf">logout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">return_to</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">name_id</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">session_index</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Initiates the SLO process.</span>
 
 <span class="sd">        :param return_to: Optional argument. The target URL the user should be redirected to after logout.</span>
 <span class="sd">        :type return_to: string</span>
-
+<span class="sd">        :param name_id: Optional argument. The NameID that will be set in the LogoutRequest.</span>
+<span class="sd">        :type name_id: string</span>
+<span class="sd">        :param session_index: Optional argument. SessionIndex that identifies the session of the user.</span>
+<span class="sd">        :type session_index: string</span>
 <span class="sd">        :returns: Redirection url</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">slo_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_slo_url</span><span class="p">()</span>

docs/saml2/_modules/saml2/logout_request.html

@@ -70,7 +70,7 @@ <h1>Source code for saml2.logout_request</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="OneLogin_Saml2_Logout_Request"><a class="viewcode-back" href="../../saml2.html#saml2.logout_request.OneLogin_Saml2_Logout_Request">[docs]</a><span class="k">class</span> <span class="nc">OneLogin_Saml2_Logout_Request</span><span class="p">:</span>
 
-    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">):</span>
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span>,<span class="n">request</span><span class="o">=</span><span class="bp">None</span><span class="p">,<span class="n">name_id</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">session_index</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Constructs the Logout Request object.</span>
 

docs/saml2/saml2.html

@@ -142,6 +142,22 @@ <h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" ti
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="saml2.auth.OneLogin_Saml2_Auth.get_last_error_reason">
+<tt class="descname">get_last_error_reason</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_last_error_reason"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_last_error_reason" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the reason for the last error</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Error</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="method">
 <dt id="saml2.auth.OneLogin_Saml2_Auth.get_nameid">
 <tt class="descname">get_nameid</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_nameid" title="Permalink to this definition">¶</a></dt>
@@ -232,13 +248,18 @@ <h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" ti
 
 <dl class="method">
 <dt id="saml2.auth.OneLogin_Saml2_Auth.logout">
-<tt class="descname">logout</tt><big>(</big><em>return_to=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.logout" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">logout</tt><big>(</big><em>return_to=None</em>, <em>name_id=None</em>, <em>session_index=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.logout" title="Permalink to this definition">¶</a></dt>
 <dd><p>Initiates the SLO process.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>return_to</strong> (<em>string</em>) &#8211; Optional argument. The target URL the user should be redirected to after logout.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th>
+  <td class="field-body"><ul class="first simple">
+<li><strong>return_to</strong> (<em>string</em>) &#8211; Optional argument. The target URL the user should be redirected to after logout.</li>
+<li><strong>name_id</strong> (<em>string</em>) &#8211; Optional argument. The NameID that will be set in the LogoutRequest.</li>
+<li><strong>session_index</strong> (<em>string</em>) &#8211; Optional argument. SessionIndex that identifies the session of the user.</li>
+</ul></td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Redirection url</td>
 </tr>
@@ -633,7 +654,7 @@ <h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" ti
 <span id="logout-request-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">logout_request</span></tt> Class<a class="headerlink" href="#module-saml2.logout_request" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request">
-<em class="property">class </em><tt class="descclassname">onelogin.saml2.logout_request.</tt><tt class="descname">OneLogin_Saml2_Logout_Request</tt><big>(</big><em>settings</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">onelogin.saml2.logout_request.</tt><tt class="descname">OneLogin_Saml2_Logout_Request</tt><big>(</big><em>settings</em>, <em>request=None</em>, <em>name_id=None</em>, <em>session_index=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request" title="Permalink to this definition">¶</a></dt>
 <dd><dl class="staticmethod">
 <dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_id">
 <em class="property">static </em><tt class="descname">get_id</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_id" title="Permalink to this definition">¶</a></dt>
@@ -708,6 +729,13 @@ <h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" ti
 :rtype: boolean</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error">
+<tt class="descname">get_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>After execute a validation process, if fails this method returns the cause
+:rtype: str object</p>
+</dd></dl>
+
 </dd></dl>
 
 </div>
@@ -758,6 +786,13 @@ <h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" ti
 :rtype: boolean</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error">
+<tt class="descname">get_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error" title="Permalink to this definition">¶</a></dt>
+<dd><p>After execute a validation process, if fails this method returns the cause
+:rtype: str object</p>
+</dd></dl>
+
 </dd></dl>
 
 </div>

src/onelogin/saml2/auth.py

@@ -224,7 +224,7 @@ def get_errors(self):
 
     def get_last_error_reason(self):
         """
-        Return the reason for the last error
+        Returns the reason for the last error
 
         :returns: Reason of the last error
         :rtype: None | string
@@ -279,6 +279,12 @@ def logout(self, return_to=None, name_id=None, session_index=None):
         :param return_to: Optional argument. The target URL the user should be redirected to after logout.
         :type return_to: string
 
+        :param name_id: The NameID that will be set in the LogoutRequest.
+        :type name_id: string
+
+        :param session_index: SessionIndex that identifies the session of the user.
+        :type session_index: string
+
         :returns: Redirection url
         """
         slo_url = self.get_slo_url()

src/onelogin/saml2/logout_request.py

@@ -33,8 +33,17 @@ def __init__(self, settings, request=None, name_id=None, session_index=None):
         """
         Constructs the Logout Request object.
 
-        Arguments are:
-            * (OneLogin_Saml2_Settings)   settings. Setting data
+        :param settings: Setting data
+        :type request_data: OneLogin_Saml2_Settings
+
+        :param request: Optional. A LogoutRequest to be loaded instead build one.
+        :type request: string
+
+        :param name_id: The NameID that will be set in the LogoutRequest.
+        :type name_id: string
+
+        :param session_index: SessionIndex that identifies the session of the user.
+        :type session_index: string
         """
         self.__settings = settings
         self.__error = None

tests/src/OneLogin/saml2_tests/auth_test.py

@@ -680,7 +680,7 @@ def testLogoutNameIDandSessionIndex(self):
         self.assertIn('SAMLRequest', parsed_query)
 
         logout_request = OneLogin_Saml2_Utils.decode_base64_and_inflate(parsed_query['SAMLRequest'][0])
-        name_id_from_request =  OneLogin_Saml2_Logout_Request.get_nameid(logout_request)
+        name_id_from_request = OneLogin_Saml2_Logout_Request.get_nameid(logout_request)
         sessions_index_in_request = OneLogin_Saml2_Logout_Request.get_session_indexes(logout_request)
         self.assertIn(session_index, sessions_index_in_request)
         self.assertEqual(name_id, name_id_from_request)
@@ -706,7 +706,7 @@ def testLogoutNameID(self):
         self.assertIn('SAMLRequest', parsed_query)
         logout_request = OneLogin_Saml2_Utils.decode_base64_and_inflate(parsed_query['SAMLRequest'][0])
 
-        name_id_from_request =  OneLogin_Saml2_Logout_Request.get_nameid(logout_request)
+        name_id_from_request = OneLogin_Saml2_Logout_Request.get_nameid(logout_request)
         self.assertEqual(name_id_from_response, name_id_from_request)
 
     def testSetStrict(self):