Update docs for 2.1.4

Author: aholmberg

_modules/cassandra.html

@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>cassandra &mdash; Cassandra Driver 2.1.3 documentation</title>
+    <title>cassandra &mdash; Cassandra Driver 2.1.4 documentation</title>
 
     <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '2.1.3',
+        VERSION:     '2.1.4',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="Cassandra Driver 2.1.3 documentation" href="../index.html" />
+    <link rel="top" title="Cassandra Driver 2.1.4 documentation" href="../index.html" />
     <link rel="up" title="Module code" href="index.html" /> 
   </head>
   <body>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../index.html">Cassandra Driver 2.1.3 documentation</a> &raquo;</li>
+        <li><a href="../index.html">Cassandra Driver 2.1.4 documentation</a> &raquo;</li>
           <li><a href="index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
     </div>
@@ -89,7 +89,7 @@ <h1>Source code for cassandra</h1><div class="highlight"><pre>
 <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">&#39;cassandra&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">NullHandler</span><span class="p">())</span>
 
 
-<span class="n">__version_info__</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">)</span>
+<span class="n">__version_info__</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
 <span class="n">__version__</span> <span class="o">=</span> <span class="s">&#39;.&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">__version_info__</span><span class="p">))</span>
 
 
@@ -384,7 +384,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../index.html">Cassandra Driver 2.1.3 documentation</a> &raquo;</li>
+        <li><a href="../index.html">Cassandra Driver 2.1.4 documentation</a> &raquo;</li>
           <li><a href="index.html" >Module code</a> &raquo;</li> 
       </ul>
     </div>

_modules/cassandra/auth.html

@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>cassandra.auth &mdash; Cassandra Driver 2.1.3 documentation</title>
+    <title>cassandra.auth &mdash; Cassandra Driver 2.1.4 documentation</title>
 
     <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '2.1.3',
+        VERSION:     '2.1.4',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
-    <link rel="top" title="Cassandra Driver 2.1.3 documentation" href="../../index.html" />
+    <link rel="top" title="Cassandra Driver 2.1.4 documentation" href="../../index.html" />
     <link rel="up" title="cassandra" href="../cassandra.html" /> 
   </head>
   <body>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../../index.html">Cassandra Driver 2.1.3 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Cassandra Driver 2.1.4 documentation</a> &raquo;</li>
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../cassandra.html" accesskey="U">cassandra</a> &raquo;</li> 
       </ul>
@@ -77,7 +77,10 @@ <h1>Source code for cassandra.auth</h1><div class="highlight"><pre>
 <span class="c"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c"># See the License for the specific language governing permissions and</span>
-
+<span class="k">try</span><span class="p">:</span>
+    <span class="kn">from</span> <span class="nn">puresasl.client</span> <span class="kn">import</span> <span class="n">SASLClient</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
+    <span class="n">SASLClient</span> <span class="o">=</span> <span class="bp">None</span>
 
 <div class="viewcode-block" id="AuthProvider"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.AuthProvider">[docs]</a><span class="k">class</span> <span class="nc">AuthProvider</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
@@ -189,7 +192,56 @@ <h1>Source code for cassandra.auth</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="s">&quot;</span><span class="se">\x00</span><span class="si">%s</span><span class="se">\x00</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">username</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">evaluate_challenge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">challenge</span><span class="p">):</span>
-        <span class="k">return</span> <span class="bp">None</span></div>
+        <span class="k">return</span> <span class="bp">None</span>
+
+</div>
+<div class="viewcode-block" id="SaslAuthProvider"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.SaslAuthProvider">[docs]</a><span class="k">class</span> <span class="nc">SaslAuthProvider</span><span class="p">(</span><span class="n">AuthProvider</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    An :class:`~.AuthProvider` supporting general SASL auth mechanisms</span>
+
+<span class="sd">    Suitable for GSSAPI or other SASL mechanisms</span>
+
+<span class="sd">    Example usage::</span>
+
+<span class="sd">        from cassandra.cluster import Cluster</span>
+<span class="sd">        from cassandra.auth import SaslAuthProvider</span>
+
+<span class="sd">        sasl_kwargs = {&#39;host&#39;: &#39;localhost&#39;,</span>
+<span class="sd">                       &#39;service&#39;: &#39;dse&#39;,</span>
+<span class="sd">                       &#39;mechanism&#39;: &#39;GSSAPI&#39;,</span>
+<span class="sd">                       &#39;qops&#39;: &#39;auth&#39;.split(&#39;,&#39;)}</span>
+<span class="sd">        auth_provider = SaslAuthProvider(**sasl_kwargs)</span>
+<span class="sd">        cluster = Cluster(auth_provider=auth_provider)</span>
+
+<span class="sd">    .. versionadded:: 2.1.4</span>
+<span class="sd">    &quot;&quot;&quot;</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="o">**</span><span class="n">sasl_kwargs</span><span class="p">):</span>
+        <span class="k">if</span> <span class="n">SASLClient</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s">&#39;The puresasl library has not been installed&#39;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">sasl_kwargs</span> <span class="o">=</span> <span class="n">sasl_kwargs</span>
+
+    <span class="k">def</span> <span class="nf">new_authenticator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
+        <span class="k">return</span> <span class="n">SaslAuthenticator</span><span class="p">(</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">sasl_kwargs</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="SaslAuthenticator"><a class="viewcode-back" href="../../api/cassandra/auth.html#cassandra.auth.SaslAuthenticator">[docs]</a><span class="k">class</span> <span class="nc">SaslAuthenticator</span><span class="p">(</span><span class="n">Authenticator</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    A pass-through :class:`~.Authenticator` using the third party package</span>
+<span class="sd">    &#39;pure-sasl&#39; for authentication</span>
+
+<span class="sd">    .. versionadded:: 2.1.4</span>
+<span class="sd">    &quot;&quot;&quot;</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">host</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">mechanism</span><span class="o">=</span><span class="s">&#39;GSSAPI&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">sasl_kwargs</span><span class="p">):</span>
+        <span class="k">if</span> <span class="n">SASLClient</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="s">&#39;The puresasl library has not been installed&#39;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">sasl</span> <span class="o">=</span> <span class="n">SASLClient</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">mechanism</span><span class="p">,</span> <span class="o">**</span><span class="n">sasl_kwargs</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">initial_response</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sasl</span><span class="o">.</span><span class="n">process</span><span class="p">()</span>
+
+    <span class="k">def</span> <span class="nf">evaluate_challenge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">challenge</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sasl</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">challenge</span><span class="p">)</span></div>
 </pre></div>
 
           </div>
@@ -206,7 +258,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li><a href="../../index.html">Cassandra Driver 2.1.3 documentation</a> &raquo;</li>
+        <li><a href="../../index.html">Cassandra Driver 2.1.4 documentation</a> &raquo;</li>
           <li><a href="../index.html" >Module code</a> &raquo;</li>
           <li><a href="../cassandra.html" >cassandra</a> &raquo;</li> 
       </ul>