apidoc 0.1.0

data/spec/apidoc_spec.rb

@@ -0,0 +1,211 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'sinatra/base'
+
+describe ApiDoc do
+  before do
+    class TestApp < Sinatra::Base
+      get '/tacos.json' do
+        JSON.generate [ { meat: 'beef' }, { meat: 'chicken' } ]
+      end
+
+      post '/tacos.json' do
+        request.body
+      end
+    end
+
+    @doc = ApiDoc.new(TestApp) do
+      get '/tacos.json' do
+        desc "Get all tacos"
+      end
+    end
+  end
+
+  subject { @doc }
+
+  it "should have one resource" do
+    subject.resources.length.should == 1
+  end
+
+  describe "the /tacos.json resource" do
+    before do
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+    its(:method) { should == 'GET' }
+    its(:path) { should == '/tacos.json' }
+    its(:response_body) { should == JSON.generate([ { meat: 'beef' }, { meat: 'chicken' } ]) }
+  end
+
+  describe "when writing to HTML" do
+    subject do
+      stream = StringIO.new
+      ApiDoc::HtmlWriter.new(@doc).write(stream)
+      stream.read
+    end
+
+    it "should write the request method" do
+      subject.should include('GET')
+    end
+
+    it "should write the request path" do
+      subject.should include("/tacos.json")
+    end
+
+    it "should write the response body" do
+      subject.should include('meat')
+    end
+
+    describe "when accepting JSON as input" do
+      before do
+        @doc = ApiDoc.new(TestApp) do
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            accept :json
+            params do
+              JSON.generate({ meat: 'beef', lettuce: true })
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject do
+        stream = StringIO.new
+        ApiDoc::HtmlWriter.new(@doc).write(stream)
+        stream.read
+      end
+
+      it "should pretty-print the JSON data in the IN section" do
+        subject.should include("{\n  &quot;meat&quot;: &quot;beef&quot;,\n  &quot;lettuce&quot;: true\n}")
+      end
+    end
+
+    describe "when setting the default accept and content type" do
+      before do
+        @doc = ApiDoc.new(TestApp) do
+          accept :json
+          content_type :json
+
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            params do
+              JSON.generate({ meat: 'beef', lettuce: true })
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject { @doc }
+
+      it "should propagate the accept type to its resources" do
+        @doc.resources.first.accept.should == :json
+      end
+
+      it "should propagate the content type to its resources" do
+        @doc.resources.first.content_type.should == :json
+      end
+    end
+
+    describe "when providing JSON as output" do
+      before do
+        @doc = ApiDoc.new(TestApp) do
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            content_type :json
+            params do
+              JSON.generate({ meat: 'beef', lettuce: true })
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject do
+        stream = StringIO.new
+        ApiDoc::HtmlWriter.new(@doc).write(stream)
+        stream.read
+      end
+
+      it "should pretty-print the JSON data in the OUT section" do
+        subject.should include("{\n  &quot;meat&quot;: &quot;beef&quot;,\n  &quot;lettuce&quot;: true\n}")
+      end
+    end
+
+  end
+
+  describe "different request methods" do
+    before do
+      class RequestMethodsApp < Sinatra::Base
+        get '/get.json' do
+          JSON.generate({ method: 'GET' })
+        end
+        post '/post.json' do
+          JSON.generate({ method: 'POST' })
+        end
+        put '/put.json' do
+          JSON.generate({ method: 'PUT' })
+        end
+        delete '/delete.json' do
+          JSON.generate({ method: 'DELETE' })
+        end
+        options '/options.json' do
+          JSON.generate({ method: 'OPTIONS' })
+        end
+      end
+
+      @doc = ApiDoc.new(RequestMethodsApp) do
+        get '/get.json' do
+          desc "a get request"
+        end
+
+        post '/post.json' do
+          desc "a post request"
+        end
+
+        put '/put.json' do
+          desc "a put request"
+        end
+
+        delete '/delete.json' do
+          desc "a delete request" 
+        end
+
+        options '/options.json' do
+          desc "an options request"
+        end
+      end
+    end
+
+    it "should have all five resources" do
+      @doc.resources.length.should == 5
+    end
+
+  end
+
+  describe "when specifying a request with parameters" do
+    before do
+      @doc = ApiDoc.new(TestApp) do
+        post '/tacos.json' do
+          desc "Make a new delicious taco"
+          params do
+            JSON.generate({ meat: 'beef', lettuce: true })
+          end
+        end
+      end
+
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+
+    its(:params) { should == JSON.generate({ meat: 'beef', lettuce: true }) }
+    its(:response_body) { should == JSON.generate({ meat: 'beef', lettuce: true }) }
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'apidoc'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/templates/apidoc_helper.rb

@@ -0,0 +1,11 @@
+require 'apidoc'
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../../config/environment", __FILE__)
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+require 'database_cleaner'
+
+DatabaseCleaner.strategy = :truncation
+

data/templates/layout.mustache

@@ -0,0 +1,163 @@
+<html>
+  <head>
+    <title>{{name}}</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">{{name}}</div>
+      {{{content}}}
+    </div>
+  </body>
+</html>
+

data/templates/resource.mustache

@@ -0,0 +1,7 @@
+<div class="api-resource">
+  <div class="method">{{method}}</div>
+  <div class="path">{{path}}</div>
+  <div class="desc">{{desc}}</div>
+  <div class="params">{{params}}</div>
+  <div class="response">{{response}}</div>
+</div>

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: apidoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- T.J. VanSlyke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70176282425060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176282425060
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: &70176282424240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176282424240
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70176282423620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176282423620
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: &70176282410920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176282410920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70176282410100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70176282410100
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70176282409460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70176282409460
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70176282408660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70176282408660
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70176282407880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70176282407880
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70176282407180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176282407180
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70176282406500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176282406500
+description: Minimalist API documentation generator for Rack applications.
+email: tj@turing.com
+executables:
+- apidoc
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+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
+homepage: http://github.com/turingstudio/apidoc
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1506073471830786691
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Minimalist API documentation generator for Rack applications.
+test_files: []