Skip to content
This repository
Browse code

updating documentation; version 0.1.10

  • Loading branch information...
commit ce5d684ecaa96d4d9c03c89e256ceaaebfc89463 1 parent 6f73125
Max Countryman maxcountryman authored
BIN  docs/_build/doctrees/environment.pickle
Binary file not shown
BIN  docs/_build/doctrees/index.doctree
Binary file not shown
2  docs/_build/html/.buildinfo
... ... @@ -1,4 +1,4 @@
1 1 # Sphinx build info version 1
2 2 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3   -config: b9b126491ce3d87c154f3b01012d4f58
  3 +config: 686d1d9a53cf9d513f5d3adea79e6b90
4 4 tags: fbb0d17656682115ca4d033fb2f83ba1
3  docs/_build/html/_sources/index.txt
@@ -111,3 +111,6 @@ API
111 111
112 112 .. autoclass:: webauth.service.OAuth1Service
113 113 :members:
  114 +
  115 +.. autoclass:: webauth.hook.OAuth1Hook
  116 + :members:
26 docs/_build/html/genindex.html
@@ -9,7 +9,7 @@
9 9 <head>
10 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 11
12   - <title>Index &mdash; Webauth 0.1.9 documentation</title>
  12 + <title>Index &mdash; Webauth 0.1.10 documentation</title>
13 13
14 14 <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
15 15 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -17,7 +17,7 @@
17 17 <script type="text/javascript">
18 18 var DOCUMENTATION_OPTIONS = {
19 19 URL_ROOT: '',
20   - VERSION: '0.1.9',
  20 + VERSION: '0.1.10',
21 21 COLLAPSE_INDEX: false,
22 22 FILE_SUFFIX: '.html',
23 23 HAS_SOURCE: true
@@ -26,7 +26,7 @@
26 26 <script type="text/javascript" src="_static/jquery.js"></script>
27 27 <script type="text/javascript" src="_static/underscore.js"></script>
28 28 <script type="text/javascript" src="_static/doctools.js"></script>
29   - <link rel="top" title="Webauth 0.1.9 documentation" href="index.html" />
  29 + <link rel="top" title="Webauth 0.1.10 documentation" href="index.html" />
30 30 </head>
31 31 <body>
32 32
@@ -52,6 +52,14 @@ <h2 id="G">G</h2>
52 52 <table style="width: 100%" class="indextable genindextable"><tr>
53 53 <td style="width: 33%" valign="top"><dl>
54 54
  55 + <dt><a href="index.html#webauth.hook.OAuth1Hook.generate_authorization_header">generate_authorization_header() (webauth.hook.OAuth1Hook method)</a>
  56 + </dt>
  57 +
  58 +
  59 + <dt><a href="index.html#webauth.hook.OAuth1Hook.generate_oauth_params">generate_oauth_params() (webauth.hook.OAuth1Hook method)</a>
  60 + </dt>
  61 +
  62 +
55 63 <dt><a href="index.html#webauth.service.OAuth1Service.get_access_token">get_access_token() (webauth.service.OAuth1Service method)</a>
56 64 </dt>
57 65
@@ -61,12 +69,12 @@ <h2 id="G">G</h2>
61 69 </dt>
62 70
63 71 </dl></dd>
  72 + </dl></td>
  73 + <td style="width: 33%" valign="top"><dl>
64 74
65 75 <dt><a href="index.html#webauth.service.OAuth1Service.get_authenticated_session">get_authenticated_session() (webauth.service.OAuth1Service method)</a>
66 76 </dt>
67 77
68   - </dl></td>
69   - <td style="width: 33%" valign="top"><dl>
70 78
71 79 <dt><a href="index.html#webauth.service.OAuth1Service.get_authorize_url">get_authorize_url() (webauth.service.OAuth1Service method)</a>
72 80 </dt>
@@ -92,16 +100,20 @@ <h2 id="O">O</h2>
92 100 <table style="width: 100%" class="indextable genindextable"><tr>
93 101 <td style="width: 33%" valign="top"><dl>
94 102
95   - <dt><a href="index.html#webauth.service.OAuth1Service">OAuth1Service (class in webauth.service)</a>
  103 + <dt><a href="index.html#webauth.hook.OAuth1Hook">OAuth1Hook (class in webauth.hook)</a>
96 104 </dt>
97 105
98 106
99   - <dt><a href="index.html#webauth.service.OAuth2Service">OAuth2Service (class in webauth.service)</a>
  107 + <dt><a href="index.html#webauth.service.OAuth1Service">OAuth1Service (class in webauth.service)</a>
100 108 </dt>
101 109
102 110 </dl></td>
103 111 <td style="width: 33%" valign="top"><dl>
104 112
  113 + <dt><a href="index.html#webauth.service.OAuth2Service">OAuth2Service (class in webauth.service)</a>
  114 + </dt>
  115 +
  116 +
105 117 <dt><a href="index.html#webauth.service.OflyService">OflyService (class in webauth.service)</a>
106 118 </dt>
107 119
101 docs/_build/html/index.html
@@ -7,7 +7,7 @@
7 7 <head>
8 8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 9
10   - <title>Webauth &mdash; Webauth 0.1.9 documentation</title>
  10 + <title>Webauth &mdash; Webauth 0.1.10 documentation</title>
11 11
12 12 <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
13 13 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
15 15 <script type="text/javascript">
16 16 var DOCUMENTATION_OPTIONS = {
17 17 URL_ROOT: '',
18   - VERSION: '0.1.9',
  18 + VERSION: '0.1.10',
19 19 COLLAPSE_INDEX: false,
20 20 FILE_SUFFIX: '.html',
21 21 HAS_SOURCE: true
@@ -24,7 +24,7 @@
24 24 <script type="text/javascript" src="_static/jquery.js"></script>
25 25 <script type="text/javascript" src="_static/underscore.js"></script>
26 26 <script type="text/javascript" src="_static/doctools.js"></script>
27   - <link rel="top" title="Webauth 0.1.9 documentation" href="#" />
  27 + <link rel="top" title="Webauth 0.1.10 documentation" href="#" />
28 28 </head>
29 29 <body>
30 30
@@ -180,11 +180,9 @@
180 180
181 181 <dl class="method">
182 182 <dt id="webauth.service.OflyService.request">
183   -<tt class="descname">request</tt><big>(</big><em>http_method</em>, <em>url</em>, <em>header_auth=False</em>, <em>**params</em><big>)</big><a class="headerlink" href="#webauth.service.OflyService.request" title="Permalink to this definition">¶</a></dt>
  183 +<tt class="descname">request</tt><big>(</big><em>http_method</em>, <em>url</em>, <em>header_auth=False</em>, <em>params=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#webauth.service.OflyService.request" title="Permalink to this definition">¶</a></dt>
184 184 <dd><p>Sends a request to an Ofly endpoint, properly wrapped around
185 185 requests.</p>
186   -<p>The first time an access token is provided it will be saved on the
187   -object for convenience.</p>
188 186 <table class="docutils field-list" frame="void" rules="none">
189 187 <col class="field-name" />
190 188 <col class="field-body" />
@@ -194,8 +192,9 @@
194 192 used.</li>
195 193 <li><strong>url</strong> &#8211; The resource to be requested.</li>
196 194 <li><strong>header_auth</strong> &#8211; Authenication via header, defaults to False.</li>
197   -<li><strong>params</strong> &#8211; Additional keyworded arguments to be added to the
198   -request querystring.</li>
  195 +<li><strong>params</strong> &#8211; Additional arguments to be added to the request
  196 +querystring.</li>
  197 +<li><strong>data</strong> &#8211; Additional data to be included in the request body.</li>
199 198 </ul>
200 199 </td>
201 200 </tr>
@@ -291,7 +290,7 @@
291 290
292 291 <dl class="method">
293 292 <dt id="webauth.service.OAuth2Service.request">
294   -<tt class="descname">request</tt><big>(</big><em>http_method</em>, <em>url</em>, <em>access_token=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#webauth.service.OAuth2Service.request" title="Permalink to this definition">¶</a></dt>
  293 +<tt class="descname">request</tt><big>(</big><em>http_method</em>, <em>url</em>, <em>access_token=None</em>, <em>params=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#webauth.service.OAuth2Service.request" title="Permalink to this definition">¶</a></dt>
295 294 <dd><p>Sends a request to an OAuth 2.0 endpoint, properly wrapped around
296 295 requests.</p>
297 296 <p>The first time an access token is provided it will be saved on the
@@ -306,8 +305,9 @@
306 305 <li><strong>url</strong> &#8211; The resource to be requested.</li>
307 306 <li><strong>access_token</strong> &#8211; The access token as returned by
308 307 <tt class="xref py py-class docutils literal"><span class="pre">get_access_token</span></tt>.</li>
309   -<li><strong>params</strong> &#8211; Additional keyworded arguments to be added to the
310   -request querystring.</li>
  308 +<li><strong>params</strong> &#8211; Additional arguments to be added to the request
  309 +querystring.</li>
  310 +<li><strong>data</strong> &#8211; Additional data to be included in the request body.</li>
311 311 </ul>
312 312 </td>
313 313 </tr>
@@ -489,6 +489,85 @@
489 489
490 490 </dd></dl>
491 491
  492 +<dl class="class">
  493 +<dt id="webauth.hook.OAuth1Hook">
  494 +<em class="property">class </em><tt class="descclassname">webauth.hook.</tt><tt class="descname">OAuth1Hook</tt><big>(</big><em>consumer_key</em>, <em>consumer_secret</em>, <em>access_token=None</em>, <em>access_token_secret=None</em>, <em>header_auth=False</em>, <em>signature=None</em><big>)</big><a class="headerlink" href="#webauth.hook.OAuth1Hook" title="Permalink to this definition">¶</a></dt>
  495 +<dd><p>Provides a pre-request hook into requests for OAuth 1.0/a services.</p>
  496 +<p>This package is built on the excellent Python Requests package. It
  497 +functions by &#8220;hooking&#8221; into a request and appending various attributes to
  498 +it which allow a client to interact with a standardized OAuth 1.0/a
  499 +provider.</p>
  500 +<p>You might intialize <tt class="xref py py-class docutils literal"><span class="pre">OAuthHook</span></tt> something like this:</p>
  501 +<div class="highlight-python"><div class="highlight"><pre><span class="n">oauth</span> <span class="o">=</span> <span class="n">OAuthHook</span><span class="p">(</span><span class="n">consumer_key</span><span class="o">=</span><span class="mi">1234</span><span class="p">,</span>
  502 + <span class="n">consumer_secret</span><span class="o">=</span><span class="mi">5678</span><span class="p">)</span>
  503 +<span class="n">oauth_session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">session</span><span class="p">(</span><span class="n">hooks</span><span class="o">=</span><span class="p">{</span><span class="s">&#39;pre_request&#39;</span><span class="p">:</span> <span class="n">oauth</span><span class="p">})</span>
  504 +</pre></div>
  505 +</div>
  506 +<p>This establishes a requests session that is wrapped if the OAuth-capable
  507 +hook. Using this session, an OAuth provider may be interacted with and
  508 +will receive the proper formatting for requests.</p>
  509 +<p>Note that this is normally used as a starting from which a request token
  510 +would be generated whereupon an access token is received. Once such a token
  511 +has been received, the wrapper should be reinitalized with this token:</p>
  512 +<div class="highlight-python"><div class="highlight"><pre><span class="c"># we provide our consumer pair as well as the access pair as returned</span>
  513 +<span class="c"># by the provider endpoint</span>
  514 +<span class="n">oauth</span> <span class="o">=</span> <span class="n">OAuthHook</span><span class="p">(</span><span class="n">consumer_key</span><span class="o">=</span><span class="mi">1234</span><span class="p">,</span>
  515 + <span class="n">consumer_secret</span><span class="o">=</span><span class="mi">5678</span><span class="p">,</span>
  516 + <span class="n">access_token</span><span class="o">=</span><span class="mi">4321</span><span class="p">,</span>
  517 + <span class="n">access_token_secret</span><span class="o">=</span><span class="mi">8765</span><span class="p">)</span>
  518 +<span class="n">oauth_session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">session</span><span class="p">(</span><span class="n">hooks</span><span class="o">=</span><span class="p">{</span><span class="s">&#39;pre_request&#39;</span><span class="p">:</span> <span class="n">oauth</span><span class="p">})</span>
  519 +</pre></div>
  520 +</div>
  521 +<p>The session is now ready to make calls to the endpoints made available by
  522 +the provider.</p>
  523 +<p>Additionally some services will make use of header authentication. This is
  524 +provided by passing <tt class="xref py py-class docutils literal"><span class="pre">__init__</span></tt> the <cite>auth_header</cite> parameter as
  525 +<cite>True</cite>.</p>
  526 +<table class="docutils field-list" frame="void" rules="none">
  527 +<col class="field-name" />
  528 +<col class="field-body" />
  529 +<tbody valign="top">
  530 +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  531 +<li><strong>consumer_key</strong> &#8211; Client consumer key.</li>
  532 +<li><strong>consumer_secret</strong> &#8211; Client consumer secret.</li>
  533 +<li><strong>access_token</strong> &#8211; Access token key.</li>
  534 +<li><strong>access_token_secret</strong> &#8211; Access token secret.</li>
  535 +<li><strong>header_auth</strong> &#8211; Authenication via header, defauls to False.</li>
  536 +<li><strong>signature</strong> &#8211; A signature method used to sign request parameters.</li>
  537 +</ul>
  538 +</td>
  539 +</tr>
  540 +</tbody>
  541 +</table>
  542 +<p>Defaults to None. If None the <cite>HmacSha1Signature</cite> method is used as
  543 +default.</p>
  544 +<dl class="method">
  545 +<dt id="webauth.hook.OAuth1Hook.generate_authorization_header">
  546 +<tt class="descname">generate_authorization_header</tt><big>(</big><em>oauth_params</em>, <em>realm=None</em><big>)</big><a class="headerlink" href="#webauth.hook.OAuth1Hook.generate_authorization_header" title="Permalink to this definition">¶</a></dt>
  547 +<dd><p>This method constructs an authorization header.</p>
  548 +<table class="docutils field-list" frame="void" rules="none">
  549 +<col class="field-name" />
  550 +<col class="field-body" />
  551 +<tbody valign="top">
  552 +<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  553 +<li><strong>oauth_params</strong> &#8211; The OAuth parameters to be added to the header.</li>
  554 +<li><strong>realm</strong> &#8211; The authentication realm. Defaults to None.</li>
  555 +</ul>
  556 +</td>
  557 +</tr>
  558 +</tbody>
  559 +</table>
  560 +</dd></dl>
  561 +
  562 +<dl class="method">
  563 +<dt id="webauth.hook.OAuth1Hook.generate_oauth_params">
  564 +<tt class="descname">generate_oauth_params</tt><big>(</big><big>)</big><a class="headerlink" href="#webauth.hook.OAuth1Hook.generate_oauth_params" title="Permalink to this definition">¶</a></dt>
  565 +<dd><p>This method handles generating the necessary URL parameters the
  566 +OAuth provider will expect.</p>
  567 +</dd></dl>
  568 +
  569 +</dd></dl>
  570 +
492 571 </div>
493 572 </div>
494 573
BIN  docs/_build/html/objects.inv
Binary file not shown
6 docs/_build/html/py-modindex.html
@@ -7,7 +7,7 @@
7 7 <head>
8 8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 9
10   - <title>Python Module Index &mdash; Webauth 0.1.9 documentation</title>
  10 + <title>Python Module Index &mdash; Webauth 0.1.10 documentation</title>
11 11
12 12 <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
13 13 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
15 15 <script type="text/javascript">
16 16 var DOCUMENTATION_OPTIONS = {
17 17 URL_ROOT: '',
18   - VERSION: '0.1.9',
  18 + VERSION: '0.1.10',
19 19 COLLAPSE_INDEX: false,
20 20 FILE_SUFFIX: '.html',
21 21 HAS_SOURCE: true
@@ -24,7 +24,7 @@
24 24 <script type="text/javascript" src="_static/jquery.js"></script>
25 25 <script type="text/javascript" src="_static/underscore.js"></script>
26 26 <script type="text/javascript" src="_static/doctools.js"></script>
27   - <link rel="top" title="Webauth 0.1.9 documentation" href="index.html" />
  27 + <link rel="top" title="Webauth 0.1.10 documentation" href="index.html" />
28 28
29 29
30 30 <script type="text/javascript">
6 docs/_build/html/search.html
@@ -7,7 +7,7 @@
7 7 <head>
8 8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 9
10   - <title>Search &mdash; Webauth 0.1.9 documentation</title>
  10 + <title>Search &mdash; Webauth 0.1.10 documentation</title>
11 11
12 12 <link rel="stylesheet" href="_static/flasky.css" type="text/css" />
13 13 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
15 15 <script type="text/javascript">
16 16 var DOCUMENTATION_OPTIONS = {
17 17 URL_ROOT: '',
18   - VERSION: '0.1.9',
  18 + VERSION: '0.1.10',
19 19 COLLAPSE_INDEX: false,
20 20 FILE_SUFFIX: '.html',
21 21 HAS_SOURCE: true
@@ -25,7 +25,7 @@
25 25 <script type="text/javascript" src="_static/underscore.js"></script>
26 26 <script type="text/javascript" src="_static/doctools.js"></script>
27 27 <script type="text/javascript" src="_static/searchtools.js"></script>
28   - <link rel="top" title="Webauth 0.1.9 documentation" href="index.html" />
  28 + <link rel="top" title="Webauth 0.1.10 documentation" href="index.html" />
29 29 <script type="text/javascript">
30 30 jQuery(function() { Search.loadIndex("searchindex.js"); });
31 31 </script>
2  docs/_build/html/searchindex.js
... ... @@ -1 +1 @@
1   -Search.setIndex({objects:{"":{webauth:[0,0,1,""]},"webauth.service":{OflyService:[0,1,1,""],OAuth2Service:[0,1,1,""],OAuth1Service:[0,1,1,""]},"webauth.service.OAuth2Service":{get_access_token:[0,2,1,""],request:[0,2,1,""],get_authorize_url:[0,2,1,""]},"webauth.service.OflyService":{request:[0,2,1,""],get_authorize_url:[0,2,1,""]},"webauth.service.OAuth1Service":{get_authenticated_session:[0,2,1,""],get_request_token:[0,2,1,""],get_access_token:[0,2,1,""],request:[0,2,1,""],get_authorize_url:[0,2,1,""]}},terms:{represent:0,all:[],code:0,authorization_cod:0,when:[],random:[],obtain:0,session:0,through:0,follow:0,token_kei:0,paramet:0,redirect:0,whose:[],onli:0,acquir:0,redirect_uri:0,flask:[],activ:[],param:0,should:0,response_typ:0,onc:0,input:[],hidden:[],main:[],might:0,modul:0,applic:0,global:[],"return":0,around:0,thei:[],get:0,python:0,than:0,none:0,initi:[],defaul:[],util:0,webauth:0,csrf:[],request_token:0,now:0,presum:0,string:0,like:0,name:0,specif:0,hook:0,possibl:0,"_construct_sess":0,authent:0,provid:0,token:0,exampl:0,necessari:0,contain:0,cooki:[],querystr:0,servic:0,view:[],oflyservic:0,www:0,set:0,primari:[],natur:0,secret:0,resourc:0,prehook:0,sign:0,consum:0,ensur:0,see:0,http_method:0,design:[],pass:0,fail:[],hash:[],variabl:0,subsequ:0,oflycallsignatur:0,flaskext:[],influenc:[],assum:0,someth:0,achiev:[],superb:0,content:0,enough:0,header_auth:0,django:[],"import":0,get_authorization_url:0,method:0,altern:0,intial:0,after:0,run:[],kei:0,gener:0,usag:0,accordingli:0,here:0,consumer_secret:0,extens:0,step:0,base:[],dictionari:0,setup:0,ask:0,post:[],valid:0,valu:[],addit:0,csrftoken:[],both:[],seasurf:[],similar:0,could:0,current:0,http:0,oauth2servic:0,get_access_token:0,turn:0,instanc:[],oauth_token:0,logic:[],fals:0,implement:0,com:0,assign:[],commonli:0,first:0,request_token_secret:0,pleas:0,rang:[],via:0,simpli:0,although:0,directli:0,point:0,foobar:0,app:[],easy_instal:0,oauth_request:0,header:0,api:0,oauth_kei:0,send:0,wrap:0,instal:0,miss:[],your:[],middlewar:[],backend:[],quit:0,given:0,doe:0,from:0,wai:0,start:0,addition:0,top:0,support:0,visit:0,two:0,been:0,avail:0,attach:0,reli:0,call:0,includ:0,save:0,render_templ:[],type:0,"final":0,more:0,"function":[],field:[],head:[],wrapper:0,option:0,form:[],conveni:0,exempt:[],rsa:0,oauth1servic:0,oflycallbackurl:0,made:0,bodi:0,templat:[],oauth:0,request_token_url:0,get_authenticated_sess:0,easiest:0,access_token_url:0,remote_us:0,jinja:[],endpoint:0,retriev:0,look:[],keyword:0,some_view:[],"default":0,wish:[],secret_kei:[],access:0,spec:0,can:0,abov:0,other:[],access_token_secret:0,def:[],pre:0,have:0,process:0,request:0,csrf_token:[],respons:0,shutterfli:0,argument:0,indic:[],get_authorize_url:0,packag:0,properli:0,want:0,deliv:0,pip:0,exclud:[],check:[],deault:0,access_token:0,decor:[],built:0,authen:0,author:0,rather:0,oauthhook:0,authorize_url:0,uri:0,reponse_typ:0,init_app:[],consumer_kei:0,note:0,also:0,need:0,html:[],"_csrf_token":[],futur:0,which:0,relav:0,before_request:[],instead:0,you:0,document:0,simpl:0,updat:0,oflyremoteus:0,simplifi:0,begin:0,sure:0,unless:[],thi:0,trace:[],proper:0,object:0,upon:0,sfly:0,rout:[],most:0,render:[],specifi:[],streamlin:0,mai:0,data:0,"class":0,get_request_token:0,simplic:0,sha1:0,off:[],url:0,bind:0,grant:0,well:0,ofli:0,produc:0,inform:0,client:0,command:0,allow:0,time:0,grant_typ:0,salt:[],make:0,usual:0},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Webauth"],objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},filenames:["index"]})
  1 +Search.setIndex({objects:{"":{webauth:[0,0,1,""]},"webauth.service.OflyService":{request:[0,2,1,""],get_authorize_url:[0,2,1,""]},"webauth.service.OAuth2Service":{get_access_token:[0,2,1,""],request:[0,2,1,""],get_authorize_url:[0,2,1,""]},"webauth.service.OAuth1Service":{get_authenticated_session:[0,2,1,""],get_request_token:[0,2,1,""],get_access_token:[0,2,1,""],request:[0,2,1,""],get_authorize_url:[0,2,1,""]},"webauth.service":{OflyService:[0,1,1,""],OAuth2Service:[0,1,1,""],OAuth1Service:[0,1,1,""]},"webauth.hook":{OAuth1Hook:[0,1,1,""]},"webauth.hook.OAuth1Hook":{generate_authorization_header:[0,2,1,""],generate_oauth_params:[0,2,1,""]}},terms:{represent:0,all:[],code:0,authorization_cod:0,excel:0,auth_head:0,random:[],obtain:0,addit:0,top:0,session:0,through:0,follow:0,token_kei:0,paramet:0,redirect:0,whose:[],onli:0,acquir:0,redirect_uri:0,flask:[],endpoint:0,activ:[],param:0,should:0,reinit:0,response_typ:0,foobar:0,input:[],hidden:[],main:[],might:0,app:[],applic:0,global:[],"return":0,oauth1hook:0,thei:[],get:0,python:0,initi:[],defaul:0,util:0,webauth:0,oauth_request:0,csrf:[],request_token:0,now:0,you:0,string:0,like:0,document:0,name:0,specif:0,hook:0,reponse_typ:0,"_construct_sess":0,html:[],authent:0,"default":0,achiev:[],necessari:0,contain:0,cooki:[],querystr:0,servic:0,deault:0,view:[],oflyservic:0,www:0,set:0,intial:0,client:0,natur:0,some:0,prehook:0,sign:0,consum:0,wrap:0,see:0,http_method:0,design:[],expect:0,authorize_url:0,pass:0,fail:[],run:[],append:0,variabl:0,setup:0,oflycallsignatur:0,flaskext:[],influenc:[],miss:[],someth:0,token:0,superb:0,content:0,enough:0,header_auth:0,"import":0,method:0,attribut:0,altern:0,signatur:0,object:0,hash:[],kei:0,gener:0,usag:0,given:0,here:0,standard:0,consumer_secret:0,extens:0,step:0,base:[],whereupon:0,dictionari:0,ask:0,post:[],secret_kei:[],valu:[],jinja:[],csrftoken:[],both:[],seasurf:[],produc:0,your:[],wai:0,most:0,access_token_secret:0,could:0,current:0,http:0,oauth2servic:0,get_access_token:0,turn:0,instanc:[],oauth_token:0,logic:[],implement:0,reli:0,com:0,assign:[],commonli:0,first:0,request_token_secret:0,pleas:0,rang:[],via:0,simpli:0,although:0,directli:0,point:0,onc:0,modul:0,easy_instal:0,pre_request:0,header:0,api:0,oauth_kei:0,send:0,exclud:[],ensur:0,instal:0,hmacsha1signatur:0,assum:0,primari:[],middlewar:[],backend:[],quit:0,accordingli:0,from:0,would:0,attach:0,addition:0,data:0,interact:0,support:0,visit:0,two:0,been:0,avail:0,start:0,secret:0,call:0,includ:0,easiest:0,handl:0,some_view:[],render_templ:[],type:0,"final":0,more:0,"function":0,field:[],head:[],wrapper:0,option:0,form:[],conveni:0,exempt:[],rsa:0,oauth1servic:0,oflycallbackurl:0,made:0,bodi:0,indic:[],oauth:0,request_token_url:0,get_authenticated_sess:0,"true":0,than:0,access_token_url:0,remote_us:0,also:0,none:0,subsequ:0,retriev:0,look:[],keyword:0,possibl:0,provid:0,wish:[],ofli:0,access:0,spec:0,can:0,abov:0,oauth_param:0,inform:0,other:[],similar:0,def:[],pre:0,want:0,generate_oauth_param:0,process:0,well:0,csrf_token:[],respons:0,shutterfli:0,argument:0,templat:[],get_authorize_url:0,packag:0,properli:0,have:0,deliv:0,pip:0,django:[],check:[],"__init__":0,around:0,access_token:0,readi:0,oauth_sess:0,variou:0,authen:0,author:0,rather:0,oauthhook:0,make:0,format:0,when:[],init_app:[],consumer_kei:0,note:0,fals:0,need:0,valid:0,pair:0,futur:0,which:0,relav:0,before_request:[],instead:0,presum:0,generate_authorization_head:0,simpl:0,updat:0,oflyremoteus:0,simplifi:0,begin:0,sure:0,resourc:0,allow:0,trace:[],normal:0,our:0,proper:0,after:0,upon:0,decor:[],sfly:0,rout:[],"_csrf_token":[],capabl:0,render:[],specifi:[],establish:0,streamlin:0,mai:0,realm:0,construct:0,unless:[],"class":0,built:0,get_request_token:0,simplic:0,sha1:0,off:[],save:0,url:0,bind:0,grant:0,request:0,uri:0,doe:0,receiv:0,exampl:0,command:0,thi:0,time:0,grant_typ:0,salt:[],get_authorization_url:0,usual:0},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Webauth"],objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},filenames:["index"]})
3  docs/index.rst
Source Rendered
@@ -111,3 +111,6 @@ API
111 111
112 112 .. autoclass:: webauth.service.OAuth1Service
113 113 :members:
  114 +
  115 +.. autoclass:: webauth.hook.OAuth1Hook
  116 + :members:
2  webauth/__init__.py
@@ -6,4 +6,4 @@
6 6 '''
7 7
8 8
9   -__version__ = '0.1.9'
  9 +__version__ = '0.1.10'
14 webauth/service.py
@@ -116,7 +116,7 @@ def get_authorize_url(self, remote_user=None, redirect_uri=None, **params):
116 116
117 117 :param remote_user: This is the oflyRemoteUser param. Defaults to None.
118 118 :param redirect_uri: This is the oflyCallbackUrl. Defaults to None.
119   - :param **params: Additional keyworded arguments to be added to the
  119 + :param params: Additional keyworded arguments to be added to the
120 120 request querystring.
121 121 '''
122 122 if remote_user is not None:
@@ -221,7 +221,7 @@ def get_authorize_url(self, response_type='code', **params):
221 221 '''Returns a proper authorize URL.
222 222
223 223 :param reponse_type: The response type. Defaults to 'code'.
224   - :param **params: Additional keyworded arguments to be added to the
  224 + :param params: Additional keyworded arguments to be added to the
225 225 request querystring.
226 226 '''
227 227 params.update({'client_id': self.consumer_key,
@@ -233,7 +233,7 @@ def get_access_token(self, grant_type='authorization_code', **data):
233 233 '''Retrieves the access token.
234 234
235 235 :param grant_type: The grant type. Deaults to 'authorization_code'.
236   - :param **data: Keyworded arguments to be passed in the body of the
  236 + :param data: Keyworded arguments to be passed in the body of the
237 237 request.
238 238 '''
239 239 data.update({'grant_type': grant_type})
@@ -353,7 +353,7 @@ def _construct_session(self, **kwargs):
353 353 '''Construct the request session, supplying the consumer key and
354 354 secret.
355 355
356   - :param **kwargs: Extra keyworded arguments to be passed to the
  356 + :param kwargs: Extra keyworded arguments to be passed to the
357 357 OAuth1Hook constructor.
358 358 '''
359 359 hook = OAuth1Hook(consumer_key=self.consumer_key,
@@ -366,7 +366,7 @@ def get_request_token(self, http_method, **data):
366 366
367 367 :param http_method: A string representation of the HTTP method to be
368 368 used.
369   - :param **data: Keyworded arguments to be passed in the body of the
  369 + :param data: Keyworded arguments to be passed in the body of the
370 370 request.
371 371 '''
372 372 auth_session = \
@@ -386,7 +386,7 @@ def get_authorize_url(self, request_token, **params):
386 386
387 387 :param request_token: The request token as returned by
388 388 :class:`get_request_token`.
389   - :param **params: Additional keyworded arguments to be added to the
  389 + :param params: Additional keyworded arguments to be added to the
390 390 request querystring.
391 391 '''
392 392 params.update({'oauth_token': quote(request_token)})
@@ -403,7 +403,7 @@ def get_access_token(self, request_token, request_token_secret,
403 403 :class:`get_request_token`.
404 404 :param http_method: A string representation of the HTTP method to be
405 405 used.
406   - :param **params: Additional keyworded arguments to be added to the
  406 + :param params: Additional keyworded arguments to be added to the
407 407 request querystring.
408 408 '''
409 409 auth_session = self._construct_session(

0 comments on commit ce5d684

Please sign in to comment.
Something went wrong with that request. Please try again.