auto-rswag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bd7f5d1bb6327a80a89497075356aafd2cdcba798b8d7258f2d31c682666a95
+  data.tar.gz: b509baea5844020859126427811398fa40e79496a0d5e66ef3a881c08c841c39
+SHA512:
+  metadata.gz: db3929e25c816dcd3710c081eed70c089112149d1befb1570de3a84b9306dd4897191b6643a1c47e4c74e9391a4d1b150195172be6d2fbf05f50e33bbc5fdc2e
+  data.tar.gz: 4ba7b0c799057de66e6ed2c8cc852cd67e8c15053344da60a453c0aa3dfeae861e4bacf14e07161cfd876d8f2a138145234afff7efc31cec7d741afc000992ef

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auto-rswag.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    auto-rswag (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rexml (3.2.4)
+    rspec (0.9.4)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.24.1)
+      sync
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  auto-rswag!
+  coveralls (>= 0.8.23)
+  pry (~> 0)
+  rspec (~> 0)
+  rubocop (>= 0.80.1)
+
+BUNDLED WITH
+   2.0.2

data/lib/auto_rswag.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'printer.rb'
+require_relative 'auto_rswag_helper.rb'
+require_relative 'doc_writer.rb'
+
+# This module hooks into the Rspec test to retrieve useful
+# metadata and submit it to AutoRswagHelper for conversion.
+module AutoRswag
+  def update_documentation
+    $title = metadata[:response][:schema]['$ref'].split('/').last
+
+    after do
+      payload = AutoRswagHelper.convert_response(response)
+      AutoRswagHelper.map_fields(payload)
+      docs = SwaggerPrinter.print_swagger(payload, $title)
+      DocWriter.write_docs(docs, $title)
+    end
+  end
+end

data/lib/auto_rswag_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This class performs conversions of the response data
+# based on test metadata.
+class AutoRswagHelper
+  class << self
+    def convert_response(response)
+      return response if [Array, Hash].include?(response.class)
+
+      body = response.body
+      body = body.respond_to?(:read) ? body.read : body
+
+      JSON.parse(body)
+    rescue StandardError
+      body
+    end
+
+    def map_fields(object)
+      if object.is_a? Array
+        object = {
+          type: :array,
+          items: map_fields(object.first)
+        }
+      elsif object.is_a?(Hash)
+        object = {
+          type: :object,
+          properties: map_object_keys(object)
+        }
+      end
+      object
+    end
+
+    def map_object_keys(object)
+      object.keys.each do |key|
+        value = object.delete(key)
+        converted_key = convert(key)
+        if value.is_a? Hash
+          object[converted_key] = {
+            type: :object,
+            properties: value
+          }
+          map_fields(value)
+        elsif value.is_a? Array
+          object[converted_key] = {
+            type: :array,
+            items: [value.first]
+          }
+          map_fields(value)
+        else
+          object[converted_key] = parse_field(value)
+        end
+      end
+    end
+
+    def convert(key)
+      key.to_sym
+    end
+
+    def parse_field(value)
+      type = value.nil? ? :string : value.class.to_s.downcase.to_sym
+      {
+        type: type,
+        example: value,
+        'x-nullable' => true
+      }
+    end
+  end
+end

data/lib/doc_writer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# This class writes the parsed documenation to the swagger_helper file.
+class DocWriter
+  class << self
+    def default_docs_path
+      Rails.root.join('spec', 'swagger_helper.rb').to_s
+    end
+
+    def write_docs(docs, fragment_title)
+      old_documentation = File.read(default_docs_path)
+      new_documentation_fragment = example_hash(fragment_title, old_documentation)
+      return if new_documentation_fragment.nil?
+
+      new_documentation = old_documentation.sub(new_documentation_fragment, docs)
+      File.open(default_docs_path, 'w') { |f| f.write(new_documentation) }
+    end
+
+    def example_hash(fragment_title, old_documentation)
+      match = ''
+      iterator = 1
+      while true do
+        regex = /(#{fragment_title})(.*?\}){#{iterator}}/
+        new_match_data = old_documentation.match(regex)
+        new_match = new_match_data.present? ? new_match_data[0] : nil
+        return unless new_match != match
+
+        match = new_match
+        begin
+          return match if eval("{#{match}}")
+        rescue SyntaxError
+        end
+
+        iterator += 1
+      end
+    end
+  end
+end

data/lib/printer.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# This class walks through the payload object and
+# builds a prettified representation in rswag format.
+class SwaggerPrinter
+  class << self
+    def print_swagger(object, test_title)
+      @indent ||= 2
+      line = "#{test_title}: {\n"
+      line += print_values(object)
+      line + end_wrap
+    end
+
+    def wrap_hash
+      line  = ' ' * @indent + "type: :object,\n"
+      line += ' ' * @indent + "properties: {\n"
+      @indent += 2
+      line
+    end
+
+    def wrap_array
+      line  = ' ' * @indent + "type: :array,\n"
+      line += ' ' * @indent + "items: {\n"
+      @indent += 2
+      line
+    end
+
+    def end_wrap
+      line = ''
+      while @indent > 2
+        @indent -= 2
+        line += ' ' * @indent + "}\n"
+      end
+      line + '}'
+    end
+
+    def print_values(object)
+      return wrap_array + print_values(object.first) if object.is_a?(Array)
+
+      output = wrap_hash
+      object.each_with_index do |(key, val), i|
+        line = if val[:type] == :object
+                 print_hash(key, val)
+               elsif val[:type] == :array
+                 print_array(key, val)
+               else
+                 print_line(key, val)
+               end
+        comma = i == object.keys.size - 1 ? '' : ','
+        line += "#{comma}\n"
+        output += line
+      end
+      output
+    end
+
+    def print_hash(key, val)
+      line = ' ' * @indent + "#{key}: {\n"
+      @indent += 2
+      line += print_values(val[:properties])
+      @indent -= 2
+      line += ' ' * @indent + "}\n"
+      @indent -= 2
+      line += ' ' * @indent + '}'
+      line
+    end
+
+    def print_array(key, val)
+      line = ' ' * @indent + "#{key}: {\n"
+      @indent += 2
+      line += wrap_array
+      line += print_values(val[:items].first)
+      @indent -= 2
+      line += ' ' * @indent + "}\n"
+      @indent -= 2
+      line += ' ' * @indent + '}'
+      line
+    end
+
+    def print_line(key, val)
+      line = ' ' * @indent + "#{key}: { "
+      val.each_with_index do |(val_key, val_val), j|
+        next if val_key == :type && val.any? { |k, v| k == :example && v == nil }
+        val_comma = j == val.keys.size - 1 ? '' : ','
+        line += "#{escape_key(val_key)}: #{prettify_value(val, val_key, val_val)}#{val_comma} "
+      end
+      line + '}'
+    end
+
+    def escape_key(key)
+      return key unless key.to_s.include?('-')
+      
+      "'#{key.to_s}'"
+    end
+
+    def prettify_value(type, key, val)
+      return ':' + val.to_s if key == :type
+      return val if key != :example
+      return 'nil' if val.nil?
+
+      type[:type] == :string ? "'#{val}'" : val
+    end
+  end
+end

data/rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 99

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: auto-rswag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+description: Convert raw JSON payloads to Rswag configuration to automate endpoint
+  documentation
+email: tyler.b.porter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- lib/auto_rswag.rb
+- lib/auto_rswag_helper.rb
+- lib/doc_writer.rb
+- lib/printer.rb
+- rubocop.yml
+homepage: https://rubygems.org/gems/auto-rswag
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/pawptart/auto-rswag
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: JSON to Rswag configuration
+test_files: []