swagger_autogenerate 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a323ab35e5b839c6b85294fdf080ce0053fe43854eafbc1d1046b26cf14b7f2
-  data.tar.gz: 996cd6d73b26711cc59cefe81f720fb747d1a38d5442fa713b3284528f3b8d2b
+  metadata.gz: '08b276dd458b54318a75f32c666d40840602065d89a8fa26e7ffac44341e0f15'
+  data.tar.gz: bacd1e78fe71a2909d112901a9e6ba2900117b7e2a45522b1d25f11b542aa624
 SHA512:
-  metadata.gz: 5794de7918cd298fab142696ff91a6873563fc2a31f6fa9ea60d8ea5a8c483c4467f64c5736f97ebdb92509059ab888032de8d903e8ef1caea486796384693b9
-  data.tar.gz: 82593525706f167db50f96ead26c6e6ef4f6f1ba5911b761838bd5bf6ab0772d3cd9378fd8b4e1648d9fc0bf85a87868078bfe642175fd7994c7998258a3dfa5
+  metadata.gz: 9f6c2c1c285f982a2677daf6d90040bed5682595fd65ee690ac2e01d188a37bc4afca6f4531fc4e8daad142dd5098a54d4dcb336c58ebc97e2ec305afba9eff7
+  data.tar.gz: 4c5d8642ac585f043cab7193e3eb9fb7fbe3c027c41d6bcdae6b17b5f6b905a4559469db54f166a9014a4283f9c1d798968a30f18c1ee38160c4579985d5626a

data/CHANGELOG.md

@@ -11,5 +11,7 @@
 ## [1.0.9] - 2024-06-04
 ## [1.1.0] - 2024-06-23
 ## [1.1.1] - 2024-06-26
+## [1.1.2] - 2024-08-17
+## [1.2.0] - 2024-09-08
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swagger_autogenerate (1.1.1)
+    swagger_autogenerate (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -64,7 +64,7 @@ This file should contain the test scenarios for each action (e.g., index, show,
 
 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
+SWAGGER_PATH='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.

data/lib/swagger_autogenerate/configuration.rb

@@ -1,15 +1,19 @@
 module SwaggerAutogenerate
   class Configuration
-    attr_accessor :with_config, :with_multiple_examples, :with_example_description,
-                  :with_response_description, :swagger_environment_variable,
-                  :environment_name, :security, :swagger_config, :response_status
+    attr_accessor :with_config, :with_multiple_examples, :with_rspec_examples, :with_example_description,
+                  :with_response_description, :swagger_path_environment_variable, :generate_swagger_environment_variable,
+                  :default_path, :environment_name, :security, :swagger_config, :response_status
 
     def initialize
       @with_config = true
       @with_multiple_examples = true
+      @with_rspec_examples = true
+      # remove this when we do not need it any more
       @with_example_description = true
       @with_response_description = true
-      @swagger_environment_variable = 'SWAGGER'
+      @swagger_path_environment_variable = 'SWAGGER_PATH'
+      @generate_swagger_environment_variable = 'SWAGGER_GENERATE'
+      @default_path = 'swagger'
       @environment_name = :test
       @security = default_security
       @swagger_config = default_swagger_config
@@ -78,4 +82,9 @@ module SwaggerAutogenerate
   def self.configure
     yield(configuration)
   end
+
+  def self.extract_description(full_rspec_description)
+    parts = full_rspec_description.split(' ')
+    parts&.length > 1 ? parts[2..-1].join(" ") : full_rspec_description
+  end
 end

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -5,11 +5,12 @@ module SwaggerAutogenerate
     def initialize(request, response)
       @with_config = ::SwaggerAutogenerate.configuration.with_config
       @with_multiple_examples = ::SwaggerAutogenerate.configuration.with_multiple_examples
-      @with_example_description = ::SwaggerAutogenerate.configuration.with_example_description
+      @with_rspec_examples = ::SwaggerAutogenerate.configuration.with_rspec_examples
       @with_response_description = ::SwaggerAutogenerate.configuration.with_response_description
       @security = ::SwaggerAutogenerate.configuration.security
       @swagger_config = ::SwaggerAutogenerate.configuration.swagger_config
       @response_status = ::SwaggerAutogenerate.configuration.response_status
+      @default_path = ::SwaggerAutogenerate.configuration.default_path
       @request = request
       @response = response
       @@paths = {}
@@ -20,12 +21,20 @@ module SwaggerAutogenerate
       write_swagger_trace
     end
 
-    def self.swagger_environment_variable
-      ::SwaggerAutogenerate.configuration.swagger_environment_variable
+    def self.swagger_path_environment_variable
+      ::SwaggerAutogenerate.configuration.swagger_path_environment_variable
     end
 
-    def swagger_environment_variable
-      SwaggerTrace.swagger_environment_variable
+    def swagger_path_environment_variable
+      SwaggerTrace.swagger_path_environment_variable
+    end
+
+    def self.generate_swagger_environment_variable
+      ::SwaggerAutogenerate.configuration.generate_swagger_environment_variable
+    end
+
+    def generate_swagger_environment_variable
+      SwaggerTrace.generate_swagger_environment_variable
     end
 
     def self.environment_name
@@ -39,8 +48,8 @@ module SwaggerAutogenerate
     private
 
     attr_reader :request, :response, :current_path, :yaml_file, :configuration,
-                :with_config, :with_multiple_examples, :with_example_description,
-                :with_response_description, :security, :response_status, :swagger_config
+                :with_config, :with_multiple_examples, :with_rspec_examples,
+                :with_response_description, :security, :response_status, :swagger_config, :default_path
 
     # main methods
 
@@ -88,6 +97,13 @@ module SwaggerAutogenerate
         data['paths'] = paths
         organize_result(data['paths'])
         data = data.to_hash
+        # handel examples names
+        example_title = full_rspec_description.present? ? full_rspec_description : 'example-0'
+        old_examples = data['paths'][current_path][request.method.downcase]['responses'][response.status.to_s]['content']['application/json']['examples']
+        current_example = old_examples[example_title]
+        new_example(example_title, current_example, old_examples, data['paths'], true)
+        # result
+
         result = add_quotes_to_dates(YAML.dump(data))
         file.write(result)
       end
@@ -209,17 +225,24 @@ module SwaggerAutogenerate
       }
     end
 
-    def convert_to_multipart(payload)
+    def convert_to_multipart(payload, main_key = nil, index = nil)
+      payload_keys.push(main_key) if main_key.present?
       payload.each do |key, value|
         if value.is_a?(Hash)
           payload_keys.push(key)
           convert_to_multipart(value)
+        elsif value.is_a?(Array)
+          value.each_with_index { |v, index| convert_to_multipart(v, key, index) }
         else
           keys = payload_keys.clone
           first_key = keys.shift
-          keys.each { |inner_key| first_key = "#{first_key}[#{inner_key}]" }
-          first_key = "#{first_key}[#{key}]"
+          if index.present?
+            keys.each { |inner_key| first_key = "#{first_key}[#{inner_key}][#{index}]" }
+          else
+            keys.each { |inner_key| first_key = "#{first_key}[#{inner_key}]" }
+          end
 
+          first_key = "#{first_key}[#{key}]"
           payload_hash.merge!({ first_key => { 'type' => schema_type(value), 'example' => example(value) } })
         end
       end
@@ -230,6 +253,8 @@ module SwaggerAutogenerate
       data.map do |key, value|
         if value.is_a?(Hash)
           hash_data.merge!({ key => value })
+        elsif value.is_a?(Array)
+          value.each_with_index { |v, index| convert_to_multipart(v, key) }
         else
           payload_hash.merge!({ key => { 'type' => schema_type(value), 'example' => example(value) } })
         end
@@ -250,10 +275,93 @@ module SwaggerAutogenerate
       }
     end
 
+    def json_to_content_form_data(json)
+      {
+        'multipart/form-data' => {
+          'schema' => build_properties(json)
+        }
+      }
+    end
+
+    def build_properties(json)
+      case json
+      when Hash
+        hash_properties = json.transform_values { |value| build_properties(value) if value.present? }
+        hash_properties = hash_properties.delete_if { |_k, v| !v.present? }
+
+        hashs = {
+          'type' => 'object',
+          'properties' => hash_properties
+        }
+      when Array
+        item_schemas = json.map { |item| build_properties(item) }
+        merged_schema = merge_array_schemas(item_schemas)
+
+        if merged_schema[:type] == 'object'
+          { 'type' => 'array', 'items' => merged_schema }
+        else
+          { 'type' => 'array', 'items' => { 'oneOf' => item_schemas.uniq } }
+        end
+      when String
+        { 'type' => 'string', 'example' => json }
+      when Integer
+        { 'type' => 'integer', 'example' => json }
+      when Float
+        { 'type' => 'number', 'example' => json }
+      when TrueClass, FalseClass
+        { 'type' => 'boolean', 'example' => json }
+      else
+        { 'type' => 'string', 'example' => json.to_s }
+      end
+    end
+
+    def merge_array_schemas(schemas)
+      return {} if schemas.empty?
+
+      # Attempt to merge all schemas into a single schema
+      schemas.reduce do |merged, schema|
+        merge_properties(merged, schema)
+      end
+    end
+
+    def merge_properties(old_data, new_data)
+      return old_data unless old_data.is_a?(Hash) && new_data.is_a?(Hash)
+
+      merged = old_data.dup
+      new_data.each do |key, value|
+        merged[key] = if merged[key].is_a?(Hash) && value.is_a?(Hash)
+                        merge_properties(merged[key], value)
+                      else
+                        value
+                      end
+      end
+      merged
+    end
+
+    def content_application_json_schema_properties(data)
+      hash_data = {}
+      data.map do |key, value|
+        if value.is_a?(Hash)
+          hash_data.merge!({ key => value })
+        elsif value.is_a?(Array)
+          value.each_with_index { |v, index| convert_to_multipart(v, key, index) }
+        else
+          payload_hash.merge!({ key => { 'type' => schema_type(value), 'example' => example(value) } })
+        end
+      end
+
+      convert_to_multipart(hash_data)
+      converted_payload = @payload_hash.clone
+      @payload_hash = nil
+      @payload_keys = nil
+
+      converted_payload
+    end
+
     def content_body(data)
       hash = {}
       # hash.merge!(content_json(data))
-      hash.merge!(content_form_data(data))
+      hash.merge!(json_to_content_form_data(data))
 
       { 'content' => hash }
     end
@@ -332,10 +440,14 @@ module SwaggerAutogenerate
     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
+      if ENV[generate_swagger_environment_variable].present?
+        directory_path = Rails.root.join(default_path).to_s
+        FileUtils.mkdir_p(directory_path) unless File.directory?(directory_path)
+        @swagger_location = "#{directory_path}/#{tags.first}.yaml"
+      elsif ENV[swagger_path_environment_variable].include?('.yaml') || ENV[swagger_path_environment_variable].include?('.yml')
+        @swagger_location = Rails.root.join(ENV.fetch(swagger_path_environment_variable, nil).to_s).to_s
       else
-        directory_path = Rails.root.join(ENV.fetch(swagger_environment_variable, nil).to_s).to_s
+        directory_path = Rails.root.join(ENV.fetch(swagger_path_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
@@ -351,19 +463,18 @@ module SwaggerAutogenerate
     end
 
     def content_json_example(data)
-      hash = {
+      example_title = full_rspec_description.present? ? full_rspec_description : 'example-0'
+
+      {
         'application/json' => {
           'schema' => { 'type' => 'object' },
           'examples' => {
-            'example-0' => {
+            example_title => {
               'value' => data
             }
           }
         }
       }
-      hash['application/json']['examples']['example-0']['description'] = "payload => #{example_description}" if with_example_description && !example_description.empty?
-
-      hash
     end
 
     def example_description
@@ -396,20 +507,48 @@ module SwaggerAutogenerate
       @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
+    def new_example(example_title, current_example, old_examples, all_paths = yaml_file['paths'], with_schema_properties = false)
+      if !old_examples.value?(current_example)
+        last_example = handel_name_last_example(old_examples)
+        last_example ||= example_title
+        last_example = example_title unless with_multiple_examples
+        all_paths[current_path][request.method.downcase]['responses'][response.status.to_s]['content']['application/json']['examples'][last_example] = current_example
+        add_properties_to_schema(last_example, all_paths[current_path])
+      elsif with_schema_properties
+        add_properties_to_schema(full_rspec_description.present? ? full_rspec_description : 'example-0', all_paths[current_path])
       end
 
       true
     end
 
+    def handel_name_last_example(old_examples)
+      last_example = old_examples.keys.last
+      last_example += '-1' if json_example_plus_one(last_example) == last_example
+      json_example_plus_one(last_example)
+    end
+
+    def add_properties_to_schema(last_example, main_path = yaml_file['paths'][current_path])
+      parameters = {}
+      parameters.merge!(request_parameters.values.first, query_parameters.values.first, path_parameters.values.first)
+      hash = {
+        last_example => build_properties(parameters.as_json)
+      }
+
+      main_path[request.method.downcase]['responses'][response.status.to_s].deep_merge!(
+        {
+          'content' => {
+            'application/json' => {
+              'schema' => {
+                'description' => 'These are the payloads for each example',
+                'type' => 'object',
+                'properties' => hash
+              }
+            }
+          }
+        }
+      )
+    end
+
     def apply_yaml_file_changes
       (check_path || check_method || check_status) &&
         (check_parameters || check_parameter) &&
@@ -438,24 +577,29 @@ module SwaggerAutogenerate
     def check_path
       unless old_paths.key?(current_path)
         yaml_file['paths'].merge!({ current_path => paths[current_path] })
+        update_example_title(true)
       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 }
+        update_example_title(true)
       end
     end
 
     def check_status
+      example_title = full_rspec_description.present? ? full_rspec_description : 'example-0'
       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
+          update_example_title
         else
           yaml_file['paths'][current_path][request.method.downcase]['responses'].merge!(swagger_response)
+          update_example_title(true)
         end
       else
         yaml_file['paths'][current_path][request.method.downcase]['responses'] = swagger_response
+        update_example_title
       end
     end
 
@@ -481,12 +625,31 @@ module SwaggerAutogenerate
 
     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)
+        param_current_hash = paths[current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties']
+        param_current_file = yaml_file['paths'][current_path][request.method.downcase]['requestBody']['content']['multipart/form-data']['schema']['properties']
+        if param_current_hash.present? && param_current_file.present?
+          param_names = param_current_hash.keys - param_current_file.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
+
+    def update_example_title(with_schema_properties = false)
+      example_title = full_rspec_description.present? ? full_rspec_description : 'example-0'
+      current_example = swagger_response[response.status.to_s]['content']['application/json']['examples'][example_title]
+      old_examples = old_paths[current_path][request.method.downcase]['responses'][response.status.to_s]['content']['application/json']['examples']
+      new_example(example_title, current_example, old_examples, yaml_file['paths'], with_schema_properties)
+    end
+
+    def full_rspec_description
+      with_rspec_examples ? SwaggerAutogenerate::SwaggerTrace.rspec_description : nil
+    end
+
+    class << self
+      attr_accessor :rspec_description
+    end
   end
 end

data/lib/swagger_autogenerate/version.rb

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

data/lib/swagger_autogenerate.rb

@@ -8,14 +8,24 @@ module SwaggerAutogenerate
     def process_action(*args)
       super
 
-      if ENV[SwaggerTrace.swagger_environment_variable].present? && Rails.env.send("#{SwaggerTrace.environment_name.to_s}?")
+      if SwaggerAutogenerate.allow_swagger?
         SwaggerTrace.new(request, response).call
       end
     end
   end
+
+  def self.allow_swagger?
+    (ENV[SwaggerTrace.swagger_path_environment_variable].present? || ENV[SwaggerTrace.generate_swagger_environment_variable].present?) &&
+    Rails.env.send("#{SwaggerTrace.environment_name.to_s}?")
+  end
 end
 
-# fix []
-# create command to direct add configuration file in test environment
-# handel headers
-# can the SWAGGER accespt empty value?
+if defined?(RSpec) && SwaggerAutogenerate.allow_swagger?
+  require 'rspec/rails'
+
+  RSpec.configure do |config|
+    config.before(:each) do |example|
+      SwaggerAutogenerate::SwaggerTrace.rspec_description = SwaggerAutogenerate.extract_description(example.metadata[:full_description])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - MohammedBuraiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies: []
 description: Generating Swagger YAML Automatically Based on Existing Test Cases in
   Ruby on Rails