status_dogs 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in status_dogs.gemspec
+gemspec

data/README.md

@@ -0,0 +1,69 @@
+# Status Dogs
+
+Rack middleware replacing responses with relevant pictures of dogs, based on the status code.
+
+The pictures are made/collected by [Mike Lee](https://twitter.com/mikeleeorg) on [HTTP Status Dogs](http://httpstatusdogs.com/).
+
+This is a shameless fork of [status_cats](https://github.com/iain/status_cats) by @iain.
+
+## Usage
+
+Install:
+
+``` sh
+gem install status_dogs
+```
+
+Place inside your rackup file:
+
+``` ruby
+require 'status_dogs'
+use StatusDogs
+```
+
+This will also replace valid responses, even `200`, basically making your application useless.
+
+You can manage which status codes should be replaced with dogs, by using the `:only` and `:except`
+options, which take arrays or ranges.
+
+``` ruby
+use StatusDogs, :only => [ 403, 404, 500 ]
+
+# or ...
+
+use StatusDogs, :except => 200...300
+```
+
+## Development
+
+Install dependencies:
+
+``` sh
+bundle install
+```
+
+Run tests:
+
+``` sh
+rake
+```
+
+You can run the demo application:
+
+``` sh
+bundle exec rackup
+```
+
+The application will trigger the response code depending on the path you visit, so visiting
+[http://localhost:9292/418](http://localhost:9292/418) will respond with a teapot.
+
+
+## Known issues
+
+Status codes `100` (Continue), `204` (No Content) and `304` (Not Modified) cannot have a response body. Triggering them will cause Rack to throw up.
+
+## License
+
+The Ruby code in this project is released under the MIT License.
+
+The pictures of dogs are copywrited by [Mike Lee](https://twitter.com/mikeleeorg) from http://httpstatusdogs.com/

data/Rakefile

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

data/config.ru

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'status_dogs'
+
+require File.expand_path('../spec/test_app', __FILE__)
+
+use StatusDogs
+run TestApp.new

data/lib/status_dogs.rb

@@ -0,0 +1,31 @@
+require 'rack/file'
+
+class StatusDogs
+
+  DOGS = [ 100, 200, 201, 202, 203, 206, 300, 301, 302, 303, 305, 306, 400, 401, 402, 403, 404, 405, 406, 408, 409, 410, 411, 413, 414, 416, 417, 418, 420, 422, 423, 424, 425, 426, 429, 431, 444, 450, 500, 501, 502, 503, 504, 506, 507, 508 ].freeze
+  DOGS_DIR = File.expand_path("../../dogs", __FILE__)
+
+  def initialize(app, options = {})
+    @app, @options = app, options
+  end
+
+  def call(env)
+    @status, @headers, @response = @app.call(env)
+    if display_dog?
+      _, @headers, @response = Rack::File.new(DOGS_DIR).call("REQUEST_METHOD" => "GET", "PATH_INFO" => "#{@status}.jpg")
+    end
+    [ @status, @headers, @response ]
+  end
+
+  def display_dog?
+    dogs = DOGS
+    if @options.has_key?(:only)
+      dogs = Array(@options[:only]) & dogs
+    end
+    if @options.has_key?(:except)
+      dogs = dogs - Array(@options[:except])
+    end
+    dogs.include?(@status.to_i)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rack/test'
+require 'status_dogs'
+require 'test_app'
+
+RSpec::Matchers.define :be_replaced_with_dog do |code|
+  match do |actual|
+    if code.nil?
+      actual.body != "Hello, World!"
+    else
+      path = File.expand_path("../../dogs/#{code}.jpg", __FILE__)
+      file = File.open(path, 'rb')
+      actual.body == file.read &&
+      actual.status == code &&
+      actual.headers["Content-Length"] == file.size.to_s &&
+      actual.headers["Content-Type"] == "image/jpeg"
+    end
+  end
+
+end

data/spec/status_dogs_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe StatusDogs do
+
+  include Rack::Test::Methods
+
+  describe "dog responses" do
+
+    let(:app) { StatusDogs.new(TestApp.new) }
+
+    StatusDogs::DOGS.each do |code|
+
+      it "displays dog for status #{code}" do
+        get code.to_s
+        last_response.should be_replaced_with_dog(code)
+      end
+
+    end
+
+    it "won't replace response with a dog if there is no file for it" do
+      get "600"
+      last_response.should_not be_replaced_with_dog
+    end
+
+  end
+
+  describe ":only" do
+
+    let(:app) { StatusDogs.new(TestApp.new, :only => 200...300) }
+
+    it "will replace response with a dog if status is within range" do
+      get "206"
+      last_response.should be_replaced_with_dog(206)
+    end
+
+    it "will not replace if there is no file for it" do
+      get "299"
+      last_response.should_not be_replaced_with_dog
+    end
+
+    it "will not replace if out of range" do
+      get "404"
+      last_response.should_not be_replaced_with_dog(404)
+    end
+
+  end
+
+  describe ":except" do
+
+    let(:app) { StatusDogs.new(TestApp.new, :except => 200...300) }
+
+    it "will replace response with a dog if status is not in range" do
+      get "404"
+      last_response.should be_replaced_with_dog(404)
+    end
+
+    it "will not replace response with a dog if status is in range" do
+      get "206"
+      last_response.should_not be_replaced_with_dog(206)
+    end
+
+    it "won't replace dogs that are not known" do
+      get "201"
+      last_response.should_not be_replaced_with_dog
+    end
+
+  end
+
+end

data/spec/test_app.rb

@@ -0,0 +1,11 @@
+class TestApp
+
+  def call(env)
+    status  = env["PATH_INFO"].gsub(/\D/, '').to_i
+    status = 404 if status < 100
+    headers = {"Content-Type" => "text/html"}
+    body    = ["Hello, World!"]
+    [ status, headers, body ]
+  end
+
+end

data/status_dogs.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "status_dogs"
+  s.version     = "0.0.1"
+  s.authors     = ["Jan Vlnas", "iain"]
+  s.email       = ["gems@jan.vlnas.cz", "iain@iain.nl"]
+  s.homepage    = "https://github.com/jnv/status_dogs"
+  s.summary     = %q{Rack middleware; replaces responses with dogs}
+  s.description = %q{Rack middleware replacing responses with relevant pictures of dogs, based on the status code.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", ">= 2"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "rake"
+  s.add_runtime_dependency "rack"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: status_dogs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jan Vlnas
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rack-test
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: rack
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Rack middleware replacing responses with relevant pictures of dogs, based
+  on the status code.
+email:
+- gems@jan.vlnas.cz
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- config.ru
+- dogs/100.jpg
+- dogs/200.jpg
+- dogs/201.jpg
+- dogs/202.jpg
+- dogs/203.jpg
+- dogs/204.jpg
+- dogs/206.jpg
+- dogs/300.jpg
+- dogs/301.jpg
+- dogs/302.jpg
+- dogs/303.jpg
+- dogs/304.jpg
+- dogs/305.jpg
+- dogs/306.jpg
+- dogs/400.jpg
+- dogs/401.jpg
+- dogs/402.jpg
+- dogs/403.jpg
+- dogs/404.jpg
+- dogs/405.jpg
+- dogs/406.jpg
+- dogs/408.jpg
+- dogs/409.jpg
+- dogs/410.jpg
+- dogs/411.jpg
+- dogs/413.jpg
+- dogs/414.jpg
+- dogs/416.jpg
+- dogs/417.jpg
+- dogs/418.jpg
+- dogs/420.jpg
+- dogs/422.jpg
+- dogs/423.jpg
+- dogs/424.jpg
+- dogs/425.jpg
+- dogs/426.jpg
+- dogs/429.jpg
+- dogs/431.jpg
+- dogs/444.jpg
+- dogs/450.jpg
+- dogs/500.jpg
+- dogs/501.jpg
+- dogs/502.jpg
+- dogs/503.jpg
+- dogs/504.jpg
+- dogs/506.jpg
+- dogs/507.jpg
+- dogs/508.jpg
+- lib/status_dogs.rb
+- spec/spec_helper.rb
+- spec/status_dogs_spec.rb
+- spec/test_app.rb
+- status_dogs.gemspec
+homepage: https://github.com/jnv/status_dogs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware; replaces responses with dogs
+test_files: []
+has_rdoc: