Updating documentation some.

ruby-grape · Nov 15, 2010 · 2ad602a · 2ad602a
1 parent d86da93
commit 2ad602a
Show file tree

Hide file tree

Showing 131 changed files with 8,524 additions and 18 deletions.
diff --git a/.yardoc/checksums b/.yardoc/checksums
@@ -0,0 +1,13 @@
+lib/grape.rb 8d663c999a1330ad24920b6b509c80226ebae3cf
+lib/grape/middleware/auth/basic.rb 5a1b8e48fc23bae64f59df40ae5e4532954d3f14
+lib/grape/middleware/auth/oauth2.rb 5c2101f96cd2072966078759b5ca58f045c8f966
+lib/grape/middleware/versioner.rb 3f5bc78e47672cccfae1fc1bed54ee40e6af00fc
+LICENSE de44c0f8d891b6e9d7fa511f30e71c3aaf512155
+lib/grape/middleware/formatter.rb 2840dd6304e007e7bcb872cf802f5cee64edc190
+lib/grape/endpoint.rb df89fce4da897dbd88af91d862ae937f5550c4b1
+README.markdown 9229a954c8e2dbe7f32486913479e05ecffdfc56
+lib/grape/middleware/prefixer.rb 3c296ee67cce85467aaa92cdac5001db8cf90dde
+lib/grape/middleware/error.rb 8244c1e237ddf5d0b2170e61652b16d7821c4b91
+lib/grape/api.rb 007bd49e3ab2f6a1a6ce95296892feb6313631dc
+lib/grape/middleware_stack.rb ed7dff6f588f13eeb5437b2aa41df1fbaba39643
+lib/grape/middleware/base.rb 1f8fafa2575ff63448976ccb5ab576d67efc6ec4
diff --git a/.yardoc/objects/Grape.dat b/.yardoc/objects/Grape.dat
diff --git a/.yardoc/objects/Grape/API.dat b/.yardoc/objects/Grape/API.dat
diff --git a/.yardoc/objects/Grape/API/auth_c.dat b/.yardoc/objects/Grape/API/auth_c.dat
diff --git a/.yardoc/objects/Grape/API/build_endpoint_c.dat b/.yardoc/objects/Grape/API/build_endpoint_c.dat
diff --git a/.yardoc/objects/Grape/API/call_c.dat b/.yardoc/objects/Grape/API/call_c.dat
diff --git a/.yardoc/objects/Grape/API/compile_path_c.dat b/.yardoc/objects/Grape/API/compile_path_c.dat
diff --git a/.yardoc/objects/Grape/API/default_format_c.dat b/.yardoc/objects/Grape/API/default_format_c.dat
diff --git a/.yardoc/objects/Grape/API/delete_c.dat b/.yardoc/objects/Grape/API/delete_c.dat
diff --git a/.yardoc/objects/Grape/API/get_c.dat b/.yardoc/objects/Grape/API/get_c.dat
diff --git a/.yardoc/objects/Grape/API/group_c.dat b/.yardoc/objects/Grape/API/group_c.dat
diff --git a/.yardoc/objects/Grape/API/head_c.dat b/.yardoc/objects/Grape/API/head_c.dat
diff --git a/.yardoc/objects/Grape/API/helpers_c.dat b/.yardoc/objects/Grape/API/helpers_c.dat
diff --git a/.yardoc/objects/Grape/API/http_basic_c.dat b/.yardoc/objects/Grape/API/http_basic_c.dat
diff --git a/.yardoc/objects/Grape/API/inherited_c.dat b/.yardoc/objects/Grape/API/inherited_c.dat
diff --git a/.yardoc/objects/Grape/API/logger_c.dat b/.yardoc/objects/Grape/API/logger_c.dat
diff --git a/.yardoc/objects/Grape/API/namespace_c.dat b/.yardoc/objects/Grape/API/namespace_c.dat
diff --git a/.yardoc/objects/Grape/API/nest_c.dat b/.yardoc/objects/Grape/API/nest_c.dat
diff --git a/.yardoc/objects/Grape/API/post_c.dat b/.yardoc/objects/Grape/API/post_c.dat
diff --git a/.yardoc/objects/Grape/API/prefix_c.dat b/.yardoc/objects/Grape/API/prefix_c.dat
diff --git a/.yardoc/objects/Grape/API/put_c.dat b/.yardoc/objects/Grape/API/put_c.dat
diff --git a/.yardoc/objects/Grape/API/reset_21_c.dat b/.yardoc/objects/Grape/API/reset_21_c.dat
diff --git a/.yardoc/objects/Grape/API/resource_c.dat b/.yardoc/objects/Grape/API/resource_c.dat
diff --git a/.yardoc/objects/Grape/API/resources_c.dat b/.yardoc/objects/Grape/API/resources_c.dat
diff --git a/.yardoc/objects/Grape/API/route_c.dat b/.yardoc/objects/Grape/API/route_c.dat
diff --git a/.yardoc/objects/Grape/API/route_set_c.dat b/.yardoc/objects/Grape/API/route_set_c.dat
diff --git a/.yardoc/objects/Grape/API/scope_c.dat b/.yardoc/objects/Grape/API/scope_c.dat
diff --git a/.yardoc/objects/Grape/API/set_c.dat b/.yardoc/objects/Grape/API/set_c.dat
diff --git a/.yardoc/objects/Grape/API/settings_c.dat b/.yardoc/objects/Grape/API/settings_c.dat
diff --git a/.yardoc/objects/Grape/API/settings_stack_c.dat b/.yardoc/objects/Grape/API/settings_stack_c.dat
diff --git a/.yardoc/objects/Grape/API/version_c.dat b/.yardoc/objects/Grape/API/version_c.dat
diff --git a/.yardoc/objects/Grape/Endpoint.dat b/.yardoc/objects/Grape/Endpoint.dat
diff --git a/.yardoc/objects/Grape/Endpoint/block_3D_c.dat b/.yardoc/objects/Grape/Endpoint/block_3D_c.dat
diff --git a/.yardoc/objects/Grape/Endpoint/block_c.dat b/.yardoc/objects/Grape/Endpoint/block_c.dat
diff --git a/.yardoc/objects/Grape/Endpoint/call_c.dat b/.yardoc/objects/Grape/Endpoint/call_c.dat
diff --git a/.yardoc/objects/Grape/Endpoint/call_i.dat b/.yardoc/objects/Grape/Endpoint/call_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/env_i.dat b/.yardoc/objects/Grape/Endpoint/env_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/error_21_i.dat b/.yardoc/objects/Grape/Endpoint/error_21_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/generate_c.dat b/.yardoc/objects/Grape/Endpoint/generate_c.dat
diff --git a/.yardoc/objects/Grape/Endpoint/header_i.dat b/.yardoc/objects/Grape/Endpoint/header_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/params_i.dat b/.yardoc/objects/Grape/Endpoint/params_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/request_i.dat b/.yardoc/objects/Grape/Endpoint/request_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/status_i.dat b/.yardoc/objects/Grape/Endpoint/status_i.dat
diff --git a/.yardoc/objects/Grape/Endpoint/version_i.dat b/.yardoc/objects/Grape/Endpoint/version_i.dat
diff --git a/.yardoc/objects/Grape/Middleware.dat b/.yardoc/objects/Grape/Middleware.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth.dat b/.yardoc/objects/Grape/Middleware/Auth.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic/authenticator_i.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic/authenticator_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic/basic_request_i.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic/basic_request_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic/before_i.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic/credentials_i.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic/credentials_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/Basic/initialize_i.dat b/.yardoc/objects/Grape/Middleware/Auth/Basic/initialize_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/before_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/default_options_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/default_options_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/error_out_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/error_out_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/parse_authorization_header_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/parse_authorization_header_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/token_class_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/token_class_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Auth/OAuth2/verify_token_i.dat b/.yardoc/objects/Grape/Middleware/Auth/OAuth2/verify_token_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base.dat b/.yardoc/objects/Grape/Middleware/Base.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/after_i.dat b/.yardoc/objects/Grape/Middleware/Base/after_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/app_i.dat b/.yardoc/objects/Grape/Middleware/Base/app_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/before_i.dat b/.yardoc/objects/Grape/Middleware/Base/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/call_21_i.dat b/.yardoc/objects/Grape/Middleware/Base/call_21_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/call_i.dat b/.yardoc/objects/Grape/Middleware/Base/call_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/default_options_i.dat b/.yardoc/objects/Grape/Middleware/Base/default_options_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/env_i.dat b/.yardoc/objects/Grape/Middleware/Base/env_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/initialize_i.dat b/.yardoc/objects/Grape/Middleware/Base/initialize_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/options_i.dat b/.yardoc/objects/Grape/Middleware/Base/options_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/request_i.dat b/.yardoc/objects/Grape/Middleware/Base/request_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Base/response_i.dat b/.yardoc/objects/Grape/Middleware/Base/response_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Error.dat b/.yardoc/objects/Grape/Middleware/Error.dat
diff --git a/.yardoc/objects/Grape/Middleware/Error/call_21_i.dat b/.yardoc/objects/Grape/Middleware/Error/call_21_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Error/error_response_i.dat b/.yardoc/objects/Grape/Middleware/Error/error_response_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter.dat b/.yardoc/objects/Grape/Middleware/Formatter.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/CONTENT_TYPES.dat b/.yardoc/objects/Grape/Middleware/Formatter/CONTENT_TYPES.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/after_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/after_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/before_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/content_types_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/content_types_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/default_options_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/default_options_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/encode_json_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/encode_json_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/encode_txt_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/encode_txt_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/format_from_extension_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/format_from_extension_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/format_from_header_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/format_from_header_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/headers_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/headers_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/mime_array_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/mime_array_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Formatter/mime_types_i.dat b/.yardoc/objects/Grape/Middleware/Formatter/mime_types_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Prefixer.dat b/.yardoc/objects/Grape/Middleware/Prefixer.dat
diff --git a/.yardoc/objects/Grape/Middleware/Prefixer/before_i.dat b/.yardoc/objects/Grape/Middleware/Prefixer/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Prefixer/prefix_i.dat b/.yardoc/objects/Grape/Middleware/Prefixer/prefix_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Versioner.dat b/.yardoc/objects/Grape/Middleware/Versioner.dat
diff --git a/.yardoc/objects/Grape/Middleware/Versioner/before_i.dat b/.yardoc/objects/Grape/Middleware/Versioner/before_i.dat
diff --git a/.yardoc/objects/Grape/Middleware/Versioner/default_options_i.dat b/.yardoc/objects/Grape/Middleware/Versioner/default_options_i.dat
diff --git a/.yardoc/objects/Grape/MiddlewareStack.dat b/.yardoc/objects/Grape/MiddlewareStack.dat
diff --git a/.yardoc/objects/Grape/MiddlewareStack/initialize_i.dat b/.yardoc/objects/Grape/MiddlewareStack/initialize_i.dat
diff --git a/.yardoc/objects/Grape/MiddlewareStack/stack_i.dat b/.yardoc/objects/Grape/MiddlewareStack/stack_i.dat
diff --git a/.yardoc/objects/Grape/MiddlewareStack/to_app_i.dat b/.yardoc/objects/Grape/MiddlewareStack/to_app_i.dat
diff --git a/.yardoc/objects/Grape/MiddlewareStack/use_i.dat b/.yardoc/objects/Grape/MiddlewareStack/use_i.dat
diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat
diff --git a/.yardoc/proxy_types b/.yardoc/proxy_types
@@ -0,0 +1,2 @@
+{"Object:
+class
diff --git a/Gemfile b/Gemfile
@@ -11,7 +11,8 @@ gem 'multi_xml'
 group :development do
   gem 'rake'
   gem 'jeweler'
-  # gem 'yard'
+  gem 'maruku'
+  gem 'yard'
 end
 
 group :test do

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -19,6 +19,8 @@ GEM
       rubyforge (>= 2.0.0)
     json (1.4.6)
     json_pure (1.4.3)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
     multi_json (0.0.4)
     multi_xml (0.0.1)
     rack (1.2.1)
@@ -38,8 +40,10 @@ GEM
     rspec-mocks (2.1.0)
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
+    syntax (1.0.0)
     term-ansicolor (1.0.5)
     trollop (1.16.2)
+    yard (0.6.1)
 
 PLATFORMS
   ruby
@@ -48,6 +52,7 @@ DEPENDENCIES
   cucumber (>= 0.8.5)
   jeweler
   json
+  maruku
   multi_json
   multi_xml
   rack
@@ -56,3 +61,4 @@ DEPENDENCIES
   rack-test
   rake
   rspec (>= 2.1.0)
+  yard
diff --git a/doc/Grape.html b/doc/Grape.html
@@ -0,0 +1,95 @@
+<!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" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Module: Grape</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <div id="header">
+      <div id="menu">
+
+    <a href="_index.html">Index (G)</a> &raquo; 
+
+
+    <span class="title">Grape</span>
+
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Grape
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/grape.rb<span class="defines">,<br />
+  lib/grape/api.rb,<br /> lib/grape/endpoint.rb,<br /> lib/grape/middleware/base.rb,<br /> lib/grape/middleware/error.rb,<br /> lib/grape/middleware_stack.rb,<br /> lib/grape/middleware/prefixer.rb,<br /> lib/grape/middleware/versioner.rb,<br /> lib/grape/middleware/formatter.rb,<br /> lib/grape/middleware/auth/basic.rb</span>
+</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Grape/Middleware.html" title="Grape::Middleware (module)">Middleware</a></span>
+
+
+
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Grape/API.html" title="Grape::API (class)">API</a></span>, <span class='object_link'><a href="Grape/Endpoint.html" title="Grape::Endpoint (class)">Endpoint</a></span>, <span class='object_link'><a href="Grape/MiddlewareStack.html" title="Grape::MiddlewareStack (class)">MiddlewareStack</a></span>
+
+
+</p>
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Sun Nov 14 20:41:15 2010 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.6.1 (ruby-1.8.7).
+</div>
+
+  </body>
+</html>