stoor 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+coverage
+.bundle
+pkg
+.DS_Store
+Gemfile.lock
+*.gem
+vendor
+.ruby-version
+log/*.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,130 @@
+This is an example of fronting Gollum with a small Sinatra app that authorizes against GitHub.
+
+## Rationale
+
+In our environment, the contents of our wiki are confidential and should not be pushed up to GitHub. We keep the wiki on
+a local machine (behind a firewall), and put the wiki contents into a directory that is sync'd to box.com. (box.com is useful for confidential
+data, because they will sign a HIPAA BAA.) Meanwhile, we'd like to authorize access by some means, so we use GitHub Oauth,
+so that we can constrain access by GitHub Organization Team membership.
+
+## Requirements
+
+Ruby 1.9.2 or greater.
+
+Unfortunately, this will no longer work on Ruby 1.8.7, because `gollum-lib` now wants Nokogiri 1.6.0 ([see?](https://github.com/gollum/gollum-lib/commit/eeb0a4a036001c7621d173e7152b91ed02b21ed0#commitcomment-4170065)), and
+1.8.7 isn't supported. That's too bad, because it was nice that this would work on the system Ruby on a Mac.
+
+## Setup
+
+    gem install stoor
+
+## Usage examples
+
+(Relax, the client id and secret below are fake.)
+
+### The 'stoor' command
+
+To get started, type:
+
+    stoor
+
+This will run your gollum wiki on port 3000, though it will decorate the footer with a message saying who
+the committer is. When not authenticating against GitHub, the default options for the wiki repo is used (i.e.,
+the values for the GitHub commit will be what you see in `git config -l`).
+
+The `stoor` command is a thin wrapper around the `thin` web server, and takes all `thin` options (`-p <port>`, etc.).
+
+### Specify the Wiki repo location
+
+    WIKI_PATH=/Users/admin/wiki stoor
+
+The `WIKI_PATH` environment variable provides for locating the wiki contents in a differet repo from the
+Stoor application. It is strongly advised that you do this so that you can keep your wiki code and wiki
+content separate.
+
+### GitHub authorization
+
+Require authorization via GitHub to the GitHub application with the given client id and secret
+
+    GITHUB_CLIENT_ID=780ec06a331b4f61a345 GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
+
+Access to the wiki will first run through GitHub OAuth against the app specified by the id and secret. For information
+on setting up an application in GitHub and obtaining its id and secret, see <https://github.com/settings/applications/new>.
+If you are running Stoor on localhost with Rackup, the typical settings would be:
+
+Application Name | Main URL | Callback URL
+---              | ---      |
+YourAppName      | http://localhost:3000 | http://localhost:3000/auth/github/callback
+
+**NOTE:** No matter what your domain and port, the callback path must be `/auth/github/callback`.
+
+**NOTE:** See also `STOOR_DOMAIN` below: The domain specified for the cookie should match the domain in your GitHub
+application settings.
+
+### Prefer a certain email domain
+
+If there is more than one email associated with the GitHub user, prefer the one from the specified domain (otherwise the first email will be used)
+
+    GITHUB_EMAIL_DOMAIN=7fff.com GITHUB_CLIENT_ID=780ec06a331b4f61a345 GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
+
+### Require GitHub team
+
+    GITHUB_TEAM_ID=11155 GITHUB_CLIENT_ID=780ec06a331b4f61a345 GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
+
+If the user is not a member of the specified team, they aren't allowed access.
+
+### Specify the domain (this is to ensure that cookies are set for the correct domain)
+
+    STOOR_DOMAIN=wiki.local    # default: localhost
+
+### Specify the cookie secret
+
+    STOOR_SECRET="honi soit qui mal y pense"    # default: stoor
+
+### Specify the cookie timeout
+
+    STOOR_EXPIRE_AFTER=600    # In seconds; default: 3600
+
+### Wide display
+
+    STOOR_WIDE=y              # Main wiki content will take 90% of browser width; widens tables as well
+
+## How I run it
+
+I like having my own personal wiki. Since Apache is ubiquitous on Macs, I run the Wiki with configuration in `/etc/apache2/httpd.conf`,
+~~~and just use my system Ruby~~~ some Ruby provided by rbenv, and Passenger.
+
+I create an extra name for 127.0.0.1 in `/etc/hosts` such as `wiki.local`. Then:
+
+      gem install passenger
+      passenger-install-apache2-module
+
+Then in `/etc/apache2/httpd.conf`:
+
+    LoadModule passenger_module /opt/boxen/rbenv/versions/1.9.2-p320/lib/ruby/gems/1.9.1/gems/passenger-4.0.19/buildout/apache2/mod_passenger.so
+    PassengerRoot /opt/boxen/rbenv/versions/1.9.2-p320/lib/ruby/gems/1.9.1/gems/passenger-4.0.19
+    PassengerDefaultRuby /opt/boxen/rbenv/versions/1.9.2-p320/bin/ruby
+
+    NameVirtualHost *:80
+
+    <VirtualHost *:80>
+      SetEnv GITHUB_CLIENT_ID 780ec06a331b4f61a345
+      SetEnv GITHUB_CLIENT_SECRET f1e5439aff166c34f707747120acbf66ef233fc2
+      SetEnv GITHUB_EMAIL_DOMAIN 7fff.com
+      SetEnv STOOR_DOMAIN wiki.local
+      SetEnv STOOR_EXPIRE_AFTER 60
+      SetEnv WIKI_PATH /Users/jgn/Dropbox/wiki
+      ServerName wiki.local
+      DocumentRoot "/opt/boxen/rbenv/versions/1.9.2-p320/lib/ruby/gems/1.9.1/gems/stoor-0.0.1/public"
+      <Directory "/opt/boxen/rbenv/versions/1.9.2-p320/lib/ruby/gems/1.9.1/gems/stoor-0.0.1/public">
+        Allow from all
+        Options -MultiViews
+      </Directory>
+    </VirtualHost>
+
+and finally:
+
+    sudo apachectl -k restart
+
+Now browse your wiki at <http://wiki.local>
+

data/bin/stoor

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'thin'
+ARGV.unshift 'config.ru'
+ARGV.unshift '-R'
+ARGV.unshift 'start'
+Thin::Runner.new(ARGV).run!

data/config.ru

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require 'logger'
+require 'bundler/setup'
+require 'sinatra_auth_github'
+require 'gollum/app'
+require 'stoor'
+
+# Force the NullLogger to be a no-op, since it keeps getting bound into the
+# Request instance.
+module Rack
+  class NullLogger
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    end
+  end
+end
+
+ENV['RACK_ENV'] ||= 'development'
+log_frag = "#{File.dirname(__FILE__)}/log/#{ENV['RACK_ENV']}"
+access_logger = Logger.new("#{log_frag}_access.log")
+access_logger.instance_eval do
+  def write(msg); self.send(:<<, msg); end
+end
+access_logger.level = Logger::INFO
+log_stream = File.open("#{log_frag}.log", 'a+')
+log_stream.sync = true
+
+domain = ENV['STOOR_DOMAIN'] || 'localhost'
+secret = ENV['STOOR_SECRET'] || 'stoor'
+expire_after = (ENV['STOOR_EXPIRE_AFTER'] || '3600').to_i
+
+wiki_path = ENV['WIKI_PATH_IN_USE'] = ENV['WIKI_PATH'] || File.expand_path(File.dirname(__FILE__))
+
+use Rack::CommonLogger, access_logger
+use Stoor::Logger, log_stream, Logger::INFO
+use Rack::Session::Cookie, :domain => domain, :key => 'rack.session', :secret => secret, :expire_after => expire_after
+
+use Stoor::GithubAuth
+use Stoor::GitConfig
+use Stoor::Decorate
+use Stoor::FixCssWidth if ENV['STOOR_WIDE']
+
+Precious::App.set(:gollum_path, wiki_path)
+Precious::App.set(:default_markup, :markdown)
+Precious::App.set(:wiki_options, { :universal_toc =>false })
+run Precious::App

data/lib/stoor.rb

@@ -0,0 +1,18 @@
+require 'stoor/logger'
+require 'stoor/github_auth'
+require 'stoor/git_config'
+require 'stoor/decorate'
+require 'stoor/fix_css_width'
+require 'stoor/views/layout'
+require 'stoor/views/logout'
+
+# In at least gollum 2.4.13 and later:
+#   https://github.com/gollum/gollum/blob/master/lib/gollum/uri_encode_component.rb#L36
+# seems to get scoped funny, and I see this:
+#   NoMethodError - undefined method `URIEncodeComponent' for #<URI::Parser:0x007f91db50bd78>:
+# This fixes it.
+if RUBY_VERSION == '1.9.2'
+  def encodeURIComponent(componentString)
+    ::URI::URIEncodeComponent(componentString)
+  end
+end

data/lib/stoor/decorate.rb

@@ -0,0 +1,63 @@
+module Stoor
+  class Decorate
+    include Rack::Utils
+
+    FOOTER_REGEXP = /(<div id="footer">)(.*?)(<\/div>)/im
+
+    def initialize(app); @app = app; end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+
+      if @request.session['gollum.author'].nil?
+        @request.logger.info "No 'gollum.author' in session - skipping page decoration."
+        return @app.call(env)
+      end
+
+      status, headers, response = @app.call(env)
+      headers = HeaderHash.new(headers)
+
+      if !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+          !headers['transfer-encoding'] &&
+          headers['content-type'] &&
+          headers['content-type'].include?("text/html")
+
+        # TODO: If the response isn't an Array, it's a Rack::File or something, so ignore
+        if response.respond_to? :inject
+          content = response.inject("") { |content, part| content << part }
+          if match_data = content.match(FOOTER_REGEXP)
+            new_body = "" <<
+              match_data.pre_match <<
+              match_data[1] <<
+              before_existing_footer <<
+              match_data[2] <<
+              after_existing_footer <<
+              match_data[3] <<
+              match_data.post_match
+            headers['Content-Length'] = new_body.bytesize.to_s
+            return [status, headers, [new_body]]
+          end
+        end
+      end
+
+      [status, headers, response]
+    end
+
+    def before_existing_footer
+      <<-HTML
+        <div style="float: left;">
+      HTML
+    end
+
+    def after_existing_footer
+      <<-HTML
+        </div>
+        <div style="float: right;">
+          <p style="text-align: right; font-size: .9em; line-height: 1.6em; color: #999; margin: 0.9em 0;">
+            Commiting as <b>#{@request.session['gollum.author'][:name]}</b> (#{@request.session['gollum.author'][:email]})#{" | <a href='/logout'>Logout</a>" if ENV['GITHUB_AUTHORIZED']}
+          </p>
+        </div>
+      HTML
+    end
+  end
+end

data/lib/stoor/fix_css_width.rb

@@ -0,0 +1,35 @@
+module Stoor
+  class FixCssWidth
+    include Rack::Utils
+
+    ADDITIONAL_STYLES = '<style type="text/css">#wiki-wrapper { width: 90%; } .markdown-body table { width: 100%; }</style>'
+
+    def initialize(app); @app = app; end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+
+      status, headers, response = @app.call(env)
+      headers = HeaderHash.new(headers)
+
+      if !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+          !headers['transfer-encoding'] &&
+          headers['content-type'] &&
+          headers['content-type'].include?("text/html")
+
+        # TODO: If the response isn't an Array, it's a Rack::File or something, so ignore
+        if response.respond_to? :inject
+          content = response.inject("") { |content, part| content << part }
+          if content =~ /<body>/
+            pre, match, post = $`, $&, $'
+            new_body = pre + match + ADDITIONAL_STYLES + post
+            headers['Content-Length'] = new_body.bytesize.to_s
+            return [status, headers, [new_body]]
+          end
+        end
+      end
+
+      [status, headers, response]
+    end
+  end
+end

data/lib/stoor/git_config.rb

@@ -0,0 +1,24 @@
+module Stoor
+  class GitConfig
+    def initialize(app); @app = app; end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+      unless @request.session['gollum.author']
+        if ENV['WIKI_PATH_IN_USE']
+          if name = git_option_value('user.name')
+            if email = git_option_value('user.email')
+              @request.session['gollum.author'] = { :name => name, :email => email }
+            end
+          end
+        end
+      end
+      @app.call(env)
+    end
+
+    def git_option_value(option)
+      `cd #{ENV['WIKI_PATH_IN_USE']} && git config --get #{option}`.strip
+    rescue
+    end
+  end
+end

data/lib/stoor/github_auth.rb

@@ -0,0 +1,42 @@
+module Stoor
+  class GithubAuth < Sinatra::Base
+
+    set :github_options, {
+      :scopes    => "user,user:email",
+      :client_id => ENV['GITHUB_CLIENT_ID'],
+      :secret    => ENV['GITHUB_CLIENT_SECRET']
+    }
+
+    register Sinatra::Auth::Github
+    register Mustache::Sinatra
+
+    get '/logout' do
+      logout!
+      mustache :logout
+    end
+
+    get '/*' do
+      ENV['GITHUB_AUTHORIZED'] = nil
+
+      pass unless ENV['GITHUB_CLIENT_ID'] && ENV['GITHUB_CLIENT_SECRET']
+
+      pass if request.path_info =~ /\./
+
+      authenticate!
+      if ENV['GITHUB_TEAM_ID']
+        github_team_authenticate!(ENV['GITHUB_TEAM_ID'])
+      end
+
+      ENV['GITHUB_AUTHORIZED'] = "yes"
+
+      email = nil
+      emails = github_user.api.emails
+      if ENV['GITHUB_EMAIL_DOMAIN']
+        email = emails.find { |e| e =~ /#{ENV['GITHUB_EMAIL_DOMAIN']}/ }
+      end
+      email ||= emails.first
+      session['gollum.author'] = { :name => github_user.name, :email => email }
+      pass
+    end
+  end
+end

data/lib/stoor/logger.rb

@@ -0,0 +1,18 @@
+# Like Rack::Logger, but provide for defining the stream
+# at initialization.
+module Stoor
+  class Logger
+    def initialize(app, stream = nil, level = ::Logger::INFO)
+      @app, @stream, @level = app, stream, level
+    end
+
+    def call(env)
+      stream = @stream || env['rack.errors']
+      logger = ::Logger.new(stream)
+      logger.level = @level
+
+      env['rack.logger'] = logger
+      @app.call(env)
+    end
+  end
+end

data/lib/stoor/version.rb

@@ -0,0 +1,3 @@
+module Stoor
+  VERSION = '0.1.0'
+end

data/lib/stoor/views/layout.rb

@@ -0,0 +1,10 @@
+class Stoor::GithubAuth
+  module Views
+    class Layout < Precious::Views::Layout
+      def self.template_file
+        # Steal Gollum's layout so we get the CSS, JavaScript, etc.
+        @template_file ||= File.join(File.dirname(Precious::App.new!.method(:wiki_page).source_location[0]), 'templates', 'layout.mustache')
+      end
+    end
+  end
+end

data/lib/stoor/views/logout.mustache

@@ -0,0 +1,5 @@
+<div id="wiki-wrapper" class="page">
+  <div class="markdown-body">
+    <p>You're logged out; <a href="/">Log back in</a>.</p>
+  </div>
+</div>

data/lib/stoor/views/logout.rb

@@ -0,0 +1,9 @@
+class Stoor::GithubAuth
+  module Views
+    class Logout < Layout
+      def self.template_file
+        @template_file ||= File.join(File.dirname(__FILE__), 'logout.mustache')
+      end
+    end
+  end
+end

data/log/.gitignore

@@ -0,0 +1 @@
+!.gitignore

data/public/.gitignore

@@ -0,0 +1 @@
+!.gitignore

data/stoor.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path(File.join('..', 'lib'), __FILE__)
+require 'stoor/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'stoor'
+  s.version       = Stoor::VERSION
+  s.date          = Time.now.utc.strftime('%Y-%m-%d')
+  s.summary       = 'Front-end for Gollum'
+  s.description   = 'Front-end for Gollum'
+  s.authors       = ['John G. Norman']
+  s.email         = 'john@7fff.com'
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = 'https://rubygems.org/gems/stoor'
+  s.rdoc_options  = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.test_files    = `git ls-files spec`.split("\n")
+  s.add_dependency 'thin',                '~> 1.5.1'
+  s.add_dependency 'gollum',              '~> 2.5.0'
+  s.add_dependency 'sinatra_auth_github', '~> 1.0.0'
+  s.add_dependency 'json',                '~> 1.8.0'
+  s.executables << 'stoor'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: stoor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John G. Norman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: gollum
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: sinatra_auth_github
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Front-end for Gollum
+email: john@7fff.com
+executables:
+- stoor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- bin/stoor
+- config.ru
+- lib/stoor.rb
+- lib/stoor/decorate.rb
+- lib/stoor/fix_css_width.rb
+- lib/stoor/git_config.rb
+- lib/stoor/github_auth.rb
+- lib/stoor/logger.rb
+- lib/stoor/version.rb
+- lib/stoor/views/layout.rb
+- lib/stoor/views/logout.mustache
+- lib/stoor/views/logout.rb
+- log/.gitignore
+- public/.gitignore
+- stoor.gemspec
+homepage: https://rubygems.org/gems/stoor
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Front-end for Gollum
+test_files: []