raddocs 0.0.3 → 0.1.0

data/lib/raddocs.rb

@@ -1,38 +1,15 @@
 require 'sinatra'
 require 'json'
+require 'raddocs/configuration'
+require 'raddocs/app'
+require 'raddocs/middleware'
 
-class Raddocs < Sinatra::Base
-  set :haml, :format => :html5
-
-  get "/" do
-    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_dir}/#{params[:resource]}/#{params[:example]}.json"))
-    haml :example, :locals => { :example => example }
-  end
-
-  helpers do
-    def link_to(name, link)
-      %{<a href="#{request.env["SCRIPT_NAME"]}#{link}">#{name}</a>}
-    end
-
-    def url_location
-      request.env["SCRIPT_NAME"]
-    end
-  end
-
-  class << self
-    attr_accessor :docs_dir
-
-    def docs_dir
-      @docs_dir ||= "docs"
-    end
+module Raddocs
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  def docs_dir
-    self.class.docs_dir
+  def self.configure
+    yield configuration if block_given?
   end
 end

data/lib/raddocs/app.rb

@@ -0,0 +1,42 @@
+module Raddocs
+  class App < Sinatra::Base
+    set :haml, :format => :html5
+    set :root, File.join(File.dirname(__FILE__), "..")
+
+    get "/" do
+      index = JSON.parse(File.read("#{docs_dir}/index.json"))
+      haml :index, :locals => { :index => index }
+    end
+
+    get "/*" do
+      file = "#{docs_dir}/#{params[:splat][0]}.json"
+
+      if !File.exists?(file)
+        raise Sinatra::NotFound
+      end
+
+      file_content = File.read(file)
+
+      example = JSON.parse(file_content)
+      haml :example, :locals => { :example => example }
+    end
+
+    not_found do
+      "Example does not exist"
+    end
+
+    helpers do
+      def link_to(name, link)
+        %{<a href="#{request.env["SCRIPT_NAME"]}#{link}">#{name}</a>}
+      end
+
+      def url_location
+        request.env["SCRIPT_NAME"]
+      end
+    end
+
+    def docs_dir
+      Raddocs.configuration.docs_dir
+    end
+  end
+end

data/lib/raddocs/configuration.rb

@@ -0,0 +1,23 @@
+module Raddocs
+  class Configuration
+    def self.add_setting(name, opts = {})
+      define_method("#{name}=") { |value| settings[name] = value }
+      define_method("#{name}") do
+        if settings.has_key?(name)
+          settings[name]
+        elsif opts[:default].respond_to?(:call)
+          opts[:default].call(self)
+        else
+          opts[:default]
+        end
+      end
+    end
+
+    add_setting :docs_dir, :default => "docs"
+    add_setting :docs_mime_type, :default => /text\/docs\+plain/
+
+    def settings
+      @settings ||= {}
+    end
+  end
+end

data/lib/raddocs/middleware.rb

@@ -0,0 +1,24 @@
+module Raddocs
+  class Middleware
+    def initialize(app)
+      @app = app
+      @file_server = Rack::File.new(Raddocs.configuration.docs_dir)
+    end
+
+    def call(env)
+      if env["HTTP_ACCEPT"] =~ Raddocs.configuration.docs_mime_type
+        env = env.merge({ "PATH_INFO" => File.join(env["PATH_INFO"], "index.txt") })
+        response = @file_server.call(env)
+
+        if response[0] == 404
+          body = "Docs are not available for this resource.\n"
+          response = [404, {"Content-Type" => "type/plain", "Content-Length" => body.size.to_s}, [body]]
+        end
+
+        response
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/views/example.haml

@@ -41,7 +41,9 @@
       - if request["request_body"]
         %section.body
           %h4 Body
-          .body= request["request_body"]
+          .body
+            :preserve
+              #{request["request_body"]}
 
       - if request["curl"]
         %section.curl
@@ -63,4 +65,6 @@
           - if request["response_body"]
             %section.body
               %h4 Body
-              .body= request["response_body"]
+              .body
+                :preserve
+                  #{request["response_body"]}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raddocs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70252117740960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252117740960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70252117699660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252117699660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70252117638640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252117638640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70252113306280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70252113306280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70252121997380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70252121997380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70252121924620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70252121924620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70252121928480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +117,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70252121928480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Browse documentation generated by the rspec_api_documentation gem
 email:
 - eric@oestrich.org
@@ -96,6 +131,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/public/bootstrap.min.css
+- lib/raddocs/app.rb
+- lib/raddocs/configuration.rb
+- lib/raddocs/middleware.rb
 - lib/raddocs.rb
 - lib/views/example.haml
 - lib/views/index.haml
@@ -120,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Browse documentation generated by the rspec_api_documentation gem