apispec 0.0.3

data/resources/style.css

@@ -0,0 +1,260 @@
+* {
+  margin: 0px;
+  padding: 0px;
+  font-size: 11pt;
+}
+
+ul {
+  margin-left: 20px;
+}
+
+body {
+  font-family: "Helvetica";
+}
+
+h1 {
+  color: white;
+  padding: 5px;
+  font-size: 14pt;
+  
+  border-bottom: 1px solid black;
+  background: #3714B0;
+  background-image: -webkit-gradient(
+    linear,
+    left bottom,
+    left top,
+    color-stop(0, rgb(54,20,176)),
+    color-stop(1, rgb(135,103,215))
+  );
+  background-image: -moz-linear-gradient(
+    center bottom,
+    rgb(54,20,176) 0%,
+    rgb(135,103,215) 100%
+  );
+}
+
+h2 {
+  font-size: 12pt;
+}
+
+h3 {
+  font-size: 11pt;
+}
+
+h4 {
+  font-size: 11pt;
+}
+
+h5 {
+  font-size: 11pt;
+  font-weight: normal;
+  text-decoration: underline;
+}
+
+.example {
+  overflow: auto;
+}
+
+.codeRay {
+  font-family: monospace;
+  font-size: 9pt;
+}
+
+.response .example, .response .headers, .request .example, .request .headers
+.response .content, .request .content {
+  padding: 3px;
+}
+
+.object h2 {
+  display: block;
+}
+
+.resources {}
+
+.resource {
+  margin: 10px;
+}
+
+.resources {
+}
+
+.resources .resource h2 {
+  padding: 3px;
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  border: 1px solid #ccc;
+  background: #efefef;
+}
+
+.resources .resource h2 .method {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #866FD7;
+}
+
+.resources .resource h2 .path {
+}
+
+.resources .resource h2 .path .parameter {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  margin-left: 3px;
+  margin-right: 3px;
+  color: #866FD7;
+}
+
+.resources .resource p {
+  padding: 3px;
+}
+
+.resources .resource .request h3, .resources .resource .response h3 {
+  border-top: 1px solid #ccc;
+  border-bottom: 1px solid #ccc;
+  padding: 3px;
+  color: white;
+  border-radius: 4px 4px 0px 0px;
+  -moz-border-radius: 4px 4px 0px 0px;
+  -webkit-border-radius: 4px 4px 0px 0px;
+  background: #ccc;
+}
+
+.resources .resource .response h3 .ok {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #0ACF00;
+}
+
+.resources .resource .response h3 .warn {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #FD0006;
+}
+
+.resources .resource .response h3 .error {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #FD0006;
+}
+
+.field, .object .description, .object .example {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  margin: 3px;
+  padding: 3px;
+  background: #efefef;
+}
+
+.field .name {
+  padding: 3px;
+  
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  
+  background: #2D9B27;
+  background-image: -webkit-gradient(
+    linear,
+    left bottom,
+    left top,
+    color-stop(0, #078600),
+    color-stop(1, #2D9B27)
+  );
+  background-image: -moz-linear-gradient(
+    center bottom,
+    #078600 0%,
+    #2D9B27 100%
+  );
+}
+
+.message {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  background: #efefef;
+  margin-bottom: 10px;
+  margin-left: 10px;
+  border-left: 1px solid #ccc;
+  border-bottom: 1px solid #ccc;
+  border-right: 1px solid #ccc;
+}
+
+.message > div {
+  margin: 3px;
+}
+
+.field .name .default {
+  float: right;
+}
+
+.field .name .default span {
+  font-weight: bolder;
+}
+
+.field .name .type {
+  font-weight: bolder;
+}
+
+.field .name .name {
+  font-family: monospace;
+}
+
+.field .name a, 
+.field .name a:hover, 
+.field .name a:active, 
+.field .name a:visited {
+  color: white;
+  text-decoration: none;
+}
+
+.field .name .optional {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #0ACF00;
+  float: right;
+}
+
+.field .example {
+  margin-top: 3px;
+  padding: 3px;
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  border: 1px solid #ccc;
+}
+
+.field .example span {
+  border-radius: 4px;
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  padding-left: 2px;
+  padding-right: 2px;
+  background: white;
+  color: #0ACF00;
+  float: right;
+}

data/spec/dsl/example_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Example do
+  
+end

data/spec/dsl/field_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Field do
+  pending "no spec at the moment"
+end

data/spec/dsl/interface_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Interface do
+  pending "no spec at the moment"
+end

data/spec/dsl/message_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Message do
+  pending "no spec at the moment"
+end

data/spec/dsl/object_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Object do
+  pending "no spec at the moment"
+end

data/spec/dsl/resource_spec.rb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe APISpec::Resource do
+  pending "no spec at the moment"
+end

data/spec/generator_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+EXAMPLE_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "example"))
+
+describe APISpec::Generator do
+  before(:each) do
+    @generator = APISpec::Generator.new
+    @generator.working_directory = EXAMPLE_DIR
+  end
+  
+  it "should be possible to parse the example" do
+    @generator.parse_files!
+  end
+  
+  it "should be possible to parse the example" do
+    @generator.parse_files!
+    puts @generator.namespace.print_tree()
+  end
+  
+  it "should be possible to find fields using there path" do
+    @generator.parse_files!
+    field = @generator.namespace.find_field("Header.X-User")
+    
+    field = @generator.namespace.find_field("Header.Quota.X-QuotaSize")
+    # ...
+    field = @generator.namespace.find_field("Mail.attachments")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "apispec"))

data/templates/field.html.erb

@@ -0,0 +1,24 @@
+<div class="field">
+  <div class="name">
+    <% if @optional %><div class="optional">optional</div><% end %>
+    <% if @default %>
+      <div class="default">Default: <span><%= @default %></span></div>
+    <% end %>
+    <% if @type.respond_to? :to_path %>
+      <span class="type">
+        (<a href="<%= @type.to_path %>" target="content"><%= @type.full_name %></a>)
+      </span> <span class="name"><%= @name %></span>
+    <% else %>
+      <span class="type">(<%= @type %>)</span> <span class="name"><%= @name %></span>
+    <% end %>
+  </div>
+  <% if @example %>
+    <div class="example">
+    	<span>example</span>
+      <code><%= @example %></code>
+    </div>
+  <% end %>
+  <div class="description">
+    <%= RedCloth.new(@desc || "").to_html %>
+  </div>
+</div>

data/templates/index.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
+   "http://www.w3.org/TR/html4/frameset.dtd">
+<html>
+  <head>
+    <title>Interface definition</title>
+  </head>
+  <frameset cols="25%,75%">
+    <frame src="links.html" name="navigation">
+    <frame src="<%= @namespace.interfaces.first.to_path %>" name="content">
+  </frameset>
+</html>

data/templates/interface.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+		<title><%= @name %> - Interface</title>		
+		<link href="style.css" type="text/css"  media="screen, print" rel="stylesheet" />
+    <script type="text/javascript" src="jquery.min.js"></script>
+	</head>
+  <body>
+		<h1>Interface: <%= full_name %></h1>
+		<div class="resources">
+    <% for resource in @resources do %>
+			<div class="resource">
+	    	<%= resource.to_html(generator, self) %>
+	    </div>
+    <% end %>
+		</div>
+  </body>
+</html>

data/templates/links.html.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+		<title>Overview</title>		
+		<link href="links.css" type="text/css" media="screen, print" rel="stylesheet" />
+	</head>
+  <body>
+		<h2>Objects</h2>
+		<ul class="objects">
+    <% for object in @namespace.objects do %>
+			<li class="object">
+	    	<a href="<%= object.to_path %>" target="content"><%= object.full_name %></a>
+	    </li>
+    <% end %>
+		</ul>
+		<h2>Interfaces</h2>
+		<ul class="interfaces">
+    <% for interface in @namespace.interfaces do %>
+			<li class="interface">
+	    	<a href="<%= interface.to_path %>" target="content"><%= interface.full_name %></a>
+	    </li>
+    <% end %>
+		</ul>
+  </body>
+</html>

data/templates/message.html.erb

@@ -0,0 +1,38 @@
+<p><%= RedCloth.new(@desc || "").to_html %></p>
+<% if @parameters.any? %>
+<div class="parameters">
+	<h4>Resource Parameter</h4>
+	<% for parameter in @parameters do %>
+		<%= parameter.to_html(@generator) %>
+	<% end %>
+</div>
+<% end %>
+<% if @headers.any? %>
+<div class="headers">
+	<h4>HTTP Header</h4>
+	<% for header in @headers do %>
+		<%= header.to_html(@generator) %>
+	<% end %>
+</div>
+<% end %>
+<% if (@object || @array) || @content_desc %>
+<div class="content">
+	<% if @content_desc %>	
+		<h4>Description</h4>
+		<%= RedCloth.new(@content_desc || "").to_html %>
+	<% end %>
+	<% if @object %>
+		<h4>Object</h4>
+		<a href="<%= @object.to_path %>"><%= @object.full_name %></a>
+	<% elsif @array %>
+		<h4>Array</h4>
+		Array of <a href="<%= @array.to_path %>"><%= @array.full_name %></a> Objects
+	<% end %>
+</div>
+<% end %>
+<% if @example %>
+<div class="example">
+	<h4>Example</h4>
+	<%= @example.to_html(self) %>
+</div>
+<% end %>

data/templates/object.html.erb

@@ -0,0 +1,27 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+		<title><%= @name %> - Object</title>		
+		<link href="style.css" type="text/css" rel="stylesheet" />
+	</head>
+  <body>
+		<h1>Object: <%= full_name %></h1>
+		<div class="object">
+		  <% if @desc %>
+		    <div class="description"><%= RedCloth.new(@desc || "").to_html %></div>
+		  <% end %>
+		  <div class="fields">
+        <% for field in @fields do %>
+  	    	<%= field.to_html(@generator) %>
+    		<% end %>
+  		</div>
+      <% if @example %>
+        <h2>Example</h2>
+        <div class="example">
+        	<%= @example.to_html(self) %>
+        </div>
+      <% end %>
+    </div>
+  </body>
+</html>

data/templates/resource.html.erb

@@ -0,0 +1,26 @@
+<h2 onclick="$('#<%= uid %>').toggle(2)" style="cursor: pointer;">
+  <span class="method"><%= @method.to_s.upcase %></span>
+	<span class="path"><%= highlighted_path %></span>
+</h2>
+<div id="<%= uid %>" style="display: none">
+  <p>
+  	<%= RedCloth.new(@desc || "").to_html %>
+  </p>
+  <% if @request %>
+  <div class="request message">
+  	<h3>Request</h3>
+  	<%= @request.to_html(@generator, self) %>
+  </div>
+  <% end %>
+  <% for http_code in @response.keys.sort do %>
+  <%     response = @response[http_code] %>
+  <div class="response message">
+  	<h3>
+  	  <span class="code <%= (http_code >= 400) ? :error : ((http_code >= 300) ? :warn : :ok) %>">
+  	    <%= http_code %></span>
+  	  <span>Response (<%= APISpec::HTTP_STATUS_CODES[http_code] %>)</span>
+  	</h3>
+  	<%= response.to_html(@generator, self) %>
+  </div>
+  <% end %>
+</div>

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: apispec
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Vincent Landgraf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 4
+        - 2
+        - 7
+        version: 4.2.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 9
+        - 7
+        version: 0.9.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :development
+  version_requirements: *id003
+description: A documentation generator for http/rest
+email: vilandgr+github@googlemail.com
+executables: 
+- apispec
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- apispec-0.0.2.gem
+- apispec-0.0.3.gem
+- apispec.gemspec
+- bin/apispec
+- example/datagram/user.json
+- example/example.rb
+- example/user.rb
+- lib/apispec/example.rb
+- lib/apispec/field.rb
+- lib/apispec/generator.rb
+- lib/apispec/http.rb
+- lib/apispec/interface.rb
+- lib/apispec/message.rb
+- lib/apispec/namespace.rb
+- lib/apispec/node.rb
+- lib/apispec/object.rb
+- lib/apispec/resource.rb
+- lib/apispec/version.rb
+- lib/apispec.rb
+- LICENSE
+- Rakefile
+- README.md
+- resources/jquery.min.js
+- resources/links.css
+- resources/stripe.png
+- resources/style.css
+- spec/dsl/example_spec.rb
+- spec/dsl/field_spec.rb
+- spec/dsl/interface_spec.rb
+- spec/dsl/message_spec.rb
+- spec/dsl/object_spec.rb
+- spec/dsl/resource_spec.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- templates/field.html.erb
+- templates/index.html.erb
+- templates/interface.html.erb
+- templates/links.html.erb
+- templates/message.html.erb
+- templates/object.html.erb
+- templates/resource.html.erb
+has_rdoc: true
+homepage: http://github.com/threez/apispec/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A ruby based http/rest documentation generator
+test_files: 
+- spec/dsl/example_spec.rb
+- spec/dsl/field_spec.rb
+- spec/dsl/interface_spec.rb
+- spec/dsl/message_spec.rb
+- spec/dsl/object_spec.rb
+- spec/dsl/resource_spec.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb