about_page 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in about_page.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    about_page (0.0.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.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  about_page!
+  capybara
+  jquery-rails
+  launchy
+  rspec
+  rspec-rails
+  sqlite3

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) 2012.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+# AboutPage
+
+To use in a Hydra app:
+
+    # In Gemfile
+    gem 'about_page', :git => 'git://github.com/sul-dlss/about_page.git'
+
+    # 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
+    end
+    
+    # In config/routes.rb
+    mount AboutPage::Engine => '/about(.:format)' # Or whever you want to access the about page
+	
+## Known Issues
+
+* Solr must have LukeHandler enabled on /luke

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/about_page.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "about_page/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "about_page"
+  s.version     = AboutPage::VERSION
+  s.authors     = ["Michael B. Klein", "Chris Beer"]
+  s.email       = ["mbklein@stanford.edu", "cabeer@stanford.edu"]
+  s.homepage    = "http://github.com/sul-dlss/about_page"
+  s.summary     = "Summary of AboutPage."
+  s.description = "Description of AboutPage."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency "rails", "~> 3.2"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "launchy"
+  # s.add_dependency "jquery-rails"
+end

data/app/assets/javascripts/about_page.js

@@ -0,0 +1,7 @@
+$(function() {
+  $('.about_page .pane-dependencies .dependency.group ul ul').each(function() {
+    var that = $(this);
+    that.prev('b').click(function() { that.toggle(5); });
+    that.hide();
+  });
+});

data/app/assets/stylesheets/about_page.scss

@@ -0,0 +1,16 @@
+.about_page .pane-dependencies .dependencies {
+  -moz-column-count:3; /* Firefox */
+  -webkit-column-count:3; /* Safari and Chrome */
+  column-count:3;
+}
+
+.about_page .pane.not-ok {
+  border: 3px solid #f00;
+  background-color: rgba(255,0,0,0.5);
+  margin-left: -1em;
+  padding-left: 1em;
+  margin-right: -1em;
+  padding-right: 1em;
+  padding-top: 1em;
+  padding-bottom: 1em;
+}

data/app/controllers/about_page/about_controller.rb

@@ -0,0 +1,19 @@
+module AboutPage
+  class AboutController < ApplicationController
+    before_filter :only => :index do
+      AboutPage.configuration.preflight(request)
+    end
+
+    def index
+      @configuration = AboutPage.configuration
+
+      AboutPage.configuration.set_headers!(response)
+
+      respond_to do |format|
+        format.html { render :status => @configuration.ok? ? 200 : 417 } # about_page.html.erb
+        format.json { render :json => @configuration.to_json }
+        format.xml  { render :xml  => @configuration.to_xml }
+      end
+    end
+  end
+end

data/app/helpers/about_page/about_helper.rb

@@ -0,0 +1,19 @@
+module AboutPage
+  module AboutHelper
+    def render_about_pane key, profile
+      render :partial => partial_for_about_key(key), :locals => { :key => key, :profile => profile } 
+    rescue 
+      render :partial => 'exception', :locals => { :key => key, :profile => profile, :exception => $! }
+    end
+
+    def partial_for_about_key key
+      about_page_partials[key] || key.to_s
+    end
+
+    private
+
+    def about_page_partials
+      { :solr => 'generic_hash', :fedora => 'generic_hash', :request => 'environment' }
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<h1><%= profile[:name]%> (<%= profile[:version] %>)</h1>

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

@@ -0,0 +1,9 @@
+<h1>Dependency Versions</h1>
+<div class="dependencies">
+  <ul>
+    <% profile.each_pair do |group,deps| %>
+    <li class="dependency group"><%= group %><%= render :partial => 'dependency_tree', :locals => { :graph => deps } %></li>
+    <% end %>
+  </ul>
+</div>
+

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

@@ -0,0 +1,10 @@
+<ul class="dependency">
+  <% graph.keys.sort.each do |name| spec = graph[name] %>
+    <li class="dependency">
+      <b><%= name %></b> (<%= spec[:version] %>)
+      <% if spec[:dependencies] %>
+          <%= render :partial => 'dependency_tree', :locals => { :graph => spec[:dependencies] }%>
+      <% end %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,11 @@
+<h1><%= key.to_s.humanize %></h1>
+<% profile.each_pair do |section,env| %>
+  <h3><%= section %></h3>
+  <div class="environment">
+    <ul>
+      <% env.keys.sort.each do |key| %>
+      <li><%= [key,env[key]].join('=') %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

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

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

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

@@ -0,0 +1,6 @@
+<h1><%= key.to_s.humanize %></h1>
+<ul>
+  <% profile.each_pair do |k,v| %>
+    <li><%= [k,v].join(': ') %></li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,8 @@
+<div class="about_page">
+  <% @configuration.each do |key, profile| %>
+    <div class="pane pane-<%= key.to_s.parameterize %> <%= 'not-ok' if profile.respond_to? :ok? and !profile.ok? %>">
+      <%= render_about_pane(key, profile) %>
+    </div>
+  <% end %>
+</div>
+

data/config/routes.rb

@@ -0,0 +1,3 @@
+AboutPage::Engine.routes.draw do
+  root :to => 'about_page/about#index'
+end

data/lib/about_page.rb

@@ -0,0 +1,22 @@
+require "about_page/engine"
+require "about_page/configuration"
+require "about_page/dependencies"
+require "about_page/environment"
+require "about_page/request_environment"
+
+module AboutPage
+  autoload :Fedora, "about_page/fedora"
+  autoload :Solr, "about_page/solr"
+
+  def self.configure
+    yield(self.configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset!
+    @configuration = nil
+  end
+end

data/lib/about_page/configuration.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module AboutPage
+
+  class OpenStructWithHashAccess < OpenStruct
+    delegate :each, :map, :to => :to_h
+    def to_json(options = {})
+      Hash[*@table.map { |k, v| [k, (v.to_h if v.respond_to? :to_h || v) ] }.flatten ]
+    end
+
+    def to_xml(options = {})
+      @table
+    end
+
+    def to_h
+      @table
+    end
+  end
+
+  class Configuration
+    attr_accessor :hash
+    delegate :to_xml, :to_h, :to_json, :to => :hash
+    delegate :each, :map, :to => :to_h
+
+    def initialize
+      @hash = OpenStructWithHashAccess.new
+    end
+
+    def method_missing *args
+      @hash.send(*args)
+    end
+
+    def preflight request
+      self.nodes.each { |key, profile| profile.preflight(request) }
+    end
+
+    def ok?
+       self.nodes.select { |key, profile| profile.respond_to? :ok? }.all? { |key, profile| profile.ok? }
+    end
+
+    def nodes
+      self.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
+
+    class Node
+      def preflight request
+
+      end
+
+      def set_headers! response
+
+      end
+
+      def add_header response, text
+        response.headers['X-AboutPage-Warning'] ||= "" 
+        response.headers['X-AboutPage-Warning'] += "#{text};"
+        
+      end
+
+      def ok?
+        true
+      end
+    end
+  end
+end