lina 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42f21ae8ee02bcd29bc7d4b5fcf92f00473db66f
-  data.tar.gz: 524f10fe12b14452afcdaa4e3ee75e94ebe77c56
+  metadata.gz: fa958e90d0c63e66915b3c828544a31668277469
+  data.tar.gz: c951fb86cd65c8c1df28e41ab9f34a4707b066fc
 SHA512:
-  metadata.gz: cec4c791a427e084e15a3a95e6863acbadd652cb5842c73fc47ea782e2899c089eff24e057ed0ccdccaa31a731f6d79f3db576879be80095c7aca084f0163afa
-  data.tar.gz: 877440440b7116f07894120ba7c2ab5c90cd2a5a6338bc0ab430055fecdf7f488d3eae4865bf51c65d5c6b7c698552e6fb613c26d22f5f63745ba2228426d4d2
+  metadata.gz: 03466179c4285f09047850548947bd2330ff40a1443abcb930736ba8218aae366f42d73bee38719ce71ab6fb17e42d7d3db6d9b959ae05626193390214d5c1c6
+  data.tar.gz: 0d3b4ed2283eac79dd6a6f7eef2cf4b1535eb053ca7338150ae4a03a0be037212698b30f0af38db067d4fd44ec3b09165e8156389dc34993469f494d82e2935e

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'rails41' do
+  gem 'rails', '~> 4.1.0'
+end
+
+appraise 'rails42' do
+  gem 'rails', '~> 4.2.0'
+end

data/README.md

@@ -5,9 +5,9 @@
 [![Build Status](https://travis-ci.org/windy/lina.png?branch=master)](https://travis-ci.org/windy/lina)
 [![Dependency Status](https://gemnasium.com/windy/lina.svg)](https://gemnasium.com/windy/lina)
 
-Rails 开发者零成本上手的 Restful API 框架.
+Rails 开发者零成本上手的 RESTful API 框架.
 
-Lina 是基于 `Ruby on Rails`, [JSON Schema](http://json-schema.org), `jbuilder` 的 API 开发框架, 整合 Ruby on Rails 开发 API 的最佳实践, 并添加 API 文档, 校验等必备功能.
+Lina 是基于 `Ruby on Rails`, [JSON Schema](http://json-schema.org), `jbuilder` 的 RESTful API 开发框架, 整合 Ruby on Rails 开发 API 的最佳实践, 并添加 API 文档, 校验等必备功能.
 
 它的特点:
 
@@ -22,6 +22,7 @@ Lina 是基于 `Ruby on Rails`, [JSON Schema](http://json-schema.org), `jbuilder
 
 ```ruby
 #  Gemfile
+
 gem 'lina'
 ```
 `bundle install` 之后, 安装
@@ -200,7 +201,7 @@ end
 
 ### 路由与版本
 
-`Lina` 沿用了 `Rails` 的路由系统, 建议使用 `Rails Restful Route` 写法:
+`Lina` 沿用了 `Rails` 的路由系统, 建议使用 `Rails RESTful Route` 写法:
 
 ```ruby
 Rails.application.routes.draw do
@@ -270,7 +271,7 @@ end
 
 Lina 做了以下几件事情:
 
-1. `define_action` 实际上会将 API 信息存入类实例变量中, APIDOC 通过 `Lina::ApplicationController` 的子类遍历, 依据这些信息显示的.
+1. `define_action` 实际上会将 API 信息存入类变量中, APIDOC 通过 `Lina::ApplicationController` 的子类遍历, 依据这些信息显示的.
 2. 覆写 `send_action`, 提供入口检测与返回参数检测.
 3. 提供生成器 `lina:install`, `lina:api`.
 4. 添加 `api_for` 路由项.
@@ -282,12 +283,22 @@ Lina 做了以下几件事情:
 
 提交 PR 时, 请确保本地 `appraisal rake` 通过.
 
+[![Join the chat at https://gitter.im/windy/lina](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/windy/lina?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## 常见问题
+
+### 访问 APIDOC 时 出现 Lina::ApiSpecError in Lina::ApidocController
+
+* `Lina::ApiSpecError` 说明某处的 API 定义出现了问题, 不符合约定, API 声明时, 必须有 `name`, `params`, `return`.
+
+* `Lina::ApiSpecParamsError` 说明 API 定义时 `params` 不符合 JSON Schema 的格式, 请检查.
+
+* `Lina::ApiSpecReturnError` 说明 API 定义时 `return` 不符合 JSON Schema 的格式, 请检查.
+
 ## TODOLIST
 
 * Schema Form ( TODO )
 * ActiveRecord Validator Helper ( TODO )
-* I18N Support( TODO )
-
 
 ## 贡献者
 

data/Rakefile

@@ -14,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
 

data/app/assets/stylesheets/lina/apidoc.scss

@@ -4,13 +4,26 @@
   margin-left: 0;
   font-weight: 300;
 
+  .apidoc-left-title {
+    font-weight: 200;
+    padding: 16px;
+    margin: 0;
+    border-bottom: 1px solid #eee;
+    color: #999;
+  }
+
   .apidoc-title {
     border-bottom: 1px solid #eee;
-    margin: 0;
+    margin: -10px -10px 10px -10px;
     padding: 16px;
     text-align: center;
     font-weight: 200;
     color: #999;
+
+    .api-expand-handle {
+      float: left;
+      cursor: pointer;
+    }
   }
 
   .api-content-wrapper {
@@ -40,6 +53,10 @@
       padding: 6px;
       white-space: nowrap;
     }
+
+    &.expandedTree {
+      display: none;
+    }
   }
 
   .api-contents {
@@ -48,6 +65,9 @@
     height: 100%;
     overflow-y: auto;
     font-size: 20px;
+    &.expandedTree {
+      margin-left: 0;
+    }
   }
 
   .path {

data/app/controllers/lina/apidoc_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "lina/base_controller"
+require_dependency 'lina/base_controller'
 
 module Lina
   class ApidocController < BaseController
@@ -15,10 +15,11 @@ module Lina
 
       @routes = inspector.send(:collect_routes, api_routes)
       # add schema info to route
-      @routes.each do |route|
+      @routes.select! do |route|
         controller, action = route[:reqs].split('#')
-        route[:schema] = str2controller(controller).action_schema(action)
         route[:path].gsub!('(.:format)', '')
+        route[:schema] = str2controller(controller).action_schema(action)
+        str2controller(controller).action_methods.include?(action)
       end
       @_tree = Lina::Tree.new(@routes)
       @tree = @_tree.to_tree

data/app/controllers/lina/application_controller.rb

@@ -1,12 +1,12 @@
 module Lina
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
 
     def send_action(method_name, *args)
       block = self.class.action_block(method_name)
       schema = self.class.action_schema(method_name)
       if block
         Lina::Validator.params_check(schema[:params], params)
-        ret = self.instance_exec(*args, &block)
+        ret = self.instance_exec(*args, &_convert_to_lambda(&block))
         default_render unless performed?
         Lina::Validator.return_check(schema[:return], response.body)
         ret
@@ -18,11 +18,17 @@ module Lina
     before_filter :default_format_json
 
     private
+
     def default_format_json
-      request.format = "json" unless params[:format]
+      request.format = 'json' unless params[:format]
+    end
+
+    def _convert_to_lambda(&block)
+      self.define_singleton_method(:_, &block)
+      return self.method(:_).to_proc
     end
 
-    class <<self
+    class << self
       _actions = {}
       def define_action(name, schema={}, &block)
         Lina::Validator.api_spec_check(Lina::Schema.argument, schema)
@@ -31,12 +37,12 @@ module Lina
 
       def action_methods
         @@action_methods = begin
-          methods = (api_actions + public_instance_methods(true) -
-            internal_methods +
-            public_instance_methods(false)).uniq.map { |x| x.to_s } -
-            hidden_actions.to_a
-          Set.new(methods.reject { |method| method =~ /_one_time_conditions/ })
-        end
+                             methods = (api_actions + public_instance_methods(true) -
+                                        internal_methods +
+                                        public_instance_methods(false)).uniq.map { |x| x.to_s } -
+                             hidden_actions.to_a
+                             Set.new(methods.reject { |method| method =~ /_one_time_conditions/ })
+                           end
       end
 
       # 所有支持的 API 列表

data/app/controllers/lina/schema_controller.rb

@@ -1,15 +1,15 @@
-require_dependency "lina/base_controller"
+require_dependency 'lina/base_controller'
 
 module Lina
   class SchemaController < BaseController
     def index
       if ! controller = user_api_controllers.find { |c| c == params[:schema_controller] }
-        raise "Controller #{params[:schema_controller]} 无法找到"
+        raise "#{t('lina.controller')} #{params[:schema_controller]} #{t('lina.notfound')}"
       end
 
       action = params[:schema_action].to_sym
       if ! @schema = str2controller(controller)._actions[action]
-        raise "Action #{action} 无法找到"
+        raise "#{t('lina.action')} #{action} #{t('lina.notfound')}"
       end
     end
   end

data/app/views/lina/apidoc/index.html.erb

@@ -1,10 +1,14 @@
 <div class="apidoc-page" ng-controller='ApidocController' ng-init="setData('<%= lina.data_path %>')">
 
-	<div class="api-left-tree">
-		<h4 class='apidoc-title'>APIDOC</h4>
+  <div class="api-left-tree" ng-class='{ expandedTree: expanded }'>
+    <h4 class='apidoc-left-title'> <%= t('lina.tree') %> </h4>
     <abn-tree tree-data="my_data" tree-control="my_tree" on-select='showApi(branch)'></abn-tree>
 	</div>
-	<div class="api-contents ng-cloak">
+  <div class="api-contents ng-cloak" ng-class='{ expandedTree: expanded }'>
+    <h4 class='apidoc-title'>
+      <span class='api-expand-handle glyphicon glyphicon-menu-hamburger' ng-click='expanded = ! expanded'></span>
+      <%= t('lina.apidoc') %>
+    </h4>
     <ul class='list-unstyled'>
       <li class='api-content-wrapper' ng-repeat='api in currentApi'>
         <div class='path'>
@@ -13,12 +17,12 @@
         </div>
         <div class="name">{{ api.schema.name }}</div>
         <p class='description'>{{ api.schema.description }}</p>
-        <h4 class='parameters-title'>Parameter</h4>
+        <h4 class='parameters-title'><%= t('lina.parameter') %></h4>
         <div class="table-wrapper">
           <json-schema schema='api.schema.params'></json-schema>
         </div><!-- .table-wrapper -->
 
-        <h4 class='return-title'>Return</h4>
+        <h4 class='return-title'><%= t('lina.return') %></h4>
         <p class='description'>{{ api.schema.return.description }}</p>
         <div class="table-wrapper">
           <json-schema schema='api.schema.return'></json-schema>

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  lina:
+    apidoc: API DOC
+    tree: Tree
+    return: Return
+    parameter: Parameter
+
+    controller: Controller
+    action: Action
+    notfound: NOT FOUND

data/config/locales/zh-CN.yml

@@ -0,0 +1,10 @@
+zh-CN:
+  lina:
+    apidoc: API文档
+    tree: 文档树
+    return: 返回
+    parameter: 参数
+
+    controller: 控制器
+    action: 控制器方法
+    notfound: 无法找到

data/config/routes.rb

@@ -2,5 +2,5 @@ Lina::Engine.routes.draw do
   get 'schema', to: 'schema#index'
   get 'data', to: 'apidoc#index', format: 'json'
 
-  root "apidoc#index"
+  root 'apidoc#index'
 end

data/lib/generators/lina/api/api_generator.rb

@@ -1,10 +1,10 @@
 module Lina
   module Generators
     class ApiGenerator < Rails::Generators::NamedBase # :nodoc:
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
 
-      argument :actions, type: :array, default: [], banner: "action1 action2"
-      check_class_collision suffix: "Controller"
+      argument :actions, type: :array, default: [], banner: 'action1 action2'
+      check_class_collision suffix: 'Controller'
 
       def create_controller_files
         template 'controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")

data/lib/lina/version.rb

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

data/test/controllers/lina/schema_controller_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Lina
   class SchemaControllerTest < ActionController::TestCase
-    test "Lina::ApiSpecError" do
+    test 'Lina::ApiSpecError' do
       a = -> {
         class WrongAPiSpecController < Lina::ApplicationController
           define_action :index, { params: 'spec erorr' } do
@@ -13,7 +13,7 @@ module Lina
       assert_raise(Lina::ApiSpecError, &a)
     end
 
-    test "Lina::ApiSpecParamsError" do
+    test 'Lina::ApiSpecParamsError' do
       a = -> {
         class WrongAPiSpecController < Lina::ApplicationController
           define_action :index, {
@@ -28,7 +28,7 @@ module Lina
       assert_raise(Lina::ApiSpecParamsError, &a)
     end
 
-    test "Lina::ApiSpecReturnError" do
+    test 'Lina::ApiSpecReturnError' do
       a = -> {
         class WrongAPiSpecController < Lina::ApplicationController
           define_action :index, {

data/test/dummy/app/controllers/application_controller.rb

@@ -2,4 +2,8 @@ class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
+
+  def current_user
+    "user1"
+  end
 end

data/test/dummy/app/controllers/labels_controller.rb

@@ -8,4 +8,19 @@ class LabelsController < PostsController
   } do
     render json: []
   end
+
+  define_action :show, {
+    name: 'label id show',
+    params: {
+      type: 'object',
+      properties: {
+        id: { type: 'string' }
+      }
+    },
+    return: {
+    }
+  } do
+    render json: { user: current_user }
+    return
+  end
 end

data/test/dummy/app/controllers/posts_controller.rb

@@ -17,7 +17,7 @@ class PostsController < Lina::ApplicationController
       properties: {
         id: {
           type: 'integer'
-        },
+        }
       }
     },
     return: {
@@ -34,7 +34,7 @@ class PostsController < Lina::ApplicationController
       properties: {
         id: {
           type: 'integer'
-        },
+        }
       }
     },
     return: {

data/test/dummy/config/application.rb

@@ -3,7 +3,7 @@ require File.expand_path('../boot', __FILE__)
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "lina"
+require 'lina'
 
 module Dummy
   class Application < Rails::Application
@@ -17,11 +17,10 @@ module Dummy
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
+    config.i18n.default_locale = :'zh-CN'
 
     # generators
     config.generators.assets = false
     config.generators.helper = false
   end
 end
-

data/test/dummy/config/routes.rb

@@ -4,7 +4,7 @@ Rails.application.routes.draw do
     get 'posts/index'
   end
 
-  mount Lina::Engine => "/lina"
+  mount Lina::Engine => '/lina'
 
   resources :arrays, only: [:index] do
     collection do
@@ -17,7 +17,7 @@ Rails.application.routes.draw do
   end
 
   resources :posts, only: [:index, :show, :update] do
-    resources :labels, only: [:index]
+    resources :labels, only: [:index, :show]
   end
   resources :desks, only: [:index, :show, :update] do
     collection do