swagger_autogenerate 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b52220aecae46c5818f0640a1ca979f59d38fba0720e2d5a35685fbb6c06bbd
-  data.tar.gz: 995666a3bd4de256824656420231be0c38d564aa236a6bfca10659d1474908ff
+  metadata.gz: 9156a7957bb459cdcea51aa4aaac537911daeefa44cb6cbceb6756666a924048
+  data.tar.gz: 7505182c0f2e8875ecef5a19bdc1fa63f5af1586896c5d3d9c6fcd8607f4e416
 SHA512:
-  metadata.gz: c966988c943c3d108a30fa1abc38cef2295679e8f02b2f1dd302a64eedca45d5c97f37ff2c30f7ca35c516b92fa797ea6a0670a25ef1c587cef97ab22433f569
-  data.tar.gz: a6e6c285bdad27980d524f221c8ae5204e06a3ed222de805c2c5a6ebcda637c5e312712f395aa9247bae4002182fad5d264056c0b837a9a38c7ff5dd0d105d1c
+  metadata.gz: 723c04173492313fe145364f36a0237b6c0ac490d82ef6bdc57ddd9949180a51319a77af17af6cef65b037811f1771eaa92fab052353ded4751de335e22ef07d
+  data.tar.gz: b1f5897b9e943f27a607575867b3f1fc229888947cffa8ee9ac37e23d76ebc442d6656527216d974bbb2ea9fb8333549833c1e95f6eac538d0c9fc3f75e734d5

data/CHANGELOG.md

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

data/README.md

@@ -37,28 +37,21 @@ To configure the swagger_autogenerate gem in your Rails application, follow thes
 2) Inside the class ApplicationController block.
 3) Add the following code:
 ```
-    include SwaggerAutogenerate if Rails.env.test? && ENV['SWAGGER'].present?
+    include SwaggerAutogenerate if Rails.env.test?
 ```
-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
-2) Open the ./config/initializers/swagger/swagger_autogenerate.rb
+2) Open the ./config/initializers/swagger_autogenerate.rb
 3) Add the following code to the swagger_autogenerate.rb
 ```
-module SwaggerAutogenerate
-  class SwaggerTrace
-    WITH_CONFIG = true
-    WITH_MULTIPLE_EXAMPLES = true
-    WITH_EXAMPLE_DESCRIPTION = true
-    WITH_RESPONSE_DESCRIPTION = true
-    SWAGGER_ENVIRONMENT_VARIABLE = 'SWAGGER'
-  end
+SwaggerAutogenerate.configure do |config|
+  config.with_config = true
+  config.with_example_description = true
+  config.with_multiple_examples = true
+  config.with_response_description = true
 end
+
 ```
 $ This file is optional and allows you to customize the behavior of the gem by providing additional options.
 

data/lib/swagger_autogenerate/{swagger_public_methods.rb → configuration.rb}

@@ -1,5 +1,19 @@
 module SwaggerAutogenerate
-  module SwaggerPublicMethods
+  class Configuration
+    attr_accessor :with_config, :with_multiple_examples, :with_example_description,
+                  :with_response_description, :swagger_environment_variable
+
+    def initialize
+      @with_config = true
+      @with_multiple_examples = true
+      @with_example_description = true
+      @with_response_description = true
+      @swagger_environment_variable = 'SWAGGER'
+      @security = security
+      @swagger_config = swagger_config
+      @response_status = response_status
+    end
+
     def response_status
       {
         100 => 'The initial part of the request has been received, and the client should proceed with sending the remainder of the request',
@@ -46,5 +60,20 @@ module SwaggerAutogenerate
         }
       }
     end
+
+    def security
+      [
+        { 'org_slug' => [] },
+        { 'locale' => [] }
+      ]
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
   end
 end

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
+      @security = ::SwaggerAutogenerate.configuration.security
+      @swagger_config = ::SwaggerAutogenerate.configuration.swagger_config
+      @response_status = ::SwaggerAutogenerate.configuration.response_status
       @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, :security, :response_status
 
     # 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)
 
@@ -301,13 +310,6 @@ module SwaggerAutogenerate
       @@paths ||= {}
     end
 
-    def security
-      [
-        'org_slug' => [],
-        'locale' => []
-      ]
-    end
-
     def controller_name
       request.params['controller'].split('/').last.to_s
     end
@@ -315,10 +317,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 +346,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 +388,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.4"
 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.4
 platform: ruby
 authors:
 - MohammedBuraiah
@@ -25,12 +25,14 @@ files:
 - Rakefile
 - lib/config/initializers/swagger_autogenerate.rb
 - lib/swagger_autogenerate.rb
-- lib/swagger_autogenerate/swagger_public_methods.rb
+- lib/swagger_autogenerate/configuration.rb
 - 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-1.0.2.gem
+- swagger_autogenerate-1.0.3.gem
 - swagger_autogenerate.gemspec
 homepage: https://github.com/MohammedBuraiah/swagger_autogenerate
 licenses: