olive_branch 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b54d1b0e0db59e223cf8720ae8b1c886c8f687b6
-  data.tar.gz: 77114b9066d6498f3497c46c684d1b86fc406f77
+  metadata.gz: 7b70147d89c1ed39a3d2622ace5dd0465cf0e859
+  data.tar.gz: 8ddd953cdb4b3d83dcc8f76181c021d527dbd4f9
 SHA512:
-  metadata.gz: 6d226a63c03330548194f7f0783873ea1b4468084f8655a629b36dc786b2a6f447cef0b56d6c3121c61ee62271de049c8846bcc406ab5523f42d62d37288d272
-  data.tar.gz: 92c3514964ad7b19fd31f0b5bef62dddb4f45a69face9446bb758c3ea0612cace7e466b3481736f1a4b635d06f63c894a1c6d0d1843050d88170f9114783ea84
+  metadata.gz: 5221720bceac61c7ab85c82723daf410edde7074c75727796caab89fb4df6af501bbaad7db6e78cb15a6afda97f2be33d8d93edc19fb6951dc104f0db4d036a8
+  data.tar.gz: ebac93fa3b2b241525b270e6512b3b9acfaa78e6551718dd6f9cf756a34d7bdce982457a1d34684c3ecc94eced0a0cade3e33c85b8ff79532dfdf1200f30e877

data/README.md

@@ -19,8 +19,40 @@ This gem lets your API users pass in and receive camelCased or dash-cased keys,
 
 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
+
+`OliveBranch` uses `multi_json`, which will choose the fastest available JSON parsing library and use that. Combined with `Oj` can speed things up and save ~20% rails response time.
+
+The middleware can be initialized with custom camelize/dasherize implementations, so if you know you have a fixed size set of keys, you can save a considerable amount of time by providing a custom camelize that caches like so:
+
+```ruby
+class FastCamel
+  def self.camel_cache
+    @camel_cache ||= {}
+  end
+
+  def self.camelize(string)
+    camel_cache[string] ||= string.underscore.camelize(:lower)
+  end
+end
+
+
+...
+
+    config.middleware.use OliveBranch::Middleware, camelize: FastCamel.method(:camelize)
+
+```
+
+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.
+
+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" }
+```
 
 * * *
 

data/lib/olive_branch/middleware.rb

@@ -1,51 +1,84 @@
+require "multi_json"
+
 module OliveBranch
+  class Checks
+    def self.content_type_check(content_type)
+      content_type =~ /application\/json/
+    end
+  end
+
+  class Transformations
+    class << self
+      def transform(value, transform_method)
+        case value
+        when Array then value.map { |item| transform(item, transform_method) }
+        when Hash then value.deep_transform_keys! { |key| transform(key, transform_method) }
+        when String then transform_method.call(value)
+        else value
+        end
+      end
+
+      def camelize(string)
+        string.underscore.camelize(:lower)
+      end
+
+      def dasherize(string)
+        string.dasherize
+      end
+
+      def underscore_params(env)
+        req = ActionDispatch::Request.new(env)
+        req.request_parameters
+        req.query_parameters
+
+        env["action_dispatch.request.request_parameters"].deep_transform_keys!(&:underscore)
+        env["action_dispatch.request.query_parameters"].deep_transform_keys!(&:underscore)
+      end
+    end
+  end
+
   class Middleware
-    def initialize(app)
+    def initialize(app, args = {})
       @app = app
+      @camelize = args[:camelize] || Transformations.method(:camelize)
+      @dasherize = args[:dasherize] || Transformations.method(:dasherize)
+      @content_type_check = args[:content_type_check] || Checks.method(:content_type_check)
     end
 
     def call(env)
       inflection = env["HTTP_X_KEY_INFLECTION"]
 
-      if inflection && env["CONTENT_TYPE"] =~ /application\/json/
-        underscore_params(env)
+      if inflection && @content_type_check.call(env["CONTENT_TYPE"])
+        Transformations.underscore_params(env)
       end
 
       @app.call(env).tap do |_status, headers, response|
-        next unless inflection && headers["Content-Type"] =~ /application\/json/
+        next unless inflection && @content_type_check.call(headers["Content-Type"])
         response.each do |body|
           begin
-            new_response = JSON.parse(body)
-          rescue JSON::ParserError
+            new_response = MultiJson.load(body)
+          rescue MultiJson::ParseError
             next
           end
 
-          if inflection == "camel"
-            if new_response.is_a? Array
-              new_response.each { |o| o.deep_transform_keys! { |k| k.underscore.camelize(:lower)} }
-            else
-              new_response.deep_transform_keys! { |k| k.underscore.camelize(:lower) }
-            end
-          elsif inflection == "dash"
-            if new_response.is_a? Array
-              new_response.each { |o| o.deep_transform_keys!(&:dasherize) }
-            else
-              new_response.deep_transform_keys!(&:dasherize)
-            end
-          end
+          Transformations.transform(new_response, inflection_method(inflection))
 
-          body.replace(new_response.to_json)
+          body.replace(MultiJson.dump(new_response))
         end
       end
     end
 
-    def underscore_params(env)
-      req = ActionDispatch::Request.new(env)
-      req.request_parameters
-      req.query_parameters
+    private
 
-      env["action_dispatch.request.request_parameters"].deep_transform_keys!(&:underscore)
-      env["action_dispatch.request.query_parameters"].deep_transform_keys!(&:underscore)
+    def inflection_method(inflection)
+      if inflection == "camel"
+        @camelize
+      elsif inflection == "dash"
+        @dasherize
+      else
+        # probably misconfigured, do nothing
+        -> (string) { string }
+      end
     end
   end
 end

data/lib/olive_branch/version.rb

@@ -1,3 +1,3 @@
 module OliveBranch
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Eli Fatsi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,20 +25,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handle camel/snake/dash case conversion
 email:
 - eli.fatsi@viget.com