about_page 0.1.1 → 0.2.0

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 .bundle/
 log/*.log
 pkg/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -15,4 +15,13 @@ gem "jquery-rails"
 
 # To use debugger
 # gem 'ruby-debug'
-gem 'sqlite3'
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+end
+
+platforms :ruby do
+ gem 'sqlite3'
+end
+
+gem 'rake'

data/Rakefile

@@ -6,3 +6,9 @@ rescue LoadError
 end
 
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/about_page/about_controller.rb

@@ -15,24 +15,19 @@ module AboutPage
     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 }
+        format.json { render :json   => @configuration.to_json }
+        format.xml  { render :xml    => @configuration.to_xml  }
+        format.yaml { render :text   => @configuration.to_yaml, :content_type => 'text/yaml' }
       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
+      @states = @configuration.health_report
       respond_to do |format|
         format.html { render }
         format.json { render :json => @states }
         format.xml  { render :xml  => @states }
+        format.yaml { render :text => @states.to_yaml, :content_type => 'text/yaml' }
       end
     end
   end

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

@@ -7,9 +7,9 @@
       <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>
+          <li class="component-error">
+            <%= component['errors'].to_a.join('</li><li class="component-error">').html_safe %>
+          </li>
         </ul>
       <% end %>
     </li>

data/lib/about_page/configuration.rb

@@ -27,7 +27,7 @@ module AboutPage
 
   class Configuration
     attr_accessor :hash
-    delegate :to_xml, :to_h, :to_json, :to => :hash
+    delegate :to_xml, :to_json, :to_yaml, :to => :to_h
     delegate :each, :map, :to => :to_h
 
     def initialize hash = nil
@@ -55,15 +55,31 @@ module AboutPage
     end
 
     def nodes
-      self.to_h.select { |key, profile| profile.is_a? AboutPage::Configuration::Node }
+      self.hash.to_h.select { |key, profile| profile.is_a? AboutPage::Configuration::Node }
     end
 
     def set_headers! response
       self.nodes.each { |key, profile| profile.set_headers! response }
     end
 
+    def to_h
+      self.hash.to_h.inject({}) { |h,v| h[v[0]] = v[1].respond_to?(:to_h) ? v[1].to_h : v[1]; h }
+    end
+
+    def health_report
+      self.nodes.collect do |key, profile| 
+        if 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
+    end
+
     class Node
       include ActiveModel::Validations
+      delegate :each_pair, :to_xml, :to_json, :to_yaml, :to => :to_h
 
       class << self
         attr_reader :partial
@@ -86,6 +102,10 @@ module AboutPage
         errors.to_a.uniq
       end
 
+      def to_h
+        nil
+      end
+
       def set_headers! response
         messages.each { |m| add_header(response, m) }
       end

data/lib/about_page/dependencies.rb

@@ -1,6 +1,5 @@
 module AboutPage
   class Dependencies < AboutPage::Configuration::Node
-    delegate :each_pair, :to_xml, :to_json, :to => :to_h
     attr_reader :max_depth
 
     def initialize(max_depth=100)

data/lib/about_page/environment.rb

@@ -1,17 +1,20 @@
 module AboutPage
   class Environment < AboutPage::Configuration::Node
     attr_accessor :sections
-    delegate :each_pair, :to_json, :to_xml, :to => :to_h
 
     def initialize(sections = {})
       self.sections = sections
     end
 
+    def env
+      ENV
+    end
+
     def to_h
       @request_env ||= begin
          h = Hash.new { |h,k| h[k] = {} }
 
-         environment.each_pair do |key,value|
+         env.each_pair do |key,value|
            section = section_for(key,value)
            unless section.nil?
              h[section][key] = value if value.is_a? String
@@ -30,9 +33,5 @@ module AboutPage
         end
       end
     end
-
-    def environment
-      ENV
-    end
   end
 end

data/lib/about_page/fedora.rb

@@ -1,6 +1,5 @@
 module AboutPage
   class Fedora < AboutPage::Configuration::Node
-    delegate :each_pair, :to_json, :to_xml, :to => :to_h
 
     validates_each :profile do |record, attr, value| 
       unless value.present?

data/lib/about_page/solr.rb

@@ -1,6 +1,5 @@
 module AboutPage
   class Solr  < AboutPage::Configuration::Node
-    delegate :each_pair, :to_json, :to_xml, :to => :to_h
     
     attr_accessor :rsolr, :options
 

data/lib/about_page/version.rb

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

data/lib/tasks/about_page_tasks.rake

@@ -1,4 +1,19 @@
-# desc "Explaining what the task does"
-# task :about_page do
-#   # Task goes here
-# end
+namespace :about do
+  desc "Get a full report in XML or JSON format"
+  task :report, [:format, :section] => [:environment] do |t,args|
+    args.with_defaults(:format => 'yaml')
+    configuration = AboutPage.configuration
+    configuration = configuration.select { |key, value| (args.section.split(/[\W\+]/) + ["app"]).include? key.to_s } if args.section
+    response_method = "to_#{args.format.downcase}".to_sym
+    puts configuration.send(response_method)
+  end
+
+  desc "Get a health report in XML or JSON format"
+  task :health, [:format, :section] => [:environment] do |t,args|
+    args.with_defaults(:format => 'yaml')
+    configuration = AboutPage.configuration
+    configuration = configuration.select { |key, value| (args.section.split(/[\W\+]/) + ["app"]).include? key.to_s } if args.section
+    response_method = "to_#{args.format.downcase}".to_sym
+    puts configuration.health_report.send(response_method)
+  end
+end

data/spec/{integration → features}/about_page_spec.rb

@@ -4,20 +4,20 @@ describe "the about page", :type => :request do
   before :all do
     AboutPage.reset!
 
-AboutPage.configure do |config|
-  config.app = { :name => 'Application Name', :version => '0.0.0' }
+    AboutPage.configure do |config|
+      config.app = { :name => 'Application Name', :version => '0.0.0' }
 
-  config.dependencies = AboutPage::Dependencies.new
+      config.dependencies = AboutPage::Dependencies.new
 
-  config.environment = AboutPage::Environment.new({ 
-    'Ruby' => /^(RUBY|GEM_|rvm)/
-  })
+      config.environment = AboutPage::Environment.new({ 
+        'Ruby' => /^(RUBY|GEM_|rvm)/
+      })
 
-  config.request = AboutPage::RequestEnvironment.new({
-    'HTTP Server' => /^(SERVER_|POW_)/,
-    'WebAuth' => /^WEBAUTH_/
-  })
-end
+      config.request = AboutPage::RequestEnvironment.new({
+        'HTTP Server' => /^(SERVER_|POW_)/,
+        'WebAuth' => /^WEBAUTH_/
+      })
+    end
   end
   describe "dependency versions" do
     before do
@@ -45,6 +45,7 @@ end
     end
     
     it "should" do
+      page.response_headers['Content-Type'].should =~ /xml/
       page.body.should_not be_empty
     end
   end
@@ -55,6 +56,18 @@ end
     end
     
     it "should" do
+      page.response_headers['Content-Type'].should =~ /json/
+      page.body.should_not be_empty
+    end
+  end
+
+  describe "yaml" do
+    before do
+      visit("/about.yaml")
+    end
+
+    it "should" do
+      page.response_headers['Content-Type'].should =~ /yaml/
       page.body.should_not be_empty
     end
   end

data/spec/features/health_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe "the health page", :type => :request do
+  before :all do
+    module AboutPage
+      class HealthTest < AboutPage::Configuration::Node
+        attr_reader :healthy
+        validates_each :healthy do |r,a,v|
+          r.errors.add a, ": should be healthy" unless v
+        end
+        def initialize(state)
+          @healthy = state
+        end
+      end
+    end
+  end
+
+  after :all do
+    AboutPage.send(:remove_const, :HealthTest)
+  end
+
+  describe "report" do
+    before do
+      AboutPage.reset!
+      AboutPage.configure do |config|
+        config.yup  = AboutPage::HealthTest.new(true)
+        config.nope = AboutPage::HealthTest.new(false)
+      end
+    end
+
+    describe "html" do
+      before do
+        visit('/about/health')
+      end
+
+      describe "healthy" do
+        before do
+          @context = page.find('li[class=component][1]')
+        end
+
+        it "should report the service name" do
+          @context.should have_content('yup')
+        end
+
+        it "should contain an ok status" do
+          @context.should have_xpath('span[@class="label label-success"][text() = "ok"]')
+        end
+
+        it "should not contain an error list" do
+          @context.should_not have_xpath('ul/li[@class="component-error"]')
+        end
+      end
+
+      describe "unhealthy" do
+        before do
+          @context = page.find('li[class=component][2]')
+        end
+
+        it "should report the service name" do
+          @context.should have_content('nope')
+        end
+
+        it "should contain an error status" do
+          @context.should have_xpath('span[@class="label label-important"][text() = "error"]')
+        end
+
+        it "should contain an error list" do
+          @context.should have_xpath('ul/li[@class="component-error"]')
+          @context.should have_content('Healthy : should be healthy')
+        end
+      end
+    end
+  end
+end

data/spec/lib/solr_spec.rb

@@ -2,8 +2,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"))
+    @mock_solr_connection = double('RSolr::Connection', :uri => URI.parse("http://example.edu/solr"))
   end
 
   subject { AboutPage::Solr.new(@mock_solr_connection) }
@@ -21,7 +20,7 @@ describe AboutPage::Solr do
 
   describe "#index" do
     it "should get the index information from the schema" do
-      m = mock()
+      m = double()
       subject.stub(:schema).and_return { { 'index' => m }}
 
       subject.index.should == m
@@ -65,7 +64,7 @@ describe AboutPage::Solr do
       subject.stub(:expects).and_return 5
 
       subject.should_receive(:add_header)
-      subject.set_headers! mock()
+      subject.set_headers! double()
     end
   end
 
@@ -81,7 +80,7 @@ describe AboutPage::Solr do
 
     it "should use the request parameters to set the minimum_numdocs" do
       node = AboutPage::Solr.new(@mock_solr_connection, :expects => { :numDocs => 5 })
-      node.preflight(mock(:params => { 'solr.numDocs' => 1000 }))
+      node.preflight(double(:params => { 'solr.numDocs' => 1000 }))
 
       node.expects(:numDocs).should == 1000 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: about_page
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -102,8 +102,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -168,7 +168,8 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
 - spec/dummy/tmp/capybara/capybara-201204200939394978936149.html
-- spec/integration/about_page_spec.rb
+- spec/features/about_page_spec.rb
+- spec/features/health_spec.rb
 - spec/lib/about_page_configuration.rb
 - spec/lib/configuration_environment_spec.rb
 - spec/lib/solr_spec.rb
@@ -187,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1267964176528258893
+      hash: 2575242270750158718
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1267964176528258893
+      hash: 2575242270750158718
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -239,7 +240,8 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
 - spec/dummy/tmp/capybara/capybara-201204200939394978936149.html
-- spec/integration/about_page_spec.rb
+- spec/features/about_page_spec.rb
+- spec/features/health_spec.rb
 - spec/lib/about_page_configuration.rb
 - spec/lib/configuration_environment_spec.rb
 - spec/lib/solr_spec.rb

data/Gemfile.lock

@@ -1,140 +0,0 @@
-PATH
-  remote: .
-  specs:
-    about_page (0.1.1)
-      rails (~> 3.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
-      mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    addressable (2.2.7)
-    arel (3.0.2)
-    builder (3.0.0)
-    capybara (1.1.2)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.2)
-      ffi (~> 1.0.6)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    ffi (1.0.11)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.3)
-    jquery-rails (2.0.2)
-      railties (>= 3.2.0, < 5.0)
-      thor (~> 0.14)
-    json (1.6.6)
-    launchy (2.1.0)
-      addressable (~> 2.2.6)
-    libwebsocket (0.1.3)
-      addressable
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.3.2)
-    nokogiri (1.5.2)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
-      bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    rspec-rails (2.9.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.9.0)
-    rubyzip (0.9.7)
-    selenium-webdriver (2.21.2)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0)
-      libwebsocket (~> 0.1.3)
-      multi_json (~> 1.0)
-      rubyzip
-    sprockets (2.1.2)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.14)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  about_page!
-  capybara
-  jquery-rails
-  launchy
-  rspec
-  rspec-rails
-  sqlite3