openstack
/
deb-python-hplefthandclient
Code Issues Proposed changes
deb-python-hplefthandclient/docs/_build/html/_modules/hplefthandclient/http.html

427 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>hplefthandclient.http &mdash; HP LeftHand REST Client 1.0.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<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="HP LeftHand REST Client 1.0.0 documentation" href="../../index.html" />
<link rel="up" title="hplefthandclient" href="../hplefthandclient.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">HP LeftHand REST Client 1.0.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../hplefthandclient.html" accesskey="U">hplefthandclient</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for hplefthandclient.http</h1><div class="highlight"><pre>
<span class="c"># vim: tabstop=4 shiftwidth=4 softtabstop=4</span>
<span class="c">#</span>
<span class="c"># Copyright 2013 Hewlett Packard Development Company, L.P.</span>
<span class="c"># All Rights Reserved.</span>
<span class="c">#</span>
<span class="c"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may</span>
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
<span class="c"># a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT</span>
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
<span class="c"># License for the specific language governing permissions and limitations</span>
<span class="c"># under the License.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">HPLeftHand HTTP Client</span>
<span class="sd">:Author: Walter A. Boring IV</span>
<span class="sd">:Description: This is the HTTP Client that is used to make the actual calls.</span>
<span class="sd"> It includes the authentication that knows the cookie name for LH.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">httplib2</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">pprint</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">simplejson</span> <span class="kn">as</span> <span class="nn">json</span>
<span class="kn">from</span> <span class="nn">hplefthandclient</span> <span class="kn">import</span> <span class="n">exceptions</span>
<div class="viewcode-block" id="HTTPJSONRESTClient"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient">[docs]</a><span class="k">class</span> <span class="nc">HTTPJSONRESTClient</span><span class="p">(</span><span class="n">httplib2</span><span class="o">.</span><span class="n">Http</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> An HTTP REST Client that sends and recieves JSON data as the body of the</span>
<span class="sd"> HTTP request.</span>
<span class="sd"> :param api_url: The url to the LH OS REST service</span>
<span class="sd"> ie. https://&lt;hostname or IP&gt;:&lt;port&gt;/lhos</span>
<span class="sd"> :type api_url: str</span>
<span class="sd"> :param insecure: Use https? requires a local certificate</span>
<span class="sd"> :type insecure: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">USER_AGENT</span> <span class="o">=</span> <span class="s">&#39;python-hplefthandclient&#39;</span>
<span class="n">SESSION_COOKIE_NAME</span> <span class="o">=</span> <span class="s">&#39;Authorization&#39;</span>
<span class="c">#API_VERSION = &#39;X-API-Version&#39;</span>
<span class="c">#CHRP_VERSION = &#39;X_HP-CHRP-Client-Version&#39;</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">api_url</span><span class="p">,</span> <span class="n">insecure</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">http_log_debug</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HTTPJSONRESTClient</span><span class="p">,</span>
<span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">disable_ssl_certificate_validation</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="bp">None</span>
<span class="c">#should be http://&lt;Server:Port&gt;/lhos</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_url</span><span class="p">(</span><span class="n">api_url</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_debug_flag</span><span class="p">(</span><span class="n">http_log_debug</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">times</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># [(&quot;item&quot;, starttime, endtime), ...]</span>
<span class="c"># httplib2 overrides</span>
<span class="bp">self</span><span class="o">.</span><span class="n">force_exception_to_status_code</span> <span class="o">=</span> <span class="bp">True</span>
<span class="c">#self.disable_ssl_certificate_validation = insecure</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="HTTPJSONRESTClient.set_url"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.set_url">[docs]</a> <span class="k">def</span> <span class="nf">set_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">api_url</span><span class="p">):</span>
<span class="c">#should be http://&lt;Server:Port&gt;/lhos</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_url</span> <span class="o">=</span> <span class="n">api_url</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s">&#39;/&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_url</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.set_debug_flag"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.set_debug_flag">[docs]</a> <span class="k">def</span> <span class="nf">set_debug_flag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flag</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This turns on/off http request/response debugging output to console</span>
<span class="sd"> :param flag: Set to True to enable debugging output</span>
<span class="sd"> :type flag: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">http_log_debug</span> <span class="o">=</span> <span class="n">flag</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">http_log_debug</span><span class="p">:</span>
<span class="n">ch</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">ch</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.authenticate"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.authenticate">[docs]</a> <span class="k">def</span> <span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This tries to create an authenticated session with the LH OS server</span>
<span class="sd"> :param user: The username</span>
<span class="sd"> :type user: str</span>
<span class="sd"> :param password: The password</span>
<span class="sd"> :type password: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c">#this prevens re-auth attempt if auth fails</span>
<span class="bp">self</span><span class="o">.</span><span class="n">auth_try</span> <span class="o">=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">info</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;user&#39;</span><span class="p">:</span> <span class="n">user</span><span class="p">,</span> <span class="s">&#39;password&#39;</span><span class="p">:</span> <span class="n">password</span><span class="p">}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_optional</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="n">optional</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_auth_optional</span> <span class="o">=</span> <span class="n">optional</span>
<span class="n">info</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">optional</span><span class="p">)</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s">&#39;/credentials&#39;</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">info</span><span class="p">)</span>
<span class="k">if</span> <span class="n">body</span> <span class="ow">and</span> <span class="s">&#39;authToken&#39;</span> <span class="ow">in</span> <span class="n">body</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="n">body</span><span class="p">[</span><span class="s">&#39;authToken&#39;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">auth_try</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span>
<span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span>
</div>
<span class="k">def</span> <span class="nf">_reauth</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">user</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="bp">self</span><span class="o">.</span><span class="n">_auth_optional</span><span class="p">)</span>
<div class="viewcode-block" id="HTTPJSONRESTClient.unauthenticate"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.unauthenticate">[docs]</a> <span class="k">def</span> <span class="nf">unauthenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This clears the authenticated session with the LH server. It logs out.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c">#delete the session on the LH</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="s">&#39;/credentials/</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_key</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="o">=</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.get_timings"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.get_timings">[docs]</a> <span class="k">def</span> <span class="nf">get_timings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Ths gives an array of the request timings since last reset_timings call</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">times</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.reset_timings"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.reset_timings">[docs]</a> <span class="k">def</span> <span class="nf">reset_timings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This resets the request/response timings array</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">times</span> <span class="o">=</span> <span class="p">[]</span>
</div>
<span class="k">def</span> <span class="nf">_http_log_req</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">http_log_debug</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">string_parts</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;curl -i&#39;</span><span class="p">]</span>
<span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
<span class="k">if</span> <span class="n">element</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&#39;GET&#39;</span><span class="p">,</span> <span class="s">&#39;POST&#39;</span><span class="p">):</span>
<span class="n">string_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39; -X </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">element</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">string_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39; </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">element</span><span class="p">)</span>
<span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;headers&#39;</span><span class="p">]:</span>
<span class="n">header</span> <span class="o">=</span> <span class="s">&#39; -H &quot;</span><span class="si">%s</span><span class="s">: </span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;headers&#39;</span><span class="p">][</span><span class="n">element</span><span class="p">])</span>
<span class="n">string_parts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">header</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">REQ: </span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="s">&quot;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">string_parts</span><span class="p">))</span>
<span class="k">if</span> <span class="s">&#39;body&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;REQ BODY: </span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;body&#39;</span><span class="p">]))</span>
<span class="k">def</span> <span class="nf">_http_log_resp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">http_log_debug</span><span class="p">:</span>
<span class="k">return</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;RESP:</span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span> <span class="n">pprint</span><span class="o">.</span><span class="n">pformat</span><span class="p">(</span><span class="n">resp</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;RESP BODY:</span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">,</span> <span class="n">body</span><span class="p">)</span>
<div class="viewcode-block" id="HTTPJSONRESTClient.request"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.request">[docs]</a> <span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This makes an HTTP Request to the LH server. You should use get, post,</span>
<span class="sd"> delete instead.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_key</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_try</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s">&#39;headers&#39;</span><span class="p">,</span>
<span class="p">{})[</span><span class="bp">self</span><span class="o">.</span><span class="n">SESSION_COOKIE_NAME</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">session_key</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s">&#39;headers&#39;</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;headers&#39;</span><span class="p">,</span> <span class="p">{}))</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;headers&#39;</span><span class="p">][</span><span class="s">&#39;User-Agent&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">USER_AGENT</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;headers&#39;</span><span class="p">][</span><span class="s">&#39;Accept&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;application/json&#39;</span>
<span class="k">if</span> <span class="s">&#39;body&#39;</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;headers&#39;</span><span class="p">][</span><span class="s">&#39;Content-Type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;application/json&#39;</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;body&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s">&#39;body&#39;</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_http_log_req</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">HTTPJSONRESTClient</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_http_log_resp</span><span class="p">(</span><span class="n">resp</span><span class="p">,</span> <span class="n">body</span><span class="p">)</span>
<span class="c"># Try and conver the body response to an object</span>
<span class="c"># This assumes the body of the reply is JSON</span>
<span class="k">if</span> <span class="n">body</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">body</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">body</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="c">#pprint.pprint(&quot;failed to decode json\n&quot;)</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">body</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="n">resp</span><span class="o">.</span><span class="n">status</span> <span class="o">&gt;=</span> <span class="mi">400</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">from_response</span><span class="p">(</span><span class="n">resp</span><span class="p">,</span> <span class="n">body</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
</div>
<span class="k">def</span> <span class="nf">_time_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">times</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s">&quot;</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">method</span><span class="p">,</span> <span class="n">url</span><span class="p">),</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
<span class="k">def</span> <span class="nf">_do_reauth</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">ex</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">print</span> <span class="s">&quot;_do_reauth called&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_try</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_reauth</span><span class="p">()</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_time_request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">api_url</span> <span class="o">+</span> <span class="n">url</span><span class="p">,</span>
<span class="n">method</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ex</span>
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">HTTPUnauthorized</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ex</span>
<span class="k">def</span> <span class="nf">_cs_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="c"># Perform the request once. If we get a 401 back then it</span>
<span class="c"># might be because the auth token expired, so try to</span>
<span class="c"># re-authenticate and try again. If it still fails, bail.</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_time_request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">api_url</span> <span class="o">+</span> <span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">HTTPUnauthorized</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>
<span class="k">print</span> <span class="s">&quot;_CS_REQUEST HTTPUnauthorized&quot;</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_reauth</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">ex</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
<span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">HTTPForbidden</span><span class="p">,</span> <span class="n">ex</span><span class="p">:</span>
<span class="k">print</span> <span class="s">&quot;_CS_REQUEST HTTPForbidden&quot;</span>
<span class="n">resp</span><span class="p">,</span> <span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_do_reauth</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">ex</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">,</span> <span class="n">body</span>
<div class="viewcode-block" id="HTTPJSONRESTClient.get"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Make an HTTP GET request to the server.</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> #example call</span>
<span class="sd"> try {</span>
<span class="sd"> headers, body = http.get(&#39;/volumes&#39;)</span>
<span class="sd"> } except exceptions.HTTPUnauthorized as ex:</span>
<span class="sd"> print &quot;Not logged in&quot;</span>
<span class="sd"> }</span>
<span class="sd"> :param url: The relative url from the LH api_url</span>
<span class="sd"> :type url: str</span>
<span class="sd"> :returns: headers - dict of HTTP Response headers</span>
<span class="sd"> :returns: body - the body of the response. If the body was JSON,</span>
<span class="sd"> it will be an object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cs_request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="s">&#39;GET&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.post"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.post">[docs]</a> <span class="k">def</span> <span class="nf">post</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Make an HTTP POST request to the server.</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> #example call</span>
<span class="sd"> try {</span>
<span class="sd"> info = {&#39;name&#39;: &#39;new volume name&#39;, &#39;sizeMiB&#39;: 300}</span>
<span class="sd"> headers, body = http.post(&#39;/volumes&#39;, body=info)</span>
<span class="sd"> } except exceptions.HTTPUnauthorized as ex:</span>
<span class="sd"> print &quot;Not logged in&quot;</span>
<span class="sd"> }</span>
<span class="sd"> :param url: The relative url from the LH api_url</span>
<span class="sd"> :type url: str</span>
<span class="sd"> :returns: headers - dict of HTTP Response headers</span>
<span class="sd"> :returns: body - the body of the response. If the body was JSON,</span>
<span class="sd"> it will be an object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cs_request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="s">&#39;POST&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.put"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.put">[docs]</a> <span class="k">def</span> <span class="nf">put</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Make an HTTP PUT request to the server.</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> #example call</span>
<span class="sd"> try {</span>
<span class="sd"> info = {&#39;name&#39;: &#39;something&#39;}</span>
<span class="sd"> headers, body = http.put(&#39;/volumes&#39;, body=info)</span>
<span class="sd"> } except exceptions.HTTPUnauthorized as ex:</span>
<span class="sd"> print &quot;Not logged in&quot;</span>
<span class="sd"> }</span>
<span class="sd"> :param url: The relative url from the LH api_url</span>
<span class="sd"> :type url: str</span>
<span class="sd"> :returns: headers - dict of HTTP Response headers</span>
<span class="sd"> :returns: body - the body of the response. If the body was JSON,</span>
<span class="sd"> it will be an object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cs_request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="s">&#39;PUT&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="HTTPJSONRESTClient.delete"><a class="viewcode-back" href="../../hplefthandclient.html#hplefthandclient.http.HTTPJSONRESTClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Make an HTTP DELETE request to the server.</span>
<span class="sd"> .. code-block:: python</span>
<span class="sd"> #example call</span>
<span class="sd"> try {</span>
<span class="sd"> headers, body = http.delete(&#39;/volumes/%s&#39; % name)</span>
<span class="sd"> } except exceptions.HTTPUnauthorized as ex:</span>
<span class="sd"> print &quot;Not logged in&quot;</span>
<span class="sd"> }</span>
<span class="sd"> :param url: The relative url from the LH api_url</span>
<span class="sd"> :type url: str</span>
<span class="sd"> :returns: headers - dict of HTTP Response headers</span>
<span class="sd"> :returns: body - the body of the response. If the body was JSON,</span>
<span class="sd"> it will be an object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cs_request</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="s">&#39;DELETE&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">HP LeftHand REST Client 1.0.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
<li><a href="../hplefthandclient.html" >hplefthandclient</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013 Hewlett Packard Development Company, L.P..
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
View Git Blame Copy Permalink