swagui 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fc715306148d70c2920dd1b350402168421d8a1
-  data.tar.gz: 4e117c70a2450acbbb9e185cb7000ff735d62742
+  metadata.gz: 50e4fe6a730fae9960c9038449f113c3cfef72e6
+  data.tar.gz: f31291c54b4bea9ef5f75c3fc4d2d2de4ca30ad1
 SHA512:
-  metadata.gz: d64b02242b743ce1923df4073a01ef1cc8ef8537725122b13b16603efd2421fdc1b543bb9ade3ec3983a01df52f944e328e34cadd7be12af5220a8d5f9fcdf56
-  data.tar.gz: 781936a2430e3539af3413a8269b34bf8472c4289112af43152c68ed822dc61f903cc0c1f6d9ea7d1568ca29022c55014c166305e1582445fa3a3cf67ea187fc
+  metadata.gz: e2d25877a39a5ae885ca6ac9eaa06573b3db7b96afc7d3ef40cf369593332cda51d694a64d41e816414f49f708bcc60f89a2950a20f12674b5d6a122cdab8c87
+  data.tar.gz: ebaf37b73fe27809e2e18a35c2d60b79815f5083cef08b63b09b80a949dae586e669825acbd6981309591c281a283dfb9c07d07df89d38aff49db64c28837bf0

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/lib/swagui/json_schema.rb

@@ -1,18 +1,32 @@
 module Swagui
   class JsonSchema
 
+    attr_reader :type
     attr_reader :name
 
     def initialize(schema_hash, name)
+      @nested_objects = []
+
       @name = name
       @schema_hash = schema_hash
-      @nested_objects = []
 
-      @schema_hash['properties'].each do |pname, pattributes|
-        if pattributes['type'] == 'object'
-          nested_object_name = "#{@name}-#{pname}"
-          @schema_hash['properties'][pname] = {'$ref' => nested_object_name }
-          @nested_objects << JsonSchema.new(pattributes, nested_object_name)
+      if @schema_hash['type'] == 'array'
+        @type = 'array'
+        nested_object_name = name
+        @nested_objects << JsonSchema.new(@schema_hash['items'], nested_object_name)
+        @schema_hash['items'] = {'$ref' => nested_object_name }
+      else
+        @type = 'class'
+        (@schema_hash['properties'] ||= []).each do |pname, pattributes|
+          if pattributes['type'] == 'object' || (pattributes['type'] == 'array' && !pattributes['items'].nil?)
+            nested_object_name = "#{@name}-#{pname}"
+            if pattributes['type'] == 'object'
+              @schema_hash['properties'][pname] = {'$ref' => nested_object_name }
+            else
+              @schema_hash['properties'][pname] = { 'type' => 'array', 'items' => {'$ref' => nested_object_name } }
+            end
+            @nested_objects << JsonSchema.new(pattributes, nested_object_name)
+          end
         end
       end
     end
@@ -31,7 +45,11 @@ module Swagui
     end
 
     def all_objects
-      ([self] + @nested_objects.map {|x| x.all_objects}).flatten
+      ([self].select {|x| !x.properties.nil?} + @nested_objects.map {|x| x.all_objects}).flatten
+    end
+
+    def array?
+      type == 'array'
     end
 
   end

data/lib/swagui/version.rb

@@ -1,3 +1,3 @@
 module Swagui
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/swagui/yaml_doc_handler.rb

@@ -38,26 +38,40 @@ module Swagui
       def process_schemas(response_hash)
         (response_hash['apis'] || []).each do |api_hash|
           (api_hash['operations'] || []).each do |operations_hash|
+            operation_name = operations_hash['nickname']
+
+            merge_schema!(operations_hash, response_hash, operation_name)
+
             (operations_hash['parameters'] || []).each do |parameters_hash|
-              if schema_file = parameters_hash.delete('schema')
-                schema_file_path = Swagui.file_full_path(schema_file)
-                schema = JsonSchemaParser.parse(schema_file_path, "#{operations_hash['nickname']}-Request")
-                schema.models.each {|m| (response_hash['models'] ||= {})[m['id']] = m }
-                parameters_hash.merge!('type' => schema.name)
-              end
+              merge_schema!(parameters_hash, response_hash, "#{operation_name}-#{parameters_hash['name']}")
             end
+
             (operations_hash['responseMessages'] || []).each do |response_messages_hash|
-              if schema_file = response_messages_hash.delete('schema')
-                schema_file_path = Swagui.file_full_path(schema_file)
-                schema = JsonSchemaParser.parse(schema_file_path, "#{operations_hash['nickname']}-Response-#{response_messages_hash['message'].gsub(' ', '-')}")
-                schema.models.each {|m| (response_hash['models'] ||= {})[m['id']] = m }
-                response_messages_hash.merge!('responseModel' => schema.name)
-              end
+              merge_schema!(response_messages_hash, response_hash, "#{operation_name}-Response-#{response_messages_hash['code']}", true)
             end
           end
         end
       end
 
+      def merge_schema!(parent_hash, response_hash, name, response_model = false)
+        if schema_file = parent_hash.delete('schema')
+          schema_file_path = Swagui.file_full_path(schema_file)
+          schema = JsonSchemaParser.parse(schema_file_path, name)
+          schema.models.each {|m| (response_hash['models'] ||= {})[m['id']] = m }
+          parent_hash.merge!(schema_hash(schema, response_model))
+        end
+      end
+
+      def schema_hash(schema, response_model = false)
+        if response_model
+          {'responseModel' => schema.name}
+        elsif schema.array?
+          {'type' => 'array', 'items' => { '$ref' => schema.name} }
+        else
+          {'type' => schema.name}
+        end
+      end
+
       def process_api_docs_api_listing(response_hash, doc_path)
         if doc_path.end_with?('api-docs.yml') && response_hash['models'].nil? # requesting the root
           dir_path = File.dirname(doc_path)

data/test/doc/account.yml

@@ -0,0 +1,32 @@
+---
+  produces:
+    - application/json
+  apis:
+    -
+      path: /account
+      description: create or update a account
+      operations:
+        -
+          method: POST
+          summary: create or update an account
+          nickname: PostAccount
+          parameters:
+            -
+              name: body
+              required: true
+              schema: test/doc/schemas/account_post_request_body.schema.json
+              paramType: body
+          responseMessages:
+            -
+              code: 200
+              message: account creation success
+              schema: test/doc/schemas/account_post_creation_success.schema.json
+            -
+              code: 400
+              message: account creation failure
+              schema: test/doc/schemas/account_post_creation_failure.schema.json
+        -
+          method: GET
+          summary: Get all the accounts
+          nickname: GETAccounts
+          schema: test/doc/schemas/account_get_request_body.schema.json

data/test/doc/api-docs.yml

@@ -0,0 +1,8 @@
+---
+  info:
+    title: "a sojourner's api"
+    description: "Ut? Amet, et eros nascetur parturient diam scelerisque, egestas, pulvinar sit cum, rhoncus eros vel urna aliquam massa! Turpis purus auctor proin aliquam nunc, nec proin vel enim est, scelerisque! Ac vel integer proin sed in."
+    contact: "sojourner@world.net"
+  apiVersion: "1.0.0"
+  swaggerVersion: "1.2"
+  authorizations: {}

data/test/doc/schemas/account_get_request_body.schema.json

@@ -0,0 +1,45 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Product set",
+    "type": "array",
+    "items": {
+        "title": "Product",
+        "type": "object",
+        "properties": {
+            "id": {
+                "description": "The unique identifier for a product",
+                "type": "number"
+            },
+            "name": {
+                "type": "string"
+            },
+            "price": {
+                "type": "number",
+                "minimum": 0,
+                "exclusiveMinimum": true
+            },
+            "tags": {
+                "type": "array",
+                "items": {
+                    "type": "string"
+                },
+                "minItems": 1,
+                "uniqueItems": true
+            },
+            "dimensions": {
+                "type": "object",
+                "properties": {
+                    "length": {"type": "number"},
+                    "width": {"type": "number"},
+                    "height": {"type": "number"}
+                },
+                "required": ["length", "width", "height"]
+            },
+            "warehouseLocation": {
+                "description": "Coordinates of the warehouse with the product",
+                "$ref": "http://json-schema.org/geo"
+            }
+        },
+        "required": ["id", "name", "price"]
+    }
+}

data/test/doc/schemas/account_post_creation_failure.schema.json

@@ -0,0 +1,10 @@
+{
+  "type":"object",
+  "required":true,
+  "properties":{
+    "errors": {
+      "type":"string",
+      "required":true
+    }
+  }
+}

data/test/doc/schemas/account_post_creation_success.schema.json

@@ -0,0 +1,16 @@
+{
+  "type":"object",
+  "required":true,
+  "properties":{
+    "token": {
+      "type":"object",
+      "required":true,
+      "properties":{
+        "uuid": {
+          "type":"string",
+          "required":true
+        }
+      }
+    }
+  }
+}

data/test/doc/schemas/account_post_request_body.schema.json

@@ -0,0 +1,51 @@
+{
+  "type":"object",
+  "required":true,
+  "properties":{
+    "address": {
+      "type":"string",
+      "required":true
+    },
+    "age": {
+      "type":"number",
+      "required":true
+    },
+    "contact": {
+      "type":"object",
+      "required":true,
+      "properties":{
+        "email": {
+          "type":"string",
+          "required":true
+        },
+        "phones": {
+          "type":"array",
+          "required":true,
+          "items": {
+            "type":"string",
+            "required":true
+          }
+        }
+      }
+    },
+    "entries": {
+      "type":"array",
+      "required":false,
+      "items":
+        {
+          "type":"object",
+          "required":false,
+          "properties":{
+            "guid": {
+              "type":"string",
+              "required":false
+            }
+          }
+        }
+    },
+    "name": {
+      "type":"string",
+      "required":true
+    }
+  }
+}

