apidoc 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'thor'
+gem 'mustache'
+gem 'rack-test'
+gem 'mustache'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "json"
+  gem "sinatra"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    mustache (0.99.4)
+    rack (1.4.0)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sinatra (1.3.2)
+      rack (>= 1.3.6, ~> 1.3)
+      rack-protection (~> 1.2)
+      tilt (>= 1.3.3, ~> 1.3)
+    thor (0.15.2)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  json
+  mustache
+  rack-test
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  sinatra
+  thor

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 T.J. VanSlyke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,59 @@
+= apidoc
+
+Minimalist API documentation generator for Rack applications.
+
+== Motivation
+
+After searching for similar API documentation solutions and coming up dry, I
+stumbled upon http://apiary.io. While I appreciate the motivation for this
+project, I really wanted an API documentation tool that is:
+
+1. Example based: Show me what a _real_ request looks like with _real_ data.
+2. Self-testing and replicable: Build API documentation as part of your CI build, and know
+it's up-to-date because it ran real requests against your application.
+3. Minimalist: `apidoc` is designed to make requests using the content type of
+your choice and display the request, response and a short description. Nothing more. 
+
+
+== Install
+
+    $ gem install apidoc
+
+== Use
+
+    # my_apidoc.rb
+
+    require 'path/to/my/app'
+
+    doc = ApiDoc.new(MyApp) do
+      get '/tacos.json' do
+        desc "Get all tacos owned by this user"
+      end
+
+      post "/tacos.json" do
+        desc "Make a fresh, delicious new taco"
+        params do
+          { meat: 'fish', sour_cream: true }
+        end
+      end
+    end
+
+    ApiDoc::HtmlWriter.new(doc).write(STDOUT)
+
+See the examples folder for more examples.
+
+== Contributing to apidoc
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 T.J. VanSlyke. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "apidoc"
+  gem.homepage = "http://github.com/turingstudio/apidoc"
+  gem.license = "MIT"
+  gem.summary = %Q{Minimalist API documentation generator for Rack applications.}
+  gem.description = %Q{Minimalist API documentation generator for Rack applications.}
+  gem.email = "tj@turing.com"
+  gem.authors = ["T.J. VanSlyke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "apidoc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :examples do
+  `ruby examples/tacos_api.rb > examples/tacos_api.html`
+  `ruby examples/burritos_api.rb > examples/burritos_api.html`
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/apidoc.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "apidoc"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["T.J. VanSlyke"]
+  s.date = "2012-06-03"
+  s.description = "Minimalist API documentation generator for Rack applications."
+  s.email = "tj@turing.com"
+  s.executables = ["apidoc"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "apidoc.gemspec",
+    "bin/apidoc",
+    "examples/authentication.rb",
+    "examples/burritos_api.html",
+    "examples/burritos_api.rb",
+    "examples/tacos_api.html",
+    "examples/tacos_api.rb",
+    "ftags",
+    "lib/apidoc.rb",
+    "spec/apidoc_spec.rb",
+    "spec/spec_helper.rb",
+    "templates/apidoc_helper.rb",
+    "templates/layout.mustache",
+    "templates/resource.mustache"
+  ]
+  s.homepage = "http://github.com/turingstudio/apidoc"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Minimalist API documentation generator for Rack applications."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+      s.add_runtime_dependency(%q<mustache>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-test>, [">= 0"])
+      s.add_runtime_dependency(%q<mustache>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 0"])
+    else
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<mustache>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<mustache>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<mustache>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<mustache>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+  end
+end
+

data/bin/apidoc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/apidoc'
+
+ApiDoc::Application.start
+

data/examples/authentication.rb

@@ -0,0 +1,8 @@
+require 'apidoc_helper'
+
+post "/api/v1/session.json" do
+  desc "Authenticate user session"
+  setup { @user = User.make! }
+  params { { user: { email: @user.email, password: @user.password } } }
+end
+

data/examples/burritos_api.html

@@ -0,0 +1,190 @@
+<html>
+  <head>
+    <title></title>
+		<style>
+
+			html, body, div, span, applet, object, iframe,
+			h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+			a, abbr, acronym, address, big, cite, code,
+			del, dfn, em, img, ins, kbd, q, s, samp,
+			small, strike, strong, sub, sup, tt, var,
+			b, u, i, center,
+			dl, dt, dd, ol, ul, li,
+			fieldset, form, label, legend,
+			table, caption, tbody, tfoot, thead, tr, th, td,
+			article, aside, canvas, details, embed, 
+			figure, figcaption, footer, header, hgroup, 
+			menu, nav, output, ruby, section, summary,
+			time, mark, audio, video {
+				margin: 0;
+				padding: 0;
+				border: 0;
+				font-size: 100%;
+				font: inherit;
+				vertical-align: baseline;
+			}
+			/* HTML5 display-role reset for older browsers */
+			article, aside, details, figcaption, figure, 
+			footer, header, hgroup, menu, nav, section {
+				display: block;
+			}
+			body {
+				line-height: 1;
+			}
+			ol, ul {
+				list-style: none;
+			}
+			blockquote, q {
+				quotes: none;
+			}
+			blockquote:before, blockquote:after,
+			q:before, q:after {
+				content: '';
+				content: none;
+			}
+			table {
+				border-collapse: collapse;
+				border-spacing: 0;
+			}
+
+
+
+
+
+			body {
+				font-family: Helvetica;
+				margin: 1em;
+			}
+
+			.name {
+				font-size: 2.0em;
+			}
+
+			.api-resource {
+				margin: 1em 0;
+			}
+
+			.api-resource .method {
+				font-size: 1em;
+				background-color: #999;
+				background-image: -webkit-linear-gradient(top, 
+				transparent 0%, 
+				rgba(0, 0, 0, 0.296875) 100%);
+				background-origin: padding-box;
+				border-bottom-color: 
+				white;
+				border-bottom-left-radius: 0px;
+				border-bottom-style: none;
+				border-bottom-width: 0px;
+				border-left-color: 
+				white;
+				border-left-style: none;
+				border-left-width: 0px;
+				border-right-color: 
+				white;
+				border-right-style: none;
+				border-right-width: 0px;
+				border-top-color: 
+				white;
+				border-top-left-radius: 3px;
+				border-top-style: none;
+				border-top-width: 0px;
+				color: 
+				white;
+				text-align: center;
+				text-shadow: 
+				rgba(0, 0, 0, 0.296875) 0px -1px 0px;
+				text-transform: uppercase;
+				vertical-align: baseline;
+				padding: 0.5em;
+				display: inline-block;
+				width: 84px;
+			}
+
+			.api-resource .path {
+				display: inline-block;
+				font-family: Monaco, fixed;
+				color: #0669CD;
+				font-size: 1em;
+			}
+
+			.api-resource .desc {
+				margin: 1em 0;
+				color: 
+				#333;
+				display: block;
+				font-family: Helvetica, sans-serif;
+				font-size: 13px;
+				font-style: normal;
+				font-weight: 100;
+				height: 17px;
+				line-height: 17px;
+				text-shadow: 
+				rgba(255, 255, 255, 0.597656) 0px 1px 0px;
+				vertical-align: baseline;
+			}
+			.api-resource .params,
+			.api-resource .response {
+				font-family: Monaco, fixed;
+				margin: 1em 0;
+				overflow: scroll;
+				white-space: pre;
+				background-color: #333333;
+				color: #8B8B8B;
+				padding: 1em;
+				border-radius: 2px;
+			}
+
+			.api-resource .params:before {
+				content: "IN";
+				color: #C29262;
+				display: block;
+				font-family: Helvetica;
+				margin: 0.5em 0;
+			}
+
+			.api-resource .response:before {
+				content: "OUT";
+				display: block;
+				color: #C29262;
+				font-family: Helvetica;
+				margin: 0.5em 0;
+			}
+		</style>
+  </head>
+
+  <body>
+    <div class="api">
+      <div class="name"></div>
+      <div class="api-resource">
+  <div class="method">GET</div>
+  <div class="path">/burritos.json</div>
+  <div class="desc">Get all burritos</div>
+  <div class="params"></div>
+  <div class="response">[
+  {
+    &quot;meat&quot;: &quot;chicken&quot;
+  },
+  {
+    &quot;meat&quot;: &quot;tofu&quot;
+  }
+]</div>
+</div>
+<div class="api-resource">
+  <div class="method">POST</div>
+  <div class="path">/burritos.json</div>
+  <div class="desc">Make a new delicious burrito</div>
+  <div class="params">{
+  &quot;meat&quot;: &quot;beef&quot;,
+  &quot;lettuce&quot;: true
+}</div>
+  <div class="response">{
+  &quot;meat&quot;: &quot;beef&quot;,
+  &quot;lettuce&quot;: true
+}</div>
+</div>
+
+    </div>
+  </body>
+</html>
+