apidocs 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb78f9303f77d1e79cc699920da79e6cdd83a76
-  data.tar.gz: 436c973b2bcfc270e31f8ec9245f983bbc0805c2
+  metadata.gz: 23ce21f1585d8d57c49827f01a859ada6c85a8a9
+  data.tar.gz: f188f609d02c9f7b576ee0e2465c098552fddf87
 SHA512:
-  metadata.gz: e811590754e9af2c13c39d7e8436d89ee7f264abb1de0ab954eff57bd237209667908e2a16ba647f56b159b64836a5f21970b1dd5d860a13987d0cce6b2e8de1
-  data.tar.gz: b4aa56b568dc4039cf37a3a3e12c299bbd78f2e5fb0c3b329e6f174b909542cd21f11319b8b1a83d65204c431973d4b272c515fc6fc3148766382099d882f0fc
+  metadata.gz: b72c69640d2092773e8e33a184a13ece507ec10561271102e6c37780b5dae3c425a2bd0f67635a9ced1901fb5157136a082b3188f4803e8eb555f828f04e3aa2
+  data.tar.gz: be363524935efb6957511d522d12d05aed221c2c96b91129ec0eff9df72d8e00da454e7a65e22a11e681f6760b4eec09f1b780e1d2a41c873ab55e2a18f5a1ec

data/README.md

@@ -1,18 +1,30 @@
-apidocs
+APIDOCS
 =======
 
-Generates and serves HTML documentation out of your routing and controllers for your Rails apps
+Generates on fly and serves RDoc documentation out of your controllers actions.
+
+Implemented as rails engine 
 
 Installation
 =======
+Apidocs works with Rails 3.2 onwards. You can add it to your Gemfile with:
+
+```gem 'apidocs'```
+
+Run the bundle command to install it.
 
 Add ```mount Apidocs::Engine => "/apidocs"``` to your applications ```routes.rb```  
 
 Configuration
 =======
 
+For better safety, in configuration file there is a MD5 hash of password used instead of actual password. 
+To generate it for your configuration use Digest::MD5.hexdigest('YOUR-PASSWORD-HERE'). 
+It can be done in irb after requiring 'digest/md5'.
+
     Apidocs.configure  do |config|
-      config.regex_filter = /api/ # filter routes
+      config.regex_filter = /\A\/api/ # filter routes
       config.http_username = 'admin'  # optional http basic authorization 
       config.http_password = '5ebe2294ecd0e0f08eab7690d2a6ee69' # md5 hash for password
+      config.app_name = 'Test APP' # application name
     end

data/app/controllers/apidocs/apidocs_controller.rb

@@ -3,10 +3,10 @@ require_dependency "apidocs/application_controller"
 module Apidocs
   class ApidocsController < ApplicationController
     before_action :authenticate
+    before_action :clean_cache, if: -> { Rails.env.development? }
 
     def index
       @routes = routes_rdoc
-
       if params[:search]
         @searchinput = params[:search]
       end
@@ -14,20 +14,10 @@ module Apidocs
       if params[:path]
         @route = routes_rdoc[params[:path]]
       else
-        begin
-          h = RDoc::Markup::ToHtml.new(RDoc::Options.new)
-          @intro = h.convert(Rails.root.join('API.rdoc').read)
-        rescue
-          @intro = "Please put API.rdoc into "+Rails.root.to_s
-        end
+        @intro = intro_rdoc
       end
     end
 
-    def flush
-      Rails.cache.delete("routes_rdoc_html")
-      redirect_to :back
-    end
-
     private
 
     def routes_rdoc
@@ -37,6 +27,12 @@ module Apidocs
       end
     end
 
+    def intro_rdoc
+      RDoc::Markup::ToHtml.new(RDoc::Options.new).convert(Rails.root.join('API.rdoc').read)
+    rescue
+      ""
+    end
+
     def authenticate
       if Apidocs.configuration.http_username && Apidocs.configuration.http_password
         authenticate_or_request_with_http_basic do |u, p|
@@ -44,6 +40,9 @@ module Apidocs
         end
       end
     end
+
+    def clean_cache
+      Rails.cache.delete("routes_rdoc_html")
+    end
   end
 end
-

data/app/views/apidocs/apidocs/index.html.erb

@@ -1,18 +1,22 @@
 <% content_for :nav do %>
-    <ul id="search-list" class="list-unstyled">
-        <% @routes.each do |path, route| %>
-            <li><%= link_to path, root_path(path: path), class: 'nav-button', title: path %></li>
-        <% end %>
-    </ul>
+  <ul id="search-list" class="list-unstyled">
+  <% @routes.each do |path, route| %>
+    <li><%= link_to path, root_path(path: path), class: 'nav-button', title: path %></li>
+  <% end %>
+  </ul>
 <% end %>
+
 <% if @intro %>
-    <%= @intro.html_safe %>
+  <%= @intro.html_safe %>
 <% end %>
+
 <% if @route %>
-    <% @route.each do |r| %>
-        <h3 class="action-name">
-            <%= r[:verb] %> <%= r[:path] %>
-        </h3>
-        <%= r[:html_comment].html_safe %>
-    <% end %>
+  <% @route.each do |r| %>
+
+    <h3 class="action-name">
+      <%= r[:verb] %> <%= r[:path] %>
+    </h3>
+
+    <%= r[:html_comment].html_safe %>
+  <% end %>
 <% end%>

data/app/views/layouts/apidocs/application.html.erb

@@ -1,33 +1,34 @@
 <!DOCTYPE html>
 <html>
-<head>
-    <title>Apidocs</title>
+  <head>
+    <title><%= Apidocs.configuration.app_name %> API</title>
     <%= stylesheet_link_tag "apidocs/application", media: "all" %>
     <%= javascript_include_tag "apidocs/application" %>
     <%= csrf_meta_tags %>
-</head>
-<body>
+  </head>
 
-<div class="container-fluid">
-    <nav class="navbar navbar-default" role="navigation">
-        <div class="container-fluid">
-            <%= link_to 'APIDOC', root_path, class: 'navbar-brand' %>
-            <form class="navbar-form navbar-left" role="search">
-                <div class="form-group">
-                    <input type="text"	value='<%= @searchinput %>' class="search-query" id="search-input" placeholder="Filter">
-                </div>
+  <body>
+    <div class="container">
+      <div class="row">
+        <nav class="navbar navbar-default" role="navigation">
+          <%= link_to "#{Apidocs.configuration.app_name} API", root_path, class: 'navbar-brand' %>
+        </nav>
+
+        <div class="col-md-3">
+          <div class="row">
+            <form class="col-md-12" role="search">
+              <div class="form-group">
+                <input type="text" value='<%= @searchinput %>' class="form-control" id="search-input" placeholder="Filter">
+              </div>
+
+              <nav><%= yield(:nav) %></nav>
             </form>
+          </div>
         </div>
-    </nav>
-    <div class="row">
-        <div class="col-md-2">
-            <nav><%= yield(:nav) %></nav>
-        </div>
-        <div class="col-md-10">
-            <article id="main-content"><%= yield %></article>
+        <div class="col-md-9">
+          <article id="main-content"><%= yield %></article>
         </div>
+      </div>
     </div>
-    <%= link_to "&#8634;".html_safe, flush_path, id: 'reload' %>
-</div>
-</body>
+  </body>
 </html>

data/config/routes.rb

@@ -1,4 +1,3 @@
 Apidocs::Engine.routes.draw do
   root "apidocs#index"
-  get '/flush' => 'apidocs#flush' ,as: :flush
 end

data/lib/apidocs.rb

@@ -9,7 +9,7 @@ module Apidocs
     # generate_html entry point for on fly document generation
     def generate_html
       FileUtils.rm_rf(Rails.root.join('tmp/apidocs'))
-      options = ["app/controllers", "--op=#{Rails.root.join('tmp/apidocs')}"]
+      options = [Rails.root.join("app/controllers").to_s, "--op=#{Rails.root.join('tmp/apidocs')}"]
 
       self.store = RDoc::Store.new
 
@@ -73,7 +73,7 @@ module Apidocs
   end
 
   class Configuration
-    attr_accessor :regex_filter, :http_username, :http_password
+    attr_accessor :regex_filter, :http_username, :http_password, :app_name
     def initialize
       @regex_filter = /.*/
     end

data/lib/apidocs/version.rb

@@ -1,3 +1,3 @@
 module Apidocs
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: apidocs
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
+- Hubert Łępicki
+- Dominika Kruk
 - Vladimir Motsak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,22 +68,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: On Fly RDoc generation
+description: Rails engine that will generate and serve docs for your APIs if you documented
+  your controllers using RDoc
 email:
+- hubert.lepicki@gmail.com
 - vmotsak@gmail.com
 executables: []
 extensions: []
@@ -105,7 +95,7 @@ files:
 - lib/apidocs/engine.rb
 - lib/apidocs/version.rb
 - lib/tasks/apidocs_tasks.rake
-homepage: http://github.com/vmotsak/apidocs
+homepage: http://github.com/hubertlepicki/apidocs
 licenses:
 - MIT
 metadata: {}