data/test/test_json_schema.rb

@@ -3,19 +3,29 @@ require 'test_helper'
 class TestJsonSchema < Minitest::Test
 
   def setup
-    sampole_schema_file = File.expand_path('doc/schemas/account_post_request_body.schema.json', File.dirname(__FILE__))
-    @schema_json = JSON.load(File.open(sampole_schema_file).read)
+    sample_schema_file = File.expand_path('doc/schemas/account_post_request_body.schema.json', File.dirname(__FILE__))
+    @schema_json = JSON.load(File.open(sample_schema_file).read)
+
+    sample_array_schema_file = File.expand_path('doc/schemas/account_get_request_body.schema.json', File.dirname(__FILE__))
+    @array_schema_json = JSON.load(File.open(sample_array_schema_file).read)
   end
 
   def test_objects_method_returns_array
     schema = Swagui::JsonSchema.new(@schema_json, 'PostAccount')
-    assert_equal schema.all_objects.size, 2
+    assert_equal schema.all_objects.size, 4
   end
 
   def test_models_methods_return_array_of_hash
     schema = Swagui::JsonSchema.new(@schema_json, 'PostAccount')
-    assert_equal schema.models.size, 2
-    assert_equal schema.models.map {|x| x['id']}, ['PostAccount', 'PostAccount-contact']
+    assert_equal schema.models.size, 4
+    assert_equal schema.models.map {|x| x['id']}, ["PostAccount", "PostAccount-contact", "PostAccount-contact-phones", "PostAccount-entries"]
+    assert_equal schema.models.first['properties']['entries'], {'type' => 'array', 'items' => {"$ref"=>"PostAccount-entries"}}
+  end
+
+  def test_array_schema
+    schema = Swagui::JsonSchema.new(@array_schema_json, 'GetAccount')
+    assert_equal schema.models.size, 3
+    assert_equal schema.models.map {|m| m['id']}, %w(GetAccount GetAccount-tags GetAccount-dimensions)
   end
 
 end

data/test/test_json_schema_parser.rb

@@ -7,7 +7,7 @@ class TestJsonSchemaParser < Minitest::Test
     result = Swagui::JsonSchemaParser.parse(file_path, 'PostAccount')
     assert_equal result.class, Swagui::JsonSchema
     assert_equal result.name, 'PostAccount'
-    assert_equal result.models.size, 2
+    assert_equal result.models.size, 4
     assert_equal result.models.first.class, Hash
   end
 

data/test/test_swagger_doc_handler.rb

@@ -20,9 +20,16 @@ class TestSwaggerDocHandler < Minitest::Test
     get '/doc/account'
     assert last_response.ok?
     response_json = JSON.parse(last_response.body)
+
     assert_equal response_json['apis'].size, 1
     assert response_json['models'].size > 1
-    assert_equal response_json['models'].keys.first, 'PostAccount-Request'
+    assert_equal response_json['models'].keys.first, 'PostAccount-body'
     refute response_json['basePath'].nil?
+    assert_equal response_json['apis'].first['operations'].first['parameters'].first['type'], 'PostAccount-body'
+
+    # body schema parsing
+    assert_equal response_json['apis'].first['operations'].last['type'], 'array'
+    assert_equal response_json['apis'].first['operations'].last['items'], {'$ref' => 'GETAccounts'}
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagui
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -99,6 +99,12 @@ files:
 - swagger-ui/swagger-ui.js
 - swagger-ui/swagger-ui.min.js
 - swagui.gemspec
+- test/doc/account.yml
+- test/doc/api-docs.yml
+- test/doc/schemas/account_get_request_body.schema.json
+- test/doc/schemas/account_post_creation_failure.schema.json
+- test/doc/schemas/account_post_creation_success.schema.json
+- test/doc/schemas/account_post_request_body.schema.json
 - test/test_helper.rb
 - test/test_json_schema.rb
 - test/test_json_schema_parser.rb
@@ -128,6 +134,12 @@ signing_key:
 specification_version: 4
 summary: A rack-based swagger-ui middleware and commandline utility.
 test_files:
+- test/doc/account.yml
+- test/doc/api-docs.yml
+- test/doc/schemas/account_get_request_body.schema.json
+- test/doc/schemas/account_post_creation_failure.schema.json
+- test/doc/schemas/account_post_creation_success.schema.json
+- test/doc/schemas/account_post_request_body.schema.json
 - test/test_helper.rb
 - test/test_json_schema.rb
 - test/test_json_schema_parser.rb