kissifer-rack-accept-only 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kissifer
+
+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.rdoc

@@ -0,0 +1,7 @@
+= rack-accept-only
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 kissifer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-accept-only"
+    gem.summary = %Q{Allows checking of reply content type with request accept types. Also allows contracting of downstream apps to supplying a single type.}
+    gem.email = "tierneydrchris@gmail.com"
+    gem.homepage = "http://github.com/kissifer/rack-accept-only"
+    gem.authors = ["kissifer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-accept-only #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack/accept-only.rb

@@ -0,0 +1,60 @@
+module Rack
+  class AcceptOnly
+    def initialize(app, permitted_type = nil)
+      raise "Keep the permitted content-type simple please" if permitted_type && permitted_type.match(%r{[*; ]})
+      @app = app
+      @permitted_type = permitted_type
+    end
+    
+    def call(env)
+      acceptable_types = get_acceptable_types(env)
+      return @app.call(env) unless !acceptable_types.empty? || @permitted_type
+
+      if !match_against_types?(acceptable_types, @permitted_type)
+        return unacceptable(@permitted_type)
+      end
+
+      reply = @app.call(env)
+      reply_type = reply[1]['Content-Type']
+      
+      return server_error unless reply_type
+      
+      if @permitted_type && reply_type != @permitted_type
+        reply = server_error
+      end
+      
+      if !match_against_types?(acceptable_types, reply_type)
+        reply = unacceptable(reply_type)
+      end
+
+      reply
+    end
+    
+    def get_acceptable_types(env)
+      return [] unless env['HTTP_ACCEPT']
+
+      acceptable_types = env['HTTP_ACCEPT'].split(",")
+      acceptable_types.collect do |type|
+        temp = type.strip.split(";")[0].gsub("*", "(.+)")
+        Regexp.new("^#{temp}$")
+      end
+    end
+
+    def match_against_types?(types, string)
+      return true unless !types.empty? && string
+
+      types.each do |type|
+        return true if string.match(type)
+      end
+      false
+    end
+    
+    def unacceptable(supplyable_type)
+      [406, {'Content-Type' => supplyable_type, "Content-Length" => "0"}, [""]]
+    end
+
+    def server_error
+      [500, {"Content-Length" => "0"}, [""]]
+    end
+  end
+end

data/spec/rack-accept-only_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rack::AcceptOnly" do
+  before(:each) do
+    @app = lambda{ |env| [111, {'foo' => 'bar', 'Content-Type' => @return_type}, ["Something"]] }
+  end
+  
+  context "if not supplied a permitted content type" do
+    before(:each) do
+      @accept_only = Rack::AcceptOnly.new(@app)
+    end
+    
+    context "and the Accept header is not present in the request" do
+      before(:each) do
+        @request = Rack::MockRequest.env_for("/")
+      end
+
+      it "should not modify the downstream response" do
+        @return_type = "foo"
+        @accept_only.call(@request).should == @app.call(@request)
+      end
+    end
+    
+    context "and the Accept header is present in the request" do
+      before(:each) do
+        @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "acceptable")
+      end
+      
+      context "and the Content-Type of the downstream reply is not acceptable" do
+        it "should reject the request" do
+          @return_type = "not_acceptable"
+          @accept_only.call(@request)[0].should == 406
+        end
+        
+        it "should include the downstream Content-Type in the reply" do
+          @return_type = "not_acceptable"
+          @accept_only.call(@request)[1]['Content-Type'].should == "not_acceptable"
+        end
+      end
+
+      context "and the Content-Type of the downstream reply is acceptable" do
+        it "should not modify the downstream response" do
+          @return_type = "acceptable"
+          @accept_only.call(@request).should == @app.call(@request)
+        end
+      end
+    end
+  end
+
+  context "if supplied a (single) permitted content type" do
+    before(:each) do
+      @accept_only = Rack::AcceptOnly.new(@app, "permitted")
+    end
+    
+    context "and the Accept header is not present in the request" do
+      before(:each) do
+        @request = Rack::MockRequest.env_for("/")
+      end
+
+      it "should signal server error if the Content-Type of the downstream reply is not permitted" do
+        @return_type = "not_permitted"
+        @accept_only.call(@request)[0].should == 500
+      end
+
+      it "should not modify the downstream response if the Content-Type of the downstream reply is permitted" do
+        @return_type = "permitted"
+        @accept_only.call(@request).should == @app.call(@request)
+      end
+    end
+
+    context "and the Accept header is present in the request" do
+      context "if the acceptable types do not include the permitted type" do
+        before(:each) do
+          @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "not_permitted, also_not_permitted")
+          @return_type = "shouldnt_see_this"
+        end
+        
+        it "should reject the request" do
+          @accept_only.call(@request)[0].should == 406
+        end
+
+        it "should include the permitted type in the reply" do
+          @accept_only.call(@request)[1]['Content-Type'].should == "permitted"
+        end
+        
+        it "should not call downstream middleware" do
+          @app.should_not_receive(:call)
+          @accept_only.call(@request)
+        end
+      end
+
+      context "if the acceptable types do include the permitted type" do
+        before(:each) do
+          @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "not_permitted, permitted")
+        end
+
+        it "should signal server error if the Content-Type of the downstream reply is not permitted" do
+          @return_type = "not_permitted"
+          @accept_only.call(@request)[0].should == 500
+        end
+
+        it "should not modify the downstream response if the Content-Type of the downstream reply is permitted" do
+          @return_type = "permitted"
+          @accept_only.call(@request).should == @app.call(@request)
+        end
+      end
+    end
+  end
+  
+  it "should reject non-simple permitted types" do
+    lambda{Rack::AcceptOnly.new(@app, "audio/*")}.should raise_error
+    lambda{Rack::AcceptOnly.new(@app, "*/*")}.should raise_error
+    lambda{Rack::AcceptOnly.new(@app, "image/gif; q=0.8")}.should raise_error
+  end
+  
+  it "should handle more complex accept headers in the request when given a permitted type" do
+    @accept_only = Rack::AcceptOnly.new(@app, "image/jpeg")
+    @return_type = "image/jpeg"
+
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "image/gif, image/*; q=0.8")
+    @accept_only.call(@request).should == @app.call(@request)
+
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "*/*")
+    @accept_only.call(@request).should == @app.call(@request)
+  end
+
+  it "should handle more complex accept headers in the request when not given a permitted type" do
+    @accept_only = Rack::AcceptOnly.new(@app)
+    @return_type = "image/jpeg"
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "image/gif, image/*; q=0.8")
+    @accept_only.call(@request).should == @app.call(@request)
+
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "*/*")
+    @accept_only.call(@request).should == @app.call(@request)
+  end
+  
+  it "should signal server error if the reply has no content-type when given a permitted type" do
+    @app = lambda{ |env| [111, {'foo' => 'bar'}, ["Something"]] }
+    @accept_only = Rack::AcceptOnly.new(@app, "image/jpeg")
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "image/jpeg")
+    @accept_only.call(@request)[0].should == 500
+  end
+
+  it "should signal server error if the reply has no content-type when not given a permitted type" do
+    @app = lambda{ |env| [111, {'foo' => 'bar'}, ["Something"]] }
+    @accept_only = Rack::AcceptOnly.new(@app)
+    @request = Rack::MockRequest.env_for("/", "HTTP_ACCEPT" => "image/jpeg")
+    @accept_only.call(@request)[0].should == 500
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+require 'rack/mock'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/accept-only'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: kissifer-rack-accept-only
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- kissifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tierneydrchris@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/accept-only.rb
+- spec/rack-accept-only_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/kissifer/rack-accept-only
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Allows checking of reply content type with request accept types. Also allows contracting of downstream apps to supplying a single type.
+test_files: 
+- spec/rack-accept-only_spec.rb
+- spec/spec_helper.rb