lina 0.0.1 → 0.0.2

data/lib/generators/lina/view/view_generator.rb

@@ -0,0 +1,17 @@
+class Lina::ViewGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :actions, type: :array, default: [], banner: "action1 action2"
+
+  desc "Create lina view(s)"
+
+  def copy_view_files
+    base_path = File.join("app/views", class_path, file_name)
+    empty_directory base_path
+
+    actions.each do |action|
+      @action = action
+      @path = File.join(base_path, "#{action}.json.jbuilder")
+      template 'view.json.jbuilder', @path
+    end
+  end
+end

data/lib/lina/error.rb

@@ -10,4 +10,10 @@ module Lina
 
   class ApiSpecError < Error #:nodoc:
   end
+
+  class ApiSpecParamsError < Error #:nodoc:
+  end
+
+  class ApiSpecReturnError < Error #:nodoc:
+  end
 end

data/lib/lina/schema.rb

@@ -34,12 +34,16 @@ module Lina
     def self.params_check(schema, data)
       return unless Lina.params_check
       begin
-        JSON::Validator.validate!(schema, data)
+        JSON::Validator.validate!(schema, data, insert_defaults: true)
       rescue JSON::Schema::ValidationError => e
         raise Lina::ParamsCheckError, e.message
       end
     end
 
+    def self.schema_check(schema)
+      JSON::Validator.fully_validate_schema(schema)
+    end
+
     def self.return_check(schema, data)
       return unless Lina.return_check
       begin
@@ -55,6 +59,12 @@ module Lina
       rescue JSON::Schema::ValidationError => e
         raise Lina::ApiSpecError, e.message
       end
+
+      validator_message = schema_check(data[:params])
+      raise Lina::ApiSpecParamsError, validator_message[0] if validator_message.present?
+
+      validator_message = schema_check(data[:return])
+      raise Lina::ApiSpecReturnError, validator_message[0] if validator_message.present?
     end
   end # end of class Validator
 

data/lib/lina/version.rb

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

data/test/controllers/lina/schema_controller_test.rb

@@ -2,10 +2,6 @@ require 'test_helper'
 
 module Lina
   class SchemaControllerTest < ActionController::TestCase
-    test "schema api" do
-      skip "next"
-    end
-
     test "Lina::ApiSpecError" do
       a = -> {
         class WrongAPiSpecController < Lina::ApplicationController
@@ -17,5 +13,34 @@ module Lina
       assert_raise(Lina::ApiSpecError, &a)
     end
 
+    test "Lina::ApiSpecParamsError" do
+      a = -> {
+        class WrongAPiSpecController < Lina::ApplicationController
+          define_action :index, {
+            name: 'index',
+            params: { type: 'object1' },
+            return: {}
+          } do
+          end
+        end
+      }
+
+      assert_raise(Lina::ApiSpecParamsError, &a)
+    end
+
+    test "Lina::ApiSpecReturnError" do
+      a = -> {
+        class WrongAPiSpecController < Lina::ApplicationController
+          define_action :index, {
+            name: 'index',
+            params: {},
+            return: { type: 'object1' }
+          } do
+          end
+        end
+      }
+
+      assert_raise(Lina::ApiSpecReturnError, &a)
+    end
   end
 end

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

@@ -0,0 +1,133 @@
+class ArraysController < Lina::ApplicationController
+  # def index
+  define_action :index, {
+    name: 'index',
+    description: '',
+    params: {
+      type: 'object',
+      required: [:name],
+      properties: {
+        name: {
+          type: 'string',
+          description: '名称',
+        }
+      }
+    },
+    return: {
+      oneOf: [
+        { "$ref"=> "#/definitions/error" },
+        { "$ref"=> "#/definitions/right" },
+      ],
+      definitions: {
+        error: {
+          type: 'string',
+        },
+        right: {
+          type: 'array',
+          items: {
+            type: 'string',
+          }
+        }
+      }
+    }
+  } do
+    if params[:name] == 'string'
+      render json: 'string'
+    elsif params[:name] == 'array'
+      render json: [ 'item' ]
+    else
+      render json: [ { wrong: 'wrong item' } ]
+    end
+  end
+
+  define_action :string, {
+    name: 'string return test',
+    params: {},
+    return: {
+      type: 'string',
+      description: "return value\nstring",
+      minLength: 5,
+    }
+  } do
+    render json: 'hello world'
+  end
+
+  define_action :boolean, {
+    name: 'boolean return test',
+    params: {},
+    return: {
+      type: 'boolean',
+      description: <<-EOF
+return value
+boolean test
+EOF
+    }
+  } do
+    render json: true
+  end
+
+  define_action :null, {
+    name: 'null return test',
+    params: {},
+    return: {
+      type: 'null',
+    }
+  } do
+    render json: null
+  end
+
+  define_action :array_object, {
+    name: 'array object return test',
+    params: {},
+    return: {
+      type: 'array',
+      items: {
+        type: 'object',
+        description: 'array item object description',
+        required: [ :name ],
+        properties: {
+          name: {
+            type: 'string',
+            description: 'array item name description',
+            minLength: 5,
+          }
+        }
+      }
+    }
+  } do
+    render json: [ { name: 'hello world' } ]
+  end
+
+  define_action :array_object_nested_array, {
+    name: 'array object nested array return test',
+    params: {},
+    return: {
+      type: 'array',
+      items: {
+        type: 'object',
+        description: 'array item object description',
+        required: [ :name ],
+        properties: {
+          name: {
+            type: 'array',
+            description: 'array item name description',
+            items: {
+              type: 'string',
+              minLength: 3,
+            }
+          },
+          content: {
+            type: 'string',
+            description: 'array item string description',
+          },
+          zcontent2: {
+            type: 'string',
+            description: 'array item string description',
+          }
+        }
+      }
+    }
+  } do
+    render json: [ { name: [ 'name' ]  }, { name: [ 'name' ] } ]
+  end
+end

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

@@ -40,6 +40,7 @@ class DesksController < Lina::ApplicationController
       },
     },
     return: {
+      type: 'object',
       required: [ 'name' ],
       properties: {
         name: {
@@ -74,4 +75,23 @@ class DesksController < Lina::ApplicationController
   } do
     render json: { }
   end
+
+  define_action :default_value, {
+    name: '更新指定的桌子',
+    params: {
+      type: 'object',
+      required: [ 'filter' ],
+      properties: {
+        filter: {
+          type: 'string',
+          default: 'default',
+        }
+      }
+    },
+    return: {
+    }
+  } do
+    @filter = params[:filter]
+    render json: { }
+  end
 end

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

@@ -12,6 +12,7 @@ class PostsController < Lina::ApplicationController
   define_action :show, {
     name: 'show a post by ID',
     params: {
+      type: 'object',
       required: [ :id ],
       properties: {
         id: {
@@ -28,6 +29,7 @@ class PostsController < Lina::ApplicationController
   define_action :update, {
     name: 'update the post by ID',
     params: {
+      type: 'object',
       required: [ :id ],
       properties: {
         id: {

data/test/dummy/config/routes.rb

@@ -6,9 +6,23 @@ Rails.application.routes.draw do
 
   mount Lina::Engine => "/lina"
 
+  resources :arrays, only: [:index] do
+    collection do
+      get :string
+      get :boolean
+      get :null
+      get :array_object
+      get :array_object_nested_array
+    end
+  end
+
   resources :posts, only: [:index, :show, :update] do
     resources :labels, only: [:index]
   end
-  resources :desks, only: [:index, :show, :update]
+  resources :desks, only: [:index, :show, :update] do
+    collection do
+      get :default_value
+    end
+  end
   root 'posts#index'
 end