jsonapi_parameters 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140d60d07ed8488d9009e2c0e0757b1fbcf14596d79dc552c48c9212980985fd
-  data.tar.gz: 3480f41f044a29d8d2db32aa64ab10af535997fa5cb772ca1080372abb798e4c
+  metadata.gz: f3245b44f39068e448c0acbf8ad822ebe3891133cfde009c4b6411d3b9a50f1b
+  data.tar.gz: cfc79502f187a3f9453f9b3ba952128e00114a7cc47ea5aaf6047ba5484c49cc
 SHA512:
-  metadata.gz: 8accb91454be6e686e29b4fbee76e9185df0dc2689ac50292d8098fa4f42fff9f4f8059a7c33aa389455776b7dcf8eb081ed0f472ef1e3fcd19a358f9875dac4
-  data.tar.gz: 39600f7081909c9bd5be6a16694e9db09f70b53e1e8d8126fa41fcacc9666232f68d1e16196993213cb943e7875fde0308ade0dfec889a625f254ff117ef2ad8
+  metadata.gz: 1f2504172943defbcd2bfbd86eca1134ca2da0193f6f89e0f315ba931372864b545e9005266251982c0e6b167e004a8202a1ca95954837b1b1796e7f4148897b
+  data.tar.gz: f13ad5d8f443e1cd010c133152b50791d876c44b32385d4009318b94e4f29c437d55a02882737bc57237d171e68f8f1802d52976596d13bd0cf60167cc9403ea

data/README.md

@@ -99,6 +99,12 @@ If the input is in a different convention than `:snake`, you should specify that
  
  * by a global setting: `JsonApi::Parameters.ensure_underscore_translation = true` 
  * while calling `.jsonapify`, for instance: `.jsonapify(params, naming_convention: :camel)`. **The value does not really matter, as anything different than `:snake` will result in deep keys transformation provided by [ActiveSupport](https://apidock.com/rails/v4.1.8/Hash/deep_transform_keys).**
+ 
+## Mime Type
+
+As [stated in the JSON:API specification](https://jsonapi.org/#mime-types) correct mime type for JSON:API input should be [`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json). 
+
+This gems intention is to make input consumption as easy as possible. Hence, it [registers this mime type for you](lib/jsonapi_parameters/core_ext/action_dispatch/http/mime_type.rb). 
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jsonapi_parameters/core_ext.rb

@@ -1 +1,2 @@
 require_relative 'core_ext/action_controller/parameters'
+require_relative 'core_ext/action_dispatch/http/mime_type'

data/lib/jsonapi_parameters/core_ext/action_dispatch/http/mime_type.rb

@@ -0,0 +1,9 @@
+require 'action_dispatch/http/mime_type'
+
+API_MIME_TYPES = %w(
+  application/vnd.api+json
+  text/x-json
+  application/json
+).freeze
+
+Mime::Type.register API_MIME_TYPES.first, :json, API_MIME_TYPES

data/lib/jsonapi_parameters/version.rb

@@ -1,3 +1,3 @@
 module JsonApi::Parameters
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Visuality
@@ -25,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +250,7 @@ files:
 - lib/jsonapi_parameters.rb
 - lib/jsonapi_parameters/core_ext.rb
 - lib/jsonapi_parameters/core_ext/action_controller/parameters.rb
+- lib/jsonapi_parameters/core_ext/action_dispatch/http/mime_type.rb
 - lib/jsonapi_parameters/parameters.rb
 - lib/jsonapi_parameters/translator.rb
 - lib/jsonapi_parameters/version.rb