rack-jsonparser 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9896202e4e62ec43e8ac5763b890d3285a57ba1
-  data.tar.gz: 5a8b48301176d0944e77a9b5e9abf41aca1b7840
+  metadata.gz: fb813b2a4e003337017e6e1a03532b7d7d7ce300
+  data.tar.gz: 2d3c7a0008ea0afc5518d17dd65acbb497be0667
 SHA512:
-  metadata.gz: a99240a7520e3d98d32e6bf4900b638607d47b9a95d81444158221b3203b4630c88de0dd83d65fd2ad52c4a7686fc3a74aa091893ae67d0cc98e514792a42cdf
-  data.tar.gz: 4fb7593dfa7522f049f6c3db7cb07bb993ffb6ba0a3c8aaf1033f34658af6d9c20ad4b2862f462a969a8e1b5f876b73219ffcacb45c785313492b25b13f1b8d1
+  metadata.gz: eb2a8f12b356b2e487f2c73647d90d13e916d64bce2db55d4e7357b775ef220a553f6adafa7730fc904291b1f28337ceb0c18ec1b33c53d2dad1b9fa61e2f3be
+  data.tar.gz: c825ba038737d3309ff29c72ff391099a8623a0b5de9a162aa659a6ef1620fbb3e0883fc7dfdb71f1ec5511991c088183ac37e387d387cefa9197fb88aa1c2a3

data/lib/rack/json_parser.rb

@@ -10,6 +10,9 @@ module Rack
   class JSONParser
     ENV_PAYLOAD_KEY = 'payload'.freeze
 
+    # Called via the rack `use` method. Used to register the middleware and
+    # optionally toggle request and response processing of JSON to Object.
+    # By default both the request and response is processed and transformed.
     def initialize(app, transform_request: true, transform_response: true)
       @app = app
       @transform_request = transform_request
@@ -19,6 +22,8 @@ module Rack
     # Loads the request JSON string into a Hash instance.
     # Expects the app response body to be an object instance e.g. Hash,
     # putting the object in an array will likely cause unexpected JSON.
+    # If the response body is processed then the `CONTENT_LENGTH` header will
+    # be set to the body.length.
     def call(env)
       if transform_request?(env)
         env[ENV_PAYLOAD_KEY] = Oj.load(env['rack.input'])
@@ -26,7 +31,7 @@ module Rack
 
       status, headers, body = @app.call(env)
 
-      if body && transform_response?(headers)
+      if transform_response?(headers, body)
         body = Oj.dump(body)
         headers['CONTENT_LENGTH'] = body.length.to_s
         body = [body] unless body.is_a?(Array)
@@ -37,6 +42,9 @@ module Rack
 
   private
 
+    # Determine whether or not to transform the JSON request from the client
+    # into an Object. Takes into account the `@transform_request` variable and
+    # request parameters such as headers and request body.
     def transform_request?(env)
       @transform_request &&
         env['CONTENT_TYPE'] == 'application/json' &&
@@ -44,9 +52,13 @@ module Rack
         true # so the return value is true if all prior conditions are true
     end
 
-    def transform_response?(headers)
+    # Determine whether or not to transform the JSON response from the app
+    # into a JSON string. Takes into account the `@transform_response` variable
+    # and response parameters such as headers and response body.
+    def transform_response?(headers, body)
       @transform_response &&
         headers['CONTENT_TYPE'] == 'application/json' &&
+        body &&
         true # so the return value is true if all prior conditions are true
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-jsonparser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Telford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2017-10-28 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for processing JSON requests and responses using the
   'oj' gem.