about_page 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    about_page (0.1.0)
+    about_page (0.1.1)
       rails (~> 3.2)
 
 GEM

data/README.md

@@ -7,15 +7,26 @@ To use in a Hydra app:
 
     # In config/initializers/about_page.rb
     AboutPage.configure do |config|
-      config.app_name    = MyApplication.name                       # Application Name
-      config.app_version = MyApplication::VERSION                   # Application Version
-      config.fedora      = AboutPage::Fedora.new(ActiveFedora::Base.connection_for_pid(0)) # Rubydora::Repository instance
-      config.solr        = AboutPage::Solr.new(ActiveFedora.solr)                        # RSolr instance
+      config.app           = { :name => MyApplication.name, :version => MyApplication::VERSION }
+      config.environment   = AboutPage::Environment.new({ 
+        'Ruby' => /^(RUBY|GEM_|rvm)/    # This defines a "Ruby" subsection containing
+                                        # environment variables whose names match the RegExp
+      })
+      config.request       = AboutPage::RequestEnvironment.new({
+        'HTTP Server' => /^(SERVER_|POW_)/  # This defines an "HTTP Server" subsection containing
+                                            # request variables whose names match the RegExp
+      })
+      config.dependencies  = AboutPage::Dependencies.new
+      config.fedora        = AboutPage::Fedora.new(ActiveFedora::Base.connection_for_pid(0))  # Rubydora::Repository instance
+      config.solr          = AboutPage::Solr.new(ActiveFedora.solr)                           # RSolr instance
     end
     
     # In config/routes.rb
     mount AboutPage::Engine => '/about(.:format)' # Or whever you want to access the about page
-	
+
+    # In app/assets/stylesheets/application.scss
+    @import "about_page"
+    
 ## Known Issues
 
 * Solr must have LukeHandler enabled on /luke

data/app/controllers/about_page/about_controller.rb

@@ -1,20 +1,39 @@
 module AboutPage
   class AboutController < ApplicationController
+    before_filter :load_and_filter_configuration
     before_filter :only => :index do
       AboutPage.configuration.preflight(request)
     end
 
-    def index
+    def load_and_filter_configuration
       @configuration = AboutPage.configuration
 
       @configuration = @configuration.select { |key, value| (params[:filter].split(/[\W\+]/) + ["app"]).include? key.to_s } if params[:filter]
       @configuration.set_headers!(response)
+    end
 
+    def index
       respond_to do |format|
         format.html { render :status => @configuration.valid? ? 200 : 417 } # about_page.html.erb
         format.json { render :json => @configuration.to_json }
         format.xml  { render :xml  => @configuration.to_xml }
       end
     end
+
+    def health
+      @states = @configuration.map do |key,profile| 
+        if profile.class.respond_to?(:validators) and profile.class.validators.length > 0 
+          health = profile.valid? ? 'ok' : 'error'
+          { 'component' => key.to_s, 'status' => health, 'errors' => profile.errors.to_a }
+        else
+          nil
+        end
+      end.compact
+      respond_to do |format|
+        format.html { render }
+        format.json { render :json => @states }
+        format.xml  { render :xml  => @states }
+      end
+    end
   end
 end

data/app/views/about_page/about/_dependencies.html.erb

@@ -1,4 +1,5 @@
-<h1>Dependencies</h1>
+<h2>Dependencies</h2>
+<h4 style="font-weight: normal">Explicit dependencies are in <span class="dependency required">bold</span>.</h4>
 <div class="dependencies">
   <ul>
     <% profile.spec_list.each do |dep,version,groups| %>

data/app/views/about_page/about/_environment.html.erb

@@ -1,4 +1,4 @@
-<h1><%= key.to_s.humanize %></h1>
+<h2><%= key.to_s.humanize %></h2>
 <% profile.each_pair do |section,env| %>
   <h3><%= section %></h3>
   <div class="environment">

data/app/views/about_page/about/_exception.html.erb

@@ -1,2 +1,2 @@
-<h1><%= key %></h1>
+<h2><%= key %></h2>
 <%= exception %>

data/app/views/about_page/about/_generic_hash.html.erb

@@ -1,4 +1,4 @@
-<h1><%= key.to_s.humanize %></h1>
+<h2><%= key.to_s.humanize %></h2>
   <% profile.messages.each do |msg| %>
     <div><%= msg %></div>
   <% end if profile.respond_to? :messages %>

data/app/views/about_page/about/health.html.erb

@@ -0,0 +1,19 @@
+<div class="about_page">
+<h3>Service Health</h3>
+  <ul>
+    <% @states.each do |component| %>
+    <li class="component">
+      <b><%=component['component']%></b>
+      <span class="label label-<%=component['status'] == 'error' ? 'important' : 'success'%>"><%=component['status']%></span>
+      <% if component['errors'].length > 0 %>
+        <ul>
+        <li>
+        <%= component['errors'].to_a.join('</li><li>').html_safe %>
+        </li>
+        </ul>
+      <% end %>
+    </li>
+    <% end %>
+  </ul>
+</div>
+

data/config/routes.rb

@@ -1,4 +1,5 @@
 AboutPage::Engine.routes.draw do
+  match 'health' => 'about_page/about#health'
   match ":filter" => 'about_page/about#index'
   root :to => 'about_page/about#index'
 end

data/lib/about_page/fedora.rb

@@ -4,7 +4,7 @@ module AboutPage
 
     validates_each :profile do |record, attr, value| 
       unless value.present?
-        record.errors.add attr, ": unable to connect to Fedora: #{record.rubydora.inspect}"
+        record.errors.add attr, ": unable to connect to Fedora at #{record.rubydora.config[:url]}"
       end
     end
 

data/lib/about_page/solr.rb

@@ -4,9 +4,9 @@ module AboutPage
     
     attr_accessor :rsolr, :options
 
-    validates_each :schema do |record, attr, value| 
-      unless value.present?
-        record.errors.add attr, ": unable to connect to Solr: #{record.rsolr.inspect}"
+    validates_each :ping do |record, attr, value|
+      unless value == 'OK'
+        record.errors.add attr, ": unable to ping Solr at #{record.rsolr.uri.to_s}"
       end
     end
     validates :numDocs, :numericality => { :greater_than_or_equal_to => Proc.new { |c| c.expects(:numDocs) } }
@@ -28,6 +28,12 @@ module AboutPage
       @request_expectations = {}
     end
 
+    def ping
+      rsolr.get('admin/ping')['status']
+    rescue
+      nil
+    end
+
     def schema
       @schema ||= rsolr.get self.options[:luke], :params => { :show => 'schema', :numTerms => 0 }
     rescue

data/lib/about_page/version.rb

@@ -1,3 +1,3 @@
 module AboutPage
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/lib/solr_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe AboutPage::Solr do
   before :each do
     @mock_solr_connection = double('RSolr::Connection')
+    @mock_solr_connection.stub(:uri, URI.parse("http://example.edu/solr"))
   end
 
   subject { AboutPage::Solr.new(@mock_solr_connection) }
@@ -29,18 +30,28 @@ describe AboutPage::Solr do
 
   describe "#valid?" do
     it "should be ok if the number of documents in the index is greater than or equal to the :minimum_numdocs" do
+      subject.stub(:ping).and_return { 'OK' } 
       subject.stub(:schema).and_return { { 'index' => { :numDocs => 1 } } } 
       subject.stub(:expects).and_return 1
       subject.should be_valid
     end
 
     it "should be not be ok if the number of documents in the index is less than the :minimum_numdocs" do
+      subject.stub(:ping).and_return { 'OK' } 
       subject.stub(:schema).and_return { { 'index' => { :numDocs => 1 } } }
       subject.stub(:expects).and_return 5
       subject.should_not be_valid
     end
 
     it "should not be ok if the index :numDocs param is not set" do
+      subject.stub(:ping).and_return { 'OK' } 
+      subject.stub(:schema).and_return { { 'index' => { } } } 
+      subject.stub(:expects).and_return 1
+      subject.should_not be_valid
+    end
+
+    it "should not be ok if the server doesn't respond to ping" do
+      subject.stub(:ping).and_return nil
       subject.stub(:schema).and_return { { 'index' => { } } } 
       subject.stub(:expects).and_return 1
       subject.should_not be_valid
@@ -49,6 +60,7 @@ describe AboutPage::Solr do
 
   describe "#set_headers!" do
     it "should add helpful headers when something is wrong" do
+      subject.stub(:ping).and_return { 'OK' } 
       subject.stub(:schema).and_return { { 'index' => { :numDocs => 1 } } } 
       subject.stub(:expects).and_return 5
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: about_page
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,7 @@ files:
 - app/views/about_page/about/_environment.html.erb
 - app/views/about_page/about/_exception.html.erb
 - app/views/about_page/about/_generic_hash.html.erb
+- app/views/about_page/about/health.html.erb
 - app/views/about_page/about/index.html.erb
 - config/routes.rb
 - lib/about_page.rb
@@ -186,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2674301641569901463
+      hash: 1267964176528258893
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2674301641569901463
+      hash: 1267964176528258893
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23