json_key_transformer_middleware 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f956b529cd67c92c276fe70a2cc7dd52abe762d
-  data.tar.gz: 02dad341e504dab059a7a5bfd7646cc3360a9a7b
+SHA256:
+  metadata.gz: e9347015942aa7d6f803911e9d3d35bcf95f40fe87cbe3305441ffa0361155cf
+  data.tar.gz: 7c5e912186ae953bf958d1691dd2f9182fb6ce0207a69720fb940765d615ac62
 SHA512:
-  metadata.gz: 4557b26b081a1eeaafce98296ee4ee258c2047dc0cca67c0dfdf93cd5300a0dfd50e0cf670733ff6a6ed74761a8e76becdc6c77bba369912d761efe367d5573d
-  data.tar.gz: '028906f26c05686f19c16c58ce48317abdc8509a7ad4d44e5926076139ea167b99d41706969cf8a286c049f98ac3d9bd5f80ae165fb546596aa0cecbb4bcb532'
+  metadata.gz: b2f14b7d151446e9b00cc6fdce2f908a141b127b20f1dab65ac19007650e1485705122c246fa036fc277e10db9549e17a939c9b8696b2e9fa53be4f2dfbe5334
+  data.tar.gz: 0bee3a4767f9fd059920af4f2e63312795b1579e6c548bd2155a8278940cb256c138c91d1dfb05f68fe150e291de7c5d040bf228c0c0a08b6dd2f3ad21cce5ad

data/lib/json_key_transformer_middleware/incoming_json_formatter.rb

@@ -1,18 +1,14 @@
+require 'hash_key_transformer'
 require 'oj'
 
 module JsonKeyTransformerMiddleware
 
   class IncomingJsonFormatter < Middleware
 
-    def initialize(app)
-      @app = app
-    end
-
     def call(env)
-      result =
-        Oj.dump(
-          deep_transform_hash_keys(
-            Oj.load(env['rack.input'].read), :camel_to_underscore))
+      object = Oj.load(env['rack.input'].read)
+      transformed_object = HashKeyTransformer.send(middleware_config.incoming_strategy, object, middleware_config.incoming_strategy_options)
+      result = Oj.dump(transformed_object, mode: :compat)
 
       env['rack.input'] = StringIO.new(result)
       # Rails uses this elsewhere to parse 'rack.input', it must be updated to avoid truncation

data/lib/json_key_transformer_middleware/incoming_params_formatter.rb

@@ -1,16 +1,13 @@
+require 'hash_key_transformer'
 require 'oj'
 
 module JsonKeyTransformerMiddleware
 
   class IncomingParamsFormatter < Middleware
 
-    def initialize(app)
-      @app = app
-    end
-
     def call(env)
       parsed_params = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
-      transformed_params = deep_transform_hash_keys(parsed_params, :camel_to_underscore)
+      transformed_params = HashKeyTransformer.send(middleware_config.incoming_strategy, parsed_params, middleware_config.incoming_strategy_options)
       env['QUERY_STRING'] = Rack::Utils.build_nested_query(transformed_params)
 
       @app.call(env)

data/lib/json_key_transformer_middleware/middleware.rb

@@ -1,32 +1,14 @@
 module JsonKeyTransformerMiddleware
 
   class Middleware
-    def deep_transform_hash_keys(subject, strategy)
-      if subject.is_a?(Hash)
-        subject.inject({}) do |memo, (key, value)|
-          new_key = send(strategy, key)
-          memo[new_key] = deep_transform_hash_keys(value, strategy)
-          memo
-        end
-      elsif subject.is_a?(Array)
-        subject.inject([]) do |memo, item|
-          memo << deep_transform_hash_keys(item, strategy)
-          memo
-        end
-      else
-        subject
-      end
+    def initialize(app, middleware_config)
+      @app = app
+      @middleware_config = middleware_config
     end
 
-    # 'keyName' -> 'key_name'
-    def camel_to_underscore(key)
-      key.gsub(/([A-Z])/) { "_#{$1}" }.downcase
-    end
+    private
 
-    # 'key_name' -> 'keyName'
-    def underscore_to_camel(key)
-      key.gsub(/_([a-z0-9])/) { $1.upcase }
-    end
+    attr_reader :app, :middleware_config
   end
 
 end

data/lib/json_key_transformer_middleware/outgoing_json_formatter.rb

@@ -1,13 +1,10 @@
+require 'hash_key_transformer'
 require 'oj'
 
 module JsonKeyTransformerMiddleware
 
   class OutgoingJsonFormatter < Middleware
 
-    def initialize(app)
-      @app = app
-    end
-
     def call(env)
       status, headers, body = @app.call(env)
 
@@ -28,9 +25,9 @@ module JsonKeyTransformerMiddleware
 
     def transform_outgoing_body_part(body_part)
       begin
-        Oj.dump(
-          deep_transform_hash_keys(
-            Oj.load(body_part), :underscore_to_camel))
+        object = Oj.load(body_part)
+        transformed_object = HashKeyTransformer.send(middleware_config.outgoing_strategy, object, middleware_config.outgoing_strategy_options)
+        Oj.dump(transformed_object, mode: :compat)
       rescue
         body_part
       end

data/lib/json_key_transformer_middleware/railtie.rb

@@ -4,9 +4,15 @@ module JsonKeyTransformerMiddleware
 
   class Railtie < Rails::Railtie
 
-    config.app_middleware.insert_after Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingParamsFormatter
-    config.app_middleware.insert_after Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingJsonFormatter
-    config.app_middleware.use JsonKeyTransformerMiddleware::OutgoingJsonFormatter
+    config.json_key_transformer_middleware = ActiveSupport::OrderedOptions.new
+    config.json_key_transformer_middleware.incoming_strategy = :transform_camel_to_underscore
+    config.json_key_transformer_middleware.incoming_strategy_options = ActiveSupport::OrderedOptions.new
+    config.json_key_transformer_middleware.outgoing_strategy = :transform_underscore_to_camel
+    config.json_key_transformer_middleware.outgoing_strategy_options = ActiveSupport::OrderedOptions.new
+
+    config.app_middleware.insert_after(Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingParamsFormatter, config.json_key_transformer_middleware)
+    config.app_middleware.insert_after(Rails::Rack::Logger, JsonKeyTransformerMiddleware::IncomingJsonFormatter, config.json_key_transformer_middleware)
+    config.app_middleware.use(JsonKeyTransformerMiddleware::OutgoingJsonFormatter, config.json_key_transformer_middleware)
 
   end
 

data/readme.md

@@ -2,7 +2,7 @@
 
 Rack middleware which transforms incoming and outgoing JSON keys to support the development of Rails JSON-based APIs.
 
-Incoming JSON keys are transformed from `camelCase` to `snake_case`. Outgoing JSON keys are transformed from `snake_case` to `camelCase`.
+By default, incoming JSON keys are transformed from `camelCase` to `snake_case` and outgoing JSON keys are transformed from `snake_case` to `camelCase`.
 
 ## Installation
 
@@ -22,7 +22,7 @@ Or, install it directly:
 
 Simply including the gem in the Gemfile for a Rails application will initialize the rack middleware which transforms incoming and outgoing JSON keys.
 
-The purpose of this gem is to:
+The primary purpose of this gem is to:
 
 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.
 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.
@@ -57,6 +57,25 @@ To (JSON):
     {"paramName": "value", "paramName2": [{"paramName3": "value"}]}
 ```
 
+## Configuration
+
+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`.
+
+The Railtie provides these configuration options:
+
+* `incoming_strategy` - default value of `:transform_camel_to_underscore`.
+* `incoming_strategy_options` - no options set by default.
+* `outgoing_strategy` - default value of `:transform_underscore_to_camel`.
+* `outgoing_strategy_options` - no options set by default.
+
+Here is an example Rails initializer which turns on the `outgoing_strategy_options.keep_lead_underscore` option:
+
+```ruby
+# initializers/json_key_transformer_middleware.rb
+
+Rails.application.config.json_key_transformer_middleware.outgoing_strategy_options.keep_lead_underscore = true
+```
+
 ## Notes
 
 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.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: json_key_transformer_middleware
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Rood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_key_transformer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Rack middleware which transforms incoming and outgoing JSON keys to support