lazy_api_doc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a2460462b4e6747f547a54ff2a54883eaa06332c6cff5a282596b1fa4cad3e
-  data.tar.gz: a8684334ee355acbf77cf7267de1af061560019fc6b9f26894eea739da21136c
+  metadata.gz: e13f1dbef507e8cd73dba019cf5b46049a06f257225aaba546a1e426465cfb0a
+  data.tar.gz: f7d05704e71695f96752ae86678df55d5ffbaed7fbcd8af66cb4800fae40622d
 SHA512:
-  metadata.gz: 8dd797d746ede57afd720a224dd1aca0fc381b6287a7743808279f0e3d9915591edd09323d6793218405d4f6eb4ed67ee155b7b98a67862afca7aa6ec8a5be0e
-  data.tar.gz: d2fad45f01e0ea6ce438c891e528cb9a7b11d1b347d528138bec2eb23d0edb3136a7d4abc390ea687c6f3bd23fbccc13d3be8c12983f887452b38a3432fb0396
+  metadata.gz: 412a28cb29f54a64e3290ad235b645932a86d253f3bbd5cadd9225638bec0c966a9085b56252ed27d28880c31d672fc8712c05723c0cec92f8d7d173cac3c73a
+  data.tar.gz: 5676bfcf8a8e909d9838239051c693512938ab8d0e8150e7e4b1474adf94423f365e5a3ac142e8f0df1e31f1fbf9f9de0c9e7bdbe1ada138bf7e7b74d69514ed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lazy_api_doc (0.1.0)
+    lazy_api_doc (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,7 +10,7 @@ attributes, endpoint description and then generates OpenAPI documentation.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lazy_api_doc', group: :test
+gem 'lazy_api_doc', require: false, group: :test
 ```
 
 And then execute:

data/lib/generators/lazy_api_doc/install_generator.rb

@@ -23,6 +23,7 @@ module LazyApiDoc
         insert_into_file 'spec/rails_helper.rb', after: "RSpec.configure do |config|\n" do
           <<~RUBY
             if ENV['DOC']
+              require 'lazy_api_doc'
               require 'support/lazy_api_doc_interceptor'
 
               config.include LazyApiDocInterceptor, type: :request
@@ -41,7 +42,9 @@ module LazyApiDoc
 
         append_to_file 'test/test_helper.rb' do
           <<~RUBY
+
             if ENV['DOC']
+              require 'lazy_api_doc'
               require 'support/lazy_api_doc_interceptor'
 
               class ActionDispatch::IntegrationTest

data/lib/generators/lazy_api_doc/templates/public/layout.yml

@@ -6,13 +6,9 @@ info:
     name: User Name
     email: user@example.com
     url: https://app.example.com
-tags:
 
 servers:
   - url: https://app.example.com
     description: description
 
 paths:
-
-components:
-  schemas:

data/lib/lazy_api_doc.rb

@@ -15,14 +15,19 @@ module LazyApiDoc
     generator.add(example)
   end
 
-  def self.add_spec(example)
+  def self.add_spec(example) # rubocop:disable Metrics/AbcSize
     add(
       controller: example.request.params[:controller],
       action: example.request.params[:action],
       description: example.class.description,
+      source_location: [example.class.metadata[:file_path], example.class.metadata[:line_number]],
       verb: example.request.method,
       params: example.request.params,
       content_type: example.request.content_type.to_s,
+      request: {
+        query_params: example.request.query_parameters,
+        full_path: example.request.fullpath
+      },
       response: {
         code: example.response.status,
         content_type: example.response.content_type.to_s,
@@ -31,14 +36,19 @@ module LazyApiDoc
     )
   end
 
-  def self.add_test(example)
+  def self.add_test(example) # rubocop:disable Metrics/AbcSize
     add(
       controller: example.request.params[:controller],
       action: example.request.params[:action],
       description: example.name.gsub(/\Atest_/, '').humanize,
+      source_location: example.method(example.name).source_location,
       verb: example.request.method,
       params: example.request.params,
       content_type: example.request.content_type.to_s,
+      request: {
+        query_params: example.request.query_parameters,
+        full_path: example.request.fullpath
+      },
       response: {
         code: example.response.status,
         content_type: example.response.content_type.to_s,

data/lib/lazy_api_doc/generator.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module LazyApiDoc
   class Generator
     attr_reader :examples
@@ -14,7 +16,7 @@ module LazyApiDoc
 
     def result
       result = {}
-      @examples.group_by { |example| [example.controller, example.action] }.map do |_, examples|
+      @examples.sort_by(&:source_location).group_by { |ex| [ex.controller, ex.action] }.map do |_, examples|
         first = examples.first
         route = ::LazyApiDoc::RouteParser.new(first.controller, first.action, first.verb).route
         doc_path = route[:doc_path]
@@ -24,18 +26,19 @@ module LazyApiDoc
       result
     end
 
-    def example_group(example, examples, route)
+    def example_group(example, examples, route) # rubocop:disable Metrics/AbcSize
       {
         route[:verb].downcase => {
           "tags" => [example.controller],
           "description" => example["description"].capitalize,
           "summary" => example.action,
-          "parameters" => path_params(route, examples),
+          "parameters" => path_params(route, examples) + query_params(examples),
           "requestBody" => body_params(route, examples),
           "responses" => examples.group_by { |ex| ex.response[:code] }.map do |code, variants|
             [
               code,
               {
+                "description" => variants.first["description"].capitalize,
                 "content" => {
                   example.response[:content_type] => {
                     "schema" => ::LazyApiDoc::VariantsParser.new(variants.map { |v| parse_body(v.response) }).result
@@ -43,8 +46,8 @@ module LazyApiDoc
                 }
               }
             ]
-          end.to_h
-        }
+          end.to_h # rubocop:disable Style/MultilineBlockChain
+        }.reject { |_, v| v.nil? }
       }
     end
 
@@ -59,10 +62,32 @@ module LazyApiDoc
     end
 
     def path_params(route, examples)
-      variants = examples.map { |example| example.params.slice(*route[:path_params]) }
-      ::LazyApiDoc::VariantsParser.new(variants).result["properties"].map do |param_name, schema|
+      path_variants = examples.map { |example| example.params.slice(*route[:path_params]) }
+      ::LazyApiDoc::VariantsParser.new(path_variants).result["properties"].map do |param_name, schema|
         {
           'in' => "path",
+          'required' => true,
+          'name' => param_name,
+          'schema' => schema
+        }
+      end
+    end
+
+    def query_params(examples)
+      query_variants = examples.map do |example|
+        full_path = example.request[:full_path].split('?')
+        next {} if full_path.size == 1
+
+        # TODO: simplify it
+        full_path.last.split('&').map { |part| part.split('=').map { |each| CGI.unescape(each) } }.group_by(&:first)
+                 .transform_values { |v| v.map(&:last) }.map { |k, v| [k, k.match?(/\[\]\z/) ? v : v.first] }.to_h
+      end
+
+      parsed = ::LazyApiDoc::VariantsParser.new(query_variants).result
+      parsed["properties"].map do |param_name, schema|
+        {
+          'in' => "query",
+          'required' => parsed['required'].include?(param_name),
           'name' => param_name,
           'schema' => schema
         }

data/lib/lazy_api_doc/route_parser.rb

@@ -9,7 +9,7 @@ module LazyApiDoc
     end
 
     def route
-      self.class.routes.find { |r| r[:action] == action && r[:controller] == controller && r[:verb] == verb }
+      self.class.routes.find { |r| r[:action] == action && r[:controller] == controller && r[:verb].include?(verb) }
     end
 
     def self.routes

data/lib/lazy_api_doc/variants_parser.rb

@@ -17,7 +17,7 @@ module LazyApiDoc
       when Array
         parse_array(variant, variants)
       when Hash
-        parse_hash(variant, variants)
+        parse_hash(variants)
       else
         types_template(variants).merge("example" => variant)
       end
@@ -50,6 +50,8 @@ module LazyApiDoc
         "boolean"
       when String
         type_of_string(variant)
+      when Float
+        'number'
       else
         variant.class.name.downcase
       end
@@ -64,8 +66,10 @@ module LazyApiDoc
       end
     end
 
-    def parse_hash(variant, variants)
-      result               = types_template(variants)
+    def parse_hash(variants)
+      result = types_template(variants)
+      variant = variants.select { |v| v.instance_of?(Hash) }.reverse_each
+                        .each_with_object({}) { |v, res| res.merge!(v) }
       result["properties"] = variant.map do |key, val|
         [
           key.to_s,

data/lib/lazy_api_doc/version.rb

@@ -1,3 +1,3 @@
 module LazyApiDoc
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bogdan Guban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies: []
 description: The gem collects all requests and responses from your request specs and
   generates documentationbased on it