apidocs 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bfe483d12b61ff4f45099d88d9c8718f821174d
-  data.tar.gz: 582aaeb27ea6b21ddf24123401431dcb1e2f04aa
+  metadata.gz: 73da5aca8b695e550bfc631d3f42fe6e6a585e2f
+  data.tar.gz: 39f4d0400b003afa6800405a4b3c3d00e7de5007
 SHA512:
-  metadata.gz: f466a7b4fa9578aa603d39e1b19c833ee8f4063625bce6a03fc36d196aa208d21f6854eb729f6997fae0cd037d276064f19ef7bb1fb397ec57603986db8c7611
-  data.tar.gz: e50172ab4831f655fe508f9416241af2767968d8aaf560361832ef5353f69d4c8fbab3b498a722fc9102cb86234af52aaeaf2d359463d04b1f2bddbe8724c70f
+  metadata.gz: bf08c415f14ea8dd154fad843d3c4ca715f68818518651f8db950bcfeed07f8f9cfb917a573f34e26bfd6519b7961bcda6cd3c8c47492fd5d5aa7e16c4d0239d
+  data.tar.gz: 5755ff5c3718c667e12368713b4e956fe9221ac9df9c6dbeee8861414f05e2a2f5425d6e12899d87d4253855f0f3e43e56c9037eaa5e029ca6b28d35841b5fb8

data/README.md

@@ -6,4 +6,13 @@ Generates and serves HTML documentation out of your routing and controllers for
 Installation
 =======
 
-Add <code>mount Apidocs::Engine => "/apidocs"</code> to your applications <code>routes.rb</code>  
+Add ```mount Apidocs::Engine => "/apidocs"``` to your applications ```routes.rb```  
+
+Configuration
+=======
+
+    Apidocs.configure  do |config|
+      config.regex_filter = /api/ # filter routes
+      config.http_username = 'admin'  # optional http basic authorization 
+      config.http_password = '5ebe2294ecd0e0f08eab7690d2a6ee69' # md5 hash for password
+    end

data/app/assets/javascripts/apidocs/apidocs.js

@@ -1,9 +1,8 @@
 $(function () {
-    $("#nav-button").click(function () {
-        $.get(this.getAttribute("href"), function (data) {
-            $("#main-content").html(data);
-        });
+    $('.nav-button').click(function () {
+        window.location.href = this.getAttribute("href") + '&search=' + $('#search-input').val();
         return false;
     });
     $('#search-input').fastLiveFilter('#search-list');
-});
+    $('#search-input').trigger('change');
+});

data/app/assets/stylesheets/apidocs/apidocs.css.scss

@@ -19,4 +19,9 @@ pre {
 #main-content h2 a,
 #main-content h1 a {
     display: none;
+}
+
+ul#search-list li {
+    text-overflow: ellipsis;
+    overflow: hidden;
 }

data/app/controllers/apidocs/apidocs_controller.rb

@@ -2,8 +2,15 @@ require_dependency "apidocs/application_controller"
 
 module Apidocs
   class ApidocsController < ApplicationController
+    before_action :authenticate
+
     def index
       @routes = routes_rdoc
+
+      if params[:search]
+        @searchinput = params[:search]
+      end
+
       if params[:path]
         @route = routes_rdoc[params[:path]]
       else
@@ -22,11 +29,21 @@ module Apidocs
     end
 
     private
+
     def routes_rdoc
       Rails.cache.fetch("routes_rdoc_html") do
         routes = Apidocs::ApiDocs.new.generate_html
         routes.group_by { |r| r[:path] }
       end
     end
+
+    def authenticate
+      if Apidocs.configuration.http_username && Apidocs.configuration.http_password
+        authenticate_or_request_with_http_basic do |u, p|
+          u == Apidocs.configuration.http_username && Digest::MD5.hexdigest(p) == Apidocs.configuration.http_password
+        end
+      end
+    end
   end
 end
+

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

@@ -1,7 +1,7 @@
 <% 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' %></li>
+            <li><%= link_to path, root_path(path: path), class: 'nav-button', title: path %></li>
         <% end %>
     </ul>
 <% end %>

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

@@ -14,7 +14,7 @@
             <%= link_to 'APIDOC', root_path, class: 'navbar-brand' %>
             <form class="navbar-form navbar-left" role="search">
                 <div class="form-group">
-                    <input type="text" class="search-query" id="search-input" placeholder="Search">
+                    <input type="text"	value='<%= @searchinput %>' class="search-query" id="search-input" placeholder="Filter">
                 </div>
             </form>
         </div>

data/lib/apidocs.rb

@@ -6,7 +6,7 @@ module Apidocs
   require 'fileutils'
   # This is class comment
   class ApiDocs < RDoc::RDoc
-    # generate_html  entry point for on fly document generation
+    # 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')}"]
@@ -20,10 +20,10 @@ module Apidocs
       @last_modified = setup_output_dir @options.op_dir, @options.force_update
 
       @store.encoding = @options.encoding if @options.respond_to? :encoding
-      @store.dry_run  = @options.dry_run
-      @store.main     = @options.main_page
-      @store.title    = @options.title
-      @store.path     = @options.op_dir
+      @store.dry_run = @options.dry_run
+      @store.main = @options.main_page
+      @store.title = @options.title
+      @store.path = @options.op_dir
 
       @start_time = Time.now
       @store.load_cache
@@ -31,18 +31,19 @@ module Apidocs
 
       parse_files @options.files
       @store.complete @options.visibility
-
+      Apidocs.configuration.regex_filter
       all_routes = Rails.application.routes.routes
       inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-      routes = inspector.send(:collect_routes, inspector.send(:filter_routes, nil)).select {|r| r[:reqs] =~ /#/}
+      routes = inspector.send(:collect_routes, inspector.send(:filter_routes, nil))\
+         .select { |r| r[:reqs] =~ /#/ and (r[:path] =~ Apidocs.configuration.regex_filter) if Apidocs.configuration.regex_filter}
 
       formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new)
 
       routes = routes.map do |r|
-        { verb: r[:verb],
-          path: r[:path].sub('(.:format)',''),
-          class_name: gen_class_name(r),
-          action_name: gen_action_name(r)
+        {verb: r[:verb],
+         path: r[:path].sub('(.:format)', ''),
+         class_name: gen_class_name(r),
+         action_name: gen_action_name(r)
         }
       end
 
@@ -51,7 +52,7 @@ module Apidocs
         r[:html_comment] = doc ? doc.accept(formatter) : ""
       end
 
-      routes.select {|r| r[:class_name] != "ApidocsController" }
+      routes.select { |r| r[:class_name] != "ApidocsController" }
     end
 
     private
@@ -71,6 +72,23 @@ module Apidocs
     end
   end
 
+  class Configuration
+    attr_accessor :regex_filter, :http_username, :http_password
+    def initialize
+      @regex_filter = /.*/
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
+  def self.configure
+    yield(configuration)
+  end
 
 end

data/lib/apidocs/version.rb

@@ -1,3 +1,3 @@
 module Apidocs
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apidocs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vladimir Motsak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails