yard-restful 1.2.0

data/README.markdown

@@ -0,0 +1,191 @@
+# Yardoc RESTful Web Service Plugin
+
+originally by [vWorkApp](http://www.vworkapp.com)
+rewritten for 0.3.0 by [rknLA](http://github.com/rknLA) with substantial help from [lsegal](http://gnuu.org/)
+customized by [spape](http://github.com/spape) for the [MAdeK](http://github.com/zhdk/madek)
+further customization by [DerNalia](http://github.com/DerNalia) for [TinderBox](http://gettinderbox.com)
+[API-Documentation](http://medienarchiv.zhdk.ch/api)
+
+A plugin for [Yardoc](http://yardoc.org/) that generates documentation for RESTful web services.
+
+## Install
+Bundler will reduce your headaches, so, please you that
+	gem 'yard-rest' # in your gemfile
+
+You may need to include the following dependencies as well:
+	gem 'redcarpet'
+	gem 'yard'
+
+It also requires the Jeweler gem if you plan to use the rake build tasks.
+
+You'll probably want to add these to your .gitignore as well
+	/.yardoc/*/*
+	/.yardoc/*
+	/public/api
+
+So you'll have to re-genenarte your API on every machine. This should encourage more up to dateness
+
+## Execution
+It is recommended that you use a .yardopts file
+	--title "My API Documentation"
+	--plugin rest
+	--readme API_README
+	--output-dir ./public/api
+	app/models/*.rb
+	app/controllers/*.rb
+
+So that way, whenever you want to generate your API docs, you simply need to run only
+	bundle exec yardoc
+
+
+## See an API-Example
+
+[Yard-Rest-Plugin](http://DerNalia.github.com/yard-rest-plugin) and get a look to the "Example" resource.
+
+## Demo (see the plugin in action)
+
+Visit [TinderBox API Documentation](http://mytinder.com/api/) for a demonstration.
+
+## Writing Comments
+
+The following tags are provided:
+
+- @resource resource. Specifies the resource (controller action/method) that the service is accessed from. This tag is compulsory, only **classes** and **methods** that include this in their comments are included in the API documentation.
+
+- @url url. Specifies the URL which someone should use to access that resource.
+
+- @action action. Specifies the http action (GET, POST, PUT etc.).
+
+- @status\_codes Any possible returned states codes that the API user may need to handle.
+
+- @required [type] name description. Specifies an argument that must be passed to the service. You can specify as many of these as you need.
+
+- @optional [type] name description. Specifies an optional argument that may be passed to the service. You can specify as many of these as you need.
+
+- @response_field [type] name description. Further specifies the fields that are returned within the response.
+
+- @resource\_object ModelName. A modal that users of the API should know about.
+
+- @resource\_object\_properties Description of the modal and attributes that the API user should know about.
+
+- @resource\_object\_footnotes Anything else that needs to be said about the model
+### Examples
+
+Examples should always be together in the following order: example_request, example_request_description, example_response, example_response_description (as soon as you write a example_request you need a following example_response and the other way around).
+
+Markdown rendering for the text is activated if a tags text contains a newline (see example).
+
+- @example_request example. An example of the request that is send to the service.
+
+- @example_request_description description. The description text for the example request.
+
+- @example_response example. An example of the response that is returned from the service.
+
+- @example_response example.
+    ```json
+    {
+      "examples": [{
+        "id":1,
+        "title":"Animals",
+        "text":"Dogs and cats are some.",
+        "highlight":true
+       }]
+    }
+    ```
+
+- @example_response_description example. The description text for the example response.
+
+## Ignored Documentation
+
+This plugin only documents **classes** and **methods** with **@resource** or **@resource\_object** tags. It does not support module documentation.
+
+## Example:
+For controllers:
+
+	##
+	# A thing characteristic of its kind or illustrating a general rule:
+	# it's a good example of how European action can produce results | some of these carpets are among the finest examples of the period.
+	class ExamplesController
+	  ##
+	  # Get a collection of examples:
+	  #
+	  # @resource index
+	  # @url /examples[ .format ]
+	  #
+	  # @action GET
+	  #
+	  # @optional [Boolean] highlight Show only highlighted examples.
+	  #
+	  # @response_field [Array] examples The collection of examples.
+	  #
+	  # @status_codes possible API status codes
+	  #  404 - Not Found
+	  #  401 - Unauthorized
+	  #  422 - Unprocessable Entity
+	  #  200 - OK
+	  #
+	  #
+	  # @example_request {}
+	  # @example_request_description Just requests an index of samples.
+	  # @example_response {"examples": [{"id":1, "title":"Animals", "text":"Dogs and cats are some.", "highlight":true}, {"id":2, "title":"Computers", "text":"Windows PC or Apple's Macintosh.", "highlight":false}]}
+	  # @example_response_description Responds with the index of examples.
+	  #
+	  # @example_request {"highlight": true}
+	  # @example_request_description Request only highlighted examples.
+	  # @example_response
+	  #   ```json
+	  #   {
+	  #     "examples": [{
+	  #       "id":1,
+	  #       "title":"Animals",
+	  #       "text":"Dogs and cats are some.",
+	  #       "highlight":true
+	  #     }]
+	  #   }
+	  #   ```
+	  # @example_response_description Responds only with highlighted examples.
+	  #
+	  def index
+	    #...
+	  end
+	end
+
+And for models:
+
+	##
+	# @resource_object ExamplesModel
+	# @resource_object_properties
+	#   ExamplesModel{
+	#     id: Integer
+	#     name: String
+	#   }
+	#
+	# @resource_object_footnotes
+	#   (1) For visibility, see {Shared}
+	class ExamplesModel
+
+	  # @resource
+	  CONSTANT_VARIABLE = 3
+
+	  # internal documentation
+	  # not picked up by yard-rest-plugin
+	  # @return something_else
+	  def something
+	    #...
+	  end
+
+	end
+
+## Development
+
+As always, you can see what tasks are available by running:
+    
+    rake -T
+
+You can run the template locally over the included sample code by using the following rake tasks:
+    
+    rake ex:clean
+    rake ex:generate
+
+
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-restful"
+    gem.summary = %Q{Yardoc plugin for Restful web services}
+    gem.description = %Q{A customized plugin for Yardoc that produces API documentation for Restful web services}
+    gem.email = ''
+    gem.homepage = "https://github.com/kraft/yard-restful"
+    gem.authors = ['Konstantin Rafalsky']
+    gem.add_dependency("yard", '~>0.8.3')
+    gem.files = Dir.glob("{lib,templates}/**/*").concat(["Rakefile"])
+    gem.extra_rdoc_files = ['VERSION', 'README.markdown']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Rebuild the gem from the gemspec"
+task :rebuild do
+  gemfilename = 'yard-restful-' + File.open('VERSION').gets.strip + '.gem'
+  `rm yard-restful-*.gem`
+  `gem uninstall yard-restful&& \
+   gem build yard-restful.gemspec && \
+   gem install #{gemfilename}`
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/lib/yard-rest.rb

@@ -0,0 +1,8 @@
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
+
+require 'yard-rest/tags'
+require 'yard-rest/rest_filters'
+require 'yard-rest/html_blocks_helper'
+
+YARD::Templates::Template.extra_includes << RestFilters
+YARD::Templates::Template.extra_includes << ->(opts) { HtmlBlocksHelper if opts.format == :html }

data/lib/yard-rest/html_blocks_helper.rb

@@ -0,0 +1,16 @@
+module HtmlBlocksHelper
+
+  def rotate(name = nil)
+    @counter ||= {}
+    name ||= 'odd_even'
+    name = name.to_s
+
+    @counter[name] ||= 0
+    @counter[name] += 1
+
+    elements = name.split(/[^\w]|\_/)
+    @counter[name].even? ? elements[0] : elements[1]
+  end
+
+end
+

data/lib/yard-rest/rest_filters.rb

@@ -0,0 +1,29 @@
+module YARD
+    module CodeObjects
+      class Base
+        def restful?
+          has_tag?(:restful_api)
+        end
+        def resource?
+          meths.any?{ |m| m.has_tag?(:url) }
+        end
+      end
+    end
+end
+
+module RestFilters
+
+  def select_restful(list)
+    (list || []).select(&:restful?)
+  end
+
+  def select_objects(list)
+    select_restful(list).reject(&:resource?).sort_by(&:name)
+  end
+
+  def select_resources(list)
+    select_restful(list).select(&:resource?).sort_by(&:name)
+  end
+
+end
+

data/lib/yard-rest/tags.rb

@@ -0,0 +1,26 @@
+# Define custom tags
+tags = [
+  ["Declaration of RESTful API type",:restful_api],
+  ["URL",                           :url],
+  ["HTTP-Action for the Resource",  :action],
+
+  #["Object Used in Resource",       :resource_object],
+  ["Resource Object Property",      :property, :with_types_and_name],
+  ["Resource Object Example",       :example],
+
+  ["Required Arguments",            :required,          :with_types_and_name],
+  ["Optional Arguments",            :optional,          :with_types_and_name],
+
+  ["Example Request",               :example_request],
+  ["Example Request Description",   :example_request_description],
+  ["Request Fields",                :request_field,     :with_types_and_name],
+
+  ["Example Response",              :example_response],
+  ["Example Response Description",  :example_response_description],
+  ["Response Fields",               :response_field,    :with_types_and_name],
+  ["Response Type",                 :response,    :with_types]
+]
+
+tags.each do |tag|
+    YARD::Tags::Library.define_tag(*tag)
+end

data/templates/default/class/html/fields_list.erb

@@ -0,0 +1,17 @@
+<% tags_list = object.tags(options.item) %>
+<% if tags_list.size > 0 %>
+  <div class="parameters <%= rotate(:odd_even) %>">
+    <% unless options.title.empty? %>
+      <h4><%= options.title %></h4>
+    <% end %>
+		<ul>
+  		<% tags_list.each do |tag| %>
+				<li>
+					<span class="name"><%= tag.name %></span>
+					<span class="type"><%= format_types(tag.types, false) %></span>
+					<span class="text"><%= htmlify(tag.text) %></span>
+				</li>
+  		<% end %>
+	  </ul>
+	</div>
+<% end %>

data/templates/default/class/html/header.erb

@@ -0,0 +1,7 @@
+<div class="service">
+  <h1 class="noborder title"><%= options[:title] %></h1>
+    <a class="back" href="<%= url_for('index.html') %>" title="back to the overview">&laquo; back to overview</a>
+    <h2><%= object.name.to_s.gsub(/Controller/,"") %></h2>
+    <%= yieldall %>
+</div>
+

data/templates/default/class/html/object_details.erb

@@ -0,0 +1,12 @@
+<% if object.restful? && !object.resource? %>
+  <h3 class="object_properties_title">Object properties</h3>
+  <%= yieldall(item: :property, title: '') %>
+  <% if object.tags(:example).size > 0 %>
+    <h3>Examples</h3>
+    <% object.tags(:example).each do |tag| %>
+      <div class="example">
+        <%= htmlify(tag.text) %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>

data/templates/default/class/html/resource_details.erb

@@ -0,0 +1,85 @@
+<% if object.restful? && object.resource? %>
+  <div id="Services" class="method_details_list">
+    <% @meths.each do |meth| %>
+		<div class="method">
+      <h3><%= meth.name %></h3>
+			<p class="method_desc"><%= meth.docstring %></p>
+
+      <% if meth.tags(:url).size > 0 %>
+        <div class="resource_url <%=rotate(:odd_even)%>">
+          <h4>URL</h4>
+          <span class="action"><%= meth.tag(:action).text %></span>
+          <span class="url"><%= meth.tag(:url).text %></span>
+        </div>
+      <% end %>
+
+      <%= yieldall(object: meth, item: :required, title: 'Required Parameters') %>
+      <%= yieldall(object: meth, item: :optional, title: 'Optional Parameters') %>
+      <% if meth.tags(:response).size > 0 %>
+        <div class="parameters <%=rotate(:odd_even)%>">
+          <h4>Response Object</h4>
+          <ul>
+            <li>
+              <span class="type"><%= format_types(meth.tag(:response).types, false) %></span>
+              <span class="text"><%= htmlify(meth.tag(:response).text) %></span>
+            </li>
+          </ul>
+        </div>
+      <% else %>
+        <%= yieldall(object: meth, item: :response_field, title: 'Response Fields') %>
+      <% end %>
+
+			<% if meth.tags(:example_request).size > 0 %>
+				<div class="examples">
+					<h4>Examples</h4>
+					<% meth.tags(:example_request).each_with_index do |example_request, i| %>
+						<div class="example">
+							<% example_request_description = meth.tags(:example_request_description)[i] %>
+							<% example_response = meth.tags(:example_response)[i] %>
+							<% example_response_description = meth.tags(:example_response_description)[i] %>
+							<span class="description">
+								<% if example_request_description %>
+									<% if example_request_description.text =~ /\n/im %>
+										<%= htmlify(example_request_description.text) %>
+									<% else %>
+										<%= example_request_description.text %>
+									<% end %>
+								<% end %>
+							</span>
+							<span class="hash request">
+								<strong class="type">Request</strong>
+								<% if example_request %>
+									<% if example_request.text =~ /\n/im %>
+										<%= htmlify(example_request.text) %>
+									<% else %>
+										<%= example_request.text %>
+									<% end %>
+								<% end %>
+							</span>
+							<span class="hash response">
+								<strong class="type">Response</strong>
+								<% if example_response %>
+									<% if example_response.text =~ /\n/im %>
+										<%= htmlify(example_response.text) %>
+									<% else %>
+										<%= example_response.text %>
+									<% end %>
+								<% end %>
+							</span>
+							<span class="description">
+								<% if example_response_description %>
+									<% if example_response_description.text =~ /\n/im %>
+										<%= htmlify(example_response_description.text) %>
+									<% else %>
+										<%= example_response_description.text %>
+									<% end %>
+								<% end %>
+							</span>
+						</div>
+					<% end %>
+				</div>
+			<% end %>
+		</div>
+    <% end %>
+  </div>
+<% end %>

data/templates/default/class/html/setup.rb

@@ -0,0 +1,11 @@
+def init
+  @page_title = "#{object.name.to_s.gsub(/Controller/,"")} - #{options[:title]}"
+  #sections :header, [T('docstring'), :method_details_list, [:fields_list], [T('method_details')]]
+  sections :header, [T('docstring'), :object_details, [:fields_list], :resource_details, [:fields_list]]
+end
+
+def resource_details
+  @meths = (object.meths.select{|x| x.has_tag? :url} || [])
+  erb(:resource_details)
+end
+

data/templates/default/docstring/html/setup.rb

@@ -0,0 +1,4 @@
+def init
+  return if object.docstring.blank?
+  sections :text
+end

data/templates/default/docstring/html/text.erb

@@ -0,0 +1 @@
+<%= htmlify(object.docstring.strip) %>

data/templates/default/fulldoc/html/css/custom.css

@@ -0,0 +1,184 @@
+body {
+  overflow-x: hidden;
+  overflow-y: auto;
+  padding: 0 !important;
+  margin: 0 !important;
+  width: 100%;
+}
+#toc {
+  height: 100%;
+  right: 0;
+  position: fixed;
+  top: 0;
+  width: 230px;
+}
+#header {
+  position: fixed;
+  top: 0;
+  z-index: 1001;
+}
+#header #search {
+  position: fixed;
+  top: 0;
+  right: 8px;
+  z-index: 1001;
+}
+#content {
+  margin-right: 285px;
+  position: relative;
+  padding: 20px;
+  z-index: 1;
+}
+#toc .title {display: none;}
+#toc a:link, #content a:visited { text-decoration: none; color: #05a; }
+#toc a:hover { background: #ffffa5; }
+pre code {
+  display: block;
+  background: #EAF0FF;
+  padding: 12px;
+  line-height: 1.9em;
+}
+a.back {
+  font-size: 1.2em;
+  padding: 4px;
+}
+p.method_desc {
+  padding: 16px 0 0 14px;
+  font-size: 1.2em;
+}
+h2 {
+  margin: 2.4em 0 0.5em;
+}
+.service h2 + p {
+  font-size: 1.2em;
+  margin-bottom: 62px;
+}
+.method {
+  display: block;
+  margin-top: 40px;
+  padding-top: 0;
+  position: relative;
+}
+h3 {
+  font-size: 1.6em;
+  padding-top: 6px;
+  margin-bottom: -6px;
+}
+h4 {
+  margin: 0;
+}
+#resources {
+  padding: 14px 50px 32px;
+}
+#resources li {
+  padding: 5px;
+  list-style-position: outside;
+  list-style-type: disc;
+  text-decoration: none;
+  font-weight: normal;
+  font-size: 1.4em;
+}
+.resource_url {
+  border: 1px solid white;
+  display: block;
+  margin-top: 11px;
+  padding: 12px 12px 18px;
+}
+.resource_url .action {
+  padding-left: 46px;
+  font-weight: bold;
+}
+#search_frame #search {
+  display: none;
+}
+.parameters {
+  padding: 12px;
+  border: 1px solid white;
+}
+.parameters ul li {
+  display: block;
+  padding: 4px 0 0 6px;
+}
+.parameters ul li .name {
+  font-weight: bold;
+  padding-right: 10px;
+}
+.parameters ul li .text {
+  display: block;
+}
+.parameters ul li .text p {
+  margin-top: 0px;
+}
+.parameters ul li .type tt {
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; /*taken from original yard style.css*/
+}
+.odd {
+  background: #EAF0FF;
+}
+.even {
+  background: #D5E1FF;
+}
+.examples {
+  padding: 32px 12px 12px 12px;
+}
+.example {
+  border-bottom: 1px solid #BBB;
+  display: block;
+  padding: 18px 0 26px;
+  margin-bottom: 14px;
+  margin-top: 8px;
+}
+.example .description {
+  display: block;
+  font-size: 1.2em;
+  margin: 8px 0;
+}
+
+.example .hash {
+  display: block;
+  background: #EEF;
+  font-size: 1.1em;
+  border-radius: 4px;
+  box-shadow: inset 0 2px 5px rgba(0,0,0,0.1);
+  padding: 12px;
+}
+
+.example .hash .type {
+  display: block;
+  font-size: 0.8em;
+  color: #99A;
+  padding-bottom: 6px;
+}
+
+.example .hash.request {
+  border-bottom-left-radius: 0;
+  border-bottom-right-radius: 0;
+}
+
+.example .hash.response {
+  border-top: 1px solid white;
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+
+pre.code.json {
+  margin: 0;
+}
+
+pre.code.json code {
+  position: relative;
+  border: 1px solid transparent;
+  border-radius: 6px;
+}
+
+pre.code.json code:hover {
+  background: #d4e5fe;
+}
+
+pre.code.json code:active {
+  background: #c1d8fb;
+}
+
+.object_properties_title {
+  margin-bottom: 16px;
+}

data/templates/default/fulldoc/html/frames.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title><%= options.title %></title>
+</head>
+<script type="text/javascript" charset="utf-8">
+window.onload = function() {
+  var match = window.location.hash.match(/^#!(.+)/);
+  var name = '<%= url_for_main %>';
+  if (match) {
+    name = unescape(match[1]);
+  }
+  document.writeln('<frameset cols="20%,*">' +
+    '<frame name="list" src="<%= url_for_list('resource') %>" />' +
+    '<frame name="main" src="' + name + '" />' +
+    '</frameset>');
+}
+</script>
+<noscript>
+  <frameset cols="20%,*">
+    <frame name="list" src="<%= url_for_list('resource') %>" />
+    <frame name="main" src="<%= url_for_main %>" />
+  </frameset>
+</noscript>
+</html>

data/templates/default/fulldoc/html/full_list_object.erb

@@ -0,0 +1,6 @@
+<% @items.each do |obj| %>
+  <li class="<%= rotate(:r2_r1_r2) %>">
+    <%= linkify(obj, obj.name) %>
+  </li>
+<% end %>
+

data/templates/default/fulldoc/html/full_list_resource.erb

@@ -0,0 +1,5 @@
+<% @items.each do |resource| %>
+  <li class="<%= rotate(:r2_r1) %>">
+    <%= linkify(resource, resource.name.to_s.gsub(/Controller/, "")) %>
+  </li>
+<% end %>

data/templates/default/fulldoc/html/js/rest_plugin.js

@@ -0,0 +1,55 @@
+function setup_toc() {
+	if ($('#content').length === 0) return;
+	var _toc = $('<ol class="top"></ol>');
+	var show = false;
+	var toc = _toc;
+	var counter = 0;
+	var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+	var i;
+	if ($('#content h1').length > 1) tags.unshift('h1');
+	for (i = 0; i < tags.length; i++) { tags[i] = '#content ' + tags[i]; }
+	var lastTag = parseInt(tags[0][1], 10);
+	$(tags.join(', ')).each(function() {
+		if (this.id == "content") return;
+		show = true;
+		var thisTag = parseInt(this.tagName[1], 10);
+		if (this.id.length === 0) {
+			var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+			if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+			this.id = proposedId;
+		}
+		if (thisTag > lastTag) {
+			for (i = 0; i < thisTag - lastTag; i++) {
+			  var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+			}
+		}
+		if (thisTag < lastTag) {
+			for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+		}
+		toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
+		lastTag = thisTag;
+	});
+	if (!show) return;
+	html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+	$('#content').prepend(html);
+	$('#toc').append(_toc);
+	$('#toc .hide_toc').toggle(function() {
+		$('#toc .top').slideUp('fast');
+		$('#toc').toggleClass('hidden');
+		$('#toc .title small').toggle();
+	}, function() {
+		$('#toc .top').slideDown('fast');
+		$('#toc').toggleClass('hidden');
+		$('#toc .title small').toggle();
+	});
+	$('#toc .float_toc').toggle(function() {
+		$(this).text('float');
+		$('#toc').toggleClass('nofloat');
+	}, function() {
+		$(this).text('left');
+		$('#toc').toggleClass('nofloat');
+	});
+}
+$(document).ready(function(){
+	setup_toc();
+});

data/templates/default/fulldoc/html/setup.rb

@@ -0,0 +1,22 @@
+include Helpers::ModuleHelper
+include Helpers::FilterHelper
+
+def generate_object_list
+  @items = select_objects(@objects)
+  @list_title = "List of Objects"
+  @list_type = "object"
+  generate_list_contents
+end
+
+def generate_resource_list
+  @items = select_resources(@objects)
+  @list_title = "List of Resources"
+  @list_type = "resource"
+  generate_list_contents
+end
+
+def init
+  super
+  asset("css/custom.css", file("css/custom.css", true))
+end
+

data/templates/default/layout/html/footer.erb

@@ -0,0 +1,3 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> with ruby-<%= RUBY_VERSION %>
+</div>

data/templates/default/layout/html/index.erb

@@ -0,0 +1,17 @@
+<div id="start">
+  <h1 class="noborder title"><%= options[:title] %></h1>
+
+	<%= htmlify(@readme.contents) if @readme%>
+
+  <h2>All Resources</h2>
+  <ul id="resources">
+	<% unless @resources.nil? %>
+    <% @resources.each do |resource| %>
+	    <li><%= linkify(resource, resource.name.to_s.gsub(/Controller/, "")) %></li>
+    <% end %>
+  <% end %>
+  </ul>
+
+  <div class="clear"></div>
+
+</div>

data/templates/default/layout/html/layout.erb

@@ -0,0 +1,20 @@
+<!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>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <div id="header">
+      <%= erb(:search) %>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content" style="padding-top: 12px;">
+		<%= yieldall %>
+	</div>
+
+    <%= erb(:footer) %>
+  </body>
+</html>

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,33 @@
+include Helpers::FilterHelper
+
+def init
+  @page_title = options[:title]
+  if object == "_index.html"
+
+  elsif object.name == :root
+    sections :layout, [:index]
+  else
+    super
+  end
+end
+
+def stylesheets
+  super + %w(css/custom.css)
+end
+
+def javascripts
+  super + %w(js/rest_plugin.js)
+end
+
+def menu_lists
+  [
+    { :type => 'resource', :title => "Resources", :search_title => "Resources" },
+    { :type => 'object', :title => "Objects", :search_title => "Objects" }
+  ]
+end
+
+def index
+  @readme = options[:readme]
+  @resources = select_resources(@objects)
+  erb(:index)
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: yard-restful
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Konstantin Rafalsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: A customized plugin for Yardoc that produces API documentation for Restful
+  web services
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+- VERSION
+files:
+- Rakefile
+- lib/yard-rest.rb
+- lib/yard-rest/html_blocks_helper.rb
+- lib/yard-rest/rest_filters.rb
+- lib/yard-rest/tags.rb
+- templates/default/class/html/fields_list.erb
+- templates/default/class/html/header.erb
+- templates/default/class/html/object_details.erb
+- templates/default/class/html/resource_details.erb
+- templates/default/class/html/setup.rb
+- templates/default/docstring/html/setup.rb
+- templates/default/docstring/html/text.erb
+- templates/default/fulldoc/html/css/custom.css
+- templates/default/fulldoc/html/frames.erb
+- templates/default/fulldoc/html/full_list_object.erb
+- templates/default/fulldoc/html/full_list_resource.erb
+- templates/default/fulldoc/html/js/rest_plugin.js
+- templates/default/fulldoc/html/setup.rb
+- templates/default/layout/html/footer.erb
+- templates/default/layout/html/index.erb
+- templates/default/layout/html/layout.erb
+- templates/default/layout/html/setup.rb
+- README.markdown
+- VERSION
+homepage: https://github.com/kraft/yard-restful
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Yardoc plugin for Restful web services
+test_files: []