apitest 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0633ebdeafbf793f850ec77c572c6e10687c1aa
-  data.tar.gz: c8a24eb02574bf285718e4b2a1ea651168e11193
+  metadata.gz: 573eef6c4af633b41ade5cf70edc2abb18676367
+  data.tar.gz: d128c020fe260b55e550d90b2e4c59089db4e63d
 SHA512:
-  metadata.gz: 4f9234362ef3cb83cc44be3368aee0a21c8d6c82bbf1d1d2d5a67b28ffb010090372e4858aab9749071d7b719de690bfab6a3c36e7d60279200d386fc0a2f994
-  data.tar.gz: b96dc2f3036ffd72dec49ab2744cd491ffab60b8f92e059b361e268801c35e78588ba419248d1b71a197029fc75ba7d8b0f9235ecff95239070255642414ba5f
+  metadata.gz: d1b50589b5877b6f1c96d8bfc00d86962a96e3954d7da75e5667a34eb514d7e872a49372f25607b146a5d2cf430837575148f02585fd0e0c1bd7efbc8a0dc265
+  data.tar.gz: fcb4faabaad7d12e54d5ffb56320f721b3214a5b92ae35da169b25dbb6a9ad35f986dca6bfb6ab171460ee130cbd77b4790174e9f4e04b65dc12d89602b0053a

data/README.md

@@ -1,11 +1,11 @@
 # Apitest
-- 通过在API controller里的常量，配置API文档
+- 通过在API controller里配置常量，生成API文档
 - 并附带一个测试界面，辅助API开发。
 - 适用与API开发人员，客户端/前端开发人员交流验证文档。
-- 目前无出参，需要提交后，得到无法完全替代API文档
+- 目前无出参，需要提交后，得到。无法完全替代API文档
 
 ## Version 
-0.1.9
+0.2.0
 
 ## Installation
 添加如下代码到 Gemfile:
@@ -137,14 +137,71 @@ Rails.application.routes.draw do
 end
 ```
 
+如果所有API有公共必填项，例如token,version，可如下配置
+
+```ruby
+Rails.application.routes.draw do
+
+  apitest_for '/apitest' do 
+    Apitest::public_required  [ 'token' , 'version'  ]
+  end
+
+end
+```
+
+可以在指定APITEST中关闭公共必填项，比如登录API，可在具体方法的APIDOC中使用false设定
+
+```ruby
+token:false
+```
+
+完整配置方法如下
+```ruby
+class Api::V1::LoginController < ApplicationController
+
+  APIDOC = {
+    type:       '业务API' , 
+    group_name: '用户登录' ,
+    sort:      1 ,
+    apis: {
+      create: {
+        api_name:   '登录' ,
+        path:       '/api/v1/login' ,
+        method:     'post' ,
+        token:      false ,      # 这里可关闭该API的token选项
+        params: {
+          mobile: {
+            required: true ,
+          } ,
+          password: {
+            required: true
+          }
+        }
+      } 
+    }
+  }
+  def create
+    ...
+  end
+  
+```
+
+
+
+
+
+
 
 
 ## TODO
 - [x] 可自定义api目录
 - [x] 可自定义theme
 - [x] 可配置分类
-- [ ] 可设定所有API都有的必填项，比如token、客户端类型、客户端版本号
+- [x] 可设定公共必填项，比如token、客户端类型、客户端版本号
+- [x] 公共必填项可在指定API中关闭
+- [x] 支持header token和params token
 - [ ] ERROR类工具
+- [ ] 出参example
 - [ ] Apitest Example 网站
 - [ ] 使用前端route
 - [ ] 生成前端mock数据

data/app/assets/javascripts/apitest/application.coffee

@@ -5,6 +5,7 @@
 #= require jquery3
 #= require jquery_ujs
 #= require turbolinks
+#= require lodash
 #= require bootstrap
 #= require adminlte/adminlte
 #= require vue
@@ -17,6 +18,7 @@ $(document).on "turbolinks:load" , ->
     vm = new Vue
       el : '#apitest_show'
       data : 
+        apitest_tab_show : 'api_test'
         root_url      : null
         apis          : null
         ws            : null
@@ -24,21 +26,39 @@ $(document).on "turbolinks:load" , ->
         current_group : ''
         current_api   : ''
         token         : ''
-        apitest_tab_show : 'api_test'
+        token_type    : ''
+        token_set     : {}
+        token_get     : []
+        headers       : {}
       mounted : ->
         @apis         = $('#data').data('apis')
-        @token        = $('#data').data('token')
+        @token_set    = $('#data').data('token-set')
+        @token_get    = $('#data').data('token-get')
+        @token_type   = @token_set[0]
         @output_area  = $('#server-logs-output')
         @root_url     = $('#data').data('root-url')
         @get_log()
+        @set_token(localStorage.apitest_token)
+        # @token_set()
 
       methods : 
-        
+        set_token : (token) ->
+          @token = token
+          localStorage.apitest_token = token
+          @set_header_token() if @token_set[0] == 'header'
+            
+        set_header_token : ->
+          @headers[@token_set[1]] = @token
+
+        fetch_token : (params) ->
+          token = eval 'params["' + @token_get.join('"]["') + '"]'
+          @set_token(token) if token
+
         group_select : (name) ->
           @current_group  = name
           @current_api    = ''
 
-        api_select : (name ) ->
+        api_select : (name) ->
           @current_api    = name
 
         api_submit : (e) ->
@@ -50,17 +70,23 @@ $(document).on "turbolinks:load" , ->
           postData    = {}
 
           elm.find('.params').each ->
-
             postData[$(this).attr('name')] = $(this).val() unless $(this).attr('name').indexOf(':id') >= 0
-          
+
           $.ajax 
             url       : path
             type      : method
             data      : postData
+            headers   : @headers
             success   : (data) =>
               result_pre.jsonViewer(data)
+              @fetch_token(data)
             error     : (data) =>
-              result.val data.responseText
+              try
+                result_pre.jsonViewer(JSON.parse(data.responseText))
+              catch e
+                result_pre.text(data.responseText)
+              
+              
 
         clear_result  : (e) ->
           $(e.target).parents('.api').find('.result_pre').html('')

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

@@ -24,6 +24,8 @@
     background-color: #fff;
     height: 514px;
     border-radius: 0px;
+    white-space: pre-wrap;
+    word-wrap: break-word;
     padding: 15px 30px 15px 30px;
   }
   .nav-pills.nav-stacked{

data/app/controllers/apitest/apitest_controller.rb

@@ -5,7 +5,10 @@ module Apitest
     before_action :get_doc ,:root_url
     def initialize
       super
-      @apidocs = {}
+      @apidocs    = {}
+      @headers    = Apitest::set_headers
+      @token_set =  Apitest::token_setting[:set]
+      @token_get =  Apitest::token_setting[:get]
     end
     def index
       respond_to do |format|
@@ -29,24 +32,24 @@ module Apitest
     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?
+        @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 = Apitest::default_types.clone
+    def get_version_doc(path_root , docs = {})
+      docs = Apitest::default_types.clone if docs.blank?
       Dir.glob("#{path_root}/*").each do |path|
         if File.directory?(path)
-          docs = docs.merge get_version_doc(path)
+          docs = docs.merge get_version_doc(path , docs)
         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
-            doc = controller_class::APIDOC 
-            doc[:sort] = 99 if doc[:sort].blank?
+            doc         = controller_class::APIDOC 
+            doc[:sort]  = 99 if doc[:sort].blank?
             doc[:apis].each do |k,v|
               d = doc[:apis][k]
-              d           = public_required d                               unless Apitest::public_required.blank? 
+              d = public_required d                               unless Apitest::public_required.blank? 
               d[:params]  = {':id' => { required: true }}.merge d[:params]  if d[:path].include? ':id'
             end 
             
@@ -55,13 +58,13 @@ module Apitest
           end
         end
       end
-      docs
+      return docs
     end
     def public_required(api)
       Apitest::public_required.reverse.each do |need|
         api[:params] = need.merge api[:params] if api[need.keys.first.to_sym] != false
       end 
-      api
+      return api
     end
   end
 end

data/app/views/apitest/apitest/show.slim

@@ -66,24 +66,44 @@ section.content
                       td 参数
                       td
                         table.table.table-hover.table-bordered
+                          tr v-if="token_type == 'params'"
+                            td
+                              span style="color:red;width:10px;display:inline-block" 
+                                span  *
+                              span token
+                            td
+                              input.form-control.params name="token" :value="token" 
                           tr v-for="(value , name , index) in api.params"
-                            td.col-md-2 v-bind:class="{'border-top-none': (index == 0)}"
+                            td.col-md-2
                               span style="color:red;width:10px;display:inline-block" 
                                 span v-if="value.required" *
                               span ="{{name}}"
-                            td v-if="name == 'token'" v-bind:class="{'border-top-none': index == 0}" 
-                              input.form-control.params :name="name" :value="token"
-                              span style="line-height:25px" = "{{value.text}}"
-                            td v-if="name != 'token'" v-bind:class="{'border-top-none': index == 0}" 
+                            td v-if="value.nested == true"
+                              table.table.table-hover 
+                                tr v-for="(v , n , i) in value" v-if="n != 'nested'"
+                                  td.col-md-3
+                                    span style="color:red;width:10px;display:inline-block" 
+                                      span v-if="v.required" *
+                                    span ="{{name}}[{{n}}]"
+                                  td 
+                                    input.form-control.params :name="name + '[' + n + ']'" 
+                                    span style="line-height:25px" = "{{v.text}}"
+                            td v-else="" 
                               input.form-control.params :name="name" 
                               span style="line-height:25px" = "{{value.text}}"
+                            / td v-if="name == 'token'" v-bind:class="{'border-top-none': index == 0}" 
+                            /   input.form-control.params :name="name" :value="token"
+                            /   span style="line-height:25px" = "{{value.text}}"
+                            / td v-if="name != 'token'" v-bind:class="{'border-top-none': index == 0}" 
+                            /   input.form-control.params :name="name" 
+                            /   span style="line-height:25px" = "{{value.text}}"
                     tr
                       td
                       td 
                         button.btn.bg-olive.btn-flat @click="api_submit"  提交                    
-                        button.btn.bg-orange.btn-flat style="margin-left:10px;margin-right:10px"   @click="clear_result" 清空结果
-                        button.btn.bg-purple.btn-flat style="margin-left:10px;margin-right:10px" @click="show_server_log" 查看server log
-                        button.btn.btn-warning.btn-flat  style="margin-right:10px" @click="clear_log"  清空log
+                        button.btn.bg-orange.btn-flat style="margin-left:10px;margin-right:10px"    @click="clear_result"     清空结果
+                        button.btn.bg-purple.btn-flat style="margin-left:10px;margin-right:10px"    @click="show_server_log"  查看server log
+                        button.btn.btn-warning.btn-flat  style="margin-right:10px"                  @click="clear_log"        清空log
                     tr
                       td 
                       td

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

@@ -31,6 +31,6 @@ html
         =yield
       footer.main-footer 
     -if params[:action] == 'show'
-      #data data-root-url="#{@root_url}" data-ws-url="ws://#{request.host}:9527" data-apis="#{@apidocs[params[:id]].to_json}" data-token="#{session[:token]}"
+      #data data-root-url="#{@root_url}" data-ws-url="ws://#{request.host}:9527" data-apis="#{@apidocs[params[:id]].to_json}" data-headers="#{@headers.to_json}" data-token-set="#{@token_set.to_json}" data-token-get="#{@token_get.to_json}"
 
       

data/lib/apitest.rb

@@ -7,6 +7,7 @@ require "font-awesome-rails"
 require "ionicons-rails"
 require 'eventmachine'
 require 'eventmachine-tail'
+require 'lodash-rails'
 require 'websocket-eventmachine-server'
 
 module Apitest
@@ -14,6 +15,8 @@ module Apitest
   @theme
   @default_types
   @public_required
+  @token_setting
+
   class << self
     def api_dir(dir = nil)
       @api_dir = dir if dir
@@ -44,6 +47,15 @@ module Apitest
       @public_required
     end
 
+    def token_setting(setting = nil)
+      @token_setting = setting if setting
+      @token_setting
+    end
+
+    def set_headers
+      @token_setting[:set] && @token_setting[:set][1] ? {@token_setting[:set][1] => ''} : {}
+    end
+
     def start_server_log_listen
       Process.detach(
         fork do
@@ -68,18 +80,6 @@ module Apitest
       )
     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

data/lib/apitest/error.rb

@@ -0,0 +1,35 @@
+module Apitest
+  module Error
+    def error(error_code = nil , data = nil,message = nil)
+      hash = {
+        status:       'error'      ,
+        error_code:   error_code   ,
+        message:      message.nil? ? self::ERROR[error_code] : message ,
+        data:         data         ,
+      }  
+      raise "#{self.to_s}::Error".constantize.new hash
+    end
+
+    def success(message = nil , data = nil)
+      hash              = {}
+      hash[:status]     = 'ok' 
+      if message.is_a? Hash
+        hash[:message]  = message[:message] ? message[:message] : ''
+        hash[:data]     = message[:data]    ? message[:data]    : message 
+      else
+        hash[:message]  = message ? message :  ''
+        hash[:data]     = data    ? data    :  {} 
+      end
+      return hash
+    end
+
+    class Error < StandardError
+      def error
+        eval(message)
+      end
+      def error_code
+        error[:error_code]
+      end
+    end
+  end
+end

data/lib/apitest/module_error.rb

@@ -0,0 +1,11 @@
+module Apitest
+  module ModelError
+    include Apitest::Error
+    def self.include(klass)
+      klass.class_eval do 
+        include ServiceError
+        extend  ServiceError
+      end
+    end
+  end
+end

data/lib/apitest/reader.rb

@@ -0,0 +1,14 @@
+module Apitest
+  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
+  

data/lib/apitest/service_error.rb

@@ -0,0 +1,41 @@
+module Apitest
+  module ServiceError
+    # include Apitest::Error
+    def self.include(klass)
+      klass.class_eval do 
+        include ServiceError
+        extend  ServiceError
+      end
+    end
+    def self.error(error_code = nil , data = nil,message = nil)
+      hash = {
+        status:       'error'      ,
+        error_code:   error_code   ,
+        message:      message.nil? ? self::ERROR[error_code] : message ,
+        data:         data         ,
+      }  
+      raise "#{self.to_s}::Error".constantize.new hash
+    end
+
+    def success(message = nil , data = nil)
+      hash              = {}
+      hash[:status]     = 'ok' 
+      if message.is_a? Hash
+        hash[:message]  = message[:message] ? message[:message] : ''
+        hash[:data]     = message[:data]    ? message[:data]    : message 
+      else
+        hash[:message]  = message ? message :  ''
+        hash[:data]     = data    ? data    :  {}
+      end
+      return hash
+    end
+    class Error < StandardError
+      def error
+        eval(message)
+      end
+      def error_code
+        error[:error_code]
+      end
+    end
+  end
+end

data/lib/apitest/version.rb

@@ -1,3 +1,3 @@
 module Apitest
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apitest
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Kyuubi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-30 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lodash-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine-tail
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +193,10 @@ files:
 - config/routes.rb
 - lib/apitest.rb
 - lib/apitest/engine.rb
+- lib/apitest/error.rb
+- lib/apitest/module_error.rb
+- lib/apitest/reader.rb
+- lib/apitest/service_error.rb
 - lib/apitest/version.rb
 - lib/tasks/apitest_tasks.rake
 homepage: https://github.com/kyuubi9/apitest