rack-truncate_error_body 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 025833864f7960a042bbc4eea8c075ad5066110e
+  data.tar.gz: d52973f0d6d65ae1831f33753aee2e36d30338b5
+SHA512:
+  metadata.gz: 65facf5e2783da1f10feec86834e976e4139685e8a4e6210cf15ff6c0838563f2028a4ae3c9c6494c4aa79cc8b24d1be0fbf84322c0b5c3ad2bdb2f41297f139
+  data.tar.gz: f86e3684c00fd5406fd53437a1565faa5da92de8273eef96b59b68dd07f409819e5fe6068e6fbad8cbfb8b153265f30de85e83aaa48c4f1607669a02eac3a61a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color -fd

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-truncate_error.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 holysugar
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,36 @@
+# Rack::TruncateErrorBody
+
+Truncate HTTP body in error response. This is maybe useful for non-html API server.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-truncate_error_body'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-truncate_error_body
+
+## Usage
+
+in Ruby on Rails:
+
+```ruby
+config.middleware.use Rack::TruncateErrorBody, only_cascaded: true, content_type: application/x-msgpack
+```
+
+`only_cascaded` option means this middleware affects only response with "X-Cascaded: pass" header. This header is added in 404 RoutingError for example.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack/truncate_error_body.rb

@@ -0,0 +1,20 @@
+require "rack/truncate_error_body/version"
+
+module Rack
+  class TruncateErrorBody
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+
+    def call(env)
+      res = @app.call(env)
+      type = @options[:content_type] || "text/plain"
+      if (!@options[:only_cascaded] || res[1]["X-Cascade"] == "pass") && res[0] >= 400
+        [res[0], {"Content-Type" => type}, []]
+      else
+        res
+      end
+    end
+  end
+end

data/lib/rack/truncate_error_body/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class TruncateErrorBody
+    VERSION = "0.1.0"
+  end
+end

data/rack-truncate_error_body.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/truncate_error_body/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-truncate_error_body"
+  spec.version       = Rack::TruncateErrorBody::VERSION
+  spec.authors       = ["holysugar"]
+  spec.email         = ["holysugar@gmail.com"]
+  spec.description   = %q{Rack middleware; truncates error body}
+  spec.summary       = %q{Rack middleware; truncates error body}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test'
+
+  spec.add_runtime_dependency 'rack'
+end

data/spec/rack/truncate_error_body_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+class RackApp
+  def initialize(status, x_cascade = true)
+    @status    = status
+    @x_cascade = x_cascade
+  end
+
+  def call(env)
+    headers = {}
+    headers["X-Cascade"] = "pass" if @x_cascade
+    [@status, headers, ["Not Found"]]
+  end
+end
+
+describe Rack::TruncateErrorBody do
+  context "when 'X-Cascade: pass'" do
+    context "when 404 not found" do
+      let(:app) { Rack::TruncateErrorBody.new(RackApp.new(404, true)) }
+
+      it "removes body" do
+        get "/"
+        last_response.body.should be_empty
+      end
+    end
+
+    context "when 200 OK" do
+      let(:app) { Rack::TruncateErrorBody.new(RackApp.new(200, true)) }
+
+      it "doesn't remove body" do
+        get "/"
+        last_response.body.should_not be_empty
+      end
+    end
+  end
+
+  context "without X-Cascade header" do
+    context "when 404 not found" do
+      let(:app) { Rack::TruncateErrorBody.new(RackApp.new(404, false)) }
+
+      it "removes body" do
+        get "/"
+        last_response.body.should be_empty
+      end
+
+      context "with :only_cascaded option" do
+        let(:app) { Rack::TruncateErrorBody.new(RackApp.new(404, false), only_cascaded: true) }
+
+        it "doesn't remove body" do
+          get "/"
+          last_response.body.should_not be_empty
+        end
+      end
+    end
+  end
+
+  describe "can set content_type in option" do
+    context "without option" do
+      let(:app) { Rack::TruncateErrorBody.new(RackApp.new(404, true)) }
+
+      it "content type is text/plain" do
+        get "/"
+        last_response.content_type.should == "text/plain"
+      end
+    end
+
+    context "with content_type option" do
+      let(:app) { Rack::TruncateErrorBody.new(RackApp.new(404, true), content_type: 'application/x-msgpack') }
+
+      it "content type is text/plain" do
+        get "/"
+        last_response.content_type.should == "application/x-msgpack"
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rack/test'
+require 'rack/truncate_error_body'
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rack-truncate_error_body
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- holysugar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+description: Rack middleware; truncates error body
+email:
+- holysugar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/truncate_error_body.rb
+- lib/rack/truncate_error_body/version.rb
+- rack-truncate_error_body.gemspec
+- spec/rack/truncate_error_body_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.0
+signing_key: 
+specification_version: 4
+summary: Rack middleware; truncates error body
+test_files:
+- spec/rack/truncate_error_body_spec.rb
+- spec/spec_helper.rb