swagger_autogenerate 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f7b9b67269b270dff6c7ec738c7b4ef8cafa149494c41e74671b0a193bc9d1
-  data.tar.gz: dadf1b845cb96e70f375a245d606b0b4a487b6a945e8ea2508bb102d9e0fbca3
+  metadata.gz: 9156a7957bb459cdcea51aa4aaac537911daeefa44cb6cbceb6756666a924048
+  data.tar.gz: 7505182c0f2e8875ecef5a19bdc1fa63f5af1586896c5d3d9c6fcd8607f4e416
 SHA512:
-  metadata.gz: 261b31e5e7c4d02f72c3a60c0262d7034210685e690d66babc899c006886bcf4887380e8d0e58904eafa433552fc56f7ee4ac0ffe7c58c2654c2c9c216c2a3ac
-  data.tar.gz: 28034a707e1568ecf04a668427b186729ea92a9709e847d4db6a29d59a02fd866fd394ed6f10e3fa26e34b51d2438309fa4047f0acbf6b86a5e36cdb9aad7821
+  metadata.gz: 723c04173492313fe145364f36a0237b6c0ac490d82ef6bdc57ddd9949180a51319a77af17af6cef65b037811f1771eaa92fab052353ded4751de335e22ef07d
+  data.tar.gz: b1f5897b9e943f27a607575867b3f1fc229888947cffa8ee9ac37e23d76ebc442d6656527216d974bbb2ea9fb8333549833c1e95f6eac538d0c9fc3f75e734d5

data/CHANGELOG.md

@@ -2,6 +2,6 @@
 
 ## [0.1.1] - 2024-05-27
 ## [1.0.2] - 2024-05-31
-## [1.0.3] - 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,15 +1,15 @@
-require_relative 'swagger_public_methods'
 require_relative 'configuration'
 
 module SwaggerAutogenerate
   class SwaggerTrace
-    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 = {}
@@ -34,7 +34,7 @@ module SwaggerAutogenerate
 
     attr_reader :request, :response, :current_path, :yaml_file, :configuration,
                 :with_config, :with_multiple_examples, :with_example_description,
-                :with_response_description
+                :with_response_description, :security, :response_status
 
     # main methods
 
@@ -310,13 +310,6 @@ module SwaggerAutogenerate
       @@paths ||= {}
     end
 
-    def security
-      [
-        'org_slug' => [],
-        'locale' => []
-      ]
-    end
-
     def controller_name
       request.params['controller'].split('/').last.to_s
     end

data/lib/swagger_autogenerate/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - MohammedBuraiah
@@ -25,13 +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: