olive_branch 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af62cb65fbea81bf6ad9a11e59412a2b8a834c94
-  data.tar.gz: 716f051af8d506fb0ebd1d9091c532654209baf6
+  metadata.gz: 0a07c5fbe243ac3032362eea45fa6d25c69e407f
+  data.tar.gz: 2977031f9cdf6abd823f21974e4647054f73440d
 SHA512:
-  metadata.gz: 833e3fb79c0f420ab19feb5b58b5b696671e755ced9d1c52556be334e4f2f0a1345118cede1fb18f1cd77a3c75e9b2a1a097b246362b996d6335649e4ee105a3
-  data.tar.gz: 775099adb481be8ab774b68e2a8eb1abeb01e7084304d879df953d6616d637701e35f1b15afa3b96ceb3085531f24630041ddf84f4ed11de963367f6ddbb7535
+  metadata.gz: c01b70ec3056840cfd42a429a81656372106251dc568fde88cf561796b132d794b62ac75c74c3808a185bfa0d4f4a76771ac558f4d468560d17653216d03776b
+  data.tar.gz: b7e9938aec19f96a77d73a3ba64a394cd58e201ac40a5e3036fceecfc3c55b54098bff659aae9df6fb8d8c03bb860ce5b86a0ec330b73482ce52be2a921181c9

data/README.md

@@ -9,17 +9,20 @@ This gem lets your API users pass in and receive camelCased or dash-cased keys,
 
 1. Add this to your Gemfile and then `bundle install`:
 
-        gem "olive_branch"
+```ruby
+gem "olive_branch"
+```
 
 2. Add this to `config/applcation.rb`:
 
-        config.middleware.use OliveBranch::Middleware
+```ruby
+config.middleware.use OliveBranch::Middleware
+```
 
 ## Use
 
 Include a `X-Key-Inflection` header with values of `camel`, `dash`, or `snake` in your JSON API requests.
 
-
 For more examples, see [our blog post](https://www.viget.com/articles/introducing-olivebranch).
 
 ## Optimizations and configuration
@@ -42,14 +45,13 @@ end
 
 ...
 
-    config.middleware.use OliveBranch::Middleware, camelize: FastCamel.method(:camelize)
-
+config.middleware.use OliveBranch::Middleware, camelize: FastCamel.method(:camelize)
 ```
 
 A default inflection can be specified so you don't have to include the `X-Key-Inflection` header on every request.
 
 ```ruby
-    config.middleware.use OliveBranch::Middleware, inflection: 'camel'
+config.middleware.use OliveBranch::Middleware, inflection: 'camel'
 ```
 
 A benchmark of this compared to the standard implementation shows a saving of ~75% rails response times for a complex response payload, or a ~400% improvement, but there is a risk of memory usage ballooning if you have dynamic keys. You can make this method as complex as required, but keep in mind that it will end up being called a _lot_ in a busy app, so it's worth thinking about how to do what you need in the fastest manner possible.
@@ -61,7 +63,9 @@ A benchmark of this compared to the standard implementation shows a saving of ~7
 It is also possible to include a custom content type check in the same manner
 
 ```ruby
-    config.middleware.use OliveBranch::Middleware, content_type_check: -> (content_type) { content_type == "my/content-type" }
+config.middleware.use OliveBranch::Middleware, content_type_check: -> (content_type) {
+  content_type == "my/content-type"
+}
 ```
 
 #### Excluding URLs
@@ -71,13 +75,25 @@ Additionally you can define a custom check by passing a proc
 For params transforming
 
 ```ruby
-    config.middleware.use OliveBranch::Middleware, exclude_params: -> (env) { env['PATH_INFO'].match(/^\/do_not_transform/) }
+config.middleware.use OliveBranch::Middleware, exclude_params: -> (env) {
+  env['PATH_INFO'].match(/^\/do_not_transform/)
+}
 ```
 
 Or response transforming
 
 ```ruby
-    config.middleware.use OliveBranch::Middleware, exclude_response: -> (env) { env['PATH_INFO'].match(/^\/do_not_transform/) }
+config.middleware.use OliveBranch::Middleware, exclude_response: -> (env) {
+  env['PATH_INFO'].match(/^\/do_not_transform/)
+}
+```
+
+## Troubleshooting
+
+We've seen a few folks raise issues that inbound transformations are not taking place. This is often due to the fact that OliveBranch, by default, is only transforming keys when a request's Content-Type is `application/json`. If you would like to force inbound transformation on every request, you must define an override for the `content_type_check` functionality:
+
+```ruby
+config.middleware.use OliveBranch::Middleware, content_type_check: -> (content_type) { true }
 ```
 
 * * *

data/lib/olive_branch/middleware.rb

@@ -54,22 +54,26 @@ module OliveBranch
 
     def call(env)
       Transformations.underscore_params(env) unless exclude_params?(env)
+      status, headers, response = @app.call(env)
 
-      @app.call(env).tap do |_status, headers, response|
-        next if exclude_response?(env, headers)
+      return [status, headers, response] if exclude_response?(env, headers)
 
-        response.each do |body|
-          begin
-            new_response = MultiJson.load(body)
-          rescue MultiJson::ParseError
-            next
-          end
+      new_responses = []
 
-          Transformations.transform(new_response, inflection_method(env))
-
-          body.replace(MultiJson.dump(new_response))
+      response.each do |body|
+        begin
+          new_response = MultiJson.load(body)
+        rescue MultiJson::ParseError
+          new_responses << body
+          next
         end
+
+        Transformations.transform(new_response, inflection_method(env))
+
+        new_responses << MultiJson.dump(new_response)
       end
+
+      [status, headers, new_responses]
     end
 
     private

data/lib/olive_branch/version.rb

@@ -1,3 +1,3 @@
 module OliveBranch
-  VERSION = '2.1.2'
+  VERSION = '2.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Eli Fatsi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Handle camel/snake/dash case conversion