swagger_autogenerate 0.1.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0f62fcc9ee0b49602228fb12f2eef9705003adbfcbcd5f007e32b00482d5e4
-  data.tar.gz: f24efab21ce5bec0391a427ef5b7e31651861eb2d78cfb881de3bd79880399e8
+  metadata.gz: 0b52220aecae46c5818f0640a1ca979f59d38fba0720e2d5a35685fbb6c06bbd
+  data.tar.gz: 995666a3bd4de256824656420231be0c38d564aa236a6bfca10659d1474908ff
 SHA512:
-  metadata.gz: fb29b9a142927b93020502301c0149a41e5bda396c48b21b36c78ecd98cc2dfd7e2208ff6f82d4e76c324493d1d28fbc8fcb30ff297ed77d9244f37ec0a179b3
-  data.tar.gz: 82fee73951f7f4791492f7ee37e7ff9384a52c915e6569012f071632be3296d017ff46e6e1960b1f256d2bf7be7785c6d88530d828eb3b7a53ebae476c69cacc
+  metadata.gz: c966988c943c3d108a30fa1abc38cef2295679e8f02b2f1dd302a64eedca45d5c97f37ff2c30f7ca35c516b92fa797ea6a0670a25ef1c587cef97ab22433f569
+  data.tar.gz: a6e6c285bdad27980d524f221c8ae5204e06a3ed222de805c2c5a6ebcda637c5e312712f395aa9247bae4002182fad5d264056c0b837a9a38c7ff5dd0d105d1c

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
 
 ## [0.1.1] - 2024-05-27
-
+## [1.0.2] - 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

@@ -17,8 +17,10 @@ module SwaggerAutogenerate
     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|
@@ -53,7 +55,7 @@ module SwaggerAutogenerate
       paths[path.to_s].merge!(hash)
     end
 
-    def write_swaggger_trace
+    def write_swagger_trace
       if paths[current_path][request.method.downcase].present?
         paths[current_path][request.method.downcase]['responses'] = swagger_response
       end

data/lib/swagger_autogenerate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.2
 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: Generating Swagger YAML Automatically Based on Existing Test Cases in
   Ruby on Rails
@@ -29,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: