rack-environmental 1.0.0

data/CHANGELOG

@@ -0,0 +1,10 @@
+1.0.0 (November 17, 2009)
+* BUGFIX: The body was being returned as a string, which is not in accordance with the Rack spec.
+* BUGFIX: The update content length algorithm was incorrect.
+* BUGFIX: The first HTML response body kept rewriting subsequent requests.
+* FEATURE: If the response is a Rails ActionController::Response object, we make sure we pass
+  it along.
+* API CHANGE: Renamed the gem from environmental to rack-environmental.
+
+0.0.1 (November 14, 2009)
+* Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Wyatt M. Greene
+
+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

@@ -0,0 +1,44 @@
+= Rack::Environmental
+
+== Description
+
+Never again will you accidentally delete production data!  Rack::Environmental adds
+an indicator badge to your web application so that you can tell whether you're
+working with the staging, test, development or production version of your web app.
+
+== Usage
+
+This Rack middleware can be used with any Rack application, but here's how you would
+use it in Rails.  Put the following in config/environment.rb:
+
+  config.middleware.use Rack::Environmental,
+                          :staging =>     { :url => /^staging.+$/   },
+                          :test =>        { :url => /^test.+$/      },
+                          :development => { :url => /^localhost.+$/ }
+
+When a request comes to your web app, Rack::Environmental compares the URL to the supplied
+regular expressions.  If the URL matches, the name of the environment is displayed at the
+top of the web page.
+
+Each environment can be further configured:
+
+  config.middleware.use Rack::Environmental,
+                          :staging =>     { :url => /^staging.+$/,
+                                            :color => "yellow",
+                                            :size => :large          },
+                          :test =>        { :url => /^test.+$/,
+                                            :color => "purple",
+                                            :style => :badge         },
+                          :development => { :url => /^localhost.+$/,
+                                            :color => "orange"       }
+
+Here's the full list of configuration options:
+
+  :url      => a regular expression
+  :style    => either :badge (a transparent, floating badge) or :banner (default)
+  :color    => a string that represents a CSS color, such as "red", "rgb(6,70,14)", or "#8e6630"
+  :size     => :small, :medium, or :large; defaults to :medium
+  :opacity  => a number from 0 (completely transparent) to 1; only works with the badge style
+  :top      => distance in pixels from the top; only works with the badge style
+  :left     => distance in pixels from the left; only works with the badge style
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rubygems'
+ 
+gem_spec = Gem::Specification.new do |s|
+  s.name          = "rack-environmental"
+  s.version       = "1.0.0"
+  s.add_dependency 'nokogiri', '>= 1.4.0'
+  s.author        = "Wyatt Greene"
+  s.email         = "techiferous@gmail.com"
+  s.summary       = "Rack middleware that adds an indicator of your application environment"
+  s.description   = %Q{
+    Rack::Environmental indicates which environment your web application is running
+    in (staging, test, etc.).
+  }
+  s.require_path  = "lib"
+  s.files         = ["lib/environmental.rb", "LICENSE", "Rakefile", "README",
+                     "CHANGELOG"]
+  s.homepage      = "http://github.com/techiferous/rack-environmental"
+  s.requirements  << "none"
+  s.has_rdoc      = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg| 
+end

data/lib/environmental.rb

@@ -0,0 +1,113 @@
+require 'nokogiri'
+ 
+module Rack
+  class Environmental
+ 
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+    end
+    
+    def call(env)
+      @doc = nil # clear out the doc object so we don't accidentally keep the last
+                 # request's HTML around
+      @request = Rack::Request.new(env)
+      status, @headers, @body = @app.call(env)
+      if html?
+        add_to_top_of_web_page(create_sticker)
+        update_content_length
+      end
+      [status, @headers, @body]
+    end
+    
+    private
+ 
+    def html?
+      @headers["Content-Type"] && @headers["Content-Type"].include?("text/html")
+    end
+
+    def add_to_top_of_web_page(node)
+      if node
+        doc.at_css("body").children.first.add_previous_sibling(node)
+      end
+      new_body_string = doc.to_html
+      # If we're dealing with a Rails response, we don't want to throw the
+      # response object away, we just want to update the response string.
+      if @body.class.name == "ActionController::Response"
+        @body.body = new_body_string
+      else
+        @body = [new_body_string]
+      end
+    end
+ 
+    def create_sticker
+      environment_name = environment(@request.url)
+      return nil if environment_name.nil?
+      div = Nokogiri::XML::Node.new("div", doc)
+      div['style'] = style(@options[environment_name])
+      div.content = environment_name.to_s
+      div
+    end
+    
+    def environment(url)
+      url = url.split('//').last # remove http://
+      @options.each do |environment_name, options|
+        if options[:url] && options[:url] =~ url
+          return environment_name
+        end
+      end
+      return nil
+    end
+ 
+    def doc
+      @doc ||= Nokogiri::HTML(body_to_string)
+    end
+  
+    def body_to_string
+      s = ""
+      @body.each { |x| s << x }
+      s
+    end
+    
+    def style(options)
+      style = ""
+      style << "font-family: Verdana, Arial, sans-serif;"
+      style << "font-weight: bold;"
+      style << "text-transform: uppercase;"
+      style << "text-align: center;"
+      style << "color: black;"
+      style << "padding: 3px;"
+      style << "background-color: #{options[:color] || "blue"};"
+      case options[:size]
+      when :large
+        style << "font-size: 20px;"
+      when :medium
+        style << "font-size: 14px;"
+      when :small
+        style << "font-size: 10px;"
+      else
+        style << "font-size: 14px;"
+      end
+      if options[:style] == :badge
+        style << "margin: 5px;"
+        style << "position: fixed;"
+        style << "top: #{options[:top] || 5}px;"
+        style << "left: #{options[:left] || 5}px;"
+        style << "opacity: #{options[:opacity] || 0.7};"
+        style << "-moz-border-radius: 5px; -khtml-border-radius: 5px; -webkit-border-radius: 5px; border-radius: 5px;"
+      else
+        style << "margin: 0px;"
+      end
+    end
+ 
+    def update_content_length
+      length = 0
+      @body.each do |s|   # we can't use inject because @body may not respond to it
+        length += Rack::Utils.bytesize(s)   # we use Rack::Utils.bytesize to avoid
+                                            # incompatibilities between Ruby 1.8 and 1.9
+      end
+      @headers['Content-Length'] = length.to_s
+    end
+ 
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: rack-environmental
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Wyatt Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "\n    Rack::Environmental indicates which environment your web application is running\n    in (staging, test, etc.).\n  "
+email: techiferous@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/environmental.rb
+- LICENSE
+- Rakefile
+- README
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/techiferous/rack-environmental
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that adds an indicator of your application environment
+test_files: []
+