restapi_doc 0.0.1

data/lib/restapi_doc/template/detail.html.haml

@@ -0,0 +1,107 @@
+!!!
+%html
+  %head
+    %meta{:name => "viewport", "content" => "width=device-width, initial-scale=1.0"}/
+    %meta{:description => ""}/
+    %meta{:author => ""}/
+    %link{:href => "../../assets/css/bootstrap.min.css", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "../../assets/css/bootstrap-responsive.min.css", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "../../assets/css/prettify.css", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "../../assets/ico/favicon.ico", :rel => "shortcut icon"}/
+    %link{:href => "../../assets/ico/apple-touch-icon-114-precomposed.png", :rel => "apple-touch-icon-precomposed", :size => "114x114"}/
+    %link{:href => "../../assets/ico/apple-touch-icon-72-precomposed.png", :rel => "apple-touch-icon-precomposed", :size => "72x72"}/
+    %link{:href => "../../assets/ico/apple-touch-icon-57-precomposed.png", :rel => "apple-touch-icon-precomposed"}/
+    %style
+      body{padding-top:60px;padding-bottom: 40px;}
+    %title #{project_info['project_name']} - RESTful API Doc
+  %body{"onload" => "prettyPrint();"}
+    %div{:class => "navbar navbar-fixed-top"}
+      %div{:class => "navbar-inner"}
+        .container
+          %a{:class => "btn btn-navbar", "data-toggle" => "collapse", "data-target" => "nav-collapse"}
+            %span{:class => "icon-bar"}
+            %span{:class => "icon-bar"}
+            %span{:class => "icon-bar"}
+          %a{:class => "brand"}
+            = "#{project_info['project_name']}"
+          %div{:class => "nav-collapse"}
+            %ul{:class=> "nav"}
+              %li{:class => "active"}
+                %a{:href => "../../index.html"}
+                  = "RESTful Resources"
+    %div{:class => "container"}
+      %h1{:style => "margin-bottom:20px;"} #{rmethod[1]} #{rmethod[2].gsub(/\(.*\)/, '')}
+      %div{:class => "row-fluid"}
+        %div{:class => "span9"}
+          %p #{rmethod[3].content unless rmethod[3].nil?}
+          %hr
+          %h4{:style => "margin-bottom:10px;"} Resource URL
+          %p #{project_info['base_url']}#{rmethod[2].gsub(/\(.*\)/, '')}
+          - if !rmethod[3].nil?
+            %h4{:style => "margin-top:30px;"} Parameters
+            %table{:class => "table"}
+              %tbody
+                - rmethod[3].params.each do |param|
+                  %tr
+                    %td{:style => "width:35%"} 
+                      = "#{param.split('-')[0].strip} (#{param.split('-')[1].strip})"
+                      %span{:class => "muted", :style => "display:block;font-size:12px;"} #{param.split('-')[2].strip.downcase}
+                    %td #{param.split('-')[3].strip}
+          %hr
+          - if !rmethod[3].nil?
+            %h4{:style => "margin-bottom:10px;"} HTTP Status Codes
+            %table{:class => "table"}
+              %tbody
+                - rmethod[3].http_responses.each do |httpresp|
+                  %tr
+                    %td
+                      = "#{httpresp.split('-')[0].strip}"
+                      %span{:class => "muted", :style => "display:block;font-size:12px;"} #{httpresp.split('-')[1].strip}
+                    %td #{httpresp.split('-')[2].strip}
+          %hr
+          %h4{:style=> "margin-bottom:10px;"} Examples
+          -if !rmethod[3].nil?
+            - if !rmethod[3].request_url.nil?
+              %h5{:style => "margin-bottom:10px;"} Request URL
+              %blockquote
+                %p{:style => "font-size:12px;"} #{project_info['base_url']}#{rmethod[3].request_url}
+          - if !rmethod[3].nil?
+            - if !rmethod[3].request.empty?
+              %h5{:style => "margin-bottom:10px;"} Request
+              %pre{:class => "prettyprint linenums"} #{rmethod[3].request unless rmethod[3].nil?}
+          - if !rmethod[3].nil?
+            - if !rmethod[3].output.empty?
+              %h5{:style => "margin-bottom:10px;"} Response
+              %pre{:class => "prettyprint linenums"} #{rmethod[3].output unless rmethod[3].nil?}
+
+        %div{:class => "span3"}
+          %div{:class => "well"}
+            %h4 Resource Information
+            %table{:class=> "table table-condensed"}
+              %thead
+                %tr
+                  %th
+              %tbody
+                %tr
+                  %td Category
+                  %td #{name}
+                %tr
+                  %td Requires Authentication?
+                  %td #{rmethod[3].requires_authentication unless rmethod[3].nil?}
+                %tr
+                  %td Requires Account Password?
+                  %td #{rmethod[3].account_password_required unless rmethod[3].nil?}
+                %tr
+                  %td Response Formats
+                  %td 
+                    - if !rmethod[3].nil?
+                      - rmethod[3].response_formats.each do |rf| 
+                        %span #{rf}
+                %tr
+                  %td HTTP Method
+                  %td #{rmethod[1]}
+
+
+    %script{:src => "../../assets/js/jquery.js", :type => "text/javascript"}
+    %script{:src => "../../assets/js/bootstrap.min.js", :type => "text/javascript"}
+    %script{:src => "../../assets/js/prettify.js", :type => "text/javascript"}

data/lib/restapi_doc/template/index.html.haml

@@ -0,0 +1,57 @@
+!!!
+%html
+  %head
+    %meta{:name => "viewport", "content" => "width=device-width, initial-scale=1.0"}/
+    %meta{:description => ""}/
+    %meta{:author => ""}/
+    %link{:href => "assets/css/bootstrap.min.css", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "assets/css/bootstrap-responsive.min.css", :rel => "stylesheet", :type => "text/css"}/
+    %link{:href => "assets/css/bootstrap.less", :rel => "stylesheet/less"}/
+    %script{:src => "assets/js/less.min.js", :type => "text/javascript"}
+    %link{:href => "assets/ico/favicon.ico", :rel => "shortcut icon"}/
+    %link{:href => "assets/ico/apple-touch-icon-114-precomposed.png", :rel => "apple-touch-icon-precomposed", :size => "114x114"}/
+    %link{:href => "assets/ico/apple-touch-icon-72-precomposed.png", :rel => "apple-touch-icon-precomposed", :size => "72x72"}/
+    %link{:href => "assets/ico/apple-touch-icon-57-precomposed.png", :rel => "apple-touch-icon-precomposed"}/
+    %style
+      body{padding-top:60px;padding-bottom: 40px;}
+    %title #{project_info['project_name']} - RESTful API Doc
+  %body
+    %div{:class => "navbar navbar-fixed-top"}
+      %div{:class => "navbar-inner"}
+        .container
+          %a{:class => "btn btn-navbar", "data-toggle" => "collapse", "data-target" => "nav-collapse"}
+            %span{:class => "icon-bar"}
+            %span{:class => "icon-bar"}
+            %span{:class => "icon-bar"}
+          %a{:class => "brand"}
+            = "#{project_info['project_name']}"
+          %div{:class => "nav-collapse"}
+            %ul{:class=> "nav"}
+              %li{:class => "active"}
+                %a{:href => "index.html"}
+                  = "RESTful Resources"
+    %div{:class => "container"}
+      #resource_index
+        %h1 RESTful API Resources
+        %hr
+        %div{:class=> "row-fluid"}
+          - resource_docs.each do |resource|
+            %h3{:style => "text-indent:5x;"} #{resource.name.capitalize}
+            %p  #{resource.description}
+            %hr{:style => "margin-top:2px;margin-bottom:2px;"}
+            %table{:class => "table table-striped"}
+              %thead
+                %tr
+                  %th{"style" => "width:35%"} Resource
+                  %th Description
+                %tbody
+                  - resource.resource_methods.each do |method_block|
+                    %tr
+                      %td 
+                        %a{:href => "resources/#{resource.name}/#{method_block[0]}.html"}
+                          = "#{method_block[1]} #{method_block[2].gsub(/\(.*\)/, '')}"
+                      %td #{method_block[3].content unless method_block[3].nil?}
+
+    %script{:src => "assets/js/jquery.js", :type => "text/javascript"}
+    %script{:src => "assets/js/bootstrap.min.js", :type => "text/javascript"}
+    %script{:src => "assets/js/prettify.js", :type => "text/javascript"}

data/lib/restapi_doc.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+require 'haml'
+require 'yaml'
+require 'fileutils'
+require File.expand_path('../restapi_doc/resource_doc', __FILE__)
+require File.expand_path('../restapi_doc/config', __FILE__)
+require File.expand_path('../restapi_doc/railtie', __FILE__) if defined?(Rails)
+
+module RestApiDoc
+  VERSION = File.read(File.expand_path("../VERSION", File.dirname(__FILE__)))
+  
+  include Config
+  include FileUtils
+  
+  def create_structure
+    File.directory?(config_dir) || mkdir(config_dir)
+    Dir["#{config_template_dir}/*.*"].each do |template_file|
+      target_file = config_dir(File.basename(template_file))
+      cp template_file, config_dir if not File.exist? target_file
+    end
+  end
+      
+  # Reads 'rake routes' output and gets the controller info
+  def get_controller_info
+    controller_info = {}
+    routes = Dir.chdir(::Rails.root.to_s) { `rake routes` }
+    routes.split("\n").each do |entry|
+      method, url, controller_action = entry.split.slice(-3, 3)
+      controller, action = controller_action.split('#')
+      controller_info[controller] ||= []
+      controller_info[controller] << [action, method, url]
+    end
+    controller_info
+  end
+  
+  # Create resources
+  def get_resources
+    controller_info = get_controller_info
+    resources = []
+    controller_info.each do |controller, action_entries|
+      controller_location = controller_dir(controller + '_controller.rb')
+      controller_base_routes = action_entries
+      resources << ResourceDoc.new(controller, action_entries, controller_location)
+    end
+    resources
+  end
+  
+  # Generates views and their index in a temp directory
+  def generate_doc(resource_docs)
+    generate_index_templates(resource_docs)
+    copy_assets!
+  end
+  
+  # Creates index template for all resources
+  def generate_index_templates(resource_docs)
+    restapi_config = YAML.load(File.read("#{config_dir}/restapi_doc.yml"))
+    resource_docs.each { |resource| resource.parse_apidoc }
+    template = IO.read(template_dir('index.html.haml'))
+    parsed = Haml::Engine.new(template).render(Object.new, :project_info => restapi_config, :resource_docs => resource_docs)
+    File.open(temp_dir("index.html"), 'w') { |file| file.write parsed }
+    
+    # Generate detail files
+    resource_docs.each do | resource_doc|
+     generate_resource_detail_file!(resource_doc)
+    end
+  end
+  
+  # Generate detail files for resource method
+  def generate_resource_detail_file!(resource_doc)
+    restapi_config = YAML.load(File.read("#{config_dir}/restapi_doc.yml"))
+    Dir.mkdir(temp_dir + "/resources") if (!File.directory?(temp_dir + "/resources"))
+    Dir.mkdir(temp_dir + "/resources/" + resource_doc.name) if (!File.directory?(temp_dir + "/resources/" + resource_doc.name))
+    resource_doc.resource_methods.each do | method|
+      template = IO.read(template_dir('detail.html.haml'))
+      parsed = Haml::Engine.new(template).render(Object.new, :project_info => restapi_config, :name => resource_doc.name , :rmethod => method)
+      File.open(temp_dir + "/resources/" + resource_doc.name + "/" + method[0] + ".html", 'w') { |file| file.write parsed }
+    end
+  end
+  
+  # Move document to public
+  def move_document
+    Dir.mkdir(target_dir) if (!File.directory?(target_dir))
+    # Only want to move the .html, .css, .png and .js files, not the .haml templates.
+    html_css_files = temp_dir("*.{html,css,js,png}")
+    Dir[html_css_files].each { |f| mv f, target_dir }
+    mv temp_dir + "/resources", target_dir, :force => true if (File.directory?(temp_dir + "/resources"))
+    mv temp_dir + "/assets", target_dir, :force => true if (File.directory?(temp_dir + "/assets"))
+  end
+  
+  def copy_assets!
+    # Copy over assets
+    cp_r asset_dir, temp_dir
+  end
+  
+  # Removes the generated files
+  def remove_structure
+    rm_rf target_dir
+  end
+end

data/restapi_doc.gemspec

@@ -0,0 +1,79 @@
+# 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 = "restapi_doc"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Haight"]
+  s.date = "2012-04-26"
+  s.description = "REST API doc generates an easy way to create a twitter style document for your RESTful interface.  \n                        Leveraging Twitter Bootstrap to create an easy to read document for your RESTful api. "
+  s.email = "kevinjhaight@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/restapi_doc.rb",
+    "lib/restapi_doc/config.rb",
+    "lib/restapi_doc/config/restapi_doc.yml",
+    "lib/restapi_doc/method_doc.rb",
+    "lib/restapi_doc/railtie.rb",
+    "lib/restapi_doc/resource_doc.rb",
+    "lib/restapi_doc/tasks/restapi_doc_tasks.rake",
+    "lib/restapi_doc/template/assets/css/bootstrap-responsive.min.css",
+    "lib/restapi_doc/template/assets/css/bootstrap.less",
+    "lib/restapi_doc/template/assets/css/bootstrap.min.css",
+    "lib/restapi_doc/template/assets/css/prettify.css",
+    "lib/restapi_doc/template/assets/img/glyphicons-halflings-white.png",
+    "lib/restapi_doc/template/assets/img/glyphicons-halflings.png",
+    "lib/restapi_doc/template/assets/js/bootstrap.min.js",
+    "lib/restapi_doc/template/assets/js/jquery.js",
+    "lib/restapi_doc/template/assets/js/less.min.js",
+    "lib/restapi_doc/template/assets/js/prettify.js",
+    "lib/restapi_doc/template/detail.html.haml",
+    "lib/restapi_doc/template/index.html.haml",
+    "restapi_doc.gemspec"
+  ]
+  s.homepage = "http://github.com/alayho/restapi_doc"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "REST API doc generates an easy way to create a twitter style document for your RESTful interface"
+
+  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<activesupport>, [">= 2.1"])
+      s.add_runtime_dependency(%q<haml>, ["= 3.1.4"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.2.0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1"])
+      s.add_dependency(%q<haml>, ["= 3.1.4"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.2.0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1"])
+    s.add_dependency(%q<haml>, ["= 3.1.4"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.2.0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: restapi_doc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Haight
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152452280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152452280
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &2152451780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152451780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152451180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152451180
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152450340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152450340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152449700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152449700
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2152449180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152449180
+description: ! "REST API doc generates an easy way to create a twitter style document
+  for your RESTful interface.  \n                        Leveraging Twitter Bootstrap
+  to create an easy to read document for your RESTful api. "
+email: kevinjhaight@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/restapi_doc.rb
+- lib/restapi_doc/config.rb
+- lib/restapi_doc/config/restapi_doc.yml
+- lib/restapi_doc/method_doc.rb
+- lib/restapi_doc/railtie.rb
+- lib/restapi_doc/resource_doc.rb
+- lib/restapi_doc/tasks/restapi_doc_tasks.rake
+- lib/restapi_doc/template/assets/css/bootstrap-responsive.min.css
+- lib/restapi_doc/template/assets/css/bootstrap.less
+- lib/restapi_doc/template/assets/css/bootstrap.min.css
+- lib/restapi_doc/template/assets/css/prettify.css
+- lib/restapi_doc/template/assets/img/glyphicons-halflings-white.png
+- lib/restapi_doc/template/assets/img/glyphicons-halflings.png
+- lib/restapi_doc/template/assets/js/bootstrap.min.js
+- lib/restapi_doc/template/assets/js/jquery.js
+- lib/restapi_doc/template/assets/js/less.min.js
+- lib/restapi_doc/template/assets/js/prettify.js
+- lib/restapi_doc/template/detail.html.haml
+- lib/restapi_doc/template/index.html.haml
+- restapi_doc.gemspec
+homepage: http://github.com/alayho/restapi_doc
+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.17
+signing_key: 
+specification_version: 3
+summary: REST API doc generates an easy way to create a twitter style document for
+  your RESTful interface
+test_files: []