RubyGems - apidoc - Versions diffs - 0.1.0 - Mend

apidoc 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

data/examples/burritos_api.rb ADDED

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'apidoc'
+require 'sinatra/base'
+class BurritoApp < Sinatra::Base
+  get '/burritos.json' do
+    JSON.generate [ { meat: 'chicken' }, { meat: 'tofu' } ]
+  end
+  post '/burritos.json' do
+    request.body
+  end
+end
+doc = ApiDoc.new BurritoApp do
+  accept :json
+  content_type :json
+  get '/burritos.json' do
+    desc "Get all burritos"
+  end
+  post '/burritos.json' do
+    desc "Make a new delicious burrito"
+    params do
+      JSON.generate({ meat: 'beef', lettuce: true })
+    end
+  end
+end
+ApiDoc::HtmlWriter.new(doc).write(STDOUT)

data/examples/tacos_api.html ADDED

@@ -0,0 +1,177 @@
+<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">/tacos.json</div>
+  <div class="desc">Get all tacos</div>
+  <div class="params"></div>
+  <div class="response">[{&quot;meat&quot;:&quot;chicken&quot;}]</div>
+</div>
+<div class="api-resource">
+  <div class="method">POST</div>
+  <div class="path">/tacos.json</div>
+  <div class="desc">Make a new delicious taco</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>

data/examples/tacos_api.rb ADDED

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'apidoc'
+require 'sinatra/base'
+class TacoApp < Sinatra::Base
+  get '/tacos.json' do
+    JSON.generate [ { meat: 'chicken' } ]
+  end
+  post '/tacos.json' do
+    request.body
+  end
+end
+doc = ApiDoc.new TacoApp do
+  get '/tacos.json' do
+    desc "Get all tacos"
+  end
+  post '/tacos.json' do
+    desc "Make a new delicious taco"
+    params do
+      JSON.generate({ meat: 'beef', lettuce: true })
+    end
+  end
+end
+ApiDoc::HtmlWriter.new(doc).write(STDOUT)

data/ftags ADDED

@@ -0,0 +1,23 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert  /dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags //
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.7	//
+.document	./.document	/^/;"	r
+.rspec	./.rspec	/^/;"	r
+Gemfile	./Gemfile	/^/;"	r
+Gemfile.lock	./Gemfile.lock	/^/;"	r
+LICENSE.txt	./LICENSE.txt	/^/;"	r
+README.rdoc	./README.rdoc	/^/;"	r
+Rakefile	./Rakefile	/^/;"	r
+apidoc	./bin/apidoc	/^/;"	r
+apidoc.rb	./lib/apidoc.rb	/^/;"	r
+apidoc_helper.rb	./templates/apidoc_helper.rb	/^/;"	r
+apidoc_spec.rb	./spec/apidoc_spec.rb	/^/;"	r
+authentication.rb	./examples/authentication.rb	/^/;"	r
+config	./.bundle/config	/^/;"	r
+ftags	./ftags	/^/;"	r
+layout.mustache	./templates/layout.mustache	/^/;"	r
+resource.mustache	./templates/resource.mustache	/^/;"	r
+spec_helper.rb	./spec/spec_helper.rb	/^/;"	r

data/lib/apidoc.rb ADDED

@@ -0,0 +1,255 @@
+require 'rack/test'
+require 'thor'
+require 'mustache'
+require 'json'
+module ApiDoc
+  VERSION = "0.1.0"
+  class << self
+    def new(app, &block)
+      @app = app
+      Runner.new(&block)
+    end
+    def app; @app; end
+  end
+  class Runner
+    def initialize(&block)
+      @resources = []
+      @accept    = nil
+      @content_type = nil
+      Blueprint.new self, &block
+    end
+    attr_accessor :resources, :accept, :content_type
+    class Blueprint
+      def initialize(runner, &block)
+        @runner = runner
+        instance_eval &block
+      end
+      def accept(type)
+        @runner.accept = type
+      end
+      def content_type(type)
+        @runner.content_type = type
+      end
+      def get(path, &block)
+        @runner.resources << GetResource.new(@runner, path, &block)
+      end
+      def post(path, &block)
+        @runner.resources << PostResource.new(@runner, path, &block)
+      end
+      def put(path, &block)
+        @runner.resources << PutResource.new(@runner, path, &block)
+      end
+      def delete(path, &block)
+        @runner.resources << DeleteResource.new(@runner, path, &block)
+      end
+      def options(path, &block)
+        @runner.resources << OptionsResource.new(@runner, path, &block)
+      end
+    end
+    def run
+      @resources.each(&:run)
+    end
+  end
+  class HtmlWriter
+    def initialize(runner)
+      @runner = runner
+    end
+    def write(stream)
+      stream.write(
+        Mustache.to_html(File.read(File.dirname(__FILE__) + '/../templates/layout.mustache'), {
+          content: @runner.resources.map {|r| resource_html(r) }.join
+        })
+      )
+      stream.rewind
+      stream
+    end
+    def resource_html(resource)
+      resource.run
+      Mustache.to_html(File.read(File.dirname(__FILE__) + '/../templates/resource.mustache'), {
+        method: resource.method,
+        path: resource.path,
+        desc: resource.desc,
+        params: formatted_params(resource),
+        response: formatted_response(resource)
+      })
+    end
+    def formatted_params(resource)
+      return '' unless resource.params
+      return resource.params unless resource.accept
+      case resource.accept.intern
+      when :json
+        JSON.pretty_generate(JSON.parse(resource.params))
+      else
+        resource.params
+      end
+    end
+    def formatted_response(resource)
+      return resource.response_body unless resource.content_type
+      case resource.content_type.intern
+      when :json
+        JSON.pretty_generate(JSON.parse(resource.response_body))
+      else
+        resource.response_body
+      end
+    end
+  end
+  class Resource
+    def initialize(runner, path, &block)
+      @runner = runner
+      @path = path
+      @params = nil
+      Blueprint.new self, &block
+    end
+    attr_accessor :path, :method, :setup, :params, :desc
+    attr_writer :accept, :content_type
+    class Blueprint
+      def initialize(resource, &block)
+        @resource = resource
+        instance_eval &block
+      end
+      def desc(val)
+        @resource.desc = val
+      end
+      def accept(format)
+        @resource.accept = format
+      end
+      def content_type(format)
+        @resource.content_type = format
+      end
+      def params(&block)
+        @resource.params = block
+      end
+      def setup(&block)
+        @resource.setup = block
+      end
+    end
+    include Rack::Test::Methods
+    def content_type
+      @content_type || @runner.content_type
+    end
+    def accept
+      @accept || @runner.accept
+    end
+    def app
+      ApiDoc.app
+    end
+    def run
+      if @setup
+        instance_eval &@setup
+      end
+      @params = @params.call if @params.is_a?(Proc)
+      @response = make_request(@path, @params)
+    end
+    def response_body
+      @response.body
+    end
+  end
+  class PostResource < Resource
+    def make_request(path, params)
+      post path, params
+    end
+    def initialize(runner, path, &block)
+      super runner, path, &block
+      @method = 'POST'
+    end
+  end
+  class GetResource < Resource
+    def make_request(path, params)
+      get path, params
+    end
+    def initialize(runner, path, &block)
+      super runner, path, &block
+      @method = 'GET'
+    end
+  end
+  class PutResource < Resource
+    def make_request(path, params)
+      put path, params
+    end
+    def initialize(runner, path, &block)
+      super runner, path, &block
+      @method = 'PUT'
+    end
+  end
+  class DeleteResource < Resource
+    def make_request(path, params)
+      delete path, params
+    end
+    def initialize(runner, path, &block)
+      super runner, path, &block
+      @method = 'DELETE'
+    end
+  end
+  class OptionsResource < Resource
+    def make_request(path, params)
+      options path, params
+    end
+    def initialize(runner, path, &block)
+      super runner, path, &block
+      @method = 'OPTIONS'
+    end
+  end
+  class Application < Thor
+    map '-v' => :version
+    desc "version", "print version information"
+    def version
+      puts ApiDoc::VERSION
+    end
+  end
+end