open_api_annotator 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb9e46a88ce7e7634106d19d12c7df63d2f5760456c0419bf90607e49e5f10b
-  data.tar.gz: 0f6d152a177721e6b753a2867cc7670d93d63c78734b38da6119ba57f273f9bb
+  metadata.gz: 928d9daca39028c7d5016fa2e44ca116891194210ebaee873e325240bff2a428
+  data.tar.gz: f40479f6b544ccef964c611acf974763bc205b623682b6114d66707253638b75
 SHA512:
-  metadata.gz: 5ffe01f6857c993dad939e5e0ae61091bc2536223ac6705c06d2f50d7646a53c8db746a7b76db88f24406e295dc2bf5f10b38cd9862175d3a8410afe65113da2
-  data.tar.gz: 65d7dd45c64987f61bcaee80fa44c2a1b33215ccce83e5e7119a66cd61b96ead87682ab94858b952e3714806f3753beb648cfb6b9c59c22feac36775acea9410
+  metadata.gz: 7bfb5f922e2b92ef554b3b2d042a108471a4fe666fd69ed9c242eeae1e48b1105af7dc30caafd8d7be64babeb478990918136563b1deedf1d3f18099addfd098
+  data.tar.gz: 7198242aec1d0c81b3e47e0ba44bcbbbfea679673f9bdf31de31c753b45aff536e4c15f46cd26b854220fbe249c82b3aa46d1a78f8b2cdc86920f26a36cdbfe2

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+        gemfile: [Gemfile]
+        include:
+          - ruby: "2.7"
+            gemfile: "gemfiles/rails-6.0.gemfile"
+          - ruby: "2.6"
+            gemfile: "gemfiles/rails-5.2.gemfile"
+
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake
+    - name: Send coverage
+      uses: paambaati/codeclimate-action@v2.7.5
+      env:
+        CC_TEST_REPORTER_ID: 921d046db793707b7d0c0d1305970a137fdf98fbc6ceeb6c355c44757040244f

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 
 Gemfile.lock
+*.gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.0.2

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Not released yet
+
+## 0.6.0
+- Support Ruby 3.0 and Rails 6.1
+## 0.5.0
+- Allow using with rails 6
+
+## 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
+
 ## 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/gemfiles/rails-5.2.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_api_annotator.gemspec
+gemspec path: '..'
+
+gem 'railties', '~> 5.2.0'

data/gemfiles/rails-6.0.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in open_api_annotator.gemspec
+gemspec path: '..'
+
+gem 'railties', '~> 6.0.0'

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
@@ -42,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
@@ -56,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
@@ -81,38 +126,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/serializer_annotatable.rb

@@ -34,7 +34,7 @@ module OpenApiAnnotator
         validate_open_api_format!(options[:format])
         validate_open_api_nullable!(options[:nullable])
       rescue ValidationError => e
-        Rails.logger.warn(e.message)
+        Rails.logger.warn("Within #{self.name}, #{field}: #{e.message}")
       end
 
       def validate_open_api_type!(type)

data/lib/open_api_annotator/version.rb

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

data/open_api_annotator.gemspec

@@ -21,17 +21,18 @@ 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.5.0"
   spec.add_dependency "active_model_serializers", "~> 0.10.0"
 
-  rails_versions = ['>= 4.1', '< 6']
+  rails_versions = ['>= 5.0', '< 6.2']
   spec.add_dependency "actionpack", rails_versions
   spec.add_dependency "railties", rails_versions
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "simplecov"
+  # Pin to 1.17 due to https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
   spec.add_development_dependency "bump"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api_annotator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kent Nagata
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2021-08-10 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.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -44,68 +44,68 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -138,16 +138,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -170,10 +170,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -182,6 +182,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rails-5.2.gemfile
+- gemfiles/rails-6.0.gemfile
 - lib/open_api_annotator.rb
 - lib/open_api_annotator/association.rb
 - lib/open_api_annotator/attribute.rb
@@ -205,7 +207,7 @@ homepage: https://github.com/ngtk/open_api_annotator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: OpenApi spec generation by bottom-up.
 test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=921d046db793707b7d0c0d1305970a137fdf98fbc6ceeb6c355c44757040244f
-sudo: false
-language: ruby
-rvm:
-  - 2.4.4
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT