swagger_autogenerate 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b52220aecae46c5818f0640a1ca979f59d38fba0720e2d5a35685fbb6c06bbd
-  data.tar.gz: 995666a3bd4de256824656420231be0c38d564aa236a6bfca10659d1474908ff
+  metadata.gz: b3f7b9b67269b270dff6c7ec738c7b4ef8cafa149494c41e74671b0a193bc9d1
+  data.tar.gz: dadf1b845cb96e70f375a245d606b0b4a487b6a945e8ea2508bb102d9e0fbca3
 SHA512:
-  metadata.gz: c966988c943c3d108a30fa1abc38cef2295679e8f02b2f1dd302a64eedca45d5c97f37ff2c30f7ca35c516b92fa797ea6a0670a25ef1c587cef97ab22433f569
-  data.tar.gz: a6e6c285bdad27980d524f221c8ae5204e06a3ed222de805c2c5a6ebcda637c5e312712f395aa9247bae4002182fad5d264056c0b837a9a38c7ff5dd0d105d1c
+  metadata.gz: 261b31e5e7c4d02f72c3a60c0262d7034210685e690d66babc899c006886bcf4887380e8d0e58904eafa433552fc56f7ee4ac0ffe7c58c2654c2c9c216c2a3ac
+  data.tar.gz: 28034a707e1568ecf04a668427b186729ea92a9709e847d4db6a29d59a02fd866fd394ed6f10e3fa26e34b51d2438309fa4047f0acbf6b86a5e36cdb9aad7821

data/CHANGELOG.md

@@ -2,4 +2,6 @@
 
 ## [0.1.1] - 2024-05-27
 ## [1.0.2] - 2024-05-31
+## [1.0.3] - 2024-05-31
+
 - Initial release

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -1,31 +1,40 @@
 require_relative 'swagger_public_methods'
+require_relative 'configuration'
 
 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)
+      @with_config = ::SwaggerAutogenerate.configuration.with_config
+      @with_multiple_examples = ::SwaggerAutogenerate.configuration.with_multiple_examples
+      @with_example_description = ::SwaggerAutogenerate.configuration.with_example_description
+      @with_response_description = ::SwaggerAutogenerate.configuration.with_response_description
       @request = request
       @response = response
       @@paths = {}
     end
 
     def call
-      if ENV[SWAGGER_ENVIRONMENT_VARIABLE].present?
+      if ENV[swagger_environment_variable].present?
         read_swagger_trace
         write_swagger_trace
       end
     end
 
+    def self.swagger_environment_variable
+      ::SwaggerAutogenerate.configuration.swagger_environment_variable
+    end
+
+    def swagger_environment_variable
+      SwaggerTrace.swagger_environment_variable
+    end
+
     private
 
-    attr_reader :request, :response, :current_path, :yaml_file
+    attr_reader :request, :response, :current_path, :yaml_file, :configuration,
+                :with_config, :with_multiple_examples, :with_example_description,
+                :with_response_description
 
     # main methods
 
@@ -69,7 +78,7 @@ module SwaggerAutogenerate
 
     def create_file
       File.open(swagger_location, 'w') do |file|
-        data = WITH_CONFIG ? swagger_config : {}
+        data = with_config ? swagger_config : {}
         data['paths'] = paths
         organize_result(data['paths'])
         data = data.to_hash
@@ -87,7 +96,7 @@ module SwaggerAutogenerate
 
       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'])
@@ -185,7 +194,7 @@ module SwaggerAutogenerate
         swagger_response = { 'file' => 'file/data' }
       end
 
-      hash['description'] = response_description if WITH_RESPONSE_DESCRIPTION
+      hash['description'] = response_description if with_response_description
       hash['headers'] = {} # response.headers
       hash['content'] = content_json_example(swagger_response)
 
@@ -315,10 +324,10 @@ 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[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
+        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
@@ -344,7 +353,7 @@ module SwaggerAutogenerate
           }
         }
       }
-      hash['application/json']['examples']['example-0']['description'] = "payload => #{example_description}" if WITH_EXAMPLE_DESCRIPTION && !example_description.empty?
+      hash['application/json']['examples']['example-0']['description'] = "payload => #{example_description}" if with_example_description && !example_description.empty?
 
       hash
     end
@@ -386,7 +395,7 @@ module SwaggerAutogenerate
       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
+        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
 

data/lib/swagger_autogenerate/version.rb

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

data/lib/swagger_autogenerate.rb

@@ -5,7 +5,7 @@ module SwaggerAutogenerate
   require_relative 'swagger_autogenerate/swagger_trace.rb'
 
   included do
-    if defined?(Rails) && Rails.env.test? && ENV[SwaggerTrace::SWAGGER_ENVIRONMENT_VARIABLE].present?
+    if defined?(Rails) && ENV[SwaggerTrace.swagger_environment_variable].present?
       def process_action(*args)
         super
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - MohammedBuraiah
@@ -31,6 +31,7 @@ files:
 - sig/swagger_autogenerate.rbs
 - swagger_autogenerate-0.1.0.gem
 - swagger_autogenerate-0.1.1.gem
+- swagger_autogenerate-1.0.2.gem
 - swagger_autogenerate.gemspec
 homepage: https://github.com/MohammedBuraiah/swagger_autogenerate
 licenses: