open_api_annotator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb9e46a88ce7e7634106d19d12c7df63d2f5760456c0419bf90607e49e5f10b
-  data.tar.gz: 0f6d152a177721e6b753a2867cc7670d93d63c78734b38da6119ba57f273f9bb
+  metadata.gz: 82d5be185e7a5b82a671e9aa01df93bec5019fb50c08d9f98726ab9b93ed006d
+  data.tar.gz: 01aad8fa87590fa903129b0a1463c21b7cb644c3bfa68a158bf29a01076bcb12
 SHA512:
-  metadata.gz: 5ffe01f6857c993dad939e5e0ae61091bc2536223ac6705c06d2f50d7646a53c8db746a7b76db88f24406e295dc2bf5f10b38cd9862175d3a8410afe65113da2
-  data.tar.gz: 65d7dd45c64987f61bcaee80fa44c2a1b33215ccce83e5e7119a66cd61b96ead87682ab94858b952e3714806f3753beb648cfb6b9c59c22feac36775acea9410
+  metadata.gz: 188c9e6692583b26d1078cc850b4a236f9e8a2fac23ebd72b505978e28269a288d1348ae32a6eb0f16ec74464ab105caa1ca2207f6a8bed524c04622f64ce33d
+  data.tar.gz: a77a59eb416c77d93fcd18112889c583df63c5151ac5a33e3fcd617a26ef85dcc592df8fced40c8f597a578aec17ea7d1aa9e68f4aa19992d4ce76af585d7026

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0
+- Add path parameters to parameters #8
+- Enable add always requried fields #9
+
 ## 0.1.0
 First release
 

data/README.md

@@ -76,7 +76,7 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number using `bundle exec bump patch`(or minor, major), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/open_api_annotator/components_builder.rb

@@ -21,6 +21,10 @@ module OpenApiAnnotator
       schema.properties.merge!(build_attribute_properties(serializer))
       schema.properties.merge!(build_has_many_association_properties(serializer))
       schema.properties.merge!(build_has_one_and_belongs_to_association_properties(serializer))
+      required_fields = OpenApiAnnotator.config.always_required_fields
+      if required_fields.present?
+        schema.required = required_fields.select{|field| schema.properties[field] }
+      end
       schema
     end
 
@@ -28,11 +32,22 @@ module OpenApiAnnotator
       properties = {}
       serializer.open_api_attributes.each do |attribute|
         next unless attribute.valid?
-        properties[attribute.name.to_sym] = OpenApi::Schema.new(
-          type: attribute.type,
-          format: attribute.format,
-          nullable: attribute.nullable,
-        )
+        properties[attribute.name.to_sym] = if attribute.type.is_a?(Array)
+          OpenApi::Schema.new(
+            type: "array",
+            items: OpenApi::Schema.new(
+              type: attribute.type.first,
+              format: attribute.format,
+              nullable: attribute.nullable,
+            )
+          )
+        else
+          OpenApi::Schema.new(
+            type: attribute.type,
+            format: attribute.format,
+            nullable: attribute.nullable,
+          )
+        end
       end
       properties
     end

data/lib/open_api_annotator/config.rb

@@ -5,6 +5,7 @@ module OpenApiAnnotator
     :path_regexp,
     :application_controller_class_name,
     :application_serializer_class_name,
+    :always_required_fields,
   )
     def application_serializer_class
       if application_serializer_class_name
@@ -50,6 +51,7 @@ module OpenApiAnnotator
       validate_path_regexp!
       validate_application_controller_class_name!
       validate_application_serializer_class_name!
+      validate_always_required_fields!
     end
 
     def validate_info!
@@ -95,6 +97,10 @@ module OpenApiAnnotator
       # Do nothing
     end
 
+    def validate_always_required_fields!
+      # Do nothing
+    end
+
     class InvalidError < StandardError; end
   end
 end

data/lib/open_api_annotator/paths_builder.rb

@@ -23,14 +23,26 @@ module OpenApiAnnotator
         media_type = resolve_media_type(route.controller_name, route.action_name)
         description = build_description(route.controller_name, route.action_name)
         next unless media_type
+        operation = OpenApi::Operation.new(responses: OpenApi::Responses.new)
         response = OpenApi::Response.new(
           description: description,
           content: {
             "application/json" => media_type,
           }
         )
-        operation = OpenApi::Operation.new(responses: OpenApi::Responses.new)
         operation.responses["200"] = response
+        route.parameters.each do |parameter|
+          parameter = OpenApi::Parameter.new(
+            name: parameter[:name],
+            in: :path,
+            required: true,
+            schema: OpenApi::Schema.new(
+              type: :string
+            )
+          )
+          operation.parameters = [] unless operation.parameters
+          operation.parameters.push(parameter)
+        end
         path_item.operations[route.http_verb.underscore] = operation
       end
       path_item
@@ -81,38 +93,43 @@ module OpenApiAnnotator
     end
   end
 
-  Route = Struct.new(:http_verb, :path, :controller_name, :action_name) do
-    def initialize(http_verb:, path:, controller_name:, action_name:)
+  Route = Struct.new(:http_verb, :path, :controller_name, :action_name, :parameters) do
+    def initialize(http_verb:, path:, controller_name:, action_name:, parameters: [])
       self.http_verb = http_verb
       self.path = path
       self.controller_name = controller_name
       self.action_name = action_name
+      self.parameters = parameters
     end
   end
 
   class RoutesFinder
     def find_all
       @routes ||= Rails.application.routes.routes.routes.map do |route|
-        path = PathResolver.new.resolve(route.path.ast)
+        parameters = []
+        path = PathResolver.new.resolve(route.path.ast, parameters)
         controller = route.requirements[:controller]
         action = route.requirements[:action]
-        Route.new(http_verb: route.verb, path: path, controller_name: controller, action_name: action)
+        Route.new(http_verb: route.verb, path: path, controller_name: controller, action_name: action, parameters: parameters)
       end
     end
   end
 
   class PathResolver
-    def resolve(ast)
+    def resolve(ast, parameters_context = [])
       res = ""
       if ast.type == :CAT
         left = ast.left
         res +=
           if left.type == :SYMBOL
+            parameters_context.push({
+              name: left.name,
+            })
             "{#{left.name}}"
           else
             left.to_s
           end
-        res += resolve(ast.right)
+        res += resolve(ast.right, parameters_context)
       end
       res
     end

data/lib/open_api_annotator/version.rb

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

data/open_api_annotator.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "open_api", ">= 0.3.4"
+  spec.add_dependency "open_api", ">= 0.4.0"
   spec.add_dependency "active_model_serializers", "~> 0.10.0"
 
   rails_versions = ['>= 4.1', '< 6']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_annotator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kent Nagata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: OpenApi spec generation by bottom-up.