├── .gitignore ├── Gemfile ├── Gemfile.lock ├── LICENSE ├── VERSION ├── json_key_transformer_middleware.gemspec ├── lib ├── json_key_transformer_middleware.rb └── json_key_transformer_middleware │ ├── incoming_json_formatter.rb │ ├── incoming_params_formatter.rb │ ├── middleware.rb │ ├── outgoing_json_formatter.rb │ └── railtie.rb └── readme.md /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | /.idea/* 4 | /.config 5 | /coverage/ 6 | /InstalledFiles 7 | /pkg/ 8 | /spec/reports/ 9 | /test/tmp/ 10 | /test/version_tmp/ 11 | /tmp/ 12 | 13 | ## Specific to RubyMotion: 14 | .dat* 15 | .repl_history 16 | build/ 17 | 18 | ## Documentation cache and generated files: 19 | /.yardoc/ 20 | /_yardoc/ 21 | /doc/ 22 | /rdoc/ 23 | 24 | ## Environment normalisation: 25 | /.bundle/ 26 | /vendor/bundle 27 | /lib/bundler/man/ 28 | 29 | # for a library or gem, you might want to ignore these files since the code is 30 | # intended to run in multiple environments; otherwise, check them in: 31 | # Gemfile.lock 32 | # .ruby-version 33 | # .ruby-gemset 34 | 35 | # unless supporting rvm < 1.11.0 or doing something fancy, ignore this: 36 | .rvmrc 37 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | json_key_transformer_middleware (0.3.0) 5 | hash_key_transformer (~> 0.1.3) 6 | oj (~> 2.0) 7 | oj_mimic_json (~> 1.0) 8 | rails (~> 5.0) 9 | 10 | GEM 11 | remote: https://rubygems.org/ 12 | specs: 13 | actioncable (5.2.0) 14 | actionpack (= 5.2.0) 15 | nio4r (~> 2.0) 16 | websocket-driver (>= 0.6.1) 17 | actionmailer (5.2.0) 18 | actionpack (= 5.2.0) 19 | actionview (= 5.2.0) 20 | activejob (= 5.2.0) 21 | mail (~> 2.5, >= 2.5.4) 22 | rails-dom-testing (~> 2.0) 23 | actionpack (5.2.0) 24 | actionview (= 5.2.0) 25 | activesupport (= 5.2.0) 26 | rack (~> 2.0) 27 | rack-test (>= 0.6.3) 28 | rails-dom-testing (~> 2.0) 29 | rails-html-sanitizer (~> 1.0, >= 1.0.2) 30 | actionview (5.2.0) 31 | activesupport (= 5.2.0) 32 | builder (~> 3.1) 33 | erubi (~> 1.4) 34 | rails-dom-testing (~> 2.0) 35 | rails-html-sanitizer (~> 1.0, >= 1.0.3) 36 | activejob (5.2.0) 37 | activesupport (= 5.2.0) 38 | globalid (>= 0.3.6) 39 | activemodel (5.2.0) 40 | activesupport (= 5.2.0) 41 | activerecord (5.2.0) 42 | activemodel (= 5.2.0) 43 | activesupport (= 5.2.0) 44 | arel (>= 9.0) 45 | activestorage (5.2.0) 46 | actionpack (= 5.2.0) 47 | activerecord (= 5.2.0) 48 | marcel (~> 0.3.1) 49 | activesupport (5.2.0) 50 | concurrent-ruby (~> 1.0, >= 1.0.2) 51 | i18n (>= 0.7, < 2) 52 | minitest (~> 5.1) 53 | tzinfo (~> 1.1) 54 | arel (9.0.0) 55 | builder (3.2.3) 56 | concurrent-ruby (1.0.5) 57 | crass (1.0.4) 58 | erubi (1.7.1) 59 | globalid (0.4.1) 60 | activesupport (>= 4.2.0) 61 | hash_key_transformer (0.1.3) 62 | i18n (1.0.1) 63 | concurrent-ruby (~> 1.0) 64 | loofah (2.2.2) 65 | crass (~> 1.0.2) 66 | nokogiri (>= 1.5.9) 67 | mail (2.7.0) 68 | mini_mime (>= 0.1.1) 69 | marcel (0.3.2) 70 | mimemagic (~> 0.3.2) 71 | method_source (0.9.0) 72 | mimemagic (0.3.2) 73 | mini_mime (1.0.0) 74 | mini_portile2 (2.3.0) 75 | minitest (5.11.3) 76 | nio4r (2.3.1) 77 | nokogiri (1.8.2) 78 | mini_portile2 (~> 2.3.0) 79 | oj (2.18.5) 80 | oj_mimic_json (1.0.1) 81 | rack (2.0.5) 82 | rack-test (1.0.0) 83 | rack (>= 1.0, < 3) 84 | rails (5.2.0) 85 | actioncable (= 5.2.0) 86 | actionmailer (= 5.2.0) 87 | actionpack (= 5.2.0) 88 | actionview (= 5.2.0) 89 | activejob (= 5.2.0) 90 | activemodel (= 5.2.0) 91 | activerecord (= 5.2.0) 92 | activestorage (= 5.2.0) 93 | activesupport (= 5.2.0) 94 | bundler (>= 1.3.0) 95 | railties (= 5.2.0) 96 | sprockets-rails (>= 2.0.0) 97 | rails-dom-testing (2.0.3) 98 | activesupport (>= 4.2.0) 99 | nokogiri (>= 1.6) 100 | rails-html-sanitizer (1.0.4) 101 | loofah (~> 2.2, >= 2.2.2) 102 | railties (5.2.0) 103 | actionpack (= 5.2.0) 104 | activesupport (= 5.2.0) 105 | method_source 106 | rake (>= 0.8.7) 107 | thor (>= 0.18.1, < 2.0) 108 | rake (12.3.1) 109 | sprockets (3.7.1) 110 | concurrent-ruby (~> 1.0) 111 | rack (> 1, < 3) 112 | sprockets-rails (3.2.1) 113 | actionpack (>= 4.0) 114 | activesupport (>= 4.0) 115 | sprockets (>= 3.0.0) 116 | thor (0.20.0) 117 | thread_safe (0.3.6) 118 | tzinfo (1.2.5) 119 | thread_safe (~> 0.1) 120 | websocket-driver (0.7.0) 121 | websocket-extensions (>= 0.1.0) 122 | websocket-extensions (0.1.3) 123 | 124 | PLATFORMS 125 | ruby 126 | 127 | DEPENDENCIES 128 | json_key_transformer_middleware! 129 | 130 | BUNDLED WITH 131 | 1.16.1 132 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 Kevin Rood 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.3.0 -------------------------------------------------------------------------------- /json_key_transformer_middleware.gemspec: -------------------------------------------------------------------------------- 1 | require 'date' 2 | 3 | module JsonKeyTransformerMiddleware 4 | VERSION = File.read(File.expand_path('../VERSION', __FILE__)).strip 5 | end 6 | 7 | Gem::Specification.new do |gem| 8 | gem.name = 'json_key_transformer_middleware' 9 | gem.version = JsonKeyTransformerMiddleware::VERSION 10 | gem.date = Date.today.strftime('%Y-%m-%d') 11 | gem.summary = 'Rack middleware which transforms incoming and outgoing JSON keys to support the development of Rails JSON-based APIs' 12 | gem.description = 'Incoming JSON keys are transformed from camelCase to snake_case. Outgoing JSON keys are transformed from snake_case to camelCase.' 13 | gem.author = ['Kevin Rood'] 14 | gem.files = `git ls-files LICENSE readme.md *.rb`.split($/) 15 | gem.homepage = 'https://github.com/kevinrood/json_key_transformer_middleware' 16 | gem.license = 'Apache-2.0' 17 | 18 | gem.add_runtime_dependency('hash_key_transformer', '~> 0.1.3') 19 | gem.add_runtime_dependency('oj', '~> 2.0') 20 | gem.add_runtime_dependency('oj_mimic_json', '~> 1.0') 21 | gem.add_runtime_dependency('rails', '~> 5.0') 22 | end 23 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware.rb: -------------------------------------------------------------------------------- 1 | require_relative 'json_key_transformer_middleware/middleware' 2 | require_relative 'json_key_transformer_middleware/incoming_params_formatter' 3 | require_relative 'json_key_transformer_middleware/incoming_json_formatter' 4 | require_relative 'json_key_transformer_middleware/outgoing_json_formatter' 5 | require_relative 'json_key_transformer_middleware/railtie' 6 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware/incoming_json_formatter.rb: -------------------------------------------------------------------------------- 1 | require 'hash_key_transformer' 2 | require 'oj' 3 | 4 | module JsonKeyTransformerMiddleware 5 | 6 | class IncomingJsonFormatter < Middleware 7 | 8 | def call(env) 9 | object = Oj.load(env['rack.input'].read) 10 | transformed_object = HashKeyTransformer.send(middleware_config.incoming_strategy, object, middleware_config.incoming_strategy_options) 11 | result = Oj.dump(transformed_object, mode: :compat) 12 | 13 | env['rack.input'] = StringIO.new(result) 14 | # Rails uses this elsewhere to parse 'rack.input', it must be updated to avoid truncation 15 | env['CONTENT_LENGTH'] = result.length.to_s 16 | 17 | @app.call(env) 18 | end 19 | 20 | end 21 | 22 | end 23 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware/incoming_params_formatter.rb: -------------------------------------------------------------------------------- 1 | require 'hash_key_transformer' 2 | require 'oj' 3 | 4 | module JsonKeyTransformerMiddleware 5 | 6 | class IncomingParamsFormatter < Middleware 7 | 8 | def call(env) 9 | parsed_params = Rack::Utils.parse_nested_query(env['QUERY_STRING']) 10 | transformed_params = HashKeyTransformer.send(middleware_config.incoming_strategy, parsed_params, middleware_config.incoming_strategy_options) 11 | env['QUERY_STRING'] = Rack::Utils.build_nested_query(transformed_params) 12 | 13 | @app.call(env) 14 | end 15 | 16 | end 17 | 18 | end 19 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware/middleware.rb: -------------------------------------------------------------------------------- 1 | module JsonKeyTransformerMiddleware 2 | 3 | class Middleware 4 | def initialize(app, middleware_config) 5 | @app = app 6 | @middleware_config = middleware_config 7 | end 8 | 9 | private 10 | 11 | attr_reader :app, :middleware_config 12 | end 13 | 14 | end 15 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware/outgoing_json_formatter.rb: -------------------------------------------------------------------------------- 1 | require 'hash_key_transformer' 2 | require 'oj' 3 | 4 | module JsonKeyTransformerMiddleware 5 | 6 | class OutgoingJsonFormatter < Middleware 7 | 8 | def call(env) 9 | status, headers, body = @app.call(env) 10 | 11 | new_body = build_new_body(body) 12 | 13 | [status, headers, new_body] 14 | end 15 | 16 | private 17 | 18 | def build_new_body(body) 19 | Enumerator.new do |yielder| 20 | body.each do |body_part| 21 | yielder << (body_part != '' ? transform_outgoing_body_part(body_part) : '') 22 | end 23 | end 24 | end 25 | 26 | def transform_outgoing_body_part(body_part) 27 | begin 28 | object = Oj.load(body_part) 29 | transformed_object = HashKeyTransformer.send(middleware_config.outgoing_strategy, object, middleware_config.outgoing_strategy_options) 30 | Oj.dump(transformed_object, mode: :compat) 31 | rescue 32 | body_part 33 | end 34 | end 35 | 36 | end 37 | 38 | end 39 | -------------------------------------------------------------------------------- /lib/json_key_transformer_middleware/railtie.rb: -------------------------------------------------------------------------------- 1 | require 'rails/railtie' 2 | 3 | module JsonKeyTransformerMiddleware 4 | 5 | class Railtie < Rails::Railtie 6 | 7 | config.json_key_transformer_middleware = ActiveSupport::OrderedOptions.new 8 | config.json_key_transformer_middleware.incoming_strategy = :transform_camel_to_underscore 9 | config.json_key_transformer_middleware.incoming_strategy_options = ActiveSupport::OrderedOptions.new 10 | config.json_key_transformer_middleware.outgoing_strategy = :transform_underscore_to_camel 11 | config.json_key_transformer_middleware.outgoing_strategy_options = ActiveSupport::OrderedOptions.new 12 | 13 | config.app_middleware.insert_after(Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingParamsFormatter, config.json_key_transformer_middleware) 14 | config.app_middleware.insert_after(Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingJsonFormatter, config.json_key_transformer_middleware) 15 | config.app_middleware.use(JsonKeyTransformerMiddleware::OutgoingJsonFormatter, config.json_key_transformer_middleware) 16 | 17 | end 18 | 19 | end 20 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # JSON Key Transformer Middleware 2 | 3 | Rack middleware which transforms incoming and outgoing JSON keys to support the development of Rails JSON-based APIs. 4 | 5 | By default, incoming JSON keys are transformed from `camelCase` to `snake_case` and outgoing JSON keys are transformed from `snake_case` to `camelCase`. 6 | 7 | ## Installation 8 | 9 | Add this to your Gemfile: 10 | 11 | gem 'json_key_transformer_middleware' 12 | 13 | Then execute: 14 | 15 | $ bundle install 16 | 17 | Or, install it directly: 18 | 19 | $ gem install json_key_transformer_middleware 20 | 21 | ## Usage 22 | 23 | Simply including the gem in the Gemfile for a Rails application will initialize the rack middleware which transforms incoming and outgoing JSON keys. 24 | 25 | The primary purpose of this gem is to: 26 | 27 | 1. Transform incoming parameter names from JSON-style `camelCase` to Ruby-style `snake_case`. Clients send `camelCase` parameters, you work with `snake_case` params in your Rails controllers. 28 | 1. Transform outgoing parameter names from Ruby-style `snake_case` to JSON-style `camelCase`. When rendering a JSON response, you send a `snake_case` hash response, the client will receive a `camelCase` response. 29 | 30 | In both cases the transformation process walks the entire incoming and outgoing data structure. 31 | 32 | *Incoming transformation example* 33 | 34 | From (JSON): 35 | 36 | ``` 37 | {"paramName": "value", "paramName2": [{"paramName3": "value"}]} 38 | ``` 39 | 40 | To (Rails params): 41 | 42 | ``` 43 | {"param_name" => "value", "param_name2" => [{"param_name3" => "value"}]} 44 | ``` 45 | 46 | *Outgoing transformation example* 47 | 48 | From (Rails response): 49 | 50 | ``` 51 | {"param_name" => "value", "param_name2" => [{"param_name3" => "value"}]} 52 | ``` 53 | 54 | To (JSON): 55 | 56 | ``` 57 | {"paramName": "value", "paramName2": [{"paramName3": "value"}]} 58 | ``` 59 | 60 | ## Configuration 61 | 62 | This middleware uses the `hash_key_transformer` gem to perform deep transformation of hash keys. You can configure incoming and outgoing hash transformations. Use any of the available transformations and transformation options provided by `hash_key_transformer`. 63 | 64 | The Railtie provides these configuration options: 65 | 66 | * `incoming_strategy` - default value of `:transform_camel_to_underscore`. 67 | * `incoming_strategy_options` - no options set by default. 68 | * `outgoing_strategy` - default value of `:transform_underscore_to_camel`. 69 | * `outgoing_strategy_options` - no options set by default. 70 | 71 | Here is an example Rails initializer which turns on the `outgoing_strategy_options.keep_lead_underscore` option: 72 | 73 | ```ruby 74 | # initializers/json_key_transformer_middleware.rb 75 | 76 | Rails.application.config.json_key_transformer_middleware.outgoing_strategy_options.keep_lead_underscore = true 77 | ``` 78 | 79 | ## Notes 80 | 81 | This gem serves a very specific purpose. As such, it only targets a specific version of Rails. Over time more versions of Rails may be supported. 82 | 83 | ## License 84 | 85 | Apache License, Version 2.0 86 | --------------------------------------------------------------------------------