ops_routes 0.4.4 → 0.5.0

data/README.rdoc

@@ -8,7 +8,7 @@ This library provides a Rails plugin and a piece of Rack middleware for monitori
 
 To include it in a Rails application, install the plugin:
 
-  script/plugin install https://duien@github.com/primedia/ops_routes.git
+  script/plugin install git://github.com/primedia/ops_routes.git
 
 Then add the following minimum configuration to <tt>config/initializers/ops_routes.rb</tt>:
 
@@ -47,6 +47,21 @@ Additionally, you can specify custom heartbeat monitoring pages as follows:
 
 The mysql example shown above would be accessed at <tt>ops/heartbeat/mysql</tt>. The heartbeat page will return a 200 'OK' as long as the provided block does not raise an error. If an error is raised or the heartbeat does not exist, a 500 will be returned instead.
 
+== Configuration Page
+
+The third provided page is <tt>/ops/configuration</tt> which is designed to let you check that the environment-specific configuration variables used by your app are set to the correct values. This is especially useful if production options are set using file replacement or modification during the deploy process.
+
+If you add any sensitive information to this page, make sure to hide it from outside access!
+
+To add a configuration section, specify it as follows:
+
+  ops.add_configuration section :action_controller do
+    { :consider_all_requests_local => Rails.configuration.consider_all_requests_local,
+      :perform_caching => Rails.configuration.perform_caching }
+  end
+
+This example will add a section to the <tt>/ops/configuration</tt> page called `action_controiller'. Each time the configuration page is requested, the block provided for the section will be called. This means the current values for your configuration options will be shown, even if they change while the app is running. The block is expected to return a hash of key/value pairs to be displayed.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.5.0

data/app/controllers/ops_controller.rb

@@ -10,4 +10,8 @@ class OpsController < ApplicationController
     render OpsRoutes.check_heartbeat(params[:name])
   end
 
+  def configuration
+    render :text => OpsRoutes.check_configuration
+  end
+
 end

data/config/routes.rb

@@ -2,4 +2,5 @@ ActionController::Routing::Routes.draw do |map|
   map.connect '/ops/version', :controller => 'ops', :action => 'version'
   map.connect '/ops/heartbeat', :controller => 'ops', :action => 'heartbeat'
   map.connect '/ops/heartbeat/:name', :controller => 'ops', :action => 'heartbeat'
+  map.connect '/ops/configuration', :controller => 'ops', :action => 'configuration'
 end

data/lib/ops_routes/middleware.rb

@@ -8,10 +8,10 @@ module OpsRoutes
     end
 
     def call(env)
-      return @app.call(env) unless env['PATH_INFO'] =~ %r{^/ops/(heartbeat|version)(?:/(\w+))?/?$}
+      return @app.call(env) unless env['PATH_INFO'] =~ %r{^/ops/(heartbeat(?:/(\w+))?|version|configuration)/?$}
       route, heartbeat_name = $1, $2
       case route
-      when 'heartbeat'
+      when /^heartbeat/
         heartbeat_result = OpsRoutes.check_heartbeat(heartbeat_name)
         headers = { 'Content-Type' => 'text/plain',
                     'Content-Length' => heartbeat_result[:text].length.to_s }
@@ -21,6 +21,11 @@ module OpsRoutes
         headers = { 'Content-Type' => 'text/html',
                     'Content-Length' => version_result.length.to_s }
         [ 200, headers, [version_result] ]
+      when 'configuration'
+        configuration_result = OpsRoutes.check_configuration
+        headers = { 'Content-Type' => 'text/html',
+                    'Content-Length' => configuration_result.length.to_s }
+        [ 200, headers, [configuration_result] ]
       end
     end
   end

data/lib/ops_routes.rb

@@ -130,6 +130,39 @@ module OpsRoutes
       "https://github.com/primedia/#{app_name}/commit/#{commit}" unless commit =~ /^Unknown/
     end
     
+    # Configuration page
+    
+    def add_configuration_section(name, &block)
+      @configuration ||= {}
+      @configuration[name] = block
+    end
+
+    def current_config
+      @configuration.inject({}) do |current, (section, block)|
+        current[section] = block.call
+        current
+      end
+    end
+
+    def check_configuration
+      config_template = File.join(File.dirname(__FILE__), 'views', 'config.html.haml')
+      Haml::Engine.new(File.read(config_template)).render(self)
+    end
+
+    def print_detail( object, indent = 0 )
+      output = ""
+      if object.kind_of? Hash
+       output << "{\n"
+       output << object.collect { |key, value|
+         "  " * indent + "  #{print_detail key} => #{print_detail value, indent+1}"
+       }.join(",\n") << "\n"
+       output << "  " * indent + "}"
+      else
+       output << object.inspect
+      end
+      output
+    end
+
   end
   
 end

data/lib/views/config.html.haml

@@ -0,0 +1,21 @@
+!!!
+%html
+  %head
+    %title= app_name
+    :css
+      td {padding: 0 5px; vertical-align: top;}
+      pre {margin: 0}
+      tr.even {background: #dddddd;}
+  %body
+    -# %pre&= @configuration.inspect
+    -# %pre&= current_config.inspect
+    - current_config.each do |section, settings|
+      %h2= section
+      %table
+        - settings.each_with_index do |(setting, value), i|
+          %tr{ :class => i%2==0 ? 'even' : nil }
+            %td= setting
+            %td
+              %pre&= print_detail(value)
+
+

data/spec/ops_routes/middleware_spec.rb

@@ -69,6 +69,20 @@ describe OpsRoutes::Middleware do
 
     end
 
+    context "configuration" do
+      it 'should call check_configuration' do
+        OpsRoutes.should_receive(:check_configuration).and_return('The configuration page')
+        get '/ops/configuration'
+      end
+
+      it 'should call the configuration block' do
+        config_block = lambda{}
+        OpsRoutes.add_configuration_section(:test, &config_block)
+        config_block.should_receive(:call).and_return( :key => 'value' )
+        get '/ops/configuration'
+      end
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'app', 'controllers'))
+require 'rubygems'
 require 'ops_routes'
 require 'ops_routes/middleware'
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 4
-  version: 0.4.4
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Primedia Team
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 -04:00
+date: 2010-09-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,6 +104,7 @@ files:
 - lib/ops_routes.rb
 - lib/ops_routes/middleware.rb
 - lib/tasks/ops_routes.rake
+- lib/views/config.html.haml
 - lib/views/version.html.haml
 - spec/app/controllers/ops_controller_spec.rb
 - spec/ops_routes/middleware_spec.rb