swagger_autogenerate 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adeb3bac00fabb0f8f62df4b322a3a2ee4dc0068c5c404e9533e1a0e9f75f5b
-  data.tar.gz: 10a0f11601d637b23378d2808a055e1140b4a79be7080b1e40ca4b5b668f2c57
+  metadata.gz: 5a79f228421fcf8a16a00e06ca839087079f3682a75b59a60db6b80711010958
+  data.tar.gz: f8ee425bfb9d3a65905ebd1a03c527b2d55b52590f217b5e2a400760f964d373
 SHA512:
-  metadata.gz: ea65f1e69465f1deda419b6fda47d775a2935f71c8cbd1dd0b3bbdc268e777d76212c4d7b66ab43743f69fa54b303f51259f984a713ed2c95810d22e1afa0d3f
-  data.tar.gz: b82d945b513d0e7c9bfa7f395985659043d9bff8c0bf782cc8c91dfd4664a16d612da7575546186fb7d18907622c97eefbc7d15d43bfb9f8db0d8c5bfd24f097
+  metadata.gz: b5867cf7d6d7dd713a5eb84eb2a1f9f222ad7c9e299a99a572fdad5596ddb181d9a47c217cc32345b4cae98aac8af09c9684738cd526d4b481f8282ae932bc90
+  data.tar.gz: 4e58b9f677e91a2811bbbd866ab948f0a5976312e5c7a8df1584337c4dc32d149cb6dd7bac946210abaf4fc14058bcde3ca76419055704d467ff965e830e23d4

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-02-20
+## [0.1.1] - 2024-05-27
+## [1.0.1] - 2024-05-31
 
 - Initial release

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -13,12 +13,14 @@ module SwaggerAutogenerate
     def initialize(request, response)
       @request = request
       @response = response
-      @@paths = {}
+      @paths = {}
     end
 
     def call
-      read_swaggger_trace
-      write_swaggger_trace
+      if ENV[SWAGGER_ENVIRONMENT_VARIABLE].present?
+        read_swagger_trace
+        write_swagger_trace
+      end
     end
 
     private
@@ -27,7 +29,7 @@ module SwaggerAutogenerate
 
     # main methods
 
-    def read_swaggger_trace
+    def read_swagger_trace
       path = request.path
 
       request.path_parameters.except(:controller, :format, :action).each do |k, v|
@@ -49,13 +51,13 @@ module SwaggerAutogenerate
         }
 
       hash[method].except!('requestBody') if hash[method]['requestBody'].blank?
-      paths[path.to_s] ||= {}
-      paths[path.to_s].merge!(hash)
+      @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
+    def write_swagger_trace
+      if @paths[current_path][request.method.downcase].present?
+        @paths[current_path][request.method.downcase]['responses'] = swagger_response
       end
 
       if File.exist?(swagger_location)
@@ -68,7 +70,7 @@ module SwaggerAutogenerate
     def create_file
       File.open(swagger_location, 'w') do |file|
         data = WITH_CONFIG ? swagger_config : {}
-        data['paths'] = paths
+        data['paths'] = @paths
         organize_result(data['paths'])
         data = data.to_hash
         result = add_quotes_to_dates(YAML.dump(data))
@@ -83,15 +85,15 @@ module SwaggerAutogenerate
         permitted_classes: [Symbol, Date, ActiveSupport::HashWithIndifferentAccess]
       )
 
-      return create_file if yaml_file.nil? || yaml_file['paths'].nil?
+      return create_file if @yaml_file.nil? || @yaml_file['paths'].nil?
 
-      yaml_file.merge!(swagger_config) if WITH_CONFIG
+      @yaml_file.merge!(swagger_config) if WITH_CONFIG
 
       apply_yaml_file_changes
-      organize_result(yaml_file['paths'])
-      @yaml_file = convert_to_hash(yaml_file)
+      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))
+        result = add_quotes_to_dates(YAML.dump(@yaml_file))
         file.write(result)
       end
     end
@@ -296,7 +298,7 @@ module SwaggerAutogenerate
     # Static
 
     def paths
-      @@paths ||= {}
+      @paths ||= {}
     end
 
     def security
@@ -418,7 +420,7 @@ module SwaggerAutogenerate
 
     def check_path
       unless old_paths.key?(current_path)
-        yaml_file['paths'].merge!({ current_path => paths[current_path] })
+        yaml_file['paths'].merge!({ current_path => @paths[current_path] })
       end
     end
 
@@ -442,29 +444,29 @@ module SwaggerAutogenerate
 
     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']
+        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 = @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 }
+        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']
+      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
+      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 }
+          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

data/lib/swagger_autogenerate/version.rb

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

data/swagger_autogenerate.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary = "Automating Swagger YAML generation in Ruby on Rails offers a range of benefits for API documentation"
+  spec.description = "Generating Swagger YAML Automatically Based on Existing Test Cases in Ruby on Rails"
   spec.homepage = "https://github.com/MohammedBuraiah/swagger_autogenerate"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - MohammedBuraiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies: []
-description: Write a longer description or delete this line.
+description: Generating Swagger YAML Automatically Based on Existing Test Cases in
+  Ruby on Rails
 email:
 - mohammed.buraiah.1996@gmail.com
 executables: []
@@ -28,6 +29,8 @@ files:
 - lib/swagger_autogenerate/swagger_trace.rb
 - lib/swagger_autogenerate/version.rb
 - sig/swagger_autogenerate.rbs
+- swagger_autogenerate-0.1.0.gem
+- swagger_autogenerate-0.1.1.gem
 - swagger_autogenerate.gemspec
 homepage: https://github.com/MohammedBuraiah/swagger_autogenerate
 licenses:
@@ -55,5 +58,6 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Automating Swagger YAML generation in Ruby on Rails offers a range of benefits
+  for API documentation
 test_files: []