processmaker-builder
Version:
The gulp task runner for ProcessMaker building
332 lines (252 loc) • 22.2 kB
HTML
<html>
<head>
<title>Luracast Restler 3 Live Examples:- Rate Limiting</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../resources/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="../resources/highlight.css" />
<link rel="stylesheet" type="text/css" href="../resources/style.css" />
<link rel="stylesheet" type="text/css" href="../resources/facebox.css" />
<link rel="stylesheet" type="text/css" href="../resources/hacks.css" />
<script type="text/javascript" src="../resources/jquery-1.7.2.min.js"></script>
<script type="text/javascript" src="../resources/facebox.js"></script>
<script type="text/javascript" src="../resources/bootstrap.min.js"></script>
<script type="text/javascript" src="../resources/highlight.pack.js"></script>
<script type="text/javascript">
$(document).ready(
function() {
$('dd pre code').each(function(i, e) {
text = $(e).text();
$(e).addClass(text.charAt(0) == '<' ? 'xml' : 'json')
//hljs.highlightBlock(e);
});
$('pre code').each(function(i, e) {
if($(e).attr('class'))
hljs.highlightBlock(e);
});
$('abbr').parents().not('a').children('abbr').click(
function() {
$('#codeviewer').load(
'../resources/getsource.php?file='
+ $(this).attr("title"),
function() {
/*
$("pre#php").snippet("php", {
style : "acid",
showNum : false
});
*/
jQuery.facebox({
div : '#codeviewer'
});
hljs.highlightBlock($("pre#php")[1]);
});
});
var curURL = window.location.pathname.split('/examples/')[1];
if (curURL == '')
curURL = 'index.html';
$("a").each(function() {
if ($(this).attr("href") && $(this).attr("href").indexOf(curURL) > -1) {
$(this).addClass("active");
}
});
$('#right tag').popover({
html : true,
placement : 'left',
trigger : 'manual',
title : 'Tagged Examples',
content : '...'
}).click(function(e) {
$('#right tag').popover('hide');
$(this).popover('show');
e.preventDefault();
e.stopPropagation ? e.stopPropagation() : e.cancelBubble = true;
});
$(document).click(function(e) {
$('#right tag').popover('hide');
});
})
</script>
<!--[if lte IE 8]>
<script type="text/javascript">
(function(){if(!/*@cc_on!@*/0)return;var e = "abbr,article,aside,audio,bb,canvas,datagrid,datalist,details,dialog,eventsource,figure,footer,header,hgroup,mark,menu,meter,nav,output,progress,section,time,video,tag".split(',');for(var i=0;i<e.length;i++){document.createElement(e[i])}})()
</script>
<![endif]-->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23777019-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<nav class="floating-menu">
<ul>
<li><a title="Restler Home" target="_blank" href="http://luracast.com/products/restler/"><img src="../resources/home.png" width="16" height="16"/> Home</a></li>
<li><a title="Getting Started with Restler" href="../.."><img src="../resources/quickstart.png" width="16" height="16"/> Start</a></li>
<!--<li><a title="Using Restler" href="#">Guide</a></li><li><a title="Restler API Reference" href="#">API</a></li>-->
<li><a class="active" href="../index.html"><img src="../resources/examples.png" width="16" height="16"/> Examples</a></li>
<li><a title="Share your knowledge by answering user questions in Stack Overflow." target="_blank" href="http://bit.ly/Restler-QA"><img src="../resources/stackoverflow.png" width="16" height="16"/> Support</a></li>
<li><a title="Contribute and Fork Restler on GitHub" target="_blank" href="http://bit.ly/LuracastRestler"><img src="../resources/github.png" width="16" height="16"/> Source</a></li>
<li><a title="Get updated on Twitter" target="_blank" href="http://twitter.com/Luracast"><img src="../resources/twitter.png" width="16" height="16"/> Update</a></li>
<li><a title="Keep in touch on Facebook" target="_blank" href="https://www.facebook.com/Luracast"><img src="../resources/facebook.png" width="16" height="16"/> Connect</a></li>
</ul>
</nav>
<div id="codeviewer" style="display: none;"></div>
<nav id="left">
<img src="../resources/Restler3.gif" width="126"
height="126" title="Luracast Restler 3" />
<h3>
<a href="../index.html">Examples</a>
</h3>
<ul>
<li><a href="../_001_helloworld/readme.html" title="Let's say hello!">Hello World</a></li>
<li><a href="../_002_minimal/readme.html" title="Less is more">Minimal</a></li>
<li><a href="../_003_multiformat/readme.html" title="Serving what the client wants">Multi-format</a></li>
<li><a href="../_004_error_response/readme.html" title="Making use of HTTP status codes">Error Response</a></li>
<li><a href="../_005_protected_api/readme.html" title="Creating restricted zone">Protected API</a></li>
<li><a href="../_006_routing/readme.html" title="Ways to map api methods to url">Routing</a></li>
<li><a href="../_007_crud/readme.html" title="using POST, GET, PUT and DELETE">CRUD</a></li>
<li><a href="../_008_documentation/readme.html" title="Commenting can be more rewarding">Documentation</a></li>
<li><a href="../_009_rate_limiting/readme.html" title="Abuse no more">Rate Limiting</a></li>
<li><a href="../_010_access_control/readme.html" title="Who can do what">Access Control</a></li>
<li><a href="../_011_versioning/readme.html" title="using the URL">Versioning</a></li>
<li><a href="../_012_vendor_mime/readme.html" title="custom media type for versioning">Vendor MIME</a></li>
<li><a href="../_013_html/readme.html" title="rendering custom views">Html Format</a></li>
<li><a href="../_014_oauth2_client/readme.html" title="to consume protected API">OAuth2 Client</a></li>
<li><a href="../_015_oauth2_server/readme.html" title="offering protected API">OAuth2 Server</a></li>
<li><a href="../_016_forms/readme.html" title="to capture user input">Forms</a></li>
</ul>
</nav>
<nav id="right">
<h3><a href="../index.html">Examples by Tag</a></h3>
<ul class="tags">
<li><tag title="Access-control Example(s)" data-content="<a href="../_010_access_control/readme.html">Access Control</a> <a href="../_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="../_015_oauth2_server/readme.html">OAuth2 Server</a>">access-control</tag><badge>3</badge></li>
<li><tag title="Acl Example(s)" data-content="<a href="../_010_access_control/readme.html">Access Control</a> <a href="../_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="../_015_oauth2_server/readme.html">OAuth2 Server</a>">acl</tag><badge>3</badge></li>
<li><tag title="Authentication Example(s)" data-content="<a href="../_005_protected_api/readme.html">Protected API</a> <a href="../_010_access_control/readme.html">Access Control</a> <a href="../_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="../_015_oauth2_server/readme.html">OAuth2 Server</a>">authentication</tag><badge>4</badge></li>
<li><tag title="Authorization Example(s)" data-content="<a href="../_005_protected_api/readme.html">Protected API</a> <a href="../_010_access_control/readme.html">Access Control</a> <a href="../_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="../_015_oauth2_server/readme.html">OAuth2 Server</a>">authorization</tag><badge>4</badge></li>
<li><tag title="Basic Example(s)" data-content="<a href="../_001_helloworld/readme.html">Hello World Example</a> <a href="../_002_minimal/readme.html">Minimal Example</a>">basic</tag><badge>2</badge></li>
<li><tag title="Blade Example(s)" data-content="<a href="../_016_forms/readme.html">Forms Example</a>">blade</tag></li>
<li><tag title="Bootstrap Example(s)" data-content="<a href="../_016_forms/readme.html">Forms Example</a>">bootstrap</tag></li>
<li><tag title="Create Example(s)" data-content="<a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">create</tag><badge>3</badge></li>
<li><tag title="Custom Example(s)" data-content="<a href="../_012_vendor_mime/readme.html">Vendor MIME</a>">custom</tag></li>
<li><tag title="Debug Example(s)" data-content="<a href="../_008_documentation/readme.html">Documentation</a>">debug</tag></li>
<li><tag title="Delete Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a> <a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">delete</tag><badge>4</badge></li>
<li><tag title="Doc Example(s)" data-content="<a href="../_008_documentation/readme.html">Documentation</a>">doc</tag></li>
<li><tag title="Emmet Example(s)" data-content="<a href="../_016_forms/readme.html">Forms Example</a>">emmet</tag></li>
<li><tag title="Exception Example(s)" data-content="<a href="../_004_error_response/readme.html">Error Response</a>">exception</tag></li>
<li><tag title="Filter Example(s)" data-content="<a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">filter</tag></li>
<li><tag title="Form Example(s)" data-content="<a href="../_016_forms/readme.html">Forms Example</a>">form</tag></li>
<li><tag title="Foundation Example(s)" data-content="<a href="../_016_forms/readme.html">Forms Example</a>">foundation</tag></li>
<li><tag title="Get Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a> <a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">get</tag><badge>4</badge></li>
<li><tag title="Handlebar Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">handlebar</tag></li>
<li><tag title="Html Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a> <a href="../_016_forms/readme.html">Forms Example</a>">html</tag><badge>2</badge></li>
<li><tag title="Http Status Example(s)" data-content="<a href="../_002_minimal/readme.html">Minimal Example</a> <a href="../_004_error_response/readme.html">Error Response</a>">http status</tag><badge>2</badge></li>
<li><tag title="Json Example(s)" data-content="<a href="../_003_multiformat/readme.html">Multi-format</a>">json</tag></li>
<li><tag title="Mediatype Example(s)" data-content="<a href="../_012_vendor_mime/readme.html">Vendor MIME</a>">mediatype</tag></li>
<li><tag title="Mime Example(s)" data-content="<a href="../_012_vendor_mime/readme.html">Vendor MIME</a>">mime</tag></li>
<li><tag title="Mustache Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">mustache</tag></li>
<li><tag title="Patch Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a>">patch</tag></li>
<li><tag title="Php Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">php</tag></li>
<li><tag title="Post Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a> <a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">post</tag><badge>4</badge></li>
<li><tag title="Production Example(s)" data-content="<a href="../_008_documentation/readme.html">Documentation</a>">production</tag></li>
<li><tag title="Put Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a> <a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">put</tag><badge>4</badge></li>
<li><tag title="Rate-limiting Example(s)" data-content="<a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">rate-limiting</tag></li>
<li><tag title="Read Example(s)" data-content="<a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">read</tag><badge>3</badge></li>
<li><tag title="Retrieve Example(s)" data-content="<a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">retrieve</tag><badge>3</badge></li>
<li><tag title="Routing Example(s)" data-content="<a href="../_006_routing/readme.html">Routing</a> <a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a>">routing</tag><badge>3</badge></li>
<li><tag title="Secure Example(s)" data-content="<a href="../_010_access_control/readme.html">Access Control</a> <a href="../_014_oauth2_client/readme.html">OAuth2 Client</a> <a href="../_015_oauth2_server/readme.html">OAuth2 Server</a>">secure</tag><badge>3</badge></li>
<li><tag title="Template Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">template</tag></li>
<li><tag title="Throttle Example(s)" data-content="<a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">throttle</tag></li>
<li><tag title="Twig Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">twig</tag></li>
<li><tag title="Update Example(s)" data-content="<a href="../_007_crud/readme.html">CRUD</a> <a href="../_008_documentation/readme.html">Documentation</a> <a href="../_009_rate_limiting/readme.html">Rate Limiting</a>">update</tag><badge>3</badge></li>
<li><tag title="Validation Example(s)" data-content="<a href="../_002_minimal/readme.html">Minimal Example</a> <a href="../_004_error_response/readme.html">Error Response</a> <a href="../_016_forms/readme.html">Forms Example</a>">validation</tag><badge>3</badge></li>
<li><tag title="Vendor Example(s)" data-content="<a href="../_012_vendor_mime/readme.html">Vendor MIME</a>">vendor</tag></li>
<li><tag title="Versioning Example(s)" data-content="<a href="../_011_versioning/readme.html">Versioning</a> <a href="../_012_vendor_mime/readme.html">Vendor MIME</a>">versioning</tag><badge>2</badge></li>
<li><tag title="View Example(s)" data-content="<a href="../_013_html/readme.html">Html Format</a>">view</tag></li>
<li><tag title="Xml Example(s)" data-content="<a href="../_003_multiformat/readme.html">Multi-format</a>">xml</tag></li>
</ul>
</nav>
<article id="page">
<div class="right"><small>9</small></div>
<p><a id="rate-limiting" class="anchor"></a><h2>Rate Limiting <requires>PHP >= 5.3</requires></h2></p>
<p><tag>create</tag>
<tag>retrieve</tag>
<tag>read</tag>
<tag>update</tag>
<tag>delete</tag>
<tag>post</tag>
<tag>get</tag>
<tag>put</tag>
<tag>filter</tag>
<tag>throttle</tag>
<tag>rate-limiting</tag></p>
<p>How to Rate Limit API access using a Filter class that implements
<code>iFilter</code> interface.</p>
<p>This example also shows how to use Defaults class to customize defaults, how to create your own
iCache implementation, and how to make a hybrid filter class that behaves differently
when the user is Authenticated</p>
<p><a href="explorer/index.html#!/authors-v1" target="_blank"><img src="../resources/explorer1.png" alt="Restler API Explorer" /></a></p>
<p>Key in <code>r3rocks</code> as the API key in the Explorer to see how rate limit changes</p>
<p>We are progressively improving the Authors class from CRUD example
to show Best Practices and Restler 3 Features.</p>
<p>Make sure you compare them to understand.</p>
<blockquote>
<p><strong>Note:-</strong></p>
<ol>
<li><p>Using session variables as DB and Cache is useless for real life and wrong. We are using it
Only for demo purpose. Since API Explorer is browser based it works well with that.</p></li>
<li><p>We are using <abbr title="_009_rate_limiting/Author.php">Author.php</abbr> to document return type of <code>GET authors/{id}</code> using <code>@return</code> comment</p></li>
</ol>
</blockquote>
<p>If you have hit the API Rate Limit or screwed up the Authors DB, you can easily reset by deleting
PHP_SESSION cookie using the Developer Tools in your browser.</p>
<blockquote>
<p>This API Server is made using the following php files/folders</p>
<ul>
<li><abbr title="_009_rate_limiting/index.php">index.php</abbr> (gateway)</li>
<li><abbr title="../../vendor/Luracast/Restler/Filter/RateLimit.php">RateLimit.php</abbr> (filter)</li>
<li><abbr title="_009_rate_limiting/SessionCache.php">SessionCache.php</abbr> (helper)</li>
<li><abbr title="_009_rate_limiting/ratelimited/Authors.php">Authors.php</abbr> (api)</li>
<li><abbr title="../../vendor/Luracast/Restler/Resources.php">Resources.php</abbr> (api)</li>
<li><abbr title="_009_rate_limiting/KeyAuth.php">KeyAuth.php</abbr> (auth)</li>
<li><abbr title="_009_rate_limiting/Author.php">Author.php</abbr> (helper)</li>
<li><abbr title="../../vendor/restler.php">restler.php</abbr> (framework)</li>
<li><abbr title="../../vendor/Luracast/Restler/Format/JsonFormat.php">JsonFormat.php</abbr> (format)</li>
</ul>
</blockquote>
<p>This API Server exposes the following URIs</p>
<pre><code>GET authors ⇠ ratelimited\Authors::index()
POST authors ⇠ ratelimited\Authors::post()
DELETE authors/{id} ⇠ ratelimited\Authors::delete()
PATCH authors/{id} ⇠ ratelimited\Authors::patch()
PUT authors/{id} ⇠ ratelimited\Authors::put()
GET authors/{id} ⇠ ratelimited\Authors::get()
GET resources ⇠ Luracast\Restler\Resources::index()
GET resources/verifyaccess ⇠ Luracast\Restler\Resources::verifyAccess()
GET resources/{id} ⇠ Luracast\Restler\Resources::get()
</code></pre>
<p>We expect the following behaviour from this example.</p>
<pre><code class="gherkin"><br />@example9 @crud
Feature: Testing Rate Limiting Example
Scenario: Failing to delete missing Author with JSON
Given that I want to delete an "Author"
And his "id" is 2000
When I request "/examples/_009_rate_limiting/authors/{id}?api_key=r3rocks"
Then the response status code should be 404
</code></pre>
<p>It can be tested by running the following command on terminal/command line
from the project root (where the vendor folder resides). Make sure <code>base_url</code>
in <code>behat.yml</code> is updated according to your web server.</p>
<pre><code class="bash">bin/behat features/examples/_009_rate_limiting.feature
</code></pre>
</article>
<footer>
© 2010 <a title="Luracast.com" href="http://luracast.com"><img src="../resources/Luracast_dark.png" width="180" height="32" title="Helping Developers with Tools, Utilities, Frameworks and Services"/></a>
</footer>
</body>
</html>