rack_upstream_identification 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,20 +1,11 @@
 = 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
+Upstream Identification is a Rack middleware that is useful in debugging requests in mult-server environments.
+It is often difficult to debug client-side (or server-side ones) that might be occuring on only a handful of machines.
+This was created to provide originating server indentity that is easily accessable in the browser (or command-line tools like curl).
 
+Read below for usage.
+  
 = Runtime Dependencies
 
 * Rack 1.0.0+
@@ -24,22 +15,44 @@ Features I'd like to add in the future:
  
 == Rails
 
-  config.gem "acts_as_filterable", :source => "http://gemcutter.org"
+  config.gem "rack_upstream_identification", :lib => "rack/upstream_identification", :version => "0.0.1", :source => "http://gemcutter.org"
+
+OR
+
+  script/plugin install git://github.com/rares/rack_upstream_identification.git
 
 == Bundler
 
   source "http://gemcutter.org"
-  gem "acts_as_filterable", "0.2.0"
+  gem "rack_upstream_identification", "0.0.1"
 
 == RubyGems
 
-  gem install acts_as_filterable --source http://gemcutter.org
+  gem install rack_upstream_identification --source http://gemcutter.org
 
 = Usage
- 
-  class MyModel < ActiveRecord::Base
-    filter_for_digits :phone_number, :fax_number
-  end
+
+By default this middleware injects a header called "X-Upsteam-Identification" that defaults to using the machine's hostname (given a hostname 'foo'):
+
+  use Rack::UpstreamIdentification
+
+yields the header: "X-Upstream-Identification: foo"
+
+There are a few available options that allow for mutation of the default output:
+
+* header - The following configuration will change the <b>name</b> of the header:
+
+    use Rack::UpstreamIdentification, "your_header_name"
+
+* blk - Passing a block yields the machine's hostname and should return a string that will be sent to the client as the value:
+
+    use Rack::UpstreamIdentification do |hostname|
+      Zlib.crc32(hostname).to_s
+    end
+
+If you plan on obfuscating this value (as above) there is no facility to track mappings from checksums to servernames so this will have to be managed in your code.
+
+Depending on what stack you are using, these statements will live in various places. Please consult documentation for the proper location.
 
 = Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rack/upstream_identification.rb

@@ -5,14 +5,14 @@ module Rack
   # A middleware for injecting upstream host info into a response header.
   class UpstreamIdentification
 
-    attr_reader :transform, :header_name
+    attr_reader :app, :transform, :header_name
 
     # Creates the middleware with the following configuration options:
     #
-    # [\+header+] The name of the header that is sent to the client.
+    # [+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
+    # [+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
@@ -31,19 +31,34 @@ module Rack
     end
 
     def call(env)
-      push_header @app.call(env)
+      status, headers, response = app.call(env)
+      inject_identity! headers 
+    
+      [status, headers, response]
     end
 
-    private
+    protected
 
     # Push the configured header down to the client
-    def push_header(response)
-      response[1][header_name] = if transform
-        transform.call(host_name).to_s
+    def inject_identity!(headers)
+      headers[header_name] = if transform
+        invoke_transform host_name, &transform             
       else
         host_name
       end
-      response
+      
+      nil
+    end
+
+    # Invoke the transform block.
+    # If the block does not return a non-nil value, raise and exception
+    def invoke_transform(host_name, &transform)
+      header_value = transform.call(host_name)
+      unless header_value
+        raise ArgumentError, "transform block must return a non-nil value"
+      end
+
+      header_value.to_s      
     end
 
     # Get the hostname for the current machine

data/test/test_rack_upstream_identification.rb

@@ -31,6 +31,13 @@ class TestRackUpstreamIdentification < Test::Unit::TestCase
         end
         run handler
       end
+      
+      map "/empty_block" do
+        use Rack::UpstreamIdentification do |host|
+        end
+        run handler
+      end
+
     end.to_app
   end
 
@@ -89,7 +96,7 @@ class TestRackUpstreamIdentification < Test::Unit::TestCase
       end
 
       should "push the header down using the transformed value" do
-        assert_header_value "X-Upstream-Identification", `hostname`.chomp.upcase
+        assert_header_value "X-Upstream-Identification", Socket.gethostname.upcase 
       end
    
     end
@@ -103,13 +110,21 @@ class TestRackUpstreamIdentification < Test::Unit::TestCase
         assert_header_present "crypted_header"
       end
 
-      should "push the header down using the crypted header value" do
+      should "push the header down using the mutated header value" do
         assert_header_value "crypted_header", Zlib.crc32(Socket.gethostname).to_s
       end
 
+    end
+ 
+    context "with an empty transform block" do
+      should "raise an ArgumentError indicating that the transform block should return a non-nil value" do
+        assert_raise ArgumentError do
+          get "/empty_block"
+        end
+      end
 
     end
-  
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack_upstream_identification
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rob Ares
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -05:00
+date: 2009-11-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency