rails-param-validation 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b29564381a128aaceb53b5099cd568cc4cc805545341903fabdde48dfbe54154
-  data.tar.gz: 8374f3dad8e614244d4b2170f8eb218bcc1baf70d965d584d3bc3ce0610c2c0f
+  metadata.gz: 9f36c1fb9e60cc1162e7a1baae9953e77441018a1a12825d72b97731a645d760
+  data.tar.gz: d4100447e253b96a02cb407dcde58c941ac44f6fb3046f1a54dd17172bcdad6e
 SHA512:
-  metadata.gz: 0dd8afd3ab0c862392cad28163f1001394c4ee028dea4acd98ce1dfa48c14cf48d0a5a2ddcdb7dd38f941dd5009aac88b5ccc29f9ff55add900b1ca4b0a63111
-  data.tar.gz: b09a6e69a242dca2fff49df1a11cf3379d53ed0d10aa241c9d2657e1b052889ce93e40013ee15d614841bdd3b69b7ce9d13fd808608cdce9aa90b872cedb5942
+  metadata.gz: 88ff549087489e388b4341a3646930ce38a07f6275fe1649f59181e2940f2ce4086a644300f7574760c654eac71c2d202ffb7ccd7d3b0ac1392ff88fa3e76ee0
+  data.tar.gz: ab7013451be92067596264d5e7f2689be20269276b0850936bc589ac43fe27276e0279344fa74786016f90fdcb77c8cf257f157793a4f8516a16f31dbd0e1dd7

data/docs/type-definition.md

@@ -82,14 +82,14 @@ In this case, `params[:radius].is_a? Float` returns `true`.
 <a name="type-boolean"></a>
 ### Boolean
 
-Accepts a float or a string, which represents a boolean (either `"true"` or `"false"`).
+Accepts a boolean or a string, which represents a boolean (either `"true"` or `"false"`).
 
 Example:
 ```ruby
-query_param :radius, Float, "Search radius"
+query_param :published, Boolean, "Indicate if a blog post is published"
 ```
 
-In this case, `params[:radius].is_a? Float` returns `true`.
+In this case, `params[:published].is_a?(TrueClass) || params[:published].is_a?(FalseClass)` returns `true`.
 
 
 <a name="type-uuid"></a>

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

@@ -1,16 +1,19 @@
 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, :source_file
     attr_accessor :description
 
-    def initialize
+    def initialize(source_file)
       @params = {}
       @paths = []
       @param_validation_enabled = true
       @description = ''
       @request_body_type = RailsParamValidation.config.default_body_content_type if defined?(Rails)
       @responses = {}
+      @flags = {}
+      @source_file = source_file
+      @security = []
     end
 
     def store_origin!(controller, action)
@@ -38,6 +41,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,
@@ -51,7 +66,10 @@ module RailsParamValidation
 
     def finalize!(class_name, method_name)
       @responses.each do |code, response|
-        name = "#{class_name.to_s.capitalize}#{method_name.to_s.camelcase}#{Rack::Utils::SYMBOL_TO_STATUS_CODE.key(code).to_s.camelize}Response".to_sym
+        name = Types::Namespace.with_namespace(
+            Types::Namespace.fetch(@source_file),
+            "#{RailsHelper.clean_controller_name(class_name)}.#{method_name.to_s.camelcase}.#{Rack::Utils::SYMBOL_TO_STATUS_CODE.key(code).to_s.camelize}Response".to_sym
+        )
         AnnotationTypes::CustomT.register(name, response[:schema])
 
         response.merge!(schema: AnnotationTypes::CustomT.new(name))

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

@@ -1,7 +1,7 @@
 module RailsParamValidation
 
   class OpenApiMetaConfig
-    attr_accessor :title, :version, :url, :description
+    attr_accessor :title, :version, :url, :description, :file_path, :security_schemes, :skip_format_endpoints
 
     def initialize
       app_class = Rails.application.class
@@ -10,6 +10,9 @@ module RailsParamValidation
       self.title = app_name(app_class)
       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
@@ -26,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
@@ -34,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)
-        @param_definition = ActionDefinition.new
+      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(Types::Namespace.caller_file)
         @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/extensions/custom_type_extension.rb

@@ -6,7 +6,8 @@ module RailsParamValidation
 
     module ClassMethods
       def declare(type, schema)
-        RailsParamValidation::AnnotationTypes::CustomT.register type, schema
+        namespace = Types::Namespace.fetch(Types::Namespace.caller_file)
+        RailsParamValidation::AnnotationTypes::CustomT.register Types::Namespace.with_namespace(namespace, type), schema
       end
     end
   end

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

@@ -38,9 +38,7 @@ module RailsParamValidation
 
       if result.matches?
         # Copy the parameters if the validation succeeded
-        @validated_parameters = ActiveSupport::HashWithIndifferentAccess.new(
-            result.value.merge(action: action, controller: controller)
-        )
+        @validated_parameters = result.value.merge(action: action, controller: controller)
       else
         # Render an appropriate error message
         _render_invalid_param_response result

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

@@ -4,6 +4,11 @@ module RailsParamValidation
     def self.controller_to_tag(klass)
       (klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').to_sym
     end
+
+    def self.clean_controller_name(klass)
+      klass = klass.to_s if klass.is_a? Symbol
+      (klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').split('::').last.capitalize.to_sym
+    end
   end
 
-end
+end

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

@@ -25,7 +25,7 @@ module RailsParamValidation
         openapi: OPENAPI_VERSION,
         info: { version: @info[:version], title: @info[:title], description: @info[:description] },
         servers: @info[:url].map { |url| { url: url } },
-        tags: @tags.map { |tag, description| { name: tag, description: description } },
+        tags: @tags.map { |tag, description| { name: RailsHelper.clean_controller_name(tag), description: description } },
         paths: {},
         components: { schemas: {} }
       }
@@ -49,8 +49,9 @@ module RailsParamValidation
         RoutingHelper.routes_for(operation.controller.to_s.underscore, operation.action.to_s).each do |route|
           action_definition = {
               operationId: "#{route[:method].downcase}#{route[:path].split(/[^a-zA-Z0-9]+/).map(&:downcase).map(&:capitalize).join}",
-              tags: [operation.controller],
+              tags: [RailsHelper.clean_controller_name(operation.controller)],
               parameters: parameters,
+              security: operation.security,
               responses: operation.responses.map do |status, values|
                 [
                     status.to_s,
@@ -69,7 +70,10 @@ module RailsParamValidation
           action_definition.merge!(summary: operation.description) if operation.description.present?
 
           if body.any?
-            body_type_name = "#{operation.controller.capitalize}#{operation.action.capitalize}Body".to_sym
+            body_type_name = Types::Namespace.with_namespace(
+                Types::Namespace.fetch(operation.source_file),
+                "#{RailsHelper.clean_controller_name operation.controller}.#{operation.action.to_s.camelcase}.Body".to_sym
+            )
             AnnotationTypes::CustomT.register(body_type_name, body)
 
             action_definition[:requestBody] = {
@@ -90,6 +94,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
 
@@ -100,7 +107,7 @@ module RailsParamValidation
         description = AnnotationManager.instance.class_annotation klass, :description
 
         if description
-          @tags[RailsHelper.controller_to_tag klass] = description
+          @tags[RailsHelper.controller_to_tag klass.constantize] = description
         end
 
         AnnotationManager.instance.methods(klass).each do |method|

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/rails/rails.rb

@@ -16,15 +16,17 @@ module RailsParamValidation
     railtie_name :param_validation
 
     initializer 'rails_param_validation.action_controller_extension' do
-      ActionController::Base.send :include, ActionControllerExtension
-      ActionController::Base.send :include, AnnotationExtension
-      ActionController::Base.send :include, CustomTypesExtension
-      ActionController::Base.send :extend, RailsParamValidation::Types
-
-      ActionController::API.send :include, ActionControllerExtension
-      ActionController::API.send :include, AnnotationExtension
-      ActionController::API.send :include, CustomTypesExtension
-      ActionController::API.send :extend, RailsParamValidation::Types
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send :include, ActionControllerExtension
+        ActionController::Base.send :include, AnnotationExtension
+        ActionController::Base.send :include, CustomTypesExtension
+        ActionController::Base.send :extend, RailsParamValidation::Types
+
+        ActionController::API.send :include, ActionControllerExtension
+        ActionController::API.send :include, AnnotationExtension
+        ActionController::API.send :include, CustomTypesExtension
+        ActionController::API.send :extend, RailsParamValidation::Types
+      end
     end
 
     rake_tasks do

data/lib/rails-param-validation/rails/tasks/openapi.rake

@@ -1,6 +1,6 @@
 namespace :openapi do
 
-  desc "Export OpenAPI definition to to openapi.yaml"
+  desc "Export OpenAPI definition to openapi.yaml"
   task export: :environment do
     # Ensure all controllers are loaded
     if defined? Zeitwerk
@@ -18,7 +18,7 @@ namespace :openapi do
         RailsParamValidation.openapi.description
     )
 
-    filename = Rails.root.join("openapi.yaml").to_s
+    filename = RailsParamValidation.openapi.file_path
     print "Writing #{filename}..."
 
     begin

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

@@ -1,7 +1,10 @@
 module RailsParamValidation
 
 def self.register(type, schema)
-  AnnotationTypes::CustomT.register type, schema
+  AnnotationTypes::CustomT.register(
+      Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type),
+      schema
+  )
 end
 
 module AnnotationTypes
@@ -72,6 +75,58 @@ end
 end
 
 module Types
+  class Namespace
+    def self.store(scope, namespace)
+      map[scope] = namespace
+    end
+
+    def self.fetch(scope)
+      path = scope.split('/')
+
+      (path.size - 1).times do
+        key = path.join '/'
+        return map[key] if map.key? key
+
+        path.pop
+      end
+    end
+
+    def self.caller_file
+      caller_locations(2, 1)[0].path
+    end
+
+    def self.with_namespace(namespace, type)
+      if namespace
+        path = namespace.to_s.split('.')
+
+        while type.start_with?("_")
+          type = type[1..-1]
+          path.pop
+        end
+
+        "#{path.join(".")}.#{type}".to_sym
+      else
+        type
+      end
+    end
+
+    class << self
+      protected
+
+      def map
+        @map ||= { '' => nil }
+      end
+    end
+  end
+
+  def FileNamespace(namespace)
+    Namespace.store Namespace.caller_file, namespace
+  end
+
+  def DirectoryNamespace(namespace)
+    Namespace.store File.dirname(caller_locations(1, 1)[0].path), namespace
+  end
+
   def ArrayType(inner_type)
     AnnotationTypes::ArrayT.new(inner_type)
   end
@@ -85,7 +140,7 @@ module Types
   end
 
   def Type(type)
-    AnnotationTypes::CustomT.new(type)
+    AnnotationTypes::CustomT.new(Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type))
   end
 end
 

data/lib/rails-param-validation/validators/constant.rb

@@ -1,6 +1,8 @@
 module RailsParamValidation
 
   class ConstantValidator < Validator
+    CLASS_MAP = { TrueClass => Boolean, FalseClass => Boolean }
+
     def initialize(schema)
       super schema
 
@@ -21,7 +23,7 @@ module RailsParamValidation
     end
 
     def to_openapi
-      ValidatorFactory.create(schema.class).to_openapi.merge(enum: [schema])
+      ValidatorFactory.create(CLASS_MAP.fetch(schema.class, schema.class)).to_openapi.merge(enum: [schema])
     end
   end
 

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

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies: []
 description: Declarative parameter definition and validation for Rails
 email:
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Declarative parameter definition and validation for Rails