rails-param-validation 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78a64263517a4c6d2d0c0e649cc7a3e4708f4ed1abb96beffb8a52b2acc2f8a0
-  data.tar.gz: dfd6039f8ce21dd31c7f96a93daf9c6b10a490107a4f96be6ceaa33f26e1a7fd
+  metadata.gz: b29564381a128aaceb53b5099cd568cc4cc805545341903fabdde48dfbe54154
+  data.tar.gz: 8374f3dad8e614244d4b2170f8eb218bcc1baf70d965d584d3bc3ce0610c2c0f
 SHA512:
-  metadata.gz: c4862edac9546192dddce87b4d0e846443611db3426ad4b91eb5c3827ddbc72cc7e283dfef1f3ed624ee18fcce52db21a4aa04b5ef359dcf85ea5f707dba5caf
-  data.tar.gz: d0606f8d37a4f2bf9e822c410779be3efbefec1e81c505179d3ecc26780202c0961e6f412bd1d4503a354d5b6c8395dd14ba6027f35840783574ad1a75bd642a
+  metadata.gz: 0dd8afd3ab0c862392cad28163f1001394c4ee028dea4acd98ce1dfa48c14cf48d0a5a2ddcdb7dd38f941dd5009aac88b5ccc29f9ff55add900b1ca4b0a63111
+  data.tar.gz: b09a6e69a242dca2fff49df1a11cf3379d53ed0d10aa241c9d2657e1b052889ce93e40013ee15d614841bdd3b69b7ce9d13fd808608cdce9aa90b872cedb5942

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/lib/rails-param-validation/rails/extensions/validation_extension.rb

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

@@ -20,6 +20,11 @@ module RailsParamValidation
       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
 
     rake_tasks do

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.0"
+  VERSION = "0.2.2"
 end

data/rails-param-validation.gemspec

@@ -6,17 +6,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Oskar Kirmis"]
   spec.email         = ["oskar.kirmis@posteo.de"]
 
-  spec.summary       = "Automatically validate rails parameter types"
-  spec.description   = "Automatically validate rails parameter types"
-  spec.homepage      = "https://git.iftrue.de/okirmis/rails-param-validation"
+  spec.summary       = "Declarative parameter definition and validation for Rails"
+  spec.description   = "Declarative parameter definition and validation for Rails"
+  spec.homepage      = "https://okirmis.github.io/rails-param-validation"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://git.iftrue.de/okirmis/rails-param-validation"
-  spec.metadata["changelog_uri"] = "https://git.iftrue.de/okirmis/rails-param-validation"
+  spec.metadata["source_code_uri"] = "https://github.com/okirmis/rails-param-validation"
+  spec.metadata["changelog_uri"] = "https://github.com/okirmis/rails-param-validation"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies: []
-description: Automatically validate rails parameter types
+description: Declarative parameter definition and validation for Rails
 email:
 - oskar.kirmis@posteo.de
 executables:
@@ -70,14 +70,14 @@ files:
 - lib/rails-param-validation/validators/uuid.rb
 - lib/rails-param-validation/version.rb
 - rails-param-validation.gemspec
-homepage: https://git.iftrue.de/okirmis/rails-param-validation
+homepage: https://okirmis.github.io/rails-param-validation
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://git.iftrue.de/okirmis/rails-param-validation
-  source_code_uri: https://git.iftrue.de/okirmis/rails-param-validation
-  changelog_uri: https://git.iftrue.de/okirmis/rails-param-validation
+  homepage_uri: https://okirmis.github.io/rails-param-validation
+  source_code_uri: https://github.com/okirmis/rails-param-validation
+  changelog_uri: https://github.com/okirmis/rails-param-validation
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -96,5 +96,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Automatically validate rails parameter types
+summary: Declarative parameter definition and validation for Rails
 test_files: []