rails-param-validation 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4a98d65517bb634880f15f8646ee1645a60c00a962c7c604df80c9ead49404f
-  data.tar.gz: 7e755c2e7011fa1c848c1f4cf59ca93232a8829ba081c11b859707e652ed3a9f
+  metadata.gz: 1e81185301762be6703608dfc575c27813c49fde9969057c0b821c7cc78f7680
+  data.tar.gz: 5c3c75f3d2a8e6275d1c794540d972e62b13ada2592a5602ca71bb80794d6f05
 SHA512:
-  metadata.gz: ceb39335b93f488396532b5317a7cc48ddd633e795417bb30b4c628f790778864024ce83e67affb2a4e91713b9e8f2f8336bdfb3d4998714fbf3ca1df6112518
-  data.tar.gz: 811e141a19bcafadc2a0270620ad844ae104249b45dd9581b0d083694b48874914dba256a304842a4d60fbbc5316ab7013a35027c693166b04ce2c07caeb39e4
+  metadata.gz: 1af2e48e2ef3d6af489e009177839378b5e19b8817a456a9cb1e399e525b2a974d52ed1986a321c44035248c527d8ef1b7711de0e175252791a12567a8bd98da
+  data.tar.gz: b4528b9e92d0c7079cced511255760766771ba6b6f9e5f013d8f1049bdf1fce6f10f86750760bae7ebb12d53ce66b027d18d4228c7dd953d5f1e6fa70af60979

data/lib/rails-param-validation/rails/action_definition.rb

@@ -1,7 +1,7 @@
 module RailsParamValidation
 
   class ActionDefinition
-    attr_reader :params, :request_body_type, :paths, :responses, :controller, :action
+    attr_reader :params, :request_body_type, :paths, :responses, :controller, :action, :security
     attr_accessor :description
 
     def initialize
@@ -11,6 +11,8 @@ module RailsParamValidation
       @description = ''
       @request_body_type = RailsParamValidation.config.default_body_content_type if defined?(Rails)
       @responses = {}
+      @flags = {}
+      @security = []
     end
 
     def store_origin!(controller, action)
@@ -38,6 +40,18 @@ module RailsParamValidation
       }
     end
 
+    def add_security(security)
+      @security.push(security.is_a?(Hash) ? security : { security => [] })
+    end
+
+    def add_flag(name, value)
+      @flags[name.to_sym] = value
+    end
+
+    def flag(name, default)
+      @flags.fetch(name, default)
+    end
+
     def add_response(status, schema, description)
       @responses[status] = {
           schema: schema,

data/lib/rails-param-validation/rails/config.rb

@@ -1,7 +1,7 @@
 module RailsParamValidation
 
   class OpenApiMetaConfig
-    attr_accessor :title, :version, :url, :description, :file_path
+    attr_accessor :title, :version, :url, :description, :file_path, :security_schemes, :skip_format_endpoints
 
     def initialize
       app_class = Rails.application.class
@@ -11,6 +11,8 @@ module RailsParamValidation
       self.version = '1.0'
       self.description = "#{app_name(app_class)} application"
       self.file_path = Rails.root.join("openapi.yaml").to_s
+      self.security_schemes = {}
+      self.skip_format_endpoints = true
     end
 
     private
@@ -27,6 +29,8 @@ module RailsParamValidation
     attr_accessor :use_validator_caching
     attr_accessor :raise_on_missing_annotation
     attr_accessor :default_body_content_type
+    attr_accessor :default_action_flags
+    attr_accessor :post_action_definition_hook
     attr_reader   :openapi
 
     def initialize
@@ -35,6 +39,8 @@ module RailsParamValidation
       @use_validator_caching = Rails.env.production?
       @raise_on_missing_annotation = true
       @default_body_content_type = 'application/json'
+      @default_action_flags = {}
+      @post_action_definition_hook = ->(_action_definition) {}
     end
   end
 

data/lib/rails-param-validation/rails/extensions/annotation_extension.rb

@@ -22,6 +22,7 @@ module RailsParamValidation
           method_name = name.to_sym
 
           @param_definition.store_origin! class_name, method_name
+          RailsParamValidation.config.post_action_definition_hook.call(@param_definition)
           @param_definition.finalize! class_name, method_name
 
           AnnotationManager.instance.annotate_method! self, name, :param_definition, @param_definition
@@ -84,12 +85,21 @@ module RailsParamValidation
         param_definition.add_response status, schema, description
       end
 
-      def action(description = nil)
+      def flag(name, value, _comment = nil)
+        @param_definition.add_flag name, value
+      end
+
+      def security_hint(security)
+        @param_definition.add_security(security)
+      end
+
+      def action(description = nil, flags = RailsParamValidation.config.default_action_flags)
         @param_definition = ActionDefinition.new
         @param_definition.description = description
+        flags.each { |name, value| @param_definition.add_flag name, value }
 
         yield
       end
     end
   end
-end
+end

data/lib/rails-param-validation/rails/openapi/openapi.rb

@@ -51,6 +51,7 @@ module RailsParamValidation
               operationId: "#{route[:method].downcase}#{route[:path].split(/[^a-zA-Z0-9]+/).map(&:downcase).map(&:capitalize).join}",
               tags: [operation.controller],
               parameters: parameters,
+              security: operation.security,
               responses: operation.responses.map do |status, values|
                 [
                     status.to_s,
@@ -90,6 +91,9 @@ module RailsParamValidation
         object[:components][:schemas][name] = ValidatorFactory.create(AnnotationTypes::CustomT.registered(name)).to_openapi
       end
 
+      if RailsParamValidation.openapi.security_schemes.any?
+        object[:components][:securitySchemes] = RailsParamValidation.openapi.security_schemes
+      end
       stringify_values object
     end
 

data/lib/rails-param-validation/rails/openapi/routing_helper.rb

@@ -29,7 +29,9 @@ module RailsParamValidation
       Rails.application.routes.routes.each do |route|
         if route.defaults[:controller] == controller && route.defaults[:action] == action
           Formatter.new.accept(route.path.ast, [""]).each do |path|
-            routes.push(path: path, method: route.verb)
+            if !RailsParamValidation.openapi.skip_format_endpoints || !path.end_with?('.{format}')
+              routes.push(path: path, method: route.verb)
+            end
           end
         end
       end

data/lib/rails-param-validation/version.rb

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies: []
 description: Declarative parameter definition and validation for Rails
 email: