swagger_autogenerate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1adeb3bac00fabb0f8f62df4b322a3a2ee4dc0068c5c404e9533e1a0e9f75f5b
+  data.tar.gz: 10a0f11601d637b23378d2808a055e1140b4a79be7080b1e40ca4b5b668f2c57
+SHA512:
+  metadata.gz: ea65f1e69465f1deda419b6fda47d775a2935f71c8cbd1dd0b3bbdc268e777d76212c4d7b66ab43743f69fa54b303f51259f984a713ed2c95810d22e1afa0d3f
+  data.tar.gz: b82d945b513d0e7c9bfa7f395985659043d9bff8c0bf782cc8c91dfd4664a16d612da7575546186fb7d18907622c97eefbc7d15d43bfb9f8db0d8c5bfd24f097

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mohammed.buraiah.1996@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 mohammedburaiah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# SwaggerAutogenerate
+automating Swagger YAML generation in Ruby on Rails offers a range of benefits for API documentation. By leveraging the power of the swagger_autogenerate gem, developers can:
+1) save time and effort
+2) (up to date) reducing the chances of inconsistencies between the actual API implementation and its documentation.
+3) improves the overall development workflow by providing a seamless integration with testing frameworks like RSpec.
+4) resulting in better communication and understanding of the APIs.
+
+The gem automatically observes the request/response patterns during the execution of test scenarios, generating accurate Swagger YAML files that reflect the API's behavior. developers and consumers can better understand and interact with the APIs.
+
+## Installation
+
+1) Open your Gemfile located at ./Gemfile
+2) Add the following line to the Gemfile within the appropriate group (e.g., :test):
+
+    ```
+    group :test do
+      gem 'swagger_autogenerate'
+    end
+    ```
+3) Install the gem and add to the application's Gemfile by executing:
+    $ bundle install
+
+## Configuration
+
+To configure the swagger_autogenerate gem in your Rails application, follow these steps:
+
+### Step 1:
+1) Open the app/controllers/application_controller.rb
+2) Inside the class ApplicationController block.
+3) Add the following code:
+```
+    include SwaggerAutogenerate if Rails.env.test? && ENV['SWAGGER'].present?
+```
+
+### Step 2 (optional)
+1) Create a file called swagger_autogenerate.rb in the ./config/initializers
+2) Open the ./config/initializers/swagger/swagger_autogenerate.rb
+3) Add the following code to the swagger_autogenerate.rb
+```
+module SwaggerAutogenerate
+  class SwaggerTrace
+    WITH_CONFIG = true
+    WITH_MULTIPLE_EXAMPLES = true
+    WITH_EXAMPLE_DESCRIPTION = true
+    WITH_RESPONSE_DESCRIPTION = true
+    SWAGGER_ENVIRONMENT_VARIABLE = 'SWAGGER'
+  end
+end
+```
+$ This file is optional and allows you to customize the behavior of the gem by providing additional options.
+
+## Example
+To generate Swagger YAML documentation for the APIs implemented in the EmployeesController class, you can follow these steps:
+1) Ensure that you have the swagger_autogenerate gem installed and configured in your Rails application, as described later.
+2) Create a spec file for the EmployeesController class at the path:
+$ spec/your_path/employees_controller_spec.rb
+This file should contain the test scenarios for each action (e.g., index, show, create) of the controller.
+
+3)Run the spec code using the rspec command and set the environment variable SWAGGER to the desired YAML file name. For example:
+```
+SWAGGER='employee_apis.yaml' rspec spec/your_path/employees_controller_spec.rb
+```
+4) This command runs the spec file and instructs the swagger_autogenerate gem to generate Swagger YAML documentation and save it to the file named employee_apis.yaml.
+5) Once the command finishes executing, you will have the Swagger YAML documentation generated based on the test scenarios in the employees_controller_spec.rb file.
+
+### Please note 
+that the generated documentation will depend on the test scenarios defined in your employees_controller_spec.rb  file. Make sure to have comprehensive test scenarios that cover  different scenarios and expected responses for accurate and detailed  Swagger documentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SwaggerAutogenerate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/swagger_autogenerate/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/config/initializers/swagger_autogenerate.rb

@@ -0,0 +1,5 @@
+Rails.application.config.after_initialize do
+  if Rails.env.test? && ENV['SWAGGER'].present?
+    ApplicationController.include(SwaggerAutogenerate)
+  end
+end

data/lib/swagger_autogenerate/swagger_public_methods.rb

@@ -0,0 +1,50 @@
+module SwaggerAutogenerate
+  module SwaggerPublicMethods
+    def response_status
+      {
+        100 => 'The initial part of the request has been received, and the client should proceed with sending the remainder of the request',
+        101 => 'The server agrees to switch protocols and is acknowledging the client\'s request to change the protocol being used',
+        200 => 'The request has succeeded',
+        201 => 'The request has been fulfilled, and a new resource has been created as a result. The newly created resource is returned in the response body',
+        202 => 'The request has been accepted for processing, but the processing has not been completed. The response may contain an estimated completion time or other status information',
+        204 => 'The server has successfully processed the request but does not need to return any content. It is often used for requests that don\'t require a response body, such as DELETE requests',
+        300 => 'The requested resource has multiple choices available, each with its own URI and representation. The client can select one of the available choices',
+        301 => 'The requested resource has been permanently moved to a new location, and any future references to this resource should use the new URI provided in the response',
+        302 => 'The requested resource has been temporarily moved to a different location. The client should use the URI specified in the response for future requests',
+        304 => 'The client\'s cached copy of a resource is still valid, and there is no need to transfer a new copy. The client can use its cached version',
+        400 => 'The server cannot understand the request due to a client error, such as malformed syntax or invalid parameters',
+        401 => 'The request requires user authentication. The client must provide valid credentials (e.g., username and password) to access the requested resource',
+        403 => 'The server understood the request, but the client does not have permission to access the requested resource',
+        404 => 'The requested resource could not be found on the server',
+        405 => 'The requested resource does not support the HTTP method used in the request (e.g., GET, POST, PUT, DELETE)',
+        409 => 'The request could not be completed due to a conflict with the current state of the target resource. The client may need to resolve the conflict before resubmitting the request',
+        422 => 'The server understands the content type of the request entity but was unable to process the contained instructions',
+        500 => 'The server encountered an unexpected condition that prevented it from fulfilling the request',
+        502 => 'The server acting as a gateway or proxy received an invalid response from an upstream server',
+        503 => 'The server is currently unable to handle the request due to temporary overload or maintenance. The server may provide a Retry-After header to indicate when the client can try the request again',
+        504 => 'The server acting as a gateway or proxy did not receive a timely response from an upstream server'
+      }
+    end
+
+    def swagger_config
+      {
+        'openapi' => '3.0.0',
+        'info' => {
+          'title' => 'title',
+          'description' => 'description',
+          'version' => '1.0.0'
+        },
+        'servers' => [],
+        'components' => {
+          'securitySchemes' => {
+            'locale' => {
+              'type' => 'apiKey',
+              'in' => 'query',
+              'name' => 'locale'
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -0,0 +1,473 @@
+require_relative 'swagger_public_methods'
+
+module SwaggerAutogenerate
+  class SwaggerTrace
+    WITH_CONFIG = true
+    WITH_MULTIPLE_EXAMPLES = true
+    WITH_EXAMPLE_DESCRIPTION = true
+    WITH_RESPONSE_DESCRIPTION = true
+    SWAGGER_ENVIRONMENT_VARIABLE = 'SWAGGER'
+
+    include SwaggerPublicMethods
+
+    def initialize(request, response)
+      @request = request
+      @response = response
+      @@paths = {}
+    end
+
+    def call
+      read_swaggger_trace
+      write_swaggger_trace
+    end
+
+    private
+
+    attr_reader :request, :response, :current_path, :yaml_file
+
+    # main methods
+
+    def read_swaggger_trace
+      path = request.path
+
+      request.path_parameters.except(:controller, :format, :action).each do |k, v|
+        path = path.gsub!(v, "{#{k}}")
+      end
+
+      @current_path = path
+      method = request.method.to_s.downcase
+      hash =
+        {
+          method => {
+            'tags' => tags,
+            'summary' => summary,
+            'requestBody' => request_body,
+            'parameters' => parameters,
+            'responses' => {},
+            'security' => security
+          }
+        }
+
+      hash[method].except!('requestBody') if hash[method]['requestBody'].blank?
+      paths[path.to_s] ||= {}
+      paths[path.to_s].merge!(hash)
+    end
+
+    def write_swaggger_trace
+      if paths[current_path][request.method.downcase].present?
+        paths[current_path][request.method.downcase]['responses'] = swagger_response
+      end
+
+      if File.exist?(swagger_location)
+        edit_file
+      else
+        create_file
+      end
+    end
+
+    def create_file
+      File.open(swagger_location, 'w') do |file|
+        data = WITH_CONFIG ? swagger_config : {}
+        data['paths'] = paths
+        organize_result(data['paths'])
+        data = data.to_hash
+        result = add_quotes_to_dates(YAML.dump(data))
+        file.write(result)
+      end
+    end
+
+    def edit_file
+      @yaml_file = YAML.load(
+        File.read(swagger_location),
+        aliases: true,
+        permitted_classes: [Symbol, Date, ActiveSupport::HashWithIndifferentAccess]
+      )
+
+      return create_file if yaml_file.nil? || yaml_file['paths'].nil?
+
+      yaml_file.merge!(swagger_config) if WITH_CONFIG
+
+      apply_yaml_file_changes
+      organize_result(yaml_file['paths'])
+      @yaml_file = convert_to_hash(yaml_file)
+      File.open(swagger_location, 'w') do |file|
+        result = add_quotes_to_dates(YAML.dump(yaml_file))
+        file.write(result)
+      end
+    end
+
+    # Helpers
+
+    def add_quotes_to_dates(string)
+      string = remove_quotes_in_dates(string)
+      string.gsub(/\b\d{4}-\d{2}-\d{2}\b/, "'\\0'")
+    end
+
+    def remove_quotes_in_dates(string)
+      string.gsub(/'(\d{4}-\d{2}-\d{2})'/, '\1')
+    end
+
+    def convert_to_hash(obj)
+      case obj
+      when ActiveSupport::HashWithIndifferentAccess
+        obj.to_hash
+      when Hash
+        obj.transform_values { |value| convert_to_hash(value) }
+      when Array
+        obj.map { |item| convert_to_hash(item) }
+      else
+        obj
+      end
+    end
+
+    def properties_data(value)
+      hash = {}
+
+      value.map do |k, v|
+        type = schema_type(v)
+        hash.merge!({ k => { 'type' => type, 'example' => convert_to_hash(v) } })
+      end
+
+      hash
+    end
+
+    def schema_data(value)
+      type = schema_type(value)
+      hash = { 'type' => type }
+      hash['properties'] = {}
+      hash['properties'] = properties_data(value) if type == 'object' && !value.nil?
+
+      hash
+    end
+
+    def set_parameters(parameters, parameter, required: false)
+      return if parameter.blank?
+
+      parameter.values.first.each do |key, value|
+        hash =
+          {
+            'name' => key.to_s,
+            'in' => parameter.keys.first.to_s,
+            'schema' => schema_data(value),
+            'example' => example(value)
+          }
+
+        hash['required'] = required if required
+        hash.except!('example') if hash['example'].blank?
+
+        parameters.push(hash)
+      end
+    end
+
+    def request_body
+      content_body(request.request_parameters) if request.request_parameters.present?
+    end
+
+    def tags
+      [ENV['tag'] || controller_name]
+    end
+
+    def summary
+      URI.parse(request.path).path
+    end
+
+    def response_description
+      response_status[response.status]
+    end
+
+    def swagger_response
+      hash = {}
+      begin
+        swagger_response = JSON.parse(response.body)
+      rescue JSON::ParserError
+        swagger_response = { 'file' => 'file/data' }
+      end
+
+      hash['description'] = response_description if WITH_RESPONSE_DESCRIPTION
+      hash['headers'] = {} # response.headers
+      hash['content'] = content_json_example(swagger_response)
+
+      {
+        response.status.to_s => hash
+      }
+    end
+
+    def convert_to_multipart(payload)
+      payload.each do |key, value|
+        if value.is_a?(Hash)
+          payload_keys.push(key)
+          convert_to_multipart(value)
+        else
+          keys = payload_keys.clone
+          first_key = keys.shift
+          keys.each { |inner_key| first_key = "#{first_key}[#{inner_key}]" }
+          first_key = "#{first_key}[#{key}]"
+
+          payload_hash.merge!({ first_key => { 'type' => schema_type(value), 'example' => example(value) } })
+        end
+      end
+    end
+
+    def content_form_data(data)
+      convert_to_multipart(data)
+      converted_payload = @payload_hash.clone
+      @payload_hash = nil
+      @payload_keys = nil
+
+      {
+        'multipart/form-data' => {
+          'schema' => {
+            'type' => 'object',
+            'properties' => converted_payload
+          }
+        }
+      }
+    end
+
+    def content_body(data)
+      hash = {}
+      # hash.merge!(content_json(data))
+      hash.merge!(content_form_data(data))
+
+      { 'content' => hash }
+    end
+
+    def number?(value)
+      true if Float(value)
+    rescue StandardError
+      false
+    end
+
+    def schema_type(value)
+      return 'integer' if number?(value)
+      return 'boolean' if (value.try(:downcase) == 'true') || (value.try(:downcase) == 'false')
+      return 'string' if value.instance_of?(String) || value.instance_of?(Symbol)
+      return 'array' if value.instance_of?(Array)
+
+      'object'
+    end
+
+    def example(value)
+      return value.to_i if number?(value)
+      return convert_to_date(value) if value.instance_of?(String) && is_valid_date?(value)
+      return value if value.instance_of?(String) || value.instance_of?(Symbol)
+
+      nil
+    end
+
+    def is_valid_date?(string)
+      Date.parse(string)
+      true
+    rescue ArgumentError
+      false
+    end
+
+    def convert_to_date(string)
+      datetime = DateTime.parse(string)
+      datetime.strftime('%Y-%m-%d')
+    rescue ArgumentError
+      string
+    end
+
+    # parameters
+
+    def parameters
+      parameters = []
+
+      set_parameters(parameters, path_parameters, required: true)
+      set_parameters(parameters, request_parameters) if request.request_parameters.blank?
+      set_parameters(parameters, query_parameters)
+
+      parameters
+    end
+
+    def request_parameters
+      { body: request.request_parameters }
+    end
+
+    def query_parameters
+      { query: request.query_parameters }
+    end
+
+    def path_parameters
+      { path: request.path_parameters.except(:controller, :format, :action) }
+    end
+
+    # Static
+
+    def paths
+      @@paths ||= {}
+    end
+
+    def security
+      [
+        'org_slug' => [],
+        'locale' => []
+      ]
+    end
+
+    def controller_name
+      request.params['controller'].split('/').last.to_s
+    end
+
+    def swagger_location
+      return @swagger_location if instance_variable_defined?(:@swagger_location)
+
+      if ENV[SWAGGER_ENVIRONMENT_VARIABLE].include?('.yaml') || ENV[SWAGGER_ENVIRONMENT_VARIABLE].include?('.yml')
+        @swagger_location = Rails.root.join(ENV.fetch(SWAGGER_ENVIRONMENT_VARIABLE, nil).to_s).to_s
+      else
+        directory_path = Rails.root.join(ENV.fetch(SWAGGER_ENVIRONMENT_VARIABLE, nil).to_s).to_s
+        FileUtils.mkdir_p(directory_path) unless File.directory?(directory_path)
+        @swagger_location = "#{directory_path}/#{tags.first}.yaml"
+      end
+    end
+
+    def content_json(data)
+      {
+        'application/json' => {
+          'schema' => { 'type' => 'object' },
+          'example' => data
+        }
+      }
+    end
+
+    def content_json_example(data)
+      hash = {
+        'application/json' => {
+          'schema' => { 'type' => 'object' },
+          'examples' => {
+            'example-0' => {
+              'value' => data
+            }
+          }
+        }
+      }
+      hash['application/json']['examples']['example-0']['description'] = "payload => #{example_description}" if WITH_EXAMPLE_DESCRIPTION && !example_description.empty?
+
+      hash
+    end
+
+    def example_description
+      body_ = request_parameters.values.first.present? ? { 'body_params' => request_parameters.values.first&.as_json }: nil
+      query_ = query_parameters.values.first.present? ? { 'query_params' => query_parameters.values.first&.as_json } : nil
+      path_ = path_parameters.values.first.present? ? { 'path_params' => path_parameters.values.first&.as_json }: nil
+
+      [path_, query_, body_].
+        compact.
+        to_s.
+        gsub('-', '/').
+        gsub("'", '').
+        gsub("=>", ': ')
+    end
+
+    def json_example_plus_one(string)
+      if string =~ /(\d+)$/
+        modified_numeric_part = $1.to_i + 1
+        string.sub(/(\d+)$/, modified_numeric_part.to_s)
+      else
+        string
+      end
+    end
+
+    def payload_keys
+      @payload_keys ||= []
+    end
+
+    def payload_hash
+      @payload_hash ||= {}
+    end
+
+    def new_example
+      current_example = swagger_response[response.status.to_s]['content']['application/json']['examples']['example-0']
+      old_examples = old_paths[current_path][request.method.downcase]['responses'][response.status.to_s]['content']['application/json']['examples']
+
+      unless old_examples.value?(current_example)
+        last_example = json_example_plus_one(old_examples.keys.last)
+        last_example ||= 'example-0'
+        last_example = 'example-0' unless WITH_MULTIPLE_EXAMPLES
+        yaml_file['paths'][current_path][request.method.downcase]['responses'][response.status.to_s]['content']['application/json']['examples'][last_example] = current_example
+      end
+
+      true
+    end
+
+    def apply_yaml_file_changes
+      (check_path || check_method || check_status) &&
+        (check_parameters || check_parameter) &&
+        (check_request_bodys || check_request_body)
+    end
+
+    def old_paths
+      yaml_file['paths']
+    end
+
+    # checks
+
+    def organize_result(current_paths)
+      new_hash = {
+        'tags' => tags,
+        'summary' => summary
+      }
+      new_hash['parameters'] = current_paths[current_path][request.method.downcase]['parameters'] if current_paths[current_path][request.method.downcase]['parameters']
+      new_hash['requestBody'] = current_paths[current_path][request.method.downcase]['requestBody'] if current_paths[current_path][request.method.downcase]['requestBody']
+      new_hash['responses'] = current_paths[current_path][request.method.downcase]['responses']
+      new_hash['security'] = security
+
+      current_paths[current_path][request.method.downcase] = new_hash
+    end
+
+    def check_path
+      unless old_paths.key?(current_path)
+        yaml_file['paths'].merge!({ current_path => paths[current_path] })
+      end
+    end
+
+    def check_method
+      unless old_paths[current_path].key?(request.method.downcase)
+        yaml_file['paths'][current_path][request.method.downcase] = { 'responses' => swagger_response }
+      end
+    end
+
+    def check_status
+      if old_paths[current_path][request.method.downcase]['responses'].present?
+        if old_paths[current_path][request.method.downcase]['responses']&.key?(response.status.to_s)
+          new_example
+        else
+          yaml_file['paths'][current_path][request.method.downcase]['responses'].merge!(swagger_response)
+        end
+      else
+        yaml_file['paths'][current_path][request.method.downcase]['responses'] = swagger_response
+      end
+    end
+
+    def check_parameters
+      if old_paths[current_path][request.method.downcase]['parameters'].blank?
+        yaml_file['paths'][current_path][request.method.downcase]['parameters'] = paths[current_path][request.method.downcase]['parameters']
+      end
+    end
+
+    def check_parameter
+      param_names = paths[current_path][request.method.downcase]['parameters'].pluck('name') - yaml_file['paths'][current_path][request.method.downcase]['parameters'].pluck('name')
+      param_names.each do |param_name|
+        param = paths[current_path][request.method.downcase]['parameters'].find { |parameter| parameter['name'] == param_name }
+        yaml_file['paths'][current_path][request.method.downcase]['parameters'].push(param)
+      end
+    end
+
+    def check_request_bodys
+      if paths[current_path][request.method.downcase]['requestBody'].present? && old_paths[current_path][request.method.downcase]['requestBody'].nil?
+        yaml_file['paths'][current_path][request.method.downcase]['requestBody'] = paths[current_path][request.method.downcase]['requestBody']
+      end
+    end
+
+    def check_request_body
+      if paths[current_path][request.method.downcase]['requestBody'].present?
+        param_names = paths[current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties'].keys - yaml_file['paths'][current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties'].keys
+        param_names.each do |param_name|
+          param = paths[current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties'].select { |parameter| parameter == param_name }
+          yaml_file['paths'][current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties'].merge!(param)
+        end
+      end
+    end
+  end
+end

data/lib/swagger_autogenerate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SwaggerAutogenerate
+  VERSION = "0.1.0"
+end

data/lib/swagger_autogenerate.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SwaggerAutogenerate
+  extend ::ActiveSupport::Concern
+  require_relative 'swagger_autogenerate/swagger_trace.rb'
+
+  included do
+    if defined?(Rails) && Rails.env.test? && ENV[SwaggerTrace::SWAGGER_ENVIRONMENT_VARIABLE].present?
+      def process_action(*args)
+        super
+
+        SwaggerTrace.new(request, response).call
+      end
+    end
+  end
+end

data/sig/swagger_autogenerate.rbs

@@ -0,0 +1,4 @@
+module SwaggerAutogenerate
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/swagger_autogenerate.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/swagger_autogenerate/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "swagger_autogenerate"
+  spec.version = SwaggerAutogenerate::VERSION
+  spec.authors = ["MohammedBuraiah"]
+  spec.email = ["mohammed.buraiah.1996@gmail.com"]
+
+  spec.summary = "Write a short summary, because RubyGems requires one."
+  spec.description = "Write a longer description or delete this line."
+  spec.homepage = "https://github.com/MohammedBuraiah/swagger_autogenerate"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/MohammedBuraiah/swagger_autogenerate"
+  spec.metadata["changelog_uri"] = "https://github.com/MohammedBuraiah/swagger_autogenerate"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: swagger_autogenerate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MohammedBuraiah
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-27 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- mohammed.buraiah.1996@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/config/initializers/swagger_autogenerate.rb
+- lib/swagger_autogenerate.rb
+- lib/swagger_autogenerate/swagger_public_methods.rb
+- lib/swagger_autogenerate/swagger_trace.rb
+- lib/swagger_autogenerate/version.rb
+- sig/swagger_autogenerate.rbs
+- swagger_autogenerate.gemspec
+homepage: https://github.com/MohammedBuraiah/swagger_autogenerate
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MohammedBuraiah/swagger_autogenerate
+  source_code_uri: https://github.com/MohammedBuraiah/swagger_autogenerate
+  changelog_uri: https://github.com/MohammedBuraiah/swagger_autogenerate
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []