Skip to content

Instantly share code, notes, and snippets.

@koos

koos/ARRRPI - GEM Connection.html

Created August 15, 2010 15:40
Show Gist options
  • Save koos/525621 to your computer and use it in GitHub Desktop.
Save koos/525621 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
ARRRPI - GEM Connection.html
<!DOCTYPE html>
<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
<head>
<meta content='text/html;charset=UTF-8' http-equiv='Content-Type'>
<title>
arrrpi
</title>
<link href="/stylesheets/reset.css?1281522515" media="screen" rel="stylesheet" type="text/css" />
<link href="/stylesheets/screen.css?1281626714" media="screen" rel="stylesheet" type="text/css" />
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js" type="text/javascript"></script>
<script src="/javascripts/jquery.js?1278687650" type="text/javascript"></script>
<script src="/javascripts/rails.js?1278952133" type="text/javascript"></script>
<script src="/javascripts/application.js?1279846344" type="text/javascript"></script>
<script src="/javascripts/jquery.liveSearch.js?1261563302" type="text/javascript"></script>
<script src="/javascripts/fancyzoom.js?1279845669" type="text/javascript"></script>
<meta name="csrf-param" content="authenticity_token"/>
<meta name="csrf-token" content="kz0toKl0qi09aSsI/XVn+Y/hTJY2NAZhgrTifCajBMs="/>
<link rel="alternate" href="<%= service_api_url(:format => 'rss') %>" type="application/rss+xml" />
</head>
<body class='apisshow'>
<div id='yeah'></div>
<div id='container'>
<div id='side'>
<h1>arrrpi</h1>
<div id='navigation'>
<ul id='navigation'>
<li><a href="/">Home</a></li>
<li><a href="/services">Services</a></li>
<li><a href="/users">Users</a></li>
<li>
Welcome
<a href="/users/4538a64043660d63f86f9dbf523ee901">jan</a>
</li>
<li><a href="/users/logout">Log out</a></li>
</ul>
</div>
</div>
<div id='content'>
<p id='notice'>Api was successfully updated.</p>
<div id='content'>
<h1>
Documentation
[final]
</h1>
<p>
Documentation
What's an API without documentation?
</p>
<ul>
<li><a href="/services/c9b759d9d13f5ec3a605b950811ef2d0/apis/c9b759d9d13f5ec3a605b950811ee998/edit">Edit</a></li>
<li><form method="post" action="/services/c9b759d9d13f5ec3a605b950811ef2d0/apis/c9b759d9d13f5ec3a605b950811ee998/fork" class="button_to"><div><input type="submit" value="Fork" /><input name="authenticity_token" type="hidden" value="kz0toKl0qi09aSsI/XVn+Y/hTJY2NAZhgrTifCajBMs=" /></div></form></li>
<li><form method="post" action="/services/c9b759d9d13f5ec3a605b950811ef2d0/apis/c9b759d9d13f5ec3a605b950811ee998" class="button_to"><div><input name="_method" type="hidden" value="delete" /><input data-confirm="Are you sure?" type="submit" value="Delete" /><input name="authenticity_token" type="hidden" value="kz0toKl0qi09aSsI/XVn+Y/hTJY2NAZhgrTifCajBMs=" /></div></form></li>
</ul>
<br>
<div class='resources' id='resources'>
<h2>Resources</h2>
<div class='resource'>
<h3>
Resource:
<span class='label'>
Embed
</span>
</h3>
<div id='operations_1281885552847'>
<div class='operations'>
<h4>Methods</h4>
<dl class='first'>
<div class='operation'></div>
<span class='method'>
<span class='label'>
<dt>HTTP-Method</dt>
</span>
<span class='value'>
<dd>GET</dd>
</span>
</span>
<span class='address'>
<span class='label'>
<dt>URI:</dt>
</span>
<span class='value'>
<dd>http://embedit.me/embedit/?url={url}&amp;height={height}&amp;width={width}&amp;api_key={api_key}&amp;frog_key={frog_key}</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>Content-Type should be set to application/json or application/xml</dd>
</span>
</span>
<span class='authentication'>
<span class='label'>
<dt>Authentication</dt>
</span>
<span class='value'>
<dd></dd>
</span>
</span>
<span class='request_example'>
<span class='label'>
<dt>Request Example:</dt>
</span>
<span class='value'>
<dd class='white'>http://embedit.me/embedit/?url=http://youtube.com/xyz&amp;height=500&amp;width=500&amp;api_key=my_fancy_api_key&amp;frog_key=my_fancy_frog_key</dd>
</span>
</span>
<span class='response_example'>
<span class='label'>
<dt>Response Example:</dt>
</span>
<span class='value'>
<dd class='white'>
HTTP/1.1 200 OK
Date: Sun, 15 Aug 2010 15:32:52 GMT
Server: Apache/2.2.9 (Ubuntu) PHP/5.2.6-2ubuntu4.2 with Suhosin-Patch Phusion_Passenger/2.2.5
X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.5
X-Runtime: 152
Etag: &quot;b6a5dbddacb401c459bb4f527c6aa382&quot;
Cache-Control: private, max-age=0, must-revalidate
Content-Length: 690
Status: 200
Connection: close
Content-Type: application/json; charset=utf-8
{&quot;valid&quot;:true,&quot;fbml&quot;:&quot;\n &lt;fb:swf \n \tswfsrc='http://www.youtube.com/v/qRuNxHqwazs'\n \twidth='500' height='500'\n /&gt;\n &quot;,&quot;format&quot;:&quot;video&quot;,&quot;url&quot;:&quot;http://www.youtube.com/watch?v=qRuNxHqwazs&quot;,&quot;title&quot;:&quot;Powerthirst&quot;,&quot;html&quot;:&quot;\n &lt;object width=\&quot;500\&quot; height=\&quot;500\&quot;&gt;\n &lt;param name=\&quot;movie\&quot; value=\&quot;http://www.youtube.com/v/qRuNxHqwazs\&quot;&gt;&lt;/param&gt;\n &lt;param name=\&quot;wmode\&quot; value=\&quot;transparent\&quot;&gt;&lt;/param&gt;\n &lt;embed src=\&quot;http://www.youtube.com/v/qRuNxHqwazs\&quot; \n type=\&quot;application/x-shockwave-flash\&quot; wmode=\&quot;transparent\&quot; \n width=\&quot;500\&quot; height=\&quot;500\&quot;&gt;\n &lt;/embed&gt;\n &lt;/object&gt;\n &quot;}
</dd>
</span>
</span>
<span class='response_parameters'>
<span class='label'>
<dt>Response Parameters:</dt>
</span>
<dd>
<ul id='response_parameters_1281885578061'>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>valid</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>boolean</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>A boolean that the request works</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>title</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The content title</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>format</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The content format (video, picture, etc.)</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>fbml</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>Facebook HTML code</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>html</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The html code for the content to embed</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='response_parameter second' id='response_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>url</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The URL of the content</dd>
</span>
</span>
</dl>
</li>
</ul>
</dd>
</span>
<span class='request_parameters'>
<span class='label'>
<dt>Request Parameters:</dt>
</span>
<dd>
<ul id='request_parameters_1281885578061'>
<li>
<dl class='request_parameter second' id='request_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>api key</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>optional (will be required soon)</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='request_parameter second' id='request_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>frog_key</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>frog key - optional (will be required soon)</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='request_parameter second' id='request_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>url</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The URL of the content - required</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='request_parameter second' id='request_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>height</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The height of the html-Object - optional</dd>
</span>
</span>
</dl>
</li>
<li>
<dl class='request_parameter second' id='request_parameter_1281885578061'>
<span class='name'>
<span class='label'>
<dt>Name:</dt>
</span>
<span class='value'>
<dd>width</dd>
</span>
</span>
<span class='data-type'>
<span class='label'>
<dt>Data Type:</dt>
</span>
<span class='value'>
<dd>string</dd>
</span>
</span>
<span class='description'>
<span class='label'>
<dt>Description:</dt>
</span>
<span class='value'>
<dd>The width of the HTML-Object</dd>
</span>
</span>
</dl>
</li>
</ul>
</dd>
</span>
</dl>
</div>
</div>
</div>
</div>
<div id='changes'>
<h2>Changes</h2>
<p><a href="http://semver.org/">Want to do this: semver.org</a></p>
<ul>
<li>New API created</li>
<li>
The API was edited. Changed: descriptionDocumentation
What's an API without documentation?resources1281885552847nameEmbedoperations1281885578061nameGETresponse_exampleHTTP/1.1 200 OK
Date: Sun, 15 Aug 2010 15:32:52 GMT
Server: Apache/2.2.9 (Ubuntu) PHP/5.2.6-2ubuntu4.2 with Suhosin-Patch Phusion_Passenger/2.2.5
X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.5
X-Runtime: 152
Etag: &quot;b6a5dbddacb401c459bb4f527c6aa382&quot;
Cache-Control: private, max-age=0, must-revalidate
Content-Length: 690
Status: 200
Connection: close
Content-Type: application/json; charset=utf-8
{&quot;valid&quot;:true,&quot;fbml&quot;:&quot;\n &lt;fb:swf \n \tswfsrc='http://www.youtube.com/v/qRuNxHqwazs'\n \twidth='500' height='500'\n /&gt;\n &quot;,&quot;format&quot;:&quot;video&quot;,&quot;url&quot;:&quot;http://www.youtube.com/watch?v=qRuNxHqwazs&quot;,&quot;title&quot;:&quot;Powerthirst&quot;,&quot;html&quot;:&quot;\n &lt;object width=\&quot;500\&quot; height=\&quot;500\&quot;&gt;\n &lt;param name=\&quot;movie\&quot; value=\&quot;http://www.youtube.com/v/qRuNxHqwazs\&quot;&gt;&lt;/param&gt;\n &lt;param name=\&quot;wmode\&quot; value=\&quot;transparent\&quot;&gt;&lt;/param&gt;\n &lt;embed src=\&quot;http://www.youtube.com/v/qRuNxHqwazs\&quot; \n type=\&quot;application/x-shockwave-flash\&quot; wmode=\&quot;transparent\&quot; \n width=\&quot;500\&quot; height=\&quot;500\&quot;&gt;\n &lt;/embed&gt;\n &lt;/object&gt;\n &quot;}urlhttp://embedit.me/embedit/?url={url}&amp;height={height}&amp;width={width}&amp;api_key={api_key}&amp;frog_key={frog_key} request_parameters1281886526714nameapi keydata_typestringdescriptionoptional (will be required soon)1281886548825namefrog_keydata_typestringdescriptionfrog key - optional (will be required soon)1281886513187namewidthdata_typestringdescriptionThe width of the HTML-Object1281886472847nameheightdata_typestringdescriptionThe height of the html-Object - optional1281886433391nameurldata_typestringdescriptionThe URL of the content - requiredrequest_examplehttp://embedit.me/embedit/?url=http://youtube.com/xyz&amp;height=500&amp;width=500&amp;api_key=my_fancy_api_key&amp;frog_key=my_fancy_frog_key
descriptionContent-Type should be set to application/json or application/xmlresponse_parameters1281886735937nametitledata_typestringdescriptionThe content title1281886588292namevaliddata_typebooleandescriptionA boolean that the request works
1281886661491nameformatdata_typestringdescriptionThe content format (video, picture, etc.)1281886640886namefbmldata_typestringdescriptionFacebook HTML code1281886760647namehtmldata_typestringdescriptionThe html code for the content to embed1281886687924nameurldata_typestringdescriptionThe URL of the contentupdated_atSun Aug 15 17:39:34 +0200 2010
</li>
</ul>
</div>
<div id='comments'>
<h2>Comments</h2>
<form action="http://localhost:3000/services/c9b759d9d13f5ec3a605b950811ef2d0/apis/c9b759d9d13f5ec3a605b950811ee998/comments" class="new_comment" id="new_comment" method="post"><div style="margin:0;padding:0;display:inline"><input name="authenticity_token" type="hidden" value="kz0toKl0qi09aSsI/XVn+Y/hTJY2NAZhgrTifCajBMs=" /></div>
<p>
<label for="comment_body">Body</label>
<textarea cols="40" id="comment_body" name="comment[body]" rows="20"></textarea>
</p>
<p class='form_actions'><input id="comment_submit" name="commit" type="submit" value="Create Comment" /></p>
</form>
</div>
</div>
</div>
<div id='footer'>
<p>arrrpi - like api, but with three Rs.</p>
<ul>
<li><a href="">About us</a></li>
<li><a href="">Weblog</a></li>
<li><a href="">Twitter</a></li>
</ul>
<ul>
<li><a href="">Yeah</a></li>
<li><a href="">Fucking</a></li>
<li><a href="">Awesome</a></li>
</ul>
</div>
</div>
</body>
</html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment