swagger_autogenerate 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a79f228421fcf8a16a00e06ca839087079f3682a75b59a60db6b80711010958
-  data.tar.gz: f8ee425bfb9d3a65905ebd1a03c527b2d55b52590f217b5e2a400760f964d373
+  metadata.gz: b3f7b9b67269b270dff6c7ec738c7b4ef8cafa149494c41e74671b0a193bc9d1
+  data.tar.gz: dadf1b845cb96e70f375a245d606b0b4a487b6a945e8ea2508bb102d9e0fbca3
 SHA512:
-  metadata.gz: b5867cf7d6d7dd713a5eb84eb2a1f9f222ad7c9e299a99a572fdad5596ddb181d9a47c217cc32345b4cae98aac8af09c9684738cd526d4b481f8282ae932bc90
-  data.tar.gz: 4e58b9f677e91a2811bbbd866ab948f0a5976312e5c7a8df1584337c4dc32d149cb6dd7bac946210abaf4fc14058bcde3ca76419055704d467ff965e830e23d4
+  metadata.gz: 261b31e5e7c4d02f72c3a60c0262d7034210685e690d66babc899c006886bcf4887380e8d0e58904eafa433552fc56f7ee4ac0ffe7c58c2654c2c9c216c2a3ac
+  data.tar.gz: 28034a707e1568ecf04a668427b186729ea92a9709e847d4db6a29d59a02fd866fd394ed6f10e3fa26e34b51d2438309fa4047f0acbf6b86a5e36cdb9aad7821

data/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## [Unreleased]
 
 ## [0.1.1] - 2024-05-27
-## [1.0.1] - 2024-05-31
+## [1.0.2] - 2024-05-31
+## [1.0.3] - 2024-05-31
 
 - Initial release

data/README.md

@@ -7,6 +7,12 @@ automating Swagger YAML generation in Ruby on Rails offers a range of benefits f
 
 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.
 
+## Dependencies
+
+The SwaggerAutogenerate gem depends on the rspec-rails gem, which brings the RSpec testing framework to Ruby on Rails.
+Please install rspec-rails first: https://github.com/rspec/rspec-rails
+Then continue the installation process.
+
 ## Installation
 
 1) Open your Gemfile located at ./Gemfile
@@ -18,7 +24,9 @@ The gem automatically observes the request/response patterns during the executio
     end
     ```
 3) Install the gem and add to the application's Gemfile by executing:
-    $ bundle install
+   ```
+   bundle install
+   ```
 
 ## Configuration
 
@@ -31,6 +39,11 @@ To configure the swagger_autogenerate gem in your Rails application, follow thes
 ```
     include SwaggerAutogenerate if Rails.env.test? && ENV['SWAGGER'].present?
 ```
+in the #Example-step you will set the ENV['SWAGGER'], 
+
+By setting the ENV['SWAGGER'] environment variable, you can specify the path to the new file,
+whether it's a specific file (e.g., ../myfile.yaml) or a directory (e.g., ../docs).
+This flexibility ensures that the documentation can be easily integrated into your project's structure and workflow.
 
 ### Step 2 (optional)
 1) Create a file called swagger_autogenerate.rb in the ./config/initializers
@@ -56,7 +69,7 @@ To generate Swagger YAML documentation for the APIs implemented in the Employees
 $ 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:
+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
 ```
@@ -69,7 +82,3 @@ that the generated documentation will depend on the test scenarios defined in yo
 ## 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/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 = {}
+      @@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
 
@@ -51,13 +60,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_swagger_trace
-      if @paths[current_path][request.method.downcase].present?
-        @paths[current_path][request.method.downcase]['responses'] = swagger_response
+      if paths[current_path][request.method.downcase].present?
+        paths[current_path][request.method.downcase]['responses'] = swagger_response
       end
 
       if File.exist?(swagger_location)
@@ -69,8 +78,8 @@ module SwaggerAutogenerate
 
     def create_file
       File.open(swagger_location, 'w') do |file|
-        data = WITH_CONFIG ? swagger_config : {}
-        data['paths'] = @paths
+        data = with_config ? swagger_config : {}
+        data['paths'] = paths
         organize_result(data['paths'])
         data = data.to_hash
         result = add_quotes_to_dates(YAML.dump(data))
@@ -85,15 +94,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
@@ -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)
 
@@ -298,7 +307,7 @@ module SwaggerAutogenerate
     # Static
 
     def paths
-      @paths ||= {}
+      @@paths ||= {}
     end
 
     def security
@@ -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
 
@@ -420,7 +429,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
 
@@ -444,29 +453,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 = "1.0.1"
+  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.1
+  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: