olive_branch 2.1.4 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e39a8f70f61df011f30f51af0d4c57819ec0d905e59d90c59911915c5709e47
-  data.tar.gz: f635a399ec1e1406e298f2787241b25b2878bdd2d8460f2fb3368d6fe069fb3c
+  metadata.gz: 6385aaf40477e1da61f791e86f1a97c5e2207bb039384f624fcc3a02b3850a01
+  data.tar.gz: 05b1cc138df81ea951f34e788d2df7ba9c0e046db0311e7d3ec0dccde0cd8bb7
 SHA512:
-  metadata.gz: 20b145eb4334cff4f2b2a1d009b5e353c9262bfcd944eef6f956f069163e95bdf4ac9fa49891f39011f4c94b4ff67b4cfa74dfb9f51e42dde26e27cc8741f686
-  data.tar.gz: 33ddfa6fd29b2701a5505f7128454bd0dc553e76955db2be9adcd0852cae06f6709e285a5caf4d305c8609d8bec110dd3620d5edaa8a2429dbf7328da36dcfbc
+  metadata.gz: 2e7f4d9ca0335cf4b1eaf98e8bcd7fe2d7c3c5651b52f65570fbacb6e2a7c497186d083feca611af4788e13783c80e315fb387136bf1131f7979ef5405cbda23
+  data.tar.gz: 6d958d754397f57209001e2ea3cec65e830f904e8e2ebc203dd97fef3b3469d71fa1791c591158b561d481a5bc59c0525ba8191153752f02118ffa87e2f7d5ef

data/README.md

@@ -13,21 +13,34 @@ 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 `X-Key-Inflection` header with values of `camel`, `dash`, or `snake` in your JSON API requests.
+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:
 
@@ -48,7 +61,13 @@ end
 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.
+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 `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'
@@ -88,9 +107,25 @@ 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 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:
+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

@@ -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,10 +50,13 @@ 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)
@@ -83,19 +90,24 @@ module OliveBranch
     end
 
     def exclude_response?(env, headers)
-      exclude?(env, headers["Content-Type"], @exclude_response)
+      exclude_rails_route?(env) ||
+        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 exclude_rails_route?(env)
+      env['PATH_INFO'].to_s.start_with?('/rails')
+    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
+      env[@inflection_header] || @default_inflection
     end
 
     def inflection_method(env)
@@ -105,6 +117,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.4'
+  VERSION = '4.0.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: olive_branch
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 4.0.1
 platform: ruby
 authors:
 - Eli Fatsi
 - David Eisinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2021-11-18 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.7.6
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Handle camel/snake/dash case conversion
 test_files: []