Skip to content

Commit

Permalink
Update for 0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dshafik committed Oct 8, 2016
1 parent 1003b97 commit 3289f8a
Show file tree
Hide file tree
Showing 19 changed files with 247 additions and 193 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
0.6.0
---
[?? ???, 2016]
[08 Oct, 2016]
* Split `\Akamai\Open\EdgeGrid\Authentication` into it's own (5.3+ compatible) package
* Move documentation to `apigen/apigen`
* Update dependencies
Expand Down
56 changes: 47 additions & 9 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h1>Class Authentication</h1>
<b>Namespace:</b> <a href="namespace-Akamai.html">Akamai</a>\<a href="namespace-Akamai.Open.html">Open</a>\<a href="namespace-Akamai.Open.EdgeGrid.html">EdgeGrid</a><br>
<b>Package:</b> \Akamai\Open\EdgeGrid\Authentication<br>

<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#22-582" title="Go to source code">Authentication.php</a>
<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#22-598" title="Go to source code">Authentication.php</a>
<br>
</div>

Expand Down Expand Up @@ -948,7 +948,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_canonicalizeHeaders">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#410-450" title="Go to source code">canonicalizeHeaders</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#410-453" title="Go to source code">canonicalizeHeaders</a>( )</code>

<div class="description short">
<p>Returns headers in normalized form</p>
Expand Down Expand Up @@ -981,7 +981,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeBase64HmacSha256">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#452-463" title="Go to source code">makeBase64HmacSha256</a>( <span>string <var>$data</var></span>, <span>string <var>$key</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#455-466" title="Go to source code">makeBase64HmacSha256</a>( <span>string <var>$data</var></span>, <span>string <var>$key</var></span> )</code>

<div class="description short">
<p>Returns Base64 encoded HMAC-SHA256 Hash</p>
Expand Down Expand Up @@ -1021,7 +1021,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeBase64Sha256">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#465-475" title="Go to source code">makeBase64Sha256</a>( <span>string <var>$data</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#468-478" title="Go to source code">makeBase64Sha256</a>( <span>string <var>$data</var></span> )</code>

<div class="description short">
<p>Returns Base64 encoded SHA256 Hash</p>
Expand Down Expand Up @@ -1059,7 +1059,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeContentHash">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#477-490" title="Go to source code">makeContentHash</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#480-493" title="Go to source code">makeContentHash</a>( )</code>

<div class="description short">
<p>Returns a hash of the HTTP POST body</p>
Expand Down Expand Up @@ -1092,7 +1092,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeDataToSign">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#492-521" title="Go to source code">makeDataToSign</a>( <span>string <var>$auth_header</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#495-524" title="Go to source code">makeDataToSign</a>( <span>string <var>$auth_header</var></span> )</code>

<div class="description short">
<p>Returns a string with all data that will be signed</p>
Expand Down Expand Up @@ -1130,7 +1130,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeSigningKey">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#523-532" title="Go to source code">makeSigningKey</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#526-535" title="Go to source code">makeSigningKey</a>( )</code>

<div class="description short">
<p>Creates a signing key based on the secret and timestamp</p>
Expand Down Expand Up @@ -1163,7 +1163,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_signRequest">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#534-546" title="Go to source code">signRequest</a>( <span>string <var>$auth_header</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#537-549" title="Go to source code">signRequest</a>( <span>string <var>$auth_header</var></span> )</code>

<div class="description short">
<p>Returns a signature of the given request, timestamp and auth_header</p>
Expand Down Expand Up @@ -1201,7 +1201,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_parseEdgeRcFile">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#548-581" title="Go to source code">parseEdgeRcFile</a>( <span> <var>$path</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#551-584" title="Go to source code">parseEdgeRcFile</a>( <span> <var>$path</var></span> )</code>

<div class="description short">
<p>Parse a .edgerc File</p>
Expand Down Expand Up @@ -1229,6 +1229,44 @@ <h4>Throws</h4>



</div>
</div></td>
</tr>
<tr data-order="buildQueryString" id="_buildQueryString">

<td class="attributes"><code>
protected
string

</code>
</td>

<td class="name"><div>
<a class="anchor" href="#_buildQueryString">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#586-597" title="Go to source code">buildQueryString</a>( <span> <var>$query</var></span> )</code>

<div class="description short">

</div>

<div class="description detailed hidden">



<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$query</var></dt>
<dd></dd>
</dl></div>

<h4>Returns</h4>
<div class="list">
string
</div>




</div>
</div></td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/class-Akamai.Open.EdgeGrid.Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ <h4>Returns</h4>
<td class="value">
<div>
<a href="#VERSION" class="anchor">#</a>
<code><span class="php-quote">&quot;0.5.0&quot;</span></code>
<code><span class="php-quote">&quot;0.6.0&quot;</span></code>
</div>
</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h3>Exceptions</h3>
</span></span><span id="3" class="l"><span class="php-comment"> * Akamai {OPEN} EdgeGrid Auth for PHP
</span></span><span id="4" class="l"><span class="php-comment"> *
</span></span><span id="5" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="6" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="6" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="7" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="8" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="9" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h3>Exceptions</h3>
</span></span><span id="3" class="l"><span class="php-comment"> * Akamai {OPEN} EdgeGrid Auth for PHP
</span></span><span id="4" class="l"><span class="php-comment"> *
</span></span><span id="5" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="6" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="6" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="7" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="8" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="9" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
348 changes: 182 additions & 166 deletions docs/source-class-Akamai.Open.EdgeGrid.Authentication.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source-class-Akamai.Open.EdgeGrid.Cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h3>Exceptions</h3>
</span></span><span id="12" class="l"><span class="php-comment"> * first call {@see Akamai\Open\EdgeGrid\Client-&gt;setAuth()}.
</span></span><span id="13" class="l"><span class="php-comment"> *
</span></span><span id="14" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="15" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="15" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="16" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="17" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="18" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
4 changes: 2 additions & 2 deletions docs/source-class-Akamai.Open.EdgeGrid.Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h3>Exceptions</h3>
</span></span><span id="12" class="l"><span class="php-comment"> * first call {@see Akamai\Open\EdgeGrid\Client-&gt;setAuth()}.
</span></span><span id="13" class="l"><span class="php-comment"> *
</span></span><span id="14" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="15" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="15" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="16" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="17" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="18" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand All @@ -175,7 +175,7 @@ <h3>Exceptions</h3>
</span></span><span id="35" class="l"><span class="php-comment"> */</span>
</span><span id="36" class="l"><span class="php-keyword1">class</span> Client <span class="php-keyword1">extends</span> \GuzzleHttp\Client <span class="php-keyword1">implements</span> \Psr\<span class="php-keyword2">Log</span>\LoggerAwareInterface
</span><span id="37" class="l">{
</span><span id="38" class="l"> <span class="php-keyword1">const</span> VERSION = <span class="php-quote">&quot;0.5.0&quot;</span>;
</span><span id="38" class="l"> <span class="php-keyword1">const</span> VERSION = <span class="php-quote">&quot;0.6.0&quot;</span>;
</span><span id="39" class="l">
</span><span id="40" class="l"> <span class="php-comment">/**
</span></span><span id="41" class="l"><span class="php-comment"> * @const int Default Timeout in seconds
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
2 changes: 1 addition & 1 deletion docs/source-class-Akamai.Open.EdgeGrid.Exception.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
2 changes: 1 addition & 1 deletion docs/source-class-Akamai.Open.EdgeGrid.Handler.Debug.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h3>Exceptions</h3>
</span></span><span id="7" class="l"><span class="php-comment"> * as GuzzleHttp a Middleware Handlers
</span></span><span id="8" class="l"><span class="php-comment"> *
</span></span><span id="9" class="l"><span class="php-comment"> * @author Davey Shafik &lt;[email protected]&gt;
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2015 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="10" class="l"><span class="php-comment"> * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
</span></span><span id="11" class="l"><span class="php-comment"> * @license Apache 2.0
</span></span><span id="12" class="l"><span class="php-comment"> * @link https://github.com/akamai-open/edgegrid-auth-php
</span></span><span id="13" class="l"><span class="php-comment"> * @link https://developer.akamai.com
Expand Down
2 changes: 1 addition & 1 deletion src/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
*/
class Client extends \GuzzleHttp\Client implements \Psr\Log\LoggerAwareInterface
{
const VERSION = "0.5.0";
const VERSION = "0.6.0";

/**
* @const int Default Timeout in seconds
Expand Down

0 comments on commit 3289f8a

Please sign in to comment.