rack-force-status 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    rack-force-status (0.0.1)
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rack (1.5.1)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-force-status!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,51 @@
+# Rack::ForceStatus
+
+Rack::ForceStatus is a simple Rack middleware for forcing status codes on responses. This is useful for dealing with things like [XDomainRequest's inability to provide responseText on errors](http://stackoverflow.com/questions/10390539/xdomainrequest-get-response-body-on-error). We can now return the error with a 200 response that XDomainRequest can receive and handle.
+
+## Installation
+
+Install the Rack::ForceStatus gem with a simple:
+
+```ruby
+gem install rack-force-status
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'rack-force-status'
+```
+
+## Usage
+
+Use the Rack::ForceStatus middleware like anything else:
+
+```ruby
+use Rack::ForceStatus
+```
+
+Or for Rails application, add the following line to your application config file (config/application.rb for Rails 3 & 4, config/environment.rb for Rails 2):
+
+```ruby
+config.middleware.use Rack::ForceStatus
+```
+
+From there you can force the status on any request by passing a ```force_status``` param, set to the value of the status you'd like. For example, if you'd like everything to always return successful, you'd do:
+
+```
+http://myapp.com/some/path?force_status=200
+```
+
+In addition to forcing the status to whatever you've specified, if the original status was different you will get a header added telling you what it was originally.
+
+```
+X-Original-Status-Code: 422
+```
+
+## Options
+
+If you'd like to customize the incoming param name or the outgoing header name, you can pass them as options.
+
+```ruby
+config.middleware.use Rack::ForceStatus, :param => 'my-custom-param', :header => 'My-Custom-Header'
+```

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/lib/rack-force-status.rb

@@ -0,0 +1 @@
+require 'rack/force-status'

data/lib/rack/force-status.rb

@@ -0,0 +1 @@
+require 'rack/force-status/middleware'

data/lib/rack/force-status/middleware.rb

@@ -0,0 +1,23 @@
+module Rack
+  class ForceStatus
+    def initialize(app, options={})
+      @app = app
+      @param = options[:param] || 'force_status'
+      @header = options[:header] || 'X-Original-Status-Code'
+    end
+    
+    def call(env)
+      request = Rack::Request.new(env)
+      force_status = request.params.delete(@param).to_i
+      
+      status, headers, body = @app.call(env)
+      
+      if force_status > 0 && status != force_status
+        headers[@header] = status.to_s
+        status = force_status
+      end
+      
+      [status, headers, body]
+    end
+  end
+end

data/lib/rack/force-status/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ForceStatus
+    VERSION = "0.0.1"
+  end
+end

data/rack-force-status.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/force-status/version"
+
+Gem::Specification.new do |s|
+  s.name         = "rack-force-status"
+  s.version      = Rack::ForceStatus::VERSION
+  s.authors      = ["Big Cartel"]
+  s.email        = "dev@bigcartel.com"
+  s.homepage     = "https://github.com/bigcartel/rack-force-status"
+  s.summary      = "Rack middleware for forcing status codes on responses."
+  s.description  = "Rack middleware for forcing status codes on responses."
+
+  s.files        = `git ls-files`.split($\)
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  
+  s.add_dependency('rack')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+end

data/spec/rack_force_status_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rack::ForceStatus do
+  let(:body) { '<html><body><h1>Hi</h1></body></html>' }
+  let(:original_status) { 422 }
+  let(:custom_param) { nil }
+  let(:custom_header) { nil }
+  let(:options) { { :param => custom_param, :header => custom_header }}
+  let(:app) { lambda { |env| [original_status, {}, [body]] } }
+  let(:request) { Rack::MockRequest.env_for("/", :params => "foo=bar&#{ custom_param || 'force_status' }=#{ forced_status }") }
+  let(:response) { Rack::ForceStatus.new(app, options).call(request) }
+  
+  describe "when we want to force the status" do
+    let(:forced_status) { 200 }
+    
+    it "should force the status code" do
+      response[0].should == forced_status
+    end
+    
+    it "should add a header with the original status code" do
+      response[1]['X-Original-Status-Code'].should == original_status.to_s
+    end
+    
+    it "shouldn't effect the body" do
+      response[2].should == [body]
+    end
+  end
+  
+  describe "when we've customized the middleware" do
+    let(:forced_status) { 200 }
+    let(:custom_param) { 'my-param' }
+    let(:custom_header) { 'my-header' }
+    
+    it "should force the status code" do
+      response[0].should == forced_status
+    end
+    
+    it "should add a header with the original status code" do
+      response[1][custom_header].should == original_status.to_s
+    end
+    
+    it "shouldn't effect the body" do
+      response[2].should == [body]
+    end
+  end
+  
+  describe "when we don't want to force the status" do
+    let(:forced_status) { nil }
+    
+    it "should maintain the original code" do
+      response[0].should == original_status
+    end
+    
+    it "should not add a header with the original status code" do
+      response[1]['X-Original-Status-Code'].should be_nil
+    end
+    
+    it "shouldn't effect the body" do
+      response[2].should == [body]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rack'
+require 'rack-force-status'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rack-force-status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Big Cartel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for forcing status codes on responses.
+email: dev@bigcartel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rack-force-status.rb
+- lib/rack/force-status.rb
+- lib/rack/force-status/middleware.rb
+- lib/rack/force-status/version.rb
+- rack-force-status.gemspec
+- spec/rack_force_status_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bigcartel/rack-force-status
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware for forcing status codes on responses.
+test_files: []