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

rack-denyie 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 1.0.0
1	+ 1.1.0

data/lib/html/default.erb CHANGED Viewed

@@ -45,19 +45,19 @@
 				font-family: Arial, Helvetica, Tahoma, sans-serif;
 				background-image: url("http://digitalstarstudios.com/images/denyie/default_bg.jpg");
 				background-repeat: repeat;
+				text-align: center;
 			}
-			div#container {
+			#container {
 				overflow: auto;
 				margin: 0 auto;
 				margin-top: 100px;
 				padding: 20px 20px 15px 20px;
 				width: 500px;
-				text-align: center;
+				text-align: left;
 				background-color: #FFFFFF;
 				border: 2px solid #2B445F;
 			}
-			div#container * { text-align: left }
 			p, li { font-size: 18px }
 			h1, p { margin-bottom: 10px }
@@ -68,7 +68,7 @@
 			span { font-weight: bold }
 			ul { margin-top: 20px }
-			ul li { float: left; width: 250px; margin-bottom: 20px }
+			ul li { float: left; margin-bottom: 20px; width: 250px }
 			ul li img { float: left; margin-right: 10px; border: none }
 			a, a:visited, a:active {
@@ -82,6 +82,9 @@
 		</style>
+		<!--[if lte IE 5]>
+			<style type="text/css">#container { width: 540px } ul li { width: 230px }</style>
+		<![endif]-->
 	</head>
   <body>
 		<div id="container">

data/lib/rack-denyie.rb CHANGED Viewed

@@ -2,76 +2,98 @@ require 'rack'
 require 'erb'
 module Rack
-  class DenyIE
-    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 # 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
+    class DenyIE
+      URL_REGEX = %r{\b(([\w-]+://?|[\w\d]+[.])[^\s()<>]+(?:(?:\([\w\d)]+\)[^\s()<>]*)+|([^[:punct:]\s]|/)))} # http://alanstorm.com/url_regex_explained
+      # Default Options
+      DEFAULT_MIN_VERSION = 7
+      DEFAULT_HEADLINE = "This version of Internet Explorer is not supported."
+      DEFAULT_SITE = "this site"
+      DEFAULT_TEMPLATE_PATH = ::File.join(::File.dirname(__FILE__), 'html', 'default.erb')
+      DEFAULT_REDIRECT_MESSAGE = "Your browser is unsupported."
+      def initialize(app, options = {})
+        @app = app
+        @options = {
+          :min_version => DEFAULT_MIN_VERSION, # The minimum version of IE you want allowed through
+          :headline => DEFAULT_HEADLINE, # The headline message displayed to filtered IE users
+          :site_name => DEFAULT_SITE, # Your site name.
+          :template => DEFAULT_TEMPLATE_PATH, # A custom template, either ERB or HTML
+          :redirect_url => nil }.merge options # Redirects users to a new location rather than displaying a template
+      end
-    def call(env)
-      status, @headers, content = @app.call(env)
-      is_unsupported?(env) && is_content_html? ? act_on_ie : @app.call(env)
-    end
+      def call(env)
+        status, @headers, content = @app.call(env)
+        is_unsupported?(env) && is_content_html? ? act_on_ie : @app.call(env)
+      end
-    private
+      private
-    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
+      # Uses a regex to filter IE versions
+      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?
-      @headers["Content-Type"] && @headers["Content-Type"].include?("text/html")
-    end
-    def act_on_ie
-      should_redirect? ? redirect_browser : display_template
-    end
+      # Checks if the content is html, this middleware ONLY filters content that is HTML
+      def is_content_html?
+        @headers["Content-Type"] && @headers["Content-Type"].include?("text/html")
+      end
-    def should_redirect?
-      !@options[:redirect_url].nil? && @options[:redirect_url].match(URL_REGEX)
-    end
+      # Decides which action to take, either redirect or display template
+      def act_on_ie
+        should_redirect? ? redirect_browser : display_template
+      end
-    def redirect_browser
-      [302, { 'Location' => @options[:redirect_url] }, "Your browser is unsupported." ]
-    end
+      # Checks if redirection is set
+      def should_redirect?
+        !@options[:redirect_url].nil? && @options[:redirect_url].match(URL_REGEX)
+      end
-    def display_template
-      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
+      # Redirects the browser to a new location
+      def redirect_browser
+        [302, { 'Location' => @options[:redirect_url] }, DEFAULT_REDIRECT_MESSAGE ]
+      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
+      # Displays the template
+      def display_template
+        response = (::File.extname(@options[:template]) == ".erb") ? ProcessERB.new(@options).bound : ::File.read(@options[:template])
+        [200, @headers, response]
+      end
-  end
+    end
-  class TemplateVars
+    class ProcessERB
-    def initialize(vars = {})
-      vars.each_pair do |key, value|
-        self.instance_variable_set("@#{key}", value)
+      def initialize(options = {})
+        @options = options
+        @erb = ERB.new(::File.read(@options[:template]), nil, "%<>")
       end
+      def bound
+        binding = TemplateVars.new(@options).get_binding # Variables passed to ERB template
+        @template = @erb.result(binding)
+        @template.gsub(/\n$/,'')
+      end
     end
+    # Binds the options as template variables (NOTE: This is probably a better way of doing this, I just don't know it.)
+    class TemplateVars
+      def initialize(options = {})
+        options.each_pair do |key, value|
+          self.instance_variable_set("@#{key}", value)
+        end
+      end
+      def get_binding
+        binding
+      end
-    def get_binding
-      binding
     end
-  end
 end

data/rack-denyie.gemspec CHANGED Viewed

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{rack-denyie}
-  s.version = "1.0.0"
+  s.version = "1.1.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.date = %q{2009-12-03}
   s.description = %q{Rack middleware that denies specified versions of IE.}
   s.email = %q{brad@digitalstarstudios.com}
   s.extra_rdoc_files = [

data/test/test_rack-denyie.rb CHANGED Viewed

@@ -6,42 +6,30 @@ 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 = {})
+  def request(user_agent, options = {}, content_type = 'text/html')
     app = Rack::Builder.new do
       use Rack::DenyIE, options
-      run lambda { |env| env["HTTP_USER_AGENT"] = user_agent; [200, {'Content-Type' => content_type}, [body] ] }
+      run lambda { |env| env["HTTP_USER_AGENT"] = user_agent; [200, {'Content-Type' => content_type}, BODY ] }
     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
+  context "When the App" do
-    user_agents = [
+     # Non-IE Tests
+    other_user_agents = [
       "Mozilla/5.0 (Windows; U; Windows NT 5.2; zh-CN; rv:1.9.1.5) Gecko/Firefox/3.5.5",
       "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_8; fi-fi) AppleWebKit/531.9 (KHTML, like Gecko) Version/4.0.3 Safari/531.9",
       "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/417.9 (KHTML, like Gecko) Safari/417.8",
       "Opera/9.64 (X11; Linux i686; U; tr) Presto/2.1.1"
     ]
-    user_agents.each do |agent|
+    # Non-IE User Agents
+    other_user_agents.each do |agent|
       context "encounters a user agent like #{agent}" do
         setup do
-          @response = get_response(agent, BODY)
+          @response = request(agent)
         end
         should "return original response" do
           assert_equal BODY, @response.body
@@ -49,91 +37,69 @@ class TestRackDenyIE < Test::Unit::TestCase
       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", { :min_version => 8 })
-      end
-      should "return original response" do
-        assert_equal BODY, @response.body
-      end
-    end
-    # 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 original response" do
-        assert_equal BODY, @response.body
-      end
-    end
-    context "encounters unsupported 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 => 7 })
-      end
-      should "return default IE template" do
-        default_template = read_erb(7)
-        assert_equal default_template, @response.body
-      end
-    end
+    # Internet Explorer Tests
-    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 => 7, :template => CUSTOM_TEMPLATE_PATH })
-      end
-      should "return custom IE template" do
-        default_template = read_erb(7)
-        custom_template = File.read(CUSTOM_TEMPLATE_PATH)
-        assert_not_equal default_template, @response.body
-        assert_equal custom_template, @response.body
-      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
+    ie_user_agents = [
+      [8, "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)"],
+      [7, "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)"],
+      [6, "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)"],
+      [5, "Mozilla/4.0 (compatible; MSIE 5.5; Windows NT 5.1; SV1; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)"],
+      [4, "Mozilla/4.0 PPC (compatible; MSIE 4.01; Windows CE; PPC; 240x320; Sprint:PPC-6700; PPC; 240x320)"],
+    ]
-    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 => 8, :template => CUSTOM_TEMPLATE_PATH })
-      end
-      should "return custom IE template" do
-        default_template = read_erb(8)
-        custom_template = File.read(CUSTOM_TEMPLATE_PATH)
-        assert_not_equal default_template, @response.body
-        assert_equal custom_template, @response.body
-      end
-    end
+    # All IE versions with Default Template
+    (4..8).each do |min_ver|
+      ie_user_agents.each do |ie_agent|
+        context "encounters Internet Explorer #{ie_agent[0]}," do
+          setup do
+            @options = { :min_version => min_ver, :headline => "Why are you using IE?", :site_name => "DenyIE Test" }
+          end
+          if ie_agent[0] >= min_ver
+            context "and the browser version (#{ie_agent[0]}) is greater than the minimum version (#{min_ver}), then it" do
+              setup do
+                @response = request(ie_agent[1], @options)
+              end
+              should "return the original body" do
+                assert_equal BODY, @response.body
+              end
+            end
+          else
+            context "if the browser version is less than or equal to #{min_ver}" do
+              context "and there is no custom template specified, then it" do
+                setup do
+                  @response = request(ie_agent[1], @options)
+                  @options[:template] = Rack::DenyIE::DEFAULT_TEMPLATE_PATH
+                  @default_template = Rack::ProcessERB.new(@options).bound
+                end
+                should "return the default template" do
+                  assert_equal @default_template, @response.body
+                end
+              end
+              context "and there is a custom template specified, then it" do
+                setup do
+                  @options[:template] = CUSTOM_TEMPLATE_PATH
+                  @response = request(ie_agent[1], @options)
+                  @custom_template = File.read(CUSTOM_TEMPLATE_PATH)
+                end
+                should "return the custom template" do
+                  assert_equal @custom_template, @response.body
+                end
+              end
+              context "and a redirection url is specified, then it" do
+                setup do
+                  @options[:redirect_url] = "http://browsehappy.org"
+                  @response = request(ie_agent[1], @options)
+                end
+                should "redirect the user to the new location" do
+                  assert_equal @response.status, 302
+                  assert_equal @response.headers["Location"], "http://browsehappy.org"
+                end
+              end
+            end # Context
+          end # Conditional
+        end # Context
+      end # Array
+    end # Loop
   end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-denyie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brad Whitcomb
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-30 00:00:00 -08:00
+date: 2009-12-03 00:00:00 -08:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency