RubyGems - rack-denyie - Versions diffs - 0.1.0 → 1.0.0 - Mend

rack-denyie 0.1.0 → 1.0.0

Files changed (9) hide show

data/README.rdoc CHANGED Viewed

@@ -1,35 +1,67 @@
 == IE Filter on Rack
-Use rack to filter out unsupported IE versions.
-Use the default template, a custom template or redirect users to another location.
+=== What?
+===
+* Rack middleware that denies specified versions of IE.
+* Use the default template, a custom template or redirect users to another location.
+=== Why?
+===
-Because dealing with IE should be easy.
-Because you can support what you want (if you're lucky).
+* Because progressive enhancement only goes so far.
 === How?
+===
+Install:
+ [sudo] gem install rack-denyie
+Use:
+ require 'rack-denyie'
+With default options: (Allows IE 7 or higher and displays the default template)
- # Default Options, IE < 7 & Default Template
- use Rack::NoIE
+ use Rack::DenyIE
- use Rack::NoIE, {
-  :version => 7, # IE < 8
-  :template => '/full/path/to/your/template.html'
+With custom template and modified minimum version:
+ use Rack::DenyIE, {
+  :min_version => 8,  # Allow IE 8 and higher
+  :template => "/full/path/to/your/template.html"  # Custom HTML template
  }
-=== Why?
+With redirection set (not well tested):
+ use Rack::DenyIE, {
+  :redirect_url => "http://browsehappy.com/"
+ }
+With all options:
+ use Rack::DenyIE, {
+  :min_version => 6,  # Minimum Version :: Allows IE 6 and higher
+  :template => '/full/path/to/your/template.erb',  # Custom template :: ERB or HTML
+  :headline => 'Sorry, old browser alert!',  # Replaces "Your version of Internet Explorer is not supported."
+  :site_name => "My Website"  # Site Name :: Replaces the default "this site" with your site name.
+ }
+Any key/value you pass in will be available to your ERB template.
+ use Rack::DenyIE, {
+  :my_key => "my value"
+ }
-1. IE 6 was released in 2001.
-2. Developing for IE 6 costs extra time + money.
-3. Because they're releasing the alpha version of IE 9 next year.
+ <%= @my_key %> #=> "my value"
-=== Release Years
+=== Todo
 ===
-* IE 9 ~ 2010
-* IE 8 = 2009
-* IE 7 = 2006
-* IE 6 = 2001 <= Should be unsupported
-* IE 5 = 1999 <= Should be unsupported
+* Allow HAML templates
+* Write tests for url redirection
+* Tests need improvement
 == Copyright

data/Rakefile CHANGED Viewed

@@ -5,10 +5,10 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "rack-denyie"
-    gem.summary = "Use rack to filter out unsupported IE versions."
-    gem.description = "Use rack to filter out unsupported IE versions.  Use default/custom template or redirect users to another place."
+    gem.summary = "Rack middleware that denies specified versions of IE."
+    gem.description = "Rack middleware that denies specified versions of IE."
     gem.email = "brad@digitalstarstudios.com"
-    gem.homepage = "http://github.com/whitcomb/rack-denyie"
+    gem.homepage = "http://digitalstarstudios.com/projects"
     gem.authors = ["Brad Whitcomb"]
     gem.add_dependency "rack", "1.0.0"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.1.0
1	+ 1.0.0

data/lib/html/default.erb ADDED Viewed

@@ -0,0 +1,116 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang="en-US" xml:lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+		<title>Please Upgrade Your Browser</title>
+		<style type="text/css">
+			/* Reset */
+			body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, form, fieldset, input, textarea, p, blockquote, th, td {
+				margin: 0;
+				padding: 0;
+			}
+			table {
+				border-collapse: collapse;
+				border-spacing: 0;
+				font-size: inherit;
+			}
+			fieldset, img {
+				border: 0;
+			}
+			address, caption, cite, code, dfn, em, strong, th, var {
+				font-style:	normal;
+				font-weight: normal;
+			}
+			ol, ul {
+				list-style:	none;
+			}
+			caption, th {
+				text-align:	left;
+			}
+			abbr, acronym {
+				border: 0;
+			}
+			:focus {
+				outline: 0;
+			}
+			* textarea {
+				overflow: auto;
+			}
+			/* Default */
+			body {
+				font-family: Arial, Helvetica, Tahoma, sans-serif;
+				background-image: url("http://digitalstarstudios.com/images/denyie/default_bg.jpg");
+				background-repeat: repeat;
+			}
+			div#container {
+				overflow: auto;
+				margin: 0 auto;
+				margin-top: 100px;
+				padding: 20px 20px 15px 20px;
+				width: 500px;
+				text-align: center;
+				background-color: #FFFFFF;
+				border: 2px solid #2B445F;
+			}
+			div#container * { text-align: left }
+			p, li { font-size: 18px }
+			h1, p { margin-bottom: 10px }
+			h1 { font-size: 20px }
+			h2 { font-size: 16px; margin-bottom: 7px }
+			p { line-height: 26px }
+			span { font-weight: bold }
+			ul { margin-top: 20px }
+			ul li { float: left; width: 250px; margin-bottom: 20px }
+			ul li img { float: left; margin-right: 10px; border: none }
+			a, a:visited, a:active {
+				padding: 3px 8px;
+				font-size: 16px;
+				text-decoration: none;
+				color: #FFFFFF;
+				background-color: #425265;
+			}
+			a:hover { background-color: #2B445F }
+		</style>
+	</head>
+  <body>
+		<div id="container">
+			<h1><%= @headline %></h1>
+			<p>You've been redirected to this page because <%= @site_name %> only supports <span>Microsoft Internet Explorer <%= @min_version %></span> or higher.</p>
+			<p>Please upgrade to the latest version of Internet Explorer or try using another browser when visiting this site.</p>
+			<p>We recommend any of the fine browsers below:</p>
+			<ul>
+				<li>
+					<img src="http://digitalstarstudios.com/images/denyie/ie.jpg" title="Microsoft Internet Explorer" width="50" height="50" alt="Internet Explorer Logo" />
+					<h2>Internet Explorer 8</h2>
+					<a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx" title="Download latest Internet Explorer">Download</a>
+				</li>
+				<li>
+					<img src="http://digitalstarstudios.com/images/denyie/firefox.jpg" title="Mozilla Firefox" width="50" height="50" alt="Firefox Logo" />
+					<h2>Mozilla Firefox 3+</h2>
+					<a href="http://firefox.com" title="Download Firefox">Download</a>
+				</li>
+				<li>
+					<img src="http://digitalstarstudios.com/images/denyie/safari.jpg" title="Apple Safari" width="50" height="49" alt="Safari Logo" />
+					<h2>Apple Safari 4+</h2>
+					<a href="http://apple.com/safari" title="Download Safari">Download</a>
+				</li>
+				<li>
+					<img src="http://digitalstarstudios.com/images/denyie/opera.jpg" title="Opera" width="50" height="50" alt="Opera Logo" />
+					<h2>Opera 10+</h2>
+					<a href="http://opera.com" title="Download Opera">Download</a>
+				</li>
+			</ul>
+		</div>
+  </body>
+</html>

data/lib/rack-denyie.rb CHANGED Viewed

@@ -1,24 +1,32 @@
 require 'rack'
+require 'erb'
 module Rack
   class DenyIE
-    DEFAULT_TEMPLATE_PATH = ::File.join(::File.dirname(__FILE__), 'html', 'default.html')
+    DEFAULT_TEMPLATE_PATH = ::File.join(::File.dirname(__FILE__), 'html', 'default.erb')
+    URL_REGEX = %r{\b(([\w-]+://?|[\w\d]+[.])[^\s()<>]+(?:(?:\([\w\d)]+\)[^\s()<>]*)+|([^[:punct:]\s]|/)))} # http://alanstorm.com/url_regex_explained
     def initialize(app, options = {})
-      @app = app
-      @options = { :min_version => 6, :template_path => DEFAULT_TEMPLATE_PATH, :redirect_url => nil }.merge options
+      @app = app # Passed App
+      @options = {
+        :min_version => 7,
+        :headline => "Your version of Internet Explorer is not supported.",
+        :site_name => "this site",
+        :template => DEFAULT_TEMPLATE_PATH,
+        :redirect_url => nil }.merge options # Middleware Options
     end
     def call(env)
       status, @headers, content = @app.call(env)
-      is_browser_supported?(env) && is_content_html? ? act_on_ie : @app.call(env)
+      is_unsupported?(env) && is_content_html? ? act_on_ie : @app.call(env)
     end
     private
-    def is_browser_supported?(env)
-      env["HTTP_USER_AGENT"].match(/MSIE [0-#{@options[:min_version]}]\.[0-9][0-9]?/)
+    def is_unsupported?(env)
+      minimum_version = (@options[:min_version].to_i - 1)
+      env["HTTP_USER_AGENT"].match(/MSIE [0-#{minimum_version}]/) # \.[0-9][0-9]?
     end
     def is_content_html?
@@ -30,7 +38,7 @@ module Rack
     end
     def should_redirect?
-      !@options[:redirect_url].nil? && @options[:redirect_url].match(/(^$)|(^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$)/ix)
+      !@options[:redirect_url].nil? && @options[:redirect_url].match(URL_REGEX)
     end
     def redirect_browser
@@ -38,10 +46,32 @@ module Rack
     end
     def display_template
-      response = ::File.read(@options[:template_path]) # TODO: Add check to see if template points to an actual file
+      response = (::File.extname(@options[:template]) == ".erb") ? process_erb : ::File.read(@options[:template]) # TODO: Add check to see if template points to an actual file
       @headers['Content-Length'] = Rack::Utils.bytesize(response.to_s).to_s
       [200, @headers, response]
     end
+    def process_erb
+      raw = ::File.read(@options[:template])
+      erb = ERB.new(raw, nil, "%<>")
+      binding = TemplateVars.new(@options).get_binding # Variables passed to ERB template
+      template = erb.result(binding)
+      template.gsub(/\n$/,'')
+    end
+  end
+  class TemplateVars
+    def initialize(vars = {})
+      vars.each_pair do |key, value|
+        self.instance_variable_set("@#{key}", value)
+      end
+    end
+    def get_binding
+      binding
+    end
   end
 end

data/rack-denyie.gemspec ADDED Viewed

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{rack-denyie}
+  s.version = "1.0.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad Whitcomb"]
+  s.date = %q{2009-11-30}
+  s.description = %q{Rack middleware that denies specified versions of IE.}
+  s.email = %q{brad@digitalstarstudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/html/default.erb",
+     "lib/rack-denyie.rb",
+     "rack-denyie.gemspec",
+     "test/html/custom_template.html",
+     "test/test_helper.rb",
+     "test/test_rack-denyie.rb"
+  ]
+  s.homepage = %q{http://digitalstarstudios.com/projects}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack middleware that denies specified versions of IE.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/test_rack-denyie.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, ["= 1.0.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, ["= 1.0.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, ["= 1.0.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/test/test_rack-denyie.rb CHANGED Viewed

@@ -1,9 +1,9 @@
 require 'test_helper'
+require 'erb'
 class TestRackDenyIE < Test::Unit::TestCase
   BODY = "OK"
   CUSTOM_TEMPLATE_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'html', 'custom_template.html'))
   def get_response(user_agent, body, content_type = 'text/html', options = {})
@@ -13,6 +13,21 @@ class TestRackDenyIE < Test::Unit::TestCase
     end
     Rack::MockRequest.new(app).get('/')
   end
+  def read_erb(ver)
+    @defaults = {
+      :min_version => ver || 7,
+      :headline => "Your version of Internet Explorer is not supported.",
+      :site_name => "this site",
+      :template => Rack::DenyIE::DEFAULT_TEMPLATE_PATH,
+      :redirect_url => nil
+    }
+    raw = File.read(@defaults[:template])
+    erb = ERB.new(raw, nil, "%<>")
+    binding = Rack::TemplateVars.new(@defaults).get_binding
+    template = erb.result(binding)
+    template.gsub(/\n$/,'')
+  end
   context "When Rack::DenyIE" do
@@ -34,45 +49,35 @@ class TestRackDenyIE < Test::Unit::TestCase
       end
     end
-    context "encounters supported IE 7" do
-      setup do
-        user_agent = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322; .NET CLR 3.5.21022)"
-        @response = get_response(user_agent, BODY, "text/html", { :version => 6 })
-      end
-      should "return original response" do
-        assert_equal BODY, @response.body
-      end
-    end
     context "encounters supported IE 8" do
       setup do
         user_agent = "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; WOW64; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729)"
-        @response = get_response(user_agent, BODY, "text/html", { :version => 7 })
+        @response = get_response(user_agent, BODY, "text/html", { :min_version => 8 })
       end
       should "return original response" do
         assert_equal BODY, @response.body
       end
     end
-    context "encounters unsupported IE 6" do
+    # IE 6 Tests
+    context "encounters supported IE 6" do
       setup do
         user_agent = "Mozilla/4.0 (Compatible; Windows NT 5.1; MSIE 6.0) (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"
         @response = get_response(user_agent, BODY, "text/html", { :min_version => 6 })
       end
-      should "return default IE template" do
-        default_template = File.read(Rack::DenyIE::DEFAULT_TEMPLATE_PATH)
-        assert_equal default_template, @response.body
+      should "return original response" do
+        assert_equal BODY, @response.body
       end
     end
-    context "encounters unsupported IE 7" do
+    context "encounters unsupported IE 6" do
       setup do
-        user_agent = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322; .NET CLR 3.5.21022)"
+        user_agent = "Mozilla/4.0 (Compatible; Windows NT 5.1; MSIE 6.0) (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"
         @response = get_response(user_agent, BODY, "text/html", { :min_version => 7 })
       end
       should "return default IE template" do
-        default_template = File.read(Rack::DenyIE::DEFAULT_TEMPLATE_PATH)
+        default_template = read_erb(7)
         assert_equal default_template, @response.body
       end
@@ -81,10 +86,10 @@ class TestRackDenyIE < Test::Unit::TestCase
     context "encounters unsupported IE 6 and custom template" do
       setup do
         user_agent = "Mozilla/4.0 (Compatible; Windows NT 5.1; MSIE 6.0) (compatible; MSIE 6.0; Windows NT 5.1; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"
-        @response = get_response(user_agent, BODY, "text/html", { :min_version => 6, :template_path => CUSTOM_TEMPLATE_PATH })
+        @response = get_response(user_agent, BODY, "text/html", { :min_version => 7, :template => CUSTOM_TEMPLATE_PATH })
       end
       should "return custom IE template" do
-        default_template = File.read(Rack::DenyIE::DEFAULT_TEMPLATE_PATH)
+        default_template = read_erb(7)
         custom_template = File.read(CUSTOM_TEMPLATE_PATH)
         assert_not_equal default_template, @response.body
@@ -92,13 +97,37 @@ class TestRackDenyIE < Test::Unit::TestCase
       end
     end
+    # IE 7 Tests
+    context "encounters supported IE 7" do
+      setup do
+        user_agent = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322; .NET CLR 3.5.21022)"
+        @response = get_response(user_agent, BODY, "text/html", { :min_version => 7 })
+      end
+      should "return original response" do
+        assert_equal BODY, @response.body
+      end
+    end
+    context "encounters unsupported IE 7" do
+      setup do
+        user_agent = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322; .NET CLR 3.5.21022)"
+        @response = get_response(user_agent, BODY, "text/html", { :min_version => 8 })
+      end
+      should "return default IE template" do
+        default_template = read_erb(8)
+        assert_equal default_template, @response.body
+      end
+    end
     context "encounters unsupported IE 7 and custom template" do
       setup do
         user_agent = "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; WOW64; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; Media Center PC 5.0; .NET CLR 1.1.4322; .NET CLR 3.5.21022)"
-        @response = get_response(user_agent, BODY, "text/html", { :min_version => 7, :template_path => CUSTOM_TEMPLATE_PATH })
+        @response = get_response(user_agent, BODY, "text/html", { :min_version => 8, :template => CUSTOM_TEMPLATE_PATH })
       end
       should "return custom IE template" do
-        default_template = File.read(Rack::DenyIE::DEFAULT_TEMPLATE_PATH)
+        default_template = read_erb(8)
         custom_template = File.read(CUSTOM_TEMPLATE_PATH)
         assert_not_equal default_template, @response.body

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-denyie
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Whitcomb
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-24 00:00:00 -08:00
+date: 2009-11-30 00:00:00 -08:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: "0"
     version:
-description: Use rack to filter out unsupported IE versions.  Use default/custom template or redirect users to another place.
+description: Rack middleware that denies specified versions of IE.
 email: brad@digitalstarstudios.com
 executables: []
@@ -48,13 +48,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- lib/html/default.html
+- lib/html/default.erb
 - lib/rack-denyie.rb
+- rack-denyie.gemspec
 - test/html/custom_template.html
 - test/test_helper.rb
 - test/test_rack-denyie.rb
 has_rdoc: true
-homepage: http://github.com/whitcomb/rack-denyie
+homepage: http://digitalstarstudios.com/projects
 licenses: []
 post_install_message:
@@ -80,7 +81,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key:
 specification_version: 3
-summary: Use rack to filter out unsupported IE versions.
+summary: Rack middleware that denies specified versions of IE.
 test_files:
 - test/test_helper.rb
 - test/test_rack-denyie.rb

data/lib/html/default.html DELETED Viewed

@@ -1,17 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html lang="en-US" xml:lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
-	<head>
-		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-		<title>Please Upgrade</title>
-		<style type="text/css">
-			h1 {
-				color: red;
-				font-size: 22px;
-			}
-		</style>
-	</head>
-  <body>
-    <h1>Your browser is unsupported.</h1>
-		<p>Please upgrade to the latest version of <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx" title="Download Internet Explorer">Internet Explorer</a></p>
-  </body>
-</html>