open_api_annotator 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82d5be185e7a5b82a671e9aa01df93bec5019fb50c08d9f98726ab9b93ed006d
-  data.tar.gz: 01aad8fa87590fa903129b0a1463c21b7cb644c3bfa68a158bf29a01076bcb12
+  metadata.gz: 3783c346bf9c75e17861f54e485de4296630782ada42af36aa409383883bf711
+  data.tar.gz: b1c2120fa5db9eb13e8d07aefdc84ab4c38cc41d5dd3d6f32b1cf3e13599e432
 SHA512:
-  metadata.gz: 188c9e6692583b26d1078cc850b4a236f9e8a2fac23ebd72b505978e28269a288d1348ae32a6eb0f16ec74464ab105caa1ca2207f6a8bed524c04622f64ce33d
-  data.tar.gz: a77a59eb416c77d93fcd18112889c583df63c5151ac5a33e3fcd617a26ef85dcc592df8fced40c8f597a578aec17ea7d1aa9e68f4aa19992d4ce76af585d7026
+  metadata.gz: 2a867ddd7f65ac82c63038a3832751d384e26b6c7d4dfd039780fd39738e913b751f6fab2ab1933dd4acc635356e3ba07c40647daa045b923283cf9b9e24c505
+  data.tar.gz: 8edcad36fcef036a465fee95f15e138b40b99372e0722416300ba4e97c07a3d761ce006baa0b18fd31ac31ec37c954b8d9655cbb1619b62aef347118fd068b78

data/.travis.yml

@@ -6,7 +6,9 @@ language: ruby
 rvm:
   - 2.4.4
   - 2.5.1
-before_install: gem install bundler -v 1.16.1
+before_install:
+  - gem install -v 1.17.3 bundler --no-rdoc --no-ri
+  - bundle _1.17.3_ install
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Not released yet
+
+## 0.4.0
+- Enable to annotate primitive types to endpoint #11
+
 ## 0.3.0
 - Add path parameters to parameters #8
 - Enable add always requried fields #9

data/lib/open_api_annotator/paths_builder.rb

@@ -54,9 +54,21 @@ module OpenApiAnnotator
 
       case type
       when Array
-        "Returns an array of #{type.first.name}"
+        name = build_type_name(type.first)
+        "Returns an array of #{name}"
+      else
+        name = build_type_name(type)
+        "Returns a #{name}"
+      end
+    end
+
+    def build_type_name(type)
+      type = convert_primitive_class_to_data_type(type)
+      case type
+      when OpenApi::DataType
+        "#{type.name}"
       when Class
-        "Returns a #{type.name}"
+        "#{type.name}"
       else
         raise "not supported class #{type.class}"
       end
@@ -68,18 +80,39 @@ module OpenApiAnnotator
 
       case type
       when Array
-        content_class = type.first
-        reference = OpenApi::Reference.new(ref: "#/components/schemas/#{content_class.name}")
-        schema = OpenApi::Schema.new(type: "array", items: reference)
+        schema_of_array = resolve_media_type_schema(type.first)
+        schema = OpenApi::Schema.new(type: "array", items: schema_of_array)
+        OpenApi::MediaType.new(schema: schema)
+      else
+        schema = resolve_media_type_schema(type)
         OpenApi::MediaType.new(schema: schema)
+      end
+    end
+
+    def resolve_media_type_schema(type)
+      type = convert_primitive_class_to_data_type(type)
+      case type
+      when OpenApi::DataType
+        OpenApi::Schema.new(type: type.name, format: type.format)
       when Class
-        reference = OpenApi::Reference.new(ref: "#/components/schemas/#{type.name}")
-        OpenApi::MediaType.new(schema: reference)
+        OpenApi::Reference.new(ref: "#/components/schemas/#{type.name}")
       else
         raise "not supported class #{type.class}"
       end
     end
 
+    def convert_primitive_class_to_data_type(type)
+      if type == String
+        OpenApi::DataType.new(:string, :string, :string)
+      elsif type == Integer
+        OpenApi::DataType.new(:integer, :integer, :int32)
+      elsif type == Float
+        OpenApi::DataType.new(:float, :number, :float)
+      else
+        type
+      end
+    end
+
     def resolve_type(controller_name, action_name)
       controller_class_name = "#{controller_name}_controller".classify
       begin

data/lib/open_api_annotator/version.rb

@@ -1,3 +1,3 @@
 module OpenApiAnnotator
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_annotator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kent Nagata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_api