olive_branch 2.1.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af62cb65fbea81bf6ad9a11e59412a2b8a834c94
-  data.tar.gz: 716f051af8d506fb0ebd1d9091c532654209baf6
+SHA256:
+  metadata.gz: 3bec73b70112a823836210ff185bcf853dfa2d7417be60ddab5e9d2e37d59f37
+  data.tar.gz: 8c494c373619e9543d0ccb28bbafe3664edc32d3a975a220c052a9422fce916e
 SHA512:
-  metadata.gz: 833e3fb79c0f420ab19feb5b58b5b696671e755ced9d1c52556be334e4f2f0a1345118cede1fb18f1cd77a3c75e9b2a1a097b246362b996d6335649e4ee105a3
-  data.tar.gz: 775099adb481be8ab774b68e2a8eb1abeb01e7084304d879df953d6616d637701e35f1b15afa3b96ceb3085531f24630041ddf84f4ed11de963367f6ddbb7535
+  metadata.gz: 2ca6f8224a09fa9113a6e6c0caa45cb928f2eba5ed2538a06e2726d931892af3a31e31c1ca7fb90cec95e7392a5a3cc9a21b8be9427f0af4b50ee3f73672bc86
+  data.tar.gz: b949f436070efe153eb34c11b9677a0f86b8999406630753cc726de5387d5d266b856afd30c028e24df733c93669a673d4919ca922c91517cc9f9bca8f31c628

data/README.md

@@ -9,22 +9,38 @@ 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`:
+2. Add this to `config/applcation.rb` if you want the clients to control the transformation behaviour through the `Key-Inflection` HTTP header sent by the client:
 
-        config.middleware.use OliveBranch::Middleware
+```ruby
+config.middleware.use OliveBranch::Middleware
+```
 
-## Use
+Alternative, if you want to always convert between snake_case and camelCase for your API and only your API, to keep Rubyist and JavaScript developer's happy, use the following configuration:
 
-Include a `X-Key-Inflection` header with values of `camel`, `dash`, or `snake` in your JSON API requests.
+```ruby
+excluded_routes = ->(env) { !env["PATH_INFO"].match(%r{^/api}) }
+config.middleware.use OliveBranch::Middleware,
+                      inflection:       "camel",
+                      exclude_params:   excluded_routes,
+                      exclude_response: excluded_routes
+```
 
+in your `config/application.rb`.
+
+## Use
+
+Include a `Key-Inflection` header with values of `camel`, `dash`, `snake` or `pascal` 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.
+`OliveBranch` uses `multi_json`, which will automatically choose the fastest available JSON parsing library present in your application.
+ Most Ruby applications default to using the JSON library that ships with Ruby.  However, by including a coder that `multi_json` considers faster, like [Oj](https://github.com/ohler55/oj) in your gemfile, you can potentially save up to ~20% 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:
 
@@ -42,14 +58,19 @@ end
 
 ...
 
-    config.middleware.use OliveBranch::Middleware, camelize: FastCamel.method(:camelize)
+config.middleware.use OliveBranch::Middleware, camelize: FastCamel.method(:camelize)
+```
+
+Default inflection header key can be changed like
 
+```ruby
+config.middleware.use OliveBranch::Middleware, inflection_header: 'Inflect-With'
 ```
 
-A default inflection can be specified so you don't have to include the `X-Key-Inflection` header on every request.
+A default inflection can be specified so you don't have to include the `Key-Inflection` header on every request. If you opt for default inflection, you may want to exclude the routes that Rails uses (see Filtering).
 
 ```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 +82,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 +94,41 @@ 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/)
+}
+```
+
+#### Rails routes & Action Text
+
+If you're using default inflection, exclude the routes that Rails uses
+```ruby
+rails_routes = -> (env) { env['PATH_INFO'].match(/^\/rails/) }
+config.middleware.use OliveBranch::Middleware, inflection: "camel", exclude_params: rails_routes, exclude_response: rails_routes
+```
+
+## Upgrading to version 3
+
+Default inflection header changed from `X-Key-Inflection` to `Key-Inflection`.
+
+## Troubleshooting
+
+We've seen 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`.
+
+Note that your HTTP client library may suppress even a manually specified `Content-Type` header if the request body is empty (e.g. [Axios does this](https://github.com/axios/axios/issues/86)). This is a common gotcha for GET requests, the body of which are [often expected to be empty](https://stackoverflow.com/questions/978061/http-get-with-request-body) for reasons of caching. If you're seeing the middleware perform on POST or PATCH requests, but not GET requests, this may be your issue.
+
+You may choose to force inbound transformation on every request by overriding the `content_type_check` functionality:
+
+```ruby
+config.middleware.use OliveBranch::Middleware, content_type_check: -> (content_type) { true }
 ```
 
 * * *

data/lib/olive_branch/middleware.rb

@@ -3,7 +3,7 @@ require "multi_json"
 module OliveBranch
   class Checks
     def self.content_type_check(content_type)
-      content_type =~ /application\/json/
+      content_type =~ /application\/json/ || content_type =~ /application\/vnd\.api\+json/
     end
 
     def self.default_exclude(env)
@@ -22,6 +22,10 @@ module OliveBranch
         end
       end
 
+      def pascalize(string)
+        string.underscore.camelize(:upper)
+      end
+
       def camelize(string)
         string.underscore.camelize(:lower)
       end
@@ -46,30 +50,37 @@ module OliveBranch
       @app = app
       @camelize = args[:camelize] || Transformations.method(:camelize)
       @dasherize = args[:dasherize] || Transformations.method(:dasherize)
+      @pascalize = args[:pascalize] || Transformations.method(:pascalize)
       @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]
+      @inflection_header = args.fetch(:inflection_header, 'Key-Inflection').gsub(/[^a-z0-9]/i, '_').upcase
+      @inflection_header = "HTTP_#{@inflection_header}" unless @inflection_header.start_with?('HTTP_')
     end
 
     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)
-
-        response.each do |body|
-          begin
-            new_response = MultiJson.load(body)
-          rescue MultiJson::ParseError
-            next
-          end
+      return [status, headers, response] if exclude_response?(env, headers)
 
-          Transformations.transform(new_response, inflection_method(env))
+      new_responses = []
 
-          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
@@ -91,7 +102,7 @@ module OliveBranch
     end
 
     def inflection_type(env)
-      env["HTTP_X_KEY_INFLECTION"] || @default_inflection
+      env[@inflection_header] || @default_inflection
     end
 
     def inflection_method(env)
@@ -101,6 +112,8 @@ module OliveBranch
         @camelize
       elsif inflection == "dash"
         @dasherize
+      elsif inflection == 'pascal'
+        @pascalize
       else
         # probably misconfigured, do nothing
         -> (string) { string }

data/lib/olive_branch/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Eli Fatsi
 - David Eisinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !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
@@ -95,20 +81,6 @@ dependencies:
     - - ">="
       - !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
@@ -126,7 +98,7 @@ homepage: https://github.com/vigetlabs/olive_branch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Handle camel/snake/dash case conversion
 test_files: []