swaggard 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed70536923570dc261e856336612392dbf360df9e5fbe0854c435eca43be1379
-  data.tar.gz: a838d6c384fe16bc135463d5c356871bc949fa5410f079822b7e79f757817733
+  metadata.gz: d74cf8955c1980e4153b8a1af250e09471b2bdce60e7e59aba84520aaeb66c40
+  data.tar.gz: c82d51b65fe90228bb4428c16426332a69a2af202e442a4e3b728cf6d48581c7
 SHA512:
-  metadata.gz: 99b13f5741da156d8d9f442131f4fd7b5d2cb9c69d5218ae64bcb14beb0937a4918bf7ea3da6cd7ea102c4e99a5b3ccf564107046745af55b45f46fa9442b7e4
-  data.tar.gz: 99c290f273f52991dd9f7fbd26bd3d40e170991e5e5eadbc6417e8d3e228a2d27f3fc5d953263539bb7f35e6096b1241e7b8d759bb6a46ce02f32f65d4ca89ab
+  metadata.gz: ca72d1996855482ef03474325479dae941fbd68b5d2ab7d928c0c132992156bcfe91391ab5bb3aa9b6c48174171a66d9cbf67006e77fab977aec2daab5b1bb9d
+  data.tar.gz: 5d824f78de1e1a2096899be9378e336631fdb4abd5a6b3185d9d6e368353e73a142cf8e942b5315c2557b2f8ef45e48fa5e092cd3f54f0eacf9ff0a5e2847d25

data/README.md

@@ -49,7 +49,7 @@ Make sure the asset pipeline is enabled by either requiring all railties
 or just the sprockets one:
 
     # config/application.rb
-    
+
     require 'sprockets/railtie'
 
 Access your service documentation
@@ -154,7 +154,7 @@ Will generate
 
 ### Controllers
 
-- `@tag name` This is used to indicate under what `name` tag this controller needs to be grouped. If not provided it will use the full controller class name.
+- `@tag name` This is used to indicate under what `name` tag this controller needs to be grouped. If not provided and Con.ignore_untagged_controllers = true it will use the full controller class name.
 - `@query_parameter [type] name` This is used to indicate that your action receives the `name` parameter of `type` on the query string.
 - `@body_parameter [type] name` This is used to indicate that your action receives the `name` parameter of `type` on the body.
 - `@response_class type` This is used to indicate that your action returns a response of `type`.
@@ -163,6 +163,15 @@ Will generate
 - `@form_parameter`
 - `@parameter_list`
 
+If you want to generate documentation for all controllers even for those that don't have a tag do:
+    # config/initializers/swaggard.rb
+    Swaggard.configure do |config|
+      ...
+      config.ignore_untagged_controllers = false
+      ...
+    end
+
+
 ### Models
 
 - `@attr [type] name` This is used to indicate that your models has an attribute `name` of `type`.

data/lib/swaggard/api_definition.rb

@@ -52,7 +52,7 @@ module Swaggard
         'tags'        => @tags.map { |_, tag| tag.to_doc },
         'paths'       => Hash[@paths.values.map { |path| [format_path(path.path), path.to_doc] }],
         'definitions' => Hash[@definitions.merge(Swaggard.configuration.definitions).map { |id, definition| [id, definition.to_doc(@definitions)] }]
-      }
+      }.merge(security_definitions)
     end
 
     private
@@ -62,5 +62,22 @@ module Swaggard
 
       path.gsub(Swaggard.configuration.api_base_path, '')
     end
+
+    def security_definitions
+      security_definitions = Swaggard.configuration.security_definitions
+
+      return {} if security_definitions.empty? && Swaggard.configuration.security.empty?
+
+      Swaggard.configuration.security.keys.each do |authentication_type|
+        next if security_definitions.key?(authentication_type)
+
+        warn "#{authentication_type} not supported by securityDefinitions"
+      end
+
+      {
+        'securityDefinitions' => security_definitions,
+        'security' => Swaggard.configuration.security,
+      }
+    end
   end
 end

data/lib/swaggard/configuration.rb

@@ -21,7 +21,7 @@ module Swaggard
                 :language, :additional_parameters, :schemes, :ignore_undocumented_paths,
                 :license_name, :exclude_base_path_from_paths, :default_response_description,
                 :default_response_status_code, :excluded_paths, :path_parameter_description,
-                :ignore_put_if_patch_exists
+                :ignore_put_if_patch_exists, :ignore_untagged_controllers
 
     def swagger_version
       @swagger_version ||= '2.0'
@@ -117,6 +117,12 @@ module Swaggard
       @ignore_undocumented_paths = false
     end
 
+    def ignore_untagged_controllers
+      return @ignore_untagged_controllers unless @ignore_untagged_controllers.nil?
+
+      @ignore_untagged_controllers = true
+    end
+
     def exclude_base_path_from_paths
       return @exclude_base_path_from_paths unless @exclude_base_path_from_paths.nil?
 
@@ -164,5 +170,21 @@ module Swaggard
 
       @ignore_put_if_patch_exists = false
     end
+
+    def security_definitions
+      @security_definitions ||= {}
+    end
+
+    def security
+      @security ||= {}
+    end
+
+    def add_security_definition(authentication_key, definition)
+      security_definitions[authentication_key] = definition
+    end
+
+    def add_security(authentication_key, scopes = [])
+      security[authentication_key] = scopes
+    end
   end
 end

data/lib/swaggard/parsers/controller.rb

@@ -25,6 +25,10 @@ module Swaggard
       def get_tags(yard_object)
         tags = yard_object.tags.select { |tag| tag.tag_name == 'tag' }
 
+        if tags.empty? && !Swaggard.configuration.ignore_untagged_controllers
+          tags << nil
+        end
+
         tags.map { |tag| Swagger::Tag.new(yard_object, tag) }
       end
     end

data/lib/swaggard/swagger/operation.rb

@@ -94,6 +94,7 @@ module Swaggard
       def definitions
         @responses.map(&:definition).compact.inject({}) do |definitions, definition|
           definitions[definition.id] = definition
+          definitions
         end.tap do |definitions|
           next unless @body_parameter
 

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/spec/fixtures/dummy/config/application.rb

@@ -6,9 +6,6 @@ require File.expand_path('../../../../../lib/swaggard', __FILE__)
 module Dummy
   class Application < Rails::Application
     config.root = File.expand_path('../../', __FILE__)
-
-    # Disable the asset pipeline.
-    config.assets.enabled = false
   end
 end
 

data/spec/integration/swaggard_spec.rb

@@ -12,6 +12,7 @@ describe Swaggard, '.get_doc' do
     Swaggard.configure do |config|
       config.controllers_path = controller_path
       config.routes = Dummy::Application.routes.routes
+      config.ignore_untagged_controllers = false
     end
 
     swagger_json = JSON.dump(Swaggard.get_doc(host))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Adrian Gomez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -194,6 +194,7 @@ files:
 - spec/fixtures/dummy/config/application.rb
 - spec/fixtures/dummy/config/environments/development.rb
 - spec/fixtures/dummy/config/routes.rb
+- spec/fixtures/dummy/log/development.log
 - spec/fixtures/swagger_schema.json
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: 'Swaggard: Swagger Rails REST API doc using yard YARD'
@@ -228,6 +229,7 @@ test_files:
 - spec/fixtures/dummy/config/application.rb
 - spec/fixtures/dummy/config/environments/development.rb
 - spec/fixtures/dummy/config/routes.rb
+- spec/fixtures/dummy/log/development.log
 - spec/fixtures/swagger_schema.json
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb