swagger_autogenerate 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131bed446c702ccaacd09c8e320b10775c1e5cea7dc9a0d894b675302b2b24d1
-  data.tar.gz: a3df01d6c6dc46d1f6e38a0fc8a592dafabba1f2bf52ecb85574284230ce9835
+  metadata.gz: fa0e0d56334a728cbd835bf8ecf0cf4b2c330eb62aeb92e6b9bc20d1251ed5cd
+  data.tar.gz: c5869ad74ec90bffdb1a58bdfbb52645849b14f88e81e876f5b856d280dab536
 SHA512:
-  metadata.gz: fca6c316c35e49ebceecb69b0304a9d818ddf5d7b06b128cf02c339b88ebf17e003d5d4e08d7e1b712d699d12e8eb4d6c68fb3273ff35fefc978bdddeb56a7e3
-  data.tar.gz: b51b77a5ea1b37f800405396483d74d92ba5b5cab4e29e5597ae8f43b42df08982ca9c0c531c0d6caf52caded6a825e3c26f4df356e636deb9614eba0126a85f
+  metadata.gz: 7766553dbaa81ee1506f36727411a24e36d9dd7c73bc4733a2bc034be406b2c94e4526f7c73467e1d383cf3e566fecaa6ea592a06627f4a5778dba61cd5f142e
+  data.tar.gz: ab857ce41cc465f94b961c61d2f3bbeb48195c8bf5472152c43524384caa57313325b852df8417e2c07489fed8ae0e656c941d9c91a395ea6e16895ace7a990c

data/CHANGELOG.md

@@ -10,5 +10,7 @@
 ## [1.0.8] - 2024-06-03
 ## [1.0.9] - 2024-06-04
 ## [1.1.0] - 2024-06-23
+## [1.1.1] - 2024-06-26
+## [1.1.2] - 2024-08-17
 
 - Initial release

data/Gemfile.lock

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

data/lib/swagger_autogenerate/configuration.rb

@@ -1,22 +1,24 @@
 module SwaggerAutogenerate
   class Configuration
-    attr_accessor :with_config, :with_multiple_examples, :with_example_description,
+    attr_accessor :with_config, :with_multiple_examples, :with_rspec_examples, :with_example_description,
                   :with_response_description, :swagger_environment_variable,
                   :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'
       @environment_name = :test
-      @security = security
-      @swagger_config = swagger_config
-      @response_status = response_status
+      @security = default_security
+      @swagger_config = default_swagger_config
+      @response_status = default_response_status
     end
 
-    def response_status
+    def default_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',
@@ -42,7 +44,7 @@ module SwaggerAutogenerate
       }
     end
 
-    def swagger_config
+    def default_swagger_config
       {
         'openapi' => '3.0.0',
         'info' => {
@@ -63,7 +65,7 @@ module SwaggerAutogenerate
       }
     end
 
-    def security
+    def default_security
       [
         { 'org_slug' => [] },
         { 'locale' => [] }
@@ -78,4 +80,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,7 +5,7 @@ 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
@@ -39,7 +39,7 @@ module SwaggerAutogenerate
     private
 
     attr_reader :request, :response, :current_path, :yaml_file, :configuration,
-                :with_config, :with_multiple_examples, :with_example_description,
+                :with_config, :with_multiple_examples, :with_rspec_examples,
                 :with_response_description, :security, :response_status, :swagger_config
 
     # main methods
@@ -88,6 +88,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,24 +216,42 @@ 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
     end
 
     def content_form_data(data)
-      convert_to_multipart(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) }
+        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
@@ -241,10 +266,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
@@ -342,19 +450,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
@@ -387,20 +494,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) &&
@@ -429,24 +564,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
 
@@ -472,12 +612,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.0"
+  VERSION = "1.1.2"
 end

data/lib/swagger_autogenerate.rb

@@ -8,9 +8,23 @@ 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_environment_variable].present? && Rails.env.send("#{SwaggerTrace.environment_name.to_s}?")
+  end
+end
+
+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.0
+  version: 1.1.2
 platform: ruby
 authors:
 - MohammedBuraiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Generating Swagger YAML Automatically Based on Existing Test Cases in
   Ruby on Rails