media_types-validation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53701447adf5bc4114c48808916b5d507dabe56c8524ca06fd73a5d23d5e3c1e
-  data.tar.gz: 96ef62f1a31fb84e326351ab3dd3bc545ea78d4708654b76ff894639c9f506cb
+  metadata.gz: 7af4e0eddfb876d2fcf698fab8bd96deac9ac5c34a3b1c60567c21119597db51
+  data.tar.gz: 1c6d6482a8a4701ff65dc7deec8d5568bfcdf2ae5fa0d62d7b4fa53dcb5e35d5
 SHA512:
-  metadata.gz: 3b0b96ac327396ec47f0a90d84673fd9ca6f9f7d5990282928e4db4c45d2473d68d765339d2b1ff65462f4b4226bef138bf69b6119b30fd34108cd9652c39f7f
-  data.tar.gz: d771030d27b4de87739c27f5887a4c7c6e258bde5a72468b4f2fb9c0f2837ac58c3c8755e934c0c50e5cb3a528517b3e40002593614bb5ba546f442569671cde
+  metadata.gz: e7404580d33f3875931fc4199ed3127048132c03c473599a145b77439e43d4276bf44af5f34ec69b6c6764ca251570877f093fd2e00480ea7a3e5d2ff1be7f38
+  data.tar.gz: c1cb7e6869e220d9574801430578f63e624fe31f051175bb6cc8e7d4a05922388a1672e5be471191dbd1d89840d4b064cb37153ea58fafcd79f214b5114e447a

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 0.2.0
+
+- Add `instance_exec` execution for procs and configuration
+- Remove controller argument for validation proc
+- Add tests
+
+## 0.1.0
+
+:baby: initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    media_types-validation (0.1.0)
+    media_types-validation (0.2.0)
       activesupport (>= 4.0.0)
       media_types (>= 0.6.0)
       oj (>= 3.5.0)

data/README.md

@@ -24,7 +24,10 @@ Or install it yourself as:
 
 ## Usage
 
-I
+If you add the `MediaTypes::Validation` controller concern, `validate_json_with_media_type` becomes available during
+actions. This does _not_ validate only `JSON` output, but stringifies and then parses the body as `JSON`, so the 
+limitations of `JSON` apply. This step is necessary in order to make sure `rails` types and others are first correctly
+casted (and formatted).
 
 ```ruby
 require 'media_types/validation'
@@ -51,19 +54,22 @@ class BookController < ApiController
 end
 ```
 
+By default, this method only outputs to `stderr` when something is wrong; see configuration below if you want to assign
+your own behaviour, such as adding a `Warn` header, or raising a server error.
+
 ### Configuration
 
 In an initializer you can set procs in order to change the default behaviour:
 
 ```ruby
-MediaTypes::Validation.configure do |this|
-  this.json_invalid_media_proc = proc do |controller, media_type:, err:, body:| 
-    controller.response['Warn'] = '199 media type %s is invalid (%s)' % [media_type, err]
-    warn controller.response['Warn'] + "\n" + body
+MediaTypes::Validation.configure do
+  self.json_invalid_media_proc = proc do |media_type:, err:, body:| 
+    response['Warn'] = '199 media type %s is invalid (%s)' % [media_type, err]
+    warn response['Warn'] + "\n" + body
   end
   
   # Or alternatively you can always raise
-  this.raise_on_json_invalid_media = true
+  self.raise_on_json_invalid_media = true
 end
 ```
 

data/lib/media_types/validation.rb

@@ -10,10 +10,10 @@ module MediaTypes
 
     extend ActiveSupport::Concern
 
-    attr_accessor :json_invalid_media_proc, :raise_on_json_invalid_media
+    mattr_accessor :json_invalid_media_proc, :raise_on_json_invalid_media
 
-    def self.configure
-      yield self
+    def self.configure(&block)
+      instance_exec self, &block
     end
 
     def validate_json_with_media_type(body, media_type:)
@@ -42,7 +42,7 @@ module MediaTypes
       json_valid_media_or_throw?(body, media_type: media_type)
     rescue ::MediaTypes::Scheme::ValidationError => err
       if json_invalid_media_proc.respond_to?(:call)
-        json_invalid_media_proc(self, media_type: media_type, err: err, body: body)
+        instance_exec(media_type: media_type, err: err, body: body, &json_invalid_media_proc)
       else
         message = format(
           '[media type validation] The data being sent as %<media_type>s is invalid:' + "\n" \

data/lib/media_types/validation/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Validation
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: media_types-validation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,6 +109,7 @@ files:
 - ".idea/modules.xml"
 - ".idea/vcs.xml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock