rack-json_response_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b045582186350a205ba09cd1b9ef961283d4bda
+  data.tar.gz: 1bab96a3396b352f8c8149180a1b00da138aa996
+SHA512:
+  metadata.gz: 8ec0543023c93957f5f78e54a78d674dda6cc98fe432f6fa69f0d15d7c1f6eaaab937be283a6fe5f44e13ba9790c61caa6679ba637d932e669f2e2daab7e4040
+  data.tar.gz: e21ce554077dc7f3e4c94c27e93f92bdaf9a765743c2b77ee013d3709009fce5a6d04034956f4d0fbfb92c6d9a736c3d5f3852f2a4faf6f6ce4fff250147b630

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,17 @@
+rack-json_response_wrapper
+==========================
+
+Rack Middleware for JSON APIs accessed cross-domain from legacy browsers
+
+Firefox version 4 does not support response headers for cross-domain requests. This middleware intercepts all requests and if the X-WRAP-RESPONSE is set, the response will be wrappped in JSON as follows:
+
+Suppose the following is the original response body:
+
+    {"key": "value"}
+    
+With X-WRAP-RESPONSE set to true, the new response will be:
+
+    {
+      "header": { ... bunch of headers ... },
+      "body": {"key": "value"}
+    }

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+task default: [:spec]
+
+desc 'run rspec specs'
+task :spec do
+  ENV['RACK_ENV'] ||= 'test'
+  sh 'rspec'
+end

data/lib/rack/json_response_wrapper.rb

@@ -0,0 +1,62 @@
+module Rack
+  class JsonResponseWrapper
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      response = @app.call(env)
+
+      if should_wrap? env, response
+        wrap_response(response)
+      else
+        response
+      end
+    end
+
+    private
+
+    def should_wrap?(env, response)
+      response_header = response[1]
+
+      is_json = response_header['Content-Type'].match(/application\/json/)
+      wants_wrap = env.include? 'X-WRAP-RESPONSE'
+
+      is_json && wants_wrap
+    end
+
+    def wrap_response(response)
+      response_body   = response[2].reduce(&:concat)
+      response_header = response[1]
+
+      response_obj = JSON.parse(response_body)
+
+      wrapped_obj = {
+        header: response_header,
+        body: response_obj
+      }
+
+      # dump JSON to get new content length
+      wrapped_body = JSON.dump(wrapped_obj)
+
+      # when we change the content-length, the length will change.
+      # therefore, calculate the offset by comparing the length of the old vs. new
+      original_content_length = response_header['Content-Length']
+      new_content_length = wrapped_body.length
+      adjusted_content_length =
+        new_content_length.to_s.to_json.length - original_content_length.to_s.to_json.length
+
+      # adjust the new content-length by this offset
+      new_content_length += adjusted_content_length
+
+      # set the content length part of the header and redump the JSON
+      wrapped_obj[:header]['Content-Length'] = new_content_length.to_s
+      wrapped_body = JSON.dump(wrapped_obj)
+
+      wrapped = response.dup
+      wrapped[2] = [wrapped_body]
+
+      wrapped
+    end
+  end
+end

data/spec/rack/json_response_wrapper_spec.rb

@@ -0,0 +1,64 @@
+require 'json'
+require_relative '../spec_helper'
+
+describe Rack::JsonResponseWrapper do
+  include Rack::Test::Methods
+
+  class MockedApp < Sinatra::Base
+    post '/' do
+      content_type 'application/json'
+      JSON.dump(JSON.parse(request.body.read))
+    end
+
+    post '/html' do
+      content_type 'text/html'
+      JSON.dump(JSON.parse(request.body.read))
+    end
+  end
+
+  def app
+    @app ||= Rack::JsonResponseWrapper.new(MockedApp)
+  end
+
+  describe 'call' do
+    before do
+      @obj = { foo: true, bar: 1, baz: 'hoagie' }
+      @json = JSON.dump(@obj)
+    end
+
+    it 'does nothing to the response if X-WRAP-RESPONSE is not defined' do
+      post '/', @json
+
+      expect(last_response.body).to eq @json
+    end
+
+    it 'does nothing to the response if Content-Type is not json, even with X-WRAP-RESPONSE' do
+      post '/html', @json, 'X-WRAP-RESPONSE' => true
+      
+      expect(last_response.body).to eq @json
+    end
+
+    it 'wraps the response if X-WRAP-RESPONSE is set' do
+      post '/', @json, 'X-WRAP-RESPONSE' => true
+
+      @response_obj = JSON.parse(last_response.body)
+
+      expect(@response_obj).to include 'header'
+      expect(@response_obj).to include 'body'
+
+
+      expect(JSON.dump(@response_obj['body'])).to eq @json
+    end
+
+    it 'when wrapping, includes response header in body' do
+      post '/', @json, 'X-WRAP-RESPONSE' => true
+
+      @response_obj = JSON.parse(last_response.body)
+      @response_header = last_response.header
+
+      @response_wrapped_header = @response_obj['header']
+
+      expect(JSON.dump(@response_wrapped_header)).to eq JSON.dump(@response_header)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rack/test'
+require 'sinatra/base'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rack', 'json_response_wrapper.rb')
+
+RSpec.configure do |config|
+  ENV['RACK_ENV'] ||= 'test'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rack-json_response_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- g. nicholas d'andrea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+description: "Rack Middleware for JSON APIs accessed cross-domain from legacy browsers\n\nFirefox
+  version 4 does not support response headers for cross-domain requests.\nThis middleware
+  intercepts all requests and if the X-WRAP-RESPONSE is set, \nthe response will be
+  wrappped in JSON like {header: ..., body: ...}\n"
+email: nick@gnidan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/json_response_wrapper.rb
+- spec/rack/json_response_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gnidan/rack-json_response_wrapper
+licenses:
+- Unlicense / Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Middleware for JSON APIs accessed cross-domain from legacy browsers
+test_files: []