olive_branch 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb564e7a107ec4a4ec603c123a1712b4cc564091606a42acf3a420ef61d42a8c
-  data.tar.gz: 980afa4b827e039484b1e0a9983c49cdcb884c1202c5a984ab008ecf65b0df0b
+  metadata.gz: 3bec73b70112a823836210ff185bcf853dfa2d7417be60ddab5e9d2e37d59f37
+  data.tar.gz: 8c494c373619e9543d0ccb28bbafe3664edc32d3a975a220c052a9422fce916e
 SHA512:
-  metadata.gz: 69c7a3da07246dd9566a5fb62b276f2fd31e085066a8369d3e95d49c21ee0f6592c6718eeeccf4335be6b7062af82491772919c7e37cb831cc1d949b4acb906f
-  data.tar.gz: c4662471213424e5c06ccf547b90745b75a8addd9ba6f4382ce306f47fe3af328f062144454a6f69d3a5550dc1141c7d7f1cde1a8334afd146594b689cb91f27
+  metadata.gz: 2ca6f8224a09fa9113a6e6c0caa45cb928f2eba5ed2538a06e2726d931892af3a31e31c1ca7fb90cec95e7392a5a3cc9a21b8be9427f0af4b50ee3f73672bc86
+  data.tar.gz: b949f436070efe153eb34c11b9677a0f86b8999406630753cc726de5387d5d266b856afd30c028e24df733c93669a673d4919ca922c91517cc9f9bca8f31c628

data/README.md

@@ -13,12 +13,24 @@ This gem lets your API users pass in and receive camelCased or dash-cased keys,
 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:
 
 ```ruby
 config.middleware.use OliveBranch::Middleware
 ```
 
+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:
+
+```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.
@@ -27,7 +39,8 @@ For more examples, see [our blog post](https://www.viget.com/articles/introducin
 
 ## 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:
 
@@ -54,7 +67,7 @@ Default inflection header key can be changed like
 config.middleware.use OliveBranch::Middleware, inflection_header: 'Inflect-With'
 ```
 
-A default inflection can be specified so you don't have to include the `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'
@@ -94,6 +107,18 @@ config.middleware.use OliveBranch::Middleware, exclude_response: -> (env) {
 }
 ```
 
+#### 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`.

data/lib/olive_branch/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Eli Fatsi
 - David Eisinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-16 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
@@ -112,7 +98,7 @@ homepage: https://github.com/vigetlabs/olive_branch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Handle camel/snake/dash case conversion
 test_files: []