flyapi 0.1.0

data/Manifest

@@ -0,0 +1,7 @@
+Manifest
+README.rdoc
+Rakefile
+assets/api.css
+flyapi.gemspec
+lib/flyapi.rb
+tasks/flyapi_tasks.rake

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('flyapi', '0.1.0') do |p|
+  p.description    = "Generate API documentation for a REST-styled Rails application."
+  p.url            = "http://github.com/liammonahan/flyapi"
+  p.author         = "Liam Monahan"
+  p.email          = "liammonahan@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/assets/api.css

@@ -0,0 +1,217 @@
+body {
+	margin: 0px;
+	font-family: "Helvetica Neue", Helvetica, sans-serif;
+	font-size: 14px;
+	background-color: #EBEBEB;
+}
+
+img { border: none; }
+
+#sidebar {
+	width: 140px;
+	height: 100%;
+	margin: 0 29px 0 20px;
+	position: fixed;
+}
+
+h1 {
+	font-size: 27px;
+	font-weight: 900;
+	color: #3F3F3F;
+}
+
+.highlight {
+  margin: -25px 0 0px 0;
+  padding: 1px 0 0px 15px;
+  background: #ede7d1;
+  border-bottom: 1px solid #CCCCCC;
+}
+
+.highlight img{
+	position: relative;
+	top: 4px;
+}
+
+.highlight_bottom {
+height: 20px;
+width: 100%;
+margin-top: -6px;
+background: url("/images/header-shadow.gif") no-repeat bottom center;
+}
+
+.message {
+  margin-top: 10px;
+  background: #ede7d1;
+  border-top: 1px solid #CCCCCC;
+  border-bottom: 1px solid #CCCCCC;
+  font-size: 20px;
+  text-align: center;
+}
+
+#header {
+	margin-left: auto;
+	margin-right: auto;
+	width: 100%;
+	height: 55px;
+	padding: 0;
+	font-family: Helvetica;
+	text-decoration: none;
+	font-size: 15px;
+	background: #3f3f3f;
+	position: relative;
+	border-bottom: 1px solid #4a4a4a;
+}
+
+#header .separator {
+	color: #666666;
+}
+
+#header_links {
+	margin-left: 20px;
+}
+
+#header p{
+	float: left;
+	margin: 18px 0 0 6px;
+}
+
+#header a {
+    color: white;
+		text-decoration: none;
+}
+
+#header a:hover {
+	color: #CCCCCC;
+}
+
+#header a img {
+	align: right;
+	margin: 9px 20px 0 0;
+}
+
+a {
+	color: black;
+}
+
+#skinny_line {
+height: 1px;
+background-color: #202020;
+}
+
+hr#header_stripe {
+	height: 12px;
+	width: 100%;
+	position: relative;
+	top: -8px;
+	background-color: #191919;
+	border: none;
+	color: #191919;
+}
+
+hr.help {
+  margin-top: 20px;
+}
+
+#wrapper {
+	margin-left: auto;
+	margin-right: auto;
+	width: 910px;
+	text-align: left;
+}
+
+th {
+	text-align: center;
+	font-size: 17px;
+	color: #ACACD7;
+}
+
+td {
+	vertical-align: top;
+	text-align: left;
+	font-size: 13px;
+	line-height: 1.5
+}
+
+#top_of_footer {
+width: 100%;
+height: 10px;
+background: url("/images/header-shadow-flipped.gif") no-repeat bottom center;
+}
+
+#footer {
+	padding: 0 0 15px 0;
+	text-align: center;
+	background: #1F1D1D; /* what about #111? */
+}
+
+#footer img {
+	margin: 20px 0 0 0;
+}
+
+#footer p {
+	color: white;
+	font-size: 13px;
+}
+
+#footer a {
+	margin: 0 10px 0 0;
+	color: white;
+}
+
+#tour {
+  margin-left: -120px;
+}
+
+.right { float:right; }
+.center { margin: 0 auto; }
+
+#content { 
+  margin-left: auto;
+  margin-right: auto;
+  font-size: 13px;
+  text-align: left;
+  width: 650px; 
+  border: 1px solid #e3e3e3;
+	background-color: white;
+	padding: 15px;
+}
+
+#sidebar ul {
+	list-style-type: none;
+	text-indent: -3em;
+	list-style-position: outside;
+}
+
+#sidebar li {
+	margin: 6px 0 0 0;
+}
+
+#content .highlight h1{
+  margin: 5px 0 10px 0; 
+}
+
+.api pre {
+  background: #363131;
+  padding: 5px;
+  margin: 0 0 10px 0;
+}
+
+h3 { margin-bottom: 0; }
+
+.api code, .api code a {
+  font-size: 10px;
+  color: #fff;
+  margin: 0;
+}
+
+.api ul code {
+  color: black;
+}
+
+.api code a {
+  color: #cf9;
+}
+
+.api code span {
+  color: #cf9;
+}

data/flyapi.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flyapi}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Liam Monahan"]
+  s.date = %q{2009-12-26}
+  s.description = %q{Generate API documentation for a REST-styled Rails application.}
+  s.email = %q{liammonahan@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/flyapi.rb", "tasks/flyapi_tasks.rake"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "assets/api.css", "flyapi.gemspec", "lib/flyapi.rb", "tasks/flyapi_tasks.rake"]
+  s.homepage = %q{http://github.com/liammonahan/flyapi}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Flyapi", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{flyapi}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Generate API documentation for a REST-styled Rails application.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/flyapi.rb

@@ -0,0 +1,2 @@
+module Flyapi
+end

data/tasks/flyapi_tasks.rake

@@ -0,0 +1,44 @@
+namespace :api do
+  desc "Generate API documentation."
+  task :generate => :environment do
+    puts "Generating folder structures..."
+    `mkdir #{RAILS_ROOT}/doc/api` if File.exist?("#{RAILS_ROOT}/doc/api") == false
+    `cp #{RAILS_ROOT}/vendor/plugins/flyapi-0.1.0/assets/api.css #{RAILS_ROOT}/doc/api/api.css`
+    puts "Extracting models..."
+    models = `ls #{RAILS_ROOT}/app/models`.split("\n")
+    models.collect! { |x| x.chomp(".rb").camelize }
+    models.reject! { |x| x == "Mailer" }
+    puts "Writing files..."
+    File.open("#{RAILS_ROOT}/doc/api/index.html", "w") do |file|
+      file.puts "<html><head><title>API</title>
+		    <link href=\"#{RAILS_ROOT}/doc/api/api.css\" rel=\"stylesheet\" type=\"text/css\" />
+		    <style>
+		      body { min-width: 970px; }
+		      ul, h2 { margin: 0; }
+		    </style></head><body>"
+      sidebar(models, file)
+      models.each do |x| 
+        `mkdir #{RAILS_ROOT}/doc/api/#{x}` if File.exist?("#{RAILS_ROOT}/doc/api/#{x}") == false
+        File.open("#{RAILS_ROOT}/doc/api/#{x}/index.html", "w") do |s|
+          s.puts "<pre>"
+          s.puts "<h1>#{x}</h1>"
+          Kernel.const_get(x).column_names.each { |c| s.puts "  #{c}" }
+          s.puts "</pre>"
+        end
+      end
+      file.puts '</body></html>'
+    end
+    puts "Done!"
+  end
+end
+
+def sidebar(models, file)
+file.puts "<div id=\"sidebar\">
+    <h2>API Pages</h2>
+    <ul>"
+      models.each do |x| 
+        file.puts "<li><a href=\"#{x}/index.html\">#{x}</a></li>"
+      end
+   file.puts "</ul>
+  </div>"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: flyapi
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Liam Monahan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Generate API documentation for a REST-styled Rails application.
+email: liammonahan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/flyapi.rb
+- tasks/flyapi_tasks.rake
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- assets/api.css
+- flyapi.gemspec
+- lib/flyapi.rb
+- tasks/flyapi_tasks.rake
+has_rdoc: true
+homepage: http://github.com/liammonahan/flyapi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Flyapi
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: flyapi
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generate API documentation for a REST-styled Rails application.
+test_files: []
+