rails-param-validation 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a1fa3f1a48672b525b0d690217217a0d3552168d0a8abe2ec6b60e57c179a5
-  data.tar.gz: 024efd90c1662104364b1d66047f96b505520b8938e39533f999c269ca09b038
+  metadata.gz: 1e81185301762be6703608dfc575c27813c49fde9969057c0b821c7cc78f7680
+  data.tar.gz: 5c3c75f3d2a8e6275d1c794540d972e62b13ada2592a5602ca71bb80794d6f05
 SHA512:
-  metadata.gz: c8025d62a6b23ee1526dc3b2f94592b51a3b37cc5e194122f4fa259bd3ca2f47b617fe149fb656ad0abfa6f773c003984246dd5e5b8c782c770ac94d7477478e
-  data.tar.gz: 13e08dda8a5baa630e3a808c3a37d7c24f8fc4b13959e0aa3131ef05f473b3eab6859dd37927604727419308a5fe3a16d4f6b0848082bdfb41786fc21c14f4ba
+  metadata.gz: 1af2e48e2ef3d6af489e009177839378b5e19b8817a456a9cb1e399e525b2a974d52ed1986a321c44035248c527d8ef1b7711de0e175252791a12567a8bd98da
+  data.tar.gz: b4528b9e92d0c7079cced511255760766771ba6b6f9e5f013d8f1049bdf1fce6f10f86750760bae7ebb12d53ce66b027d18d4228c7dd953d5f1e6fa70af60979

data/docs/annotations.md

@@ -24,15 +24,15 @@ end
 
 **query_param**
 
-Parameter passed via query string, e.g. `http://localhost/my_action?parameter=value`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./docs/type-definition.md). The last (optional) parameter to this call is the description.
+Parameter passed via query string, e.g. `http://localhost/my_action?parameter=value`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
 
 **path_param**
 
-Parameter passed as part of the actions route, e.g. `http://localhost/my_action/value` where the route definition is something like `get '/my_action/:parameter, to: 'my_controller#my_action'`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./docs/type-definition.md). The last (optional) parameter to this call is the description.
+Parameter passed as part of the actions route, e.g. `http://localhost/my_action/value` where the route definition is something like `get '/my_action/:parameter, to: 'my_controller#my_action'`. The first value is the parameter name (which must be a symbol), the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
 
 **body_param**
 
-Parameter as part of a JSON body in a POST/PUT/PATCH operation. The first value is the parameter name (which must be a symbol) as the JSON body must be a JSON object which has a key named like the parameter. The second parameter is the [type definition](./docs/type-definition.md). The last (optional) parameter to this call is the description.
+Parameter as part of a JSON body in a POST/PUT/PATCH operation. The first value is the parameter name (which must be a symbol) as the JSON body must be a JSON object which has a key named like the parameter. The second parameter is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
 
 Example body:
 
@@ -55,7 +55,7 @@ end
 
 **response**
 
-The response annotation defines the possible responses the action can generate, where the first parameter is the HTTP status code, the second is the [type definition](./docs/type-definition.md). The last (optional) parameter to this call is the description.
+The response annotation defines the possible responses the action can generate, where the first parameter is the HTTP status code, the second is the [type definition](./type-definition.md). The last (optional) parameter to this call is the description.
 
 **accept_all_params**
 

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,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
+    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)
+      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/extensions/validation_extension.rb

@@ -50,22 +50,30 @@ module RailsParamValidation
     end
 
     def _render_invalid_param_response(result)
-      # Depending on the accept header, choose the way to answer
-      respond_to do |format|
-        format.html do
-          if RailsParamValidation.config.use_default_html_response
-            _create_html_error result
-          else
-            raise ParamValidationFailedError.new(result)
+      if respond_to? :respond_to
+        # Depending on the accept header, choose the way to answer
+        respond_to do |format|
+          format.html do
+            if RailsParamValidation.config.use_default_html_response
+              _create_html_error result
+            else
+              raise ParamValidationFailedError.new(result)
+            end
           end
-        end
-        format.json do
-          if RailsParamValidation.config.use_default_json_response
-            _create_json_error result
-          else
-            raise ParamValidationFailedError.new(result)
+          format.json do
+            if RailsParamValidation.config.use_default_json_response
+              _create_json_error result
+            else
+              raise ParamValidationFailedError.new(result)
+            end
           end
         end
+      else
+        if RailsParamValidation.config.use_default_json_response
+          _create_json_error result
+        else
+          raise ParamValidationFailedError.new(result)
+        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/rails/rails.rb

@@ -16,10 +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
+      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,5 +1,9 @@
 module RailsParamValidation
 
+def self.register(type, schema)
+  AnnotationTypes::CustomT.register type, schema
+end
+
 module AnnotationTypes
 class AnnotationT
   attr_reader :inner_type

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

@@ -3,11 +3,10 @@ module RailsParamValidation
   class CustomTypeValidator < Validator
     def initialize(type)
       super type
-      @validator = ValidatorFactory.create type.schema
     end
 
     def matches?(path, data)
-      @validator.matches? path, data
+      ValidatorFactory.create(schema.schema).matches? path, data
     end
 
     def to_openapi

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

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.1.2"
+  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.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-07-27 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.0.2
 signing_key: 
 specification_version: 4
 summary: Declarative parameter definition and validation for Rails