apitest 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9c932efea1742c420d8d73ec4982d99ff9fb8ed
-  data.tar.gz: 96916744dcf87a1518ca7c5adefedcc9655b502a
+  metadata.gz: 81fc56ffb2514081bf6f44b460f844c922f148b5
+  data.tar.gz: 002c7eddb0329509034747a287b19ba04cd3fb2d
 SHA512:
-  metadata.gz: 345924cb41f29583ec7ca0f00788940dc88f80599d9f5a0f0fdc56a567d4678e2f401c11b238911b130c6f09f7a2a0dbe9268eb118bbdb784a6c50d7080b46bc
-  data.tar.gz: be819f5df9595df40196f32b53b9aa995c801c6a9cc57d7d779c45ebe4f2bba9f1ddf1105c6ca7c207b7db4e9c28160c0c64ad0cf5bc8275e36563e2ba2b3e90
+  metadata.gz: 0e4b74aebaeb67a44a9b7bfe8b51c07c8265684bfdc9e4714b32b17e26b5fd16db3f7624c6d1beafcde041af168ce28d451f3ea6f27a3b764536c59f0aeaf63d
+  data.tar.gz: ef145628b987cab510cf778c7157d5d55dcb63983bfac399b2f338f140b4776a02afdc27d4d53167ab9d219a187405fa283815c6a7e5325158a99a0463fbd4d9

data/README.md

@@ -2,7 +2,7 @@
 Short description and motivation.
 
 ## Version 
-0.1.4
+0.1.5
 
 ## Installation
 添加如下代码到 Gemfile:
@@ -45,20 +45,56 @@ $ brew install lsof #MacOS
 │   │       ├── barfoo_controller.rb
 ```
 
-mount apitest到指定url，比如：
+在routes.rb 配置apitest 目录，比如：
 
 ```ruby
-mount Apitest::Engine => "/apitest"
+  apitest_for '/apitest'
 
 ```
 
 浏览器中访问apitest 的url
 
+默认api目录为controllers/api，目录可指定
+
+```ruby
+  apitest_for '/apitest' do 
+    Apitest::api_dir 'api'
+  end 
+```
+
+默认使用blue-theme，可指定theme ，theme使用 AdminLTE，直接指定AdminLTE的theme即可：
+
+``` ruby
+  apitest_for '/apitest' do 
+    Apitest::theme  'purple-light'
+  end
+```
+theme列表如下
+```
+black-light
+black
+blue-light
+blue
+green-light
+green
+purple-light
+purple
+red-light
+red
+yellow-light
+yellow
+```
 
 
 
 ## TODO
-- [ ] 可自定义api目录
+- [x] 可自定义api目录
+- [x] 可自定义theme
+- [ ] ERROR类工具
+- [ ] APIDOC美化
+- [ ] 权限控制
+- [ ] 测试数据准备，测试用例
+- [ ] 测试中心
 
 ## Contributing
 

data/app/assets/config/apitest_manifest.js

@@ -1,2 +1,2 @@
 //= link_directory ../javascripts/apitest .js
-//= link_directory ../stylesheets/apitest .css
+//= link_directory ../stylesheets/apitest 

data/app/assets/stylesheets/apitest/application.scss

@@ -1,5 +1,5 @@
 // Place all the styles related to the apitest/v1 controller here.
-// They will automatically be included in application.css.
+// They will automatically be included in application.
 // You can use Sass (SCSS) here: http://sass-lang.com/
 //= require_directory .
 //= require bootstrap

data/app/controllers/apitest/apitest_controller.rb

@@ -2,7 +2,11 @@ require_dependency "apitest/application_controller"
 
 module Apitest
   class ApitestController < ApplicationController
-    before_action :get_doc
+    before_action :get_doc ,:root_url
+    def initialize
+      super
+      @apidocs = {}
+    end
     def index
       respond_to do |format|
         format.json { render json: @apidocs}
@@ -17,43 +21,48 @@ module Apitest
       end
     end
   
-    private    
-    def get_doc
-      path_root = "app/controllers/api/"
-      @apidocs = {}
-      Dir.glob("#{path_root}*").map do |path|
-        if File.directory?(path)
-          @apidocs[path.gsub("#{path_root}" , '')] =  get_version_doc "#{path}/"
-        end
-      end
+    private  
+    def root_url
       @root_url = main_app.root_url[0,main_app.root_url.length - 1]
-    end
+    end  
 
-    def get_version_doc(path_root)
-      
-      docs = {
+    def docs_base 
+      {
         '业务API' => [] ,
         '工具API' => [] ,
         '辅助API' => []
       }
-      dirs = []
-      Dir.glob("#{path_root}*_controller.rb").each do |path|
-        controller_name_base = path.gsub(path_root , '').gsub('.rb' , '').singularize.camelize
-        controller_class = "Api::V1::#{controller_name_base}".constantize
-        if defined? controller_class::APIDOC
-          token_need = {
-            token: {
-              text: 'token' ,
-              required: true ,
-            }
-          } 
-          doc = controller_class::APIDOC 
-          doc[:sort] = 99 if doc[:sort].blank?
-          doc[:apis].each do |k,v|
-            doc[:apis][k][:params] = token_need.merge doc[:apis][k][:params] unless v[:token] == false
-          end 
-          docs[doc[:type]] = [] if docs[doc[:type]].blank?
-          docs[doc[:type]].push doc
+    end
+    def get_doc(path_root = nil)
+      path_root ||= "app/controllers/#{Apitest.api_dir}/"
+      Dir.glob("#{path_root}*").each do |path|
+        @apidocs[path.gsub("#{path_root}" , '')] =  get_version_doc "#{path}/" if File.directory?(path) && !path.gsub("#{path_root}" , '').blank?
+      end
+    end
+
+    def get_version_doc(path_root)
+      docs = docs_base
+      Dir.glob("#{path_root}/*").each do |path|
+        if File.directory?(path)
+          docs = docs.merge get_version_doc(path)
+        else
+          class_match      = File.open(path).read.match(/class (.*) </)
+          controller_class = class_match[1].constantize if class_match && class_match[1]
+          if defined? controller_class::APIDOC
+            token_need = {
+              token: {
+                text: 'token' ,
+                required: true ,
+              }
+            } 
+            doc = controller_class::APIDOC 
+            doc[:sort] = 99 if doc[:sort].blank?
+            doc[:apis].each do |k,v|
+              doc[:apis][k][:params] = token_need.merge doc[:apis][k][:params] unless v[:token] == false
+            end 
+            docs[doc[:type]] = [] if docs[doc[:type]].blank?
+            docs[doc[:type]].push doc
+          end
         end
       end
       docs

data/app/views/layouts/apitest/application.slim

@@ -5,7 +5,7 @@ html
     = csrf_meta_tags 
     = stylesheet_link_tag    'apitest/application', 'data-turbolinks-track': 'reload' , media: 'all'
     = javascript_include_tag 'apitest/application', 'data-turbolinks-track': 'reload' 
-  body.hold-transition.skin-purple-light.sidebar-mini
+  body.hold-transition.sidebar-mini class="skin-#{Apitest::theme}"
     .wrapper id="apitest_#{params[:action]}"
       header.main-header
         a.logo href="#{root_path}" 

data/config/routes.rb

@@ -1,5 +1,5 @@
 Apitest::Engine.routes.draw do
-  resources :apitest
+  # resources :apitest
   root to: 'apitest#index'
   get '/:id' , to: 'apitest#show'
 end

data/lib/apitest/version.rb

@@ -1,3 +1,3 @@
 module Apitest
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/apitest.rb

@@ -10,17 +10,19 @@ require 'eventmachine-tail'
 require 'websocket-eventmachine-server'
 
 module Apitest
-  class Reader < EventMachine::FileTail
-    def initialize(path, startpos=-1, &block)
-      super(path, startpos)
-      @buffer = BufferedTokenizer.new
-      @block = block
-    end
+  @api_dir
+  @theme
 
-    def receive_data(data)
-      @buffer.extract(data).each { |line| @block.call(line) }
-    end
+  def self.api_dir(dir = nil)
+    @api_dir = dir if dir
+    @api_dir
+  end
+
+  def self.theme(theme = nil)
+    @theme = theme if theme
+    @theme
   end
+  
   def self.start_server_log_listen
     Process.detach(
       fork do
@@ -44,7 +46,28 @@ module Apitest
       end
     )
   end
-end
 
+  class Reader < EventMachine::FileTail
+    def initialize(path, startpos=-1, &block)
+      super(path, startpos)
+      @buffer = BufferedTokenizer.new
+      @block = block
+    end
 
+    def receive_data(data)
+      @buffer.extract(data).each { |line| @block.call(line) }
+    end
+  end
+end
+
+module ActionDispatch::Routing
+  class Mapper
+    def apitest_for(path , &block)
+      mount Apitest::Engine => path
+      Apitest::api_dir    'api'
+      Apitest::theme      'blue-light'
+      block.call
+    end
+  end
+end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitest
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kyuubi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails