raddocs 0.0.2 → 0.0.3

data/lib/raddocs.rb

@@ -5,12 +5,12 @@ class Raddocs < Sinatra::Base
   set :haml, :format => :html5
 
   get "/" do
-    index = JSON.parse(File.read("docs/index.json"))
+    index = JSON.parse(File.read("#{docs_dir}/index.json"))
     haml :index, :locals => { :index => index }
   end
 
   get "/:resource/:example" do
-    example = JSON.parse(File.read("docs/#{params[:resource]}/#{params[:example]}.json"))
+    example = JSON.parse(File.read("#{docs_dir}/#{params[:resource]}/#{params[:example]}.json"))
     haml :example, :locals => { :example => example }
   end
 
@@ -23,4 +23,16 @@ class Raddocs < Sinatra::Base
       request.env["SCRIPT_NAME"]
     end
   end
+
+  class << self
+    attr_accessor :docs_dir
+
+    def docs_dir
+      @docs_dir ||= "docs"
+    end
+  end
+
+  def docs_dir
+    self.class.docs_dir
+  end
 end

data/lib/views/example.haml

@@ -8,51 +8,59 @@
 
   - if example["parameters"].count > 0
     %h3 Parameters
-    %table
+    %table.parameters
       %thead
         %tr
           %th Name
           %th Description
       %tbody
         - example["parameters"].each do |param|
-          %tr
+          %tr.parameter
             %td
               %span.name= param["name"]
             %td
               %span.description= param["description"]
 
-  - example["requests"].each do |request|
-    .request
+  - example["requests"].each_with_index do |request, index|
+    .request{ :id => "request-#{index}" }
       %h3 Request
 
-      %h4 Headers
-      %pre.headers= request["request_headers"]
+      %section.headers
+        %h4 Headers
+        %pre.headers= request["request_headers"]
 
-      %h4 Route
-      %pre.route.highlight== #{request["request_method"]} #{request["request_path"]}
+      %section.route
+        %h4 Route
+        %pre.route.highlight== #{request["request_method"]} #{request["request_path"]}
 
       - if request["request_query_parameters"]
-        %h4 Query Parameters
-        %pre.query_parameters.highlight= request["request_query_parameters"]
+        %section.query-parameters
+          %h4 Query Parameters
+          %pre.query-parameters.highlight= request["request_query_parameters"]
 
       - if request["request_body"]
-        %h4 Body
-        .body= request["request_body"]
+        %section.body
+          %h4 Body
+          .body= request["request_body"]
 
       - if request["curl"]
-        %h4 cURL
-        %pre= request["curl"]
+        %section.curl
+          %h4 cURL
+          %pre= request["curl"]
 
-    - if request["response_status"]
-      .response
-        %h3 Response
+      - if request["response_status"]
+        .response
+          %h3 Response
 
-        %h4 Headers
-        %pre.headers= request["response_headers"]
+          %section.headers
+            %h4 Headers
+            %pre.headers= request["response_headers"]
 
-        %h4 Status
-        %pre.status= request["response_status"]
+          %section.status
+            %h4 Status
+            %pre.status= request["response_status"]
 
-        - if request["response_body"]
-          %h4 Body
-          .body= request["response_body"]
+          - if request["response_body"]
+            %section.body
+              %h4 Body
+              .body= request["response_body"]

data/lib/views/index.haml

@@ -1,8 +1,9 @@
 %h1 Api Documentation
 
 - index["resources"].each do |resource|
-  %h2= resource["name"]
-  %ul.examples
-    - resource["examples"].each do |example|
-      %li.example
-        = link_to example["description"], "/#{example["link"].gsub(".json", "")}"
+  .resource
+    %h2= resource["name"]
+    %ul.examples
+      - resource["examples"].each do |example|
+        %li.example
+          = link_to example["description"], "/#{example["link"].gsub(".json", "")}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raddocs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-23 00:00:00.000000000 Z
+date: 2012-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70257893115780 !ruby/object:Gem::Requirement
+  requirement: &70252117740960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257893115780
+  version_requirements: *70252117740960
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70257893114820 !ruby/object:Gem::Requirement
+  requirement: &70252117699660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257893114820
+  version_requirements: *70252117699660
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70257893114240 !ruby/object:Gem::Requirement
+  requirement: &70252117638640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,54 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257893114240
+  version_requirements: *70252117638640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70252113306280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252113306280
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70252121997380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252121997380
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70252121924620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252121924620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70252121928480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252121928480
 description: Browse documentation generated by the rspec_api_documentation gem
 email:
-- eric@smartlogicsolutions.com
+- eric@oestrich.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -56,7 +100,7 @@ files:
 - lib/views/example.haml
 - lib/views/index.haml
 - lib/views/layout.haml
-homepage: http://smartlogicsolutions.com
+homepage: http://github.com/oestrich/raddocs
 licenses: []
 post_install_message: 
 rdoc_options: []