olive_branch 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dceab387f022f915de93bf296b35e04dd5aaa863
-  data.tar.gz: 9f2dab3860dfa40f418655971833f4cd3db8980d
+  metadata.gz: af62cb65fbea81bf6ad9a11e59412a2b8a834c94
+  data.tar.gz: 716f051af8d506fb0ebd1d9091c532654209baf6
 SHA512:
-  metadata.gz: e669e8a4637b78ed651bc2b6ede1fb6dc87c6b644444d26bc0ac64e6730e7d11ca7172523577eac66a33f8270cbb8a09af3490ea978b16daf07fdf172a622408
-  data.tar.gz: 875fba805e072302b1002b0a6649b223fb4d3be86bedc2e93850066971ace30599b7727aa4d42a57feb331a09bf171a1a35316327920d0c5307be86ff931fe8a
+  metadata.gz: 833e3fb79c0f420ab19feb5b58b5b696671e755ced9d1c52556be334e4f2f0a1345118cede1fb18f1cd77a3c75e9b2a1a097b246362b996d6335649e4ee105a3
+  data.tar.gz: 775099adb481be8ab774b68e2a8eb1abeb01e7084304d879df953d6616d637701e35f1b15afa3b96ceb3085531f24630041ddf84f4ed11de963367f6ddbb7535

data/README.md

@@ -46,18 +46,38 @@ end
 
 ```
 
+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'
+```
+
 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.
 
+### Filtering
+
+#### Content type
+
 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" }
 ```
 
-Finally, a default inflection can be specified so you don't have to include the `X-Key-Inflection` header on every request.
+#### Excluding URLs
+
+Additionally you can define a custom check by passing a proc
+
+For params transforming
 
 ```ruby
-    config.middleware.use OliveBranch::Middleware, inflection: 'camel'
+    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/) }
 ```
 
 * * *

data/lib/olive_branch/middleware.rb

@@ -5,6 +5,10 @@ module OliveBranch
     def self.content_type_check(content_type)
       content_type =~ /application\/json/
     end
+
+    def self.default_exclude(env)
+      false
+    end
   end
 
   class Transformations
@@ -43,18 +47,17 @@ module OliveBranch
       @camelize = args[:camelize] || Transformations.method(:camelize)
       @dasherize = args[:dasherize] || Transformations.method(:dasherize)
       @content_type_check = args[:content_type_check] || Checks.method(:content_type_check)
+      @exclude_response = args[:exclude_response] || Checks.method(:default_exclude)
+      @exclude_params = args[:exclude_params] || Checks.method(:default_exclude)
       @default_inflection = args[:inflection]
     end
 
     def call(env)
-      inflection = env["HTTP_X_KEY_INFLECTION"] || @default_inflection
-
-      if inflection && @content_type_check.call(env["CONTENT_TYPE"])
-        Transformations.underscore_params(env)
-      end
+      Transformations.underscore_params(env) unless exclude_params?(env)
 
       @app.call(env).tap do |_status, headers, response|
-        next unless inflection && @content_type_check.call(headers["Content-Type"])
+        next if exclude_response?(env, headers)
+
         response.each do |body|
           begin
             new_response = MultiJson.load(body)
@@ -62,7 +65,7 @@ module OliveBranch
             next
           end
 
-          Transformations.transform(new_response, inflection_method(inflection))
+          Transformations.transform(new_response, inflection_method(env))
 
           body.replace(MultiJson.dump(new_response))
         end
@@ -71,7 +74,29 @@ module OliveBranch
 
     private
 
-    def inflection_method(inflection)
+    def exclude_params?(env)
+      exclude?(env, env["CONTENT_TYPE"], @exclude_params)
+    end
+
+    def exclude_response?(env, headers)
+      exclude?(env, headers["Content-Type"], @exclude_response)
+    end
+
+    def exclude?(env, content_type, block)
+      !inflection_type(env) || !valid_content_type?(content_type) || block.call(env)
+    end
+
+    def valid_content_type?(content_type)
+      @content_type_check.call(content_type)
+    end
+
+    def inflection_type(env)
+      env["HTTP_X_KEY_INFLECTION"] || @default_inflection
+    end
+
+    def inflection_method(env)
+      inflection = inflection_type(env)
+
       if inflection == "camel"
         @camelize
       elsif inflection == "dash"

data/lib/olive_branch/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Eli Fatsi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails