rack_upstream_identification 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rob Ares
+
+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,50 @@
+= rack_upstream_identification
+
+acts_as_filterable is an ActiveRecord plugin that was hacked together (originally a monkey patch) to avoid repeating the same text filtering logic that was re-implemented all over the place in a legacy domain model. 
+
+== Current filters in place:
+
+* filter_for_digits: leaves only numeric values
+* filter_for_uppercase: uppercase all alpha characters
+* filter_for_lowercase: lowercase all alpha characters
+* filter_for_whitespace: strips and non-essential whitespace out of a string (leaving only single whitespace characters).
+
+Features I'd like to add in the future:
+* User-defined custom filters configured via DSL.
+* Additional macros that filter decimal values, etc.
+* Allow the developer to opt-in models for filtering and not include 
+  the plugin in ActiveRecord::Base
+
+= Runtime Dependencies
+
+* Rack 1.0.0+
+* Tested against Ruby 1.8.6, 1.8.7, 1.9.1
+
+= Install
+ 
+== Rails
+
+  config.gem "acts_as_filterable", :source => "http://gemcutter.org"
+
+== Bundler
+
+  source "http://gemcutter.org"
+  gem "acts_as_filterable", "0.2.0"
+
+== RubyGems
+
+  gem install acts_as_filterable --source http://gemcutter.org
+
+= Usage
+ 
+  class MyModel < ActiveRecord::Base
+    filter_for_digits :phone_number, :fax_number
+  end
+
+= Contributing
+
+If something is broken or you need a feature; you know the deal. Don't be part of the problem. Patches or pull requests are welcome.
+
+== Copyright
+
+Copyright (c) 2009 Rob Ares. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack_upstream_identification"
+    gem.summary = %Q{Middleware that injects upstream server info into the response}
+    gem.description = %Q{Middleware that injects upstream server info into the response}
+    gem.email = "rob.ares@gmail.com"
+    gem.homepage = "http://github.com/rares/rack_upstream_identification"
+    gem.authors = ["Rob Ares"]
+    gem.add_runtime_dependency "rack", ">= 1.0"
+    gem.add_development_dependency "shoulda", ">= 2.10.2"
+    gem.add_development_dependency "rack-test", ">= 0.5.2"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.options = "-v"
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false 
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack_upstream_identification #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rack/upstream_identification.rb

@@ -0,0 +1,56 @@
+require "socket"
+
+module Rack
+
+  # A middleware for injecting upstream host info into a response header.
+  class UpstreamIdentification
+
+    attr_reader :transform, :header_name
+
+    # Creates the middleware with the following configuration options:
+    #
+    # [\+header+] The name of the header that is sent to the client.
+    #             Defaults to "X-Upstream-Identification"
+    #
+    # [\+blk+]    The optional block used to transform a header. If
+    #             a block is passed, the following applies:
+    #               * The machine's hostname is passed to the block.
+    #                 This gives the block the opportunity to change
+    #                 how the hostname is rendered (obfuscate, mangle,
+    #                 whatever).
+    #               * The block should return a string value that will
+    #                 be set as the configured header value.
+    #
+    #             If no block is passed during configuration, just send
+    #             the hostname as a default.
+    #
+    def initialize(app, header = "X-Upstream-Identification", &blk)
+      @app = app
+      @header_name = header
+      @transform = blk if block_given?
+    end
+
+    def call(env)
+      push_header @app.call(env)
+    end
+
+    private
+
+    # Push the configured header down to the client
+    def push_header(response)
+      response[1][header_name] = if transform
+        transform.call(host_name).to_s
+      else
+        host_name
+      end
+      response
+    end
+
+    # Get the hostname for the current machine
+    def host_name
+      @host_name ||= Socket.gethostname
+    end
+
+  end
+
+end

data/rack_upstream_identification.gemspec

@@ -0,0 +1,60 @@
+# 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_upstream_identification}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob Ares"]
+  s.date = %q{2009-11-21}
+  s.description = %q{Middleware that injects upstream server info into the response}
+  s.email = %q{rob.ares@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack/upstream_identification.rb",
+     "rack_upstream_identification.gemspec",
+     "test/helper.rb",
+     "test/test_rack_upstream_identification.rb"
+  ]
+  s.homepage = %q{http://github.com/rares/rack_upstream_identification}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Middleware that injects upstream server info into the response}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_rack_upstream_identification.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"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<rack>, [">= 1.0"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 1.0"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.2"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require "test/unit"
+require "shoulda"
+
+require "rack/test"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "rack/upstream_identification"
+
+class Test::Unit::TestCase
+end

data/test/test_rack_upstream_identification.rb

@@ -0,0 +1,115 @@
+require "helper"
+require "socket"
+require "zlib"
+
+class TestRackUpstreamIdentification < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    handler = lambda { |env| [200, {"Content-Type" => "text/plain"}, ["OK"]] }
+    Rack::Builder.new do
+      map "/default" do
+        use Rack::UpstreamIdentification
+        run handler
+      end
+    
+      map "/override_host" do 
+        use Rack::UpstreamIdentification, "server_header"  
+        run handler
+      end
+
+      map "/transform_block" do
+        use Rack::UpstreamIdentification do |host|
+          host.upcase
+        end
+        run handler
+      end
+
+      map "/both_options" do
+        use Rack::UpstreamIdentification, "crypted_header" do |host|
+          Zlib.crc32(host)
+        end
+        run handler
+      end
+    end.to_app
+  end
+
+  def assert_header_present(header)
+    assert last_response.headers.include? header 
+  end
+
+  def assert_header_value(header, value)
+    assert_equal value, last_response.headers[header]
+  end
+
+  context "using the upstream identification handler" do
+
+    should "allow requests to flow through without issue" do
+      get "/default"
+      assert last_response.ok?
+    end
+
+    context "with the default configuration" do
+      setup do
+        get "/default"
+      end
+
+      should "push the header down using the default name" do
+        assert_header_present "X-Upstream-Identification"
+      end
+
+      should "push the header down using the machine's hostname" do
+        assert_header_value "X-Upstream-Identification", Socket.gethostname
+      end
+
+    end
+
+    context "with an overriding the header name" do
+      setup do
+        get "/override_host"
+      end
+
+      should "push the header down with the overriden name" do
+        assert_header_present "server_header"  
+      end
+
+      should "push the header down using the machine's hostname" do
+        assert_header_value "server_header", Socket.gethostname
+      end
+
+    end
+
+    context "with a block to provide custom processing" do
+      setup do
+        get "/transform_block"
+      end
+
+      should "push the header down with the default header name" do
+        assert_header_present "X-Upstream-Identification"  
+      end
+
+      should "push the header down using the transformed value" do
+        assert_header_value "X-Upstream-Identification", `hostname`.chomp.upcase
+      end
+   
+    end
+
+    context "with the headername and transform block passed" do
+      setup do
+        get "/both_options"
+      end
+      
+      should "push the header down with the overridden header name" do
+        assert_header_present "crypted_header"
+      end
+
+      should "push the header down using the crypted header value" do
+        assert_header_value "crypted_header", Zlib.crc32(Socket.gethostname).to_s
+      end
+
+
+    end
+  
+  end
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: rack_upstream_identification
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob Ares
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+description: Middleware that injects upstream server info into the response
+email: rob.ares@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/upstream_identification.rb
+- rack_upstream_identification.gemspec
+- test/helper.rb
+- test/test_rack_upstream_identification.rb
+has_rdoc: true
+homepage: http://github.com/rares/rack_upstream_identification
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Middleware that injects upstream server info into the response
+test_files: 
+- test/helper.rb
+- test/test_rack_upstream_identification.rb