rack-jsonparser 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fc14e3e1e363152ec7848e6894c1642e6afa970
-  data.tar.gz: f0c9b28330554052704a816c4166e6f68e5bfb2f
+  metadata.gz: b9896202e4e62ec43e8ac5763b890d3285a57ba1
+  data.tar.gz: 5a8b48301176d0944e77a9b5e9abf41aca1b7840
 SHA512:
-  metadata.gz: 409d62951bb8fa5b66fa43bdf865c75f1b0ba232b89fd1492e52ef4d5db93ba2b91cef4e711b6e97b19508b82337343bd694ca24bd677090660490efcac28178
-  data.tar.gz: 2742bb8b49dd20f8f9a2544194d4d8275b6b339434ae5bb62f8661988722bf3f1ed3293f648a9665bf741e0c9f842eb9ddaa3c45a6d94d967a1d96da4619f0c1
+  metadata.gz: a99240a7520e3d98d32e6bf4900b638607d47b9a95d81444158221b3203b4630c88de0dd83d65fd2ad52c4a7686fc3a74aa091893ae67d0cc98e514792a42cdf
+  data.tar.gz: 4fb7593dfa7522f049f6c3db7cb07bb993ffb6ba0a3c8aaf1033f34658af6d9c20ad4b2862f462a969a8e1b5f876b73219ffcacb45c785313492b25b13f1b8d1

data/README.md

@@ -0,0 +1,108 @@
+# Rack::JSONParser Middleware
+
+Rack middleware which transforms an incoming request's JSON string into a `Hash` and any outgoing ruby `Object` back into a JSON string to be returned to the client.
+
+- The client sends/receives only JSON strings
+- The `app` (rack application) using the middleware sends/receives only ruby objects (no JSON parsing)
+- The `Rack::JSONParser` middleware handles the parsing of the request/response to/from JSON/Object so you don't have to
+
+The difference between this and other middleware doing the same job is that it's fast! This middleware uses the '[oj](https://github.com/ohler55/oj)' gem which gives faster processing than the `json` gem. This middleware is also configurable enabling predictive and controlled parsing. It stays out of your way when you don't need it and is seamless when you do.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'rack-jsonparser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install rack-jsonparser
+
+Then `require` it in your rack application with:
+
+```ruby
+require 'rack/json_parser'
+```
+
+## Usage
+
+Below is a sample rack app which uses the middleware to send and receive JSON:
+
+> config.ru
+
+```ruby
+require 'rack/json_parser'
+
+# Notice how the `payload` is a Hash, not a JSON string
+# We return a Hash instance (or any Ruby object) for the response body
+# We can turn off the request/response parsing via the `use` method (defaults to true)
+# Parsing will only occur if enabled AND the Content-Type is `application/json`
+handler = proc do |env|
+  payload = env['payload']
+  full_name = payload['forenames'].push(payload['surname']).join(' ')
+  res_hash = { 'full_name' => full_name }
+  [200, { 'CONTENT_TYPE' => 'application/json' }, res_hash]
+end
+
+app = Rack::Builder.new do
+  use Rack::JSONParser, transform_request: true, transform_response: true
+  map('/hello') { run handler }
+end
+
+run app
+```
+
+Run the above `config.ru` rack app with:
+
+    $ rackup
+
+Then query the app with:
+
+```shell
+curl -X POST \
+  http://localhost:9292/hello \
+  -H 'content-type: application/json' \
+  -d '{
+	"forenames": [
+		"Napolean",
+		"Neech"
+	],
+	"surname":"Manly"
+  }'
+```
+
+And the JSON response will be:
+
+```json
+{
+  "full_name":"Napolean Neech Manly"
+}
+```
+
+## Configuration
+
+The middleware is configurable so request/response processing can be turned off via the `use` method parameters if desired, see usage above.
+
+In addition, the middleware only transforms the request/response if the `Content-Type` header is correctly set to `application/json`. This applies to both the request sent from the client and the response sent from the `app`; allowing for several types of response content to be served by the application without interference by the middleware. This however requires the client and rack `app` to set the `Content-Type` header correctly. If not, then the middleware will do nothing and simply pass through the request/response data which might lead to unexpected behavior.
+
+If the middleware processes the response then it will also set/override the `Content-Length` header with the length of the JSON string being returned to the client.
+
+## Ruby Version
+
+This software was built with and supports:
+
+- `~> 2.4.0`
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/michaeltelford/rack_jsonparser).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rack/json_parser.rb

@@ -8,7 +8,7 @@ module Rack
   # served by the application without interference by this middleware. This
   # however requires the client and app to set the 'Content-Type' correctly.
   class JSONParser
-    ENV_PAYLOAD_KEY = 'payload'
+    ENV_PAYLOAD_KEY = 'payload'.freeze
 
     def initialize(app, transform_request: true, transform_response: true)
       @app = app
@@ -16,8 +16,10 @@ module Rack
       @transform_response = transform_response
     end
 
+    # 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.
     def call(env)
-      # load the json string into a Hash instance
       if transform_request?(env)
         env[ENV_PAYLOAD_KEY] = Oj.load(env['rack.input'])
       end
@@ -25,8 +27,6 @@ module Rack
       status, headers, body = @app.call(env)
 
       if body && transform_response?(headers)
-        # expects the body to be an object instance e.g. Hash
-        # putting the object in an array will cause unexpected json
         body = Oj.dump(body)
         headers['CONTENT_LENGTH'] = body.length.to_s
         body = [body] unless body.is_a?(Array)
@@ -35,7 +35,7 @@ module Rack
       [status, headers, body]
     end
 
-    private
+  private
 
     def transform_request?(env)
       @transform_request &&

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-jsonparser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Telford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-10-21 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware for processing JSON requests and responses using the
   'oj' gem.
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/rack/json_parser.rb
 homepage: https://github.com/michaeltelford/rack-jsonparser
 licenses:
@@ -29,9 +30,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="