rails-param-validation 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b55168eefe4dc2b76d0a342546f807ea6b22475a7a1798a03a53c04943726a6
-  data.tar.gz: e3c250dbb5fc1f9766f75a32146e72a42a1a7250cb261fc528088ac0e6785735
+  metadata.gz: b4a98d65517bb634880f15f8646ee1645a60c00a962c7c604df80c9ead49404f
+  data.tar.gz: 7e755c2e7011fa1c848c1f4cf59ca93232a8829ba081c11b859707e652ed3a9f
 SHA512:
-  metadata.gz: e9591ca7d203ddc520b95a9e1bcce791259d5f16ef31a43b816c6caecf53a1f68214c2b1376b38a822f59d54b29fd35bfccd30e0858361aec3c5e56700dd3a14
-  data.tar.gz: d5d75b3730271590d2c5fb30ad0b7c888a13f350b38af3da66a305e3464f84821145c8147ab81e5072cb4e6394b7f63d02356e1c2a5fb838d3911a3c3d904d24
+  metadata.gz: ceb39335b93f488396532b5317a7cc48ddd633e795417bb30b4c628f790778864024ce83e67affb2a4e91713b9e8f2f8336bdfb3d4998714fbf3ca1df6112518
+  data.tar.gz: 811e141a19bcafadc2a0270620ad844ae104249b45dd9581b0d083694b48874914dba256a304842a4d60fbbc5316ab7013a35027c693166b04ce2c07caeb39e4

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

@@ -1,7 +1,7 @@
 module RailsParamValidation
 
   class OpenApiMetaConfig
-    attr_accessor :title, :version, :url, :description
+    attr_accessor :title, :version, :url, :description, :file_path
 
     def initialize
       app_class = Rails.application.class
@@ -10,6 +10,7 @@ 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
     end
 
     private

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

@@ -38,7 +38,7 @@ module RailsParamValidation
 
       if result.matches?
         # Copy the parameters if the validation succeeded
-        @validated_parameters = result.value
+        @validated_parameters = result.value.merge(action: action, controller: controller)
       else
         # Render an appropriate error message
         _render_invalid_param_response result
@@ -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/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.1"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-07-23 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