stoor 0.1.4 → 0.1.5

data/README.md

@@ -1,17 +1,19 @@
-This is an example of fronting Gollum with a small Sinatra app that authorizes against GitHub.
+Stoor provides a Gollum (wiki) server with a few other bells and whistles, such as authentication against GitHub OAuth.
 
 ## 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,
+data, because they will sign a HIPAA BAA.) Meanwhile, we'd like to authorize access by some means: we like 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
+An operating system other than Windows (because Gollum doesn't work on Windows, because grit doesn't work on Windows . . .).
+
+Unfortunately, Stoor 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
@@ -37,9 +39,6 @@ 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.).
 
-If you get the error `Gollum::InvalidGitRepositoryError` it means that you didn't change your directory to
-a git repo.
-
 If you don't have a repo yet for your wiki . . .
 
     mkdir mywiki
@@ -49,9 +48,9 @@ If you don't have a repo yet for your wiki . . .
 
 ### Specify the Wiki repo location
 
-    WIKI_PATH=/Users/admin/wiki stoor
+    STOOR_WIKI_PATH=/Users/admin/wiki stoor
 
-The `WIKI_PATH` environment variable provides for locating the wiki contents in a differet repo from the
+The `STOOR_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.
 
@@ -59,15 +58,20 @@ content separate.
 
 Require authorization via GitHub to the GitHub application with the given client id and secret
 
-    GITHUB_CLIENT_ID=780ec06a331b4f61a345 GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
+    STOOR_GITHUB_CLIENT_ID=780ec06a331b4f61a345 STOOR_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:
+If you are running Stoor on localhost with the `stoor` command, the typical settings would be:
 
-Application Name | Main URL | Callback URL
----              | ---      |
-YourAppName      | http://localhost:3000 | http://localhost:3000/auth/github/callback
+<table>
+  <tr>
+    <th> Application Name </th> <th> Main URL </th> <th> Callback URL </th>
+  </tr>
+  <tr>
+    <td> YourAppName </td> <td> http://localhost:3000 </td><td> http://localhost:3000/auth/github/callback </td>
+  </tr>
+</table>
 
 **NOTE:** No matter what your domain and port, the callback path must be `/auth/github/callback`.
 
@@ -78,11 +82,11 @@ application settings.
 
 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
+    STOOR_GITHUB_EMAIL_DOMAIN=7fff.com STOOR_GITHUB_CLIENT_ID=780ec06a331b4f61a345 STOOR_GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
 
 ### Require GitHub team
 
-    GITHUB_TEAM_ID=11155 GITHUB_CLIENT_ID=780ec06a331b4f61a345 GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
+    STOOR_GITHUB_TEAM_ID=11155 STOOR_GITHUB_CLIENT_ID=780ec06a331b4f61a345 STOOR_GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 stoor
 
 If the user is not a member of the specified team, they aren't allowed access.
 
@@ -105,7 +109,7 @@ If the user is not a member of the specified team, they aren't allowed access.
 ## 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.
+and 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:
 
@@ -121,12 +125,12 @@ Then in `/etc/apache2/httpd.conf`:
     NameVirtualHost *:80
 
     <VirtualHost *:80>
-      SetEnv GITHUB_CLIENT_ID 780ec06a331b4f61a345
-      SetEnv GITHUB_CLIENT_SECRET f1e5439aff166c34f707747120acbf66ef233fc2
-      SetEnv GITHUB_EMAIL_DOMAIN 7fff.com
+      SetEnv STOOR_GITHUB_CLIENT_ID 780ec06a331b4f61a345
+      SetEnv STOOR_GITHUB_CLIENT_SECRET f1e5439aff166c34f707747120acbf66ef233fc2
+      SetEnv STOOR_GITHUB_EMAIL_DOMAIN 7fff.com
       SetEnv STOOR_DOMAIN wiki.local
       SetEnv STOOR_EXPIRE_AFTER 60
-      SetEnv WIKI_PATH /Users/jgn/Dropbox/wiki
+      SetEnv STOOR_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.1.4/public"
       <Directory "/opt/boxen/rbenv/versions/1.9.2-p320/lib/ruby/gems/1.9.1/gems/stoor-0.1.4/public">

data/bin/stoor

@@ -4,7 +4,7 @@ require 'thin'
 
 config_ru = File.expand_path(File.join(File.dirname(__FILE__), '..', 'config.ru'))
 
-ENV['WIKI_PATH'] ||= '.'
+ENV['STOOR_WIKI_PATH'] ||= '.'
 
 ARGV.unshift config_ru
 ARGV.unshift '-R'

data/config.ru

@@ -23,6 +23,11 @@ module Rack
 end
 
 ENV['RACK_ENV'] ||= 'development'
+
+domain       = ENV['STOOR_DOMAIN'] || 'localhost'
+secret       = ENV['STOOR_SECRET'] || 'stoor'
+expire_after = (ENV['STOOR_EXPIRE_AFTER'] || '3600').to_i
+
 log_frag = "#{File.dirname(__FILE__)}/log/#{ENV['RACK_ENV']}"
 access_logger = Logger.new("#{log_frag}_access.log")
 access_logger.instance_eval do
@@ -32,24 +37,53 @@ 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__))
+gollum_path = ENV['STOOR_WIKI_PATH'] || File.expand_path(File.dirname(__FILE__))
+repo_exists = true
+begin
+  Gollum::Wiki.new(gollum_path)
+rescue Gollum::InvalidGitRepositoryError
+  repo_exists = false
+  message = "Sorry, #{gollum_path} is not a git repository; you might try `cd #{gollum_path}; git init .`."
+rescue NameError
+  repo_exists = false
+  message = "Sorry, #{gollum_path} doesn't exist; set the environment variable STOOR_WIKI_PATH to point to a git repository."
+end
 
+use Rack::Session::Cookie, :domain => domain, :key => 'rack.session', :secret => secret, :expire_after => expire_after
 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
+if repo_exists
+  use Stoor::GithubAuth
+  use Stoor::GitConfig, gollum_path
+  use Stoor::TransformContent,
+    pass_condition: ->(request) { request.session['gollum.author'].nil? },
+    regexp: /(<div id="footer">)(.*?)(<\/div>)/im,
+    before: ->(request) do
+      <<-HTML
+        <div style="float: left;">
+      HTML
+    end,
+    after: ->(request) do
+      <<-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 request.session['stoor.github.authorized']}
+          </p>
+        </div>
+      HTML
+    end
+  if ENV['STOOR_WIDE']
+    use Stoor::TransformContent,
+      regexp: /<body>/,
+      after: '<style type="text/css">#wiki-wrapper { width: 90%; } .markdown-body table { width: 100%; }</style>'
+  end
 
-use Stoor::GithubAuth
-use Stoor::GitConfig
-use Stoor::Decorate
-if ENV['STOOR_WIDE']
-  use Stoor::AddAfter, /<body>/, '<style type="text/css">#wiki-wrapper { width: 90%; } .markdown-body table { width: 100%; }</style>'
+  Precious::App.set(:gollum_path, gollum_path)
+  Precious::App.set(:default_markup, :markdown)
+  Precious::App.set(:wiki_options, { :universal_toc =>false })
+  run Precious::App
+else
+  run Proc.new { |env| [ 200, { 'Content-Type' => 'text/plain' }, [ message ] ] }
+  puts message
 end
-
-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

@@ -1,8 +1,7 @@
 require 'stoor/logger'
 require 'stoor/github_auth'
 require 'stoor/git_config'
-require 'stoor/decorate'
-require 'stoor/add_after'
+require 'stoor/transform_content'
 require 'stoor/views/layout'
 require 'stoor/views/logout'
 

data/lib/stoor/git_config.rb

@@ -1,24 +1,26 @@
 module Stoor
   class GitConfig
-    def initialize(app); @app = app; end
+    attr_reader :repo_path
+
+    def initialize(app, repo_path = nil)
+      @app, @repo_path = app, repo_path
+    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
+        if repo_path && (name = git_option_value('user.name')) && (email = git_option_value('user.email'))
+          @request.session['gollum.author'] = { :name => name, :email => email }
         end
       end
       @app.call(env)
     end
 
+    private
+
     def git_option_value(option)
-      `cd #{ENV['WIKI_PATH_IN_USE']} && git config --get #{option}`.strip
-    rescue
+      @repo ||= Grit::Repo.new(repo_path)
+      @repo.config[option]
     end
   end
 end

data/lib/stoor/github_auth.rb

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

data/lib/stoor/transform_content.rb

@@ -0,0 +1,87 @@
+require 'rack'
+
+module Stoor
+  class TransformContent
+    include Rack::Utils
+
+    attr_reader :status, :headers, :request
+    attr_reader :app, :regexp, :content_type, :pass_condition
+
+    def initialize(app, options)
+      @app            = app
+      @regexp         = options[:regexp]
+      @before         = options[:before]
+      @after          = options[:after]
+      @content_type   = options[:content_type] || 'text/html'
+      @pass_condition = options[:pass_condition] || ->(env) { false }
+    end
+
+    def call(env)
+      @status, @headers, response = @app.call(env)
+      @request = Rack::Request.new(env)
+
+      if pass_condition.call(request)
+        if request.logger
+          request.logger.info "Skipping -- because pass condition met"
+        end
+      else
+        @headers = HeaderHash.new(@headers)
+        if has_body && not_encoded && headers['content-type'] && headers['content-type'].index(content_type)
+          content = Array(response).join('')
+          if match_data = content.match(regexp)
+            new_body = interpolate(match_data)
+            headers['Content-Length'] = new_body.bytesize.to_s
+            return [status, headers, [new_body]]
+          end
+        end
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    def has_body
+      !STATUS_WITH_NO_ENTITY_BODY.include?(status)
+    end
+
+    def not_encoded
+      !headers['transfer-encoding']
+    end
+
+    def interpolate(match_data)
+      # regexp: /<body>/
+      #   result: before<body>after
+      # regexp: /(<div>)(.*?)(<\/div)
+      #   result: <div>beforezzzafter</div>
+      "".tap do |s|
+        s << match_data.pre_match
+        if match_data.size == 1
+          s << before + match_data[0] + after
+        elsif match_data.size == 4
+          s << match_data[1] + before + match_data[2] + after + match_data[3]
+        else
+          # Might just set the result to content?
+          raise "Unexpected number of captures in #{match_data.regexp}"
+        end
+        s << match_data.post_match
+      end
+    end
+
+    def before
+      freshen(@before)
+    end
+
+    def after
+      freshen(@after)
+    end
+
+    def freshen(e)
+      if e.respond_to? :call
+        e.call(request)
+      else
+        e.to_s
+      end
+    end
+  end
+end

data/lib/stoor/version.rb

@@ -1,3 +1,3 @@
 module Stoor
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/lib/stoor/git_config_spec.rb

@@ -0,0 +1,18 @@
+require 'stoor/git_config'
+require 'spec_helper'
+require 'grit'
+require 'repo'
+
+module Stoor
+  describe GitConfig do
+    let(:inner_app) { ->(env) { [200, { }, []] } }
+    let(:app) { GitConfig.new(inner_app, 'repo') }
+
+    include_context 'repo'
+
+    it 'finds git config user.name and user.email and puts them into the session under the key gollum.author' do
+      get '/'
+      expect(last_request.env['rack.session']['gollum.author']).to eq(name: 'Mortimer Snerd', email: 'snerd@example.com')
+    end
+  end
+end

data/spec/lib/stoor/github_auth_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'sinatra'
+require 'mustache'
+require 'sinatra/auth/github'
+require 'sinatra/auth/github/test/test_helper'
+require 'gollum/app'
+require 'stoor/github_auth'
+require 'stoor/views/layout'
+require 'stoor/views/logout'
+require 'repo'
+
+module Stoor
+
+  # Follows https://github.com/atmos/sinatra_auth_github/blob/master/spec/login_spec.rb
+  # To run these specs, define a testing app at https://github.com/settings/applications/new,
+  # with a callback URL such as http://localhost:9393/auth/github/callback
+  # Then
+  #   STOOR_GITHUB_CLIENT_ID=xxx STOOR_GITHUB_CLIENT_SECRET=yyy stoor -p 9393
+  # Authenticate.
+  # Now you can test:
+  #   STOOR_GITHUB_CLIENT_ID=xxx STOOR_GITHUB_CLIENT_SECRET=yyy STOOR_TESTING_USER=jgn bundle exec rspec
+
+  describe "Logged in users" do
+    include Stoor::Test::Helper
+
+    let(:inner_app) { ->(env) { [200, { }, [ 'protected info' ]] } }
+    let(:sessions) { Rack::Session::Cookie.new(inner_app, secret: 'boo') }
+    let(:app) { GithubAuth.new(sessions) }
+
+    include_context 'repo'
+    ENV['STOOR_WIKI_PATH'] = './repo'
+
+    before do
+      Stoor::GithubAuth.send(:enable, :sessions)
+      @user = make_user(ENV['STOOR_TESTING_USER'], [ 'effie@example.com', 'effie@7fff.com', 'john@7fff.com' ])
+      login_as @user
+    end
+
+    it 'Shows the home page' do
+      get '/'
+      expect(last_response.body).to match('protected info')
+    end
+
+    it 'Sets the gollum.user with the first email' do
+      get '/'
+      expect(last_request.env['rack.session']['gollum.author']).to eq(name: 'Effie Klinker', email: 'effie@example.com')
+    end
+
+    it 'Sets the gollum.user according to domain if specified' do
+      save = ENV['STOOR_GITHUB_EMAIL_DOMAIN']
+      ENV['STOOR_GITHUB_EMAIL_DOMAIN'] = '7fff.com'
+      get '/'
+      expect(last_request.env['rack.session']['gollum.author']).to eq(name: 'Effie Klinker', email: 'effie@7fff.com')
+      ENV['STOOR_GITHUB_EMAIL_DOMAIN'] = save
+    end
+
+    it 'logs the user out' do
+      get '/'
+      get '/logout'
+      expect(last_response.status).to eql(200)
+      expect(last_response.body).to match("You're logged out")
+
+      get '/'
+      expect(last_response.status).to eql(302)
+      expect(last_response.headers['Location']).to match(/^https:\/\/github\.com\/login\/oauth\/authorize/)
+    end
+
+    it 'shows the securocat when github returns an oauth error' do
+      get '/auth/github/callback?error=redirect_uri_mismatch'
+      follow_redirect!
+      expect(last_response.body).to match(/securocat\.png/)
+    end
+  end
+end

data/spec/lib/stoor/transform_content_spec.rb

@@ -0,0 +1,146 @@
+require 'stoor/transform_content'
+require 'spec_helper'
+
+module Stoor
+
+  describe TransformContent, 'content-type matching' do
+    context 'default with text/plain response' do
+      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/plain' }, '<body>'] } }
+      let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+      it "skips" do
+        get '/'
+        expect(last_response.body).to eq('<body>')
+      end
+    end
+
+    context 'default with text/html response' do
+      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+      let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+      it "processes" do
+        get '/'
+        expect(last_response.body).to eq('<body>after-text')
+      end
+    end
+
+    context 'specifying text/plain with text/html response' do
+      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+      let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text', content_type: 'text/plain') }
+
+      it "skips" do
+        get '/'
+        expect(last_response.body).to eq('<body>')
+      end
+    end
+
+    context 'specifying regexp with text/html response' do
+      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/whatever' }, '<body>'] } }
+      let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text', content_type: /\Atext\//) }
+
+      it "processes" do
+        get '/'
+        expect(last_response.body).to eq('<body>after-text')
+      end
+    end
+  end
+
+  describe TransformContent, 'passes on condition' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text', pass_condition: ->(env) { true }) }
+
+    it 'skips when a passed-in condition returns true' do
+      get '/'
+      expect(last_response.body).to eq('<body>')
+    end
+  end
+
+  describe TransformContent, 'insertion after' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+    it 'adds text after the first occurrence of a search string' do
+      get '/'
+      expect(last_response.body).to eq('<body>after-text')
+    end
+  end
+
+  describe TransformContent, 'insertion before' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, before: 'before-text') }
+
+    it 'adds text before the first occurrence of a search string' do
+      get '/'
+      expect(last_response.body).to eq('before-text<body>')
+    end
+  end
+
+  describe TransformContent, 'insertion before and after' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, before: 'before-text', after: 'after-text') }
+
+    it 'adds text before and after the first occurrence of a search string' do
+      get '/'
+      expect(last_response.body).to eq('before-text<body>after-text')
+    end
+  end
+
+  describe TransformContent, 'insertion before and after with captures' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<div>foo</div>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /(<div>)(.*?)(<\/div>)/, before: 'before-text', after: 'after-text') }
+
+    it 'adds text before and after the middle capture' do
+      get '/'
+      expect(last_response.body).to eq('<div>before-textfooafter-text</div>')
+    end
+  end
+
+  describe TransformContent, 'not 0 or 3 captures' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<div>foo</div>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /(<div>).*?(<\/div>)/, before: 'before-text', after: 'after-text') }
+
+    it 'raises an exception' do
+      expect { get '/' }.to raise_error
+    end
+  end
+
+  describe TransformContent, 'insertion after with two potential matches' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body> <body>'] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+    it 'adds text only after the first occurrence of a search string' do
+      get '/'
+      expect(last_response.body).to eq('<body>after-text <body>')
+    end
+  end
+
+  describe TransformContent, 'insertion if response is an Array' do
+    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, [ '<bo', 'dy>' ] ] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+    it 'adds text after the first occurrence of a search string' do
+      get '/'
+      expect(last_response.body).to eq('<body>after-text')
+    end
+  end
+
+  describe TransformContent, 'status code implies no body' do
+    let(:inner_app) { ->(env) { [204, { 'Content-Type' => 'text/html' }, '<body>' ] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+    it 'skips' do
+      get '/'
+      expect(last_response.body).to eq('<body>')
+    end
+  end
+
+  describe TransformContent, 'response is transfer-encoded' do
+    let(:inner_app) { ->(env) { [200, { 'Transfer-Encoding' => 'Chunked', 'Content-Type' => 'text/html' }, '<body>' ] } }
+    let(:app) { TransformContent.new(inner_app, regexp: /<body>/, after: 'after-text') }
+
+    it 'skips' do
+      get '/'
+      expect(last_response.body).to eq('<body>')
+    end
+  end
+end

data/spec/repo.rb

@@ -0,0 +1,18 @@
+shared_context 'repo' do
+  before do
+    repo = Grit::Repo.init('repo')
+    File.open('repo/.git/config', 'a+') do |f|
+      f.write <<-GITCONFIG.strip_heredoc
+      [user]
+        name = Mortimer Snerd
+        email = snerd@example.com
+      GITCONFIG
+    end
+    File.open('repo/Home.md', 'w') { |f| f.write('### Nice wiki page') }
+    repo.add('repo/Home.md')
+  end
+
+  after do
+    FileUtils.rm_rf 'repo'
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,46 @@
 require 'rack/test'
+require 'ostruct'
 
 RSpec.configure do |conf|
   conf.include Rack::Test::Methods
 end
+
+class String
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end
+
+require 'warden/github'
+require 'warden/test/helpers'
+require 'warden/github/user'
+
+# Follows https://github.com/atmos/sinatra_auth_github/blob/master/lib/sinatra/auth/github/test/test_helper.rb
+module Stoor
+  module Test
+    module Helper
+      include Warden::Test::Helpers
+
+      class User < Warden::GitHub::User
+        attr_accessor :api
+      end
+
+      def make_user(login, emails = 'effie@example.com', override_attributes = {})
+        emails = Array(emails)
+        attributes = {
+            'login'   => login,
+            'email'   => emails.first,
+            'name'    => "Effie Klinker",
+            'company' => "7fff",
+            'gravatar_id' => 'a'*32,
+            'avatar_url'  => 'https://a249.e.akamai.net/assets.github.com/images/gravatars/gravatar-140.png?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png',
+        }
+        User.new(attributes.merge! override_attributes).tap do |user|
+          user.api = OpenStruct.new(:emails => emails)
+        end
+      end
+
+   end
+  end
+end

data/stoor.gemspec

@@ -6,11 +6,12 @@ Gem::Specification.new do |s|
   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.description   = 'Stoor is an app to bring up a local Gollum (wiki software) against a Git repo with bells and whistles like auth.'
+  s.license       = 'MIT'
   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.homepage      = 'https://github.com/jgn/stoor'
   s.rdoc_options  = ['--charset=UTF-8']
   s.require_paths = ['lib']
   s.test_files    = `git ls-files spec`.split("\n")
@@ -18,8 +19,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'gollum',              '~> 2.5.0'
   s.add_dependency 'sinatra_auth_github', '~> 1.0.0'
   s.add_dependency 'json',                '~> 1.8.0'
+  s.add_dependency 'grit',                '~> 2.5.0'
   s.executables << 'stoor'
 
+  s.add_development_dependency 'warden-github'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoor
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
@@ -75,6 +75,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: grit
+  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: warden-github
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +139,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Front-end for Gollum
+description: Stoor is an app to bring up a local Gollum (wiki software) against a
+  Git repo with bells and whistles like auth.
 email: john@7fff.com
 executables:
 - stoor
@@ -121,22 +154,25 @@ files:
 - bin/stoor
 - config.ru
 - lib/stoor.rb
-- lib/stoor/add_after.rb
-- lib/stoor/decorate.rb
 - lib/stoor/git_config.rb
 - lib/stoor/github_auth.rb
 - lib/stoor/logger.rb
+- lib/stoor/transform_content.rb
 - lib/stoor/version.rb
 - lib/stoor/views/layout.rb
 - lib/stoor/views/logout.mustache
 - lib/stoor/views/logout.rb
 - log/.gitignore
 - public/.gitignore
-- spec/lib/stoor/add_after_spec.rb
+- spec/lib/stoor/git_config_spec.rb
+- spec/lib/stoor/github_auth_spec.rb
+- spec/lib/stoor/transform_content_spec.rb
+- spec/repo.rb
 - spec/spec_helper.rb
 - stoor.gemspec
-homepage: https://rubygems.org/gems/stoor
-licenses: []
+homepage: https://github.com/jgn/stoor
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -161,5 +197,8 @@ signing_key:
 specification_version: 3
 summary: Front-end for Gollum
 test_files:
-- spec/lib/stoor/add_after_spec.rb
+- spec/lib/stoor/git_config_spec.rb
+- spec/lib/stoor/github_auth_spec.rb
+- spec/lib/stoor/transform_content_spec.rb
+- spec/repo.rb
 - spec/spec_helper.rb

data/lib/stoor/add_after.rb

@@ -1,44 +0,0 @@
-require 'rack'
-
-module Stoor
-  class AddAfter
-    include Rack::Utils
-
-    attr_reader :status, :headers
-    attr_reader :rxp, :string, :content_type
-
-    def initialize(app, rxp, string, content_type = 'text/html')
-      @app, @rxp, @string, @content_type = app, rxp, string, content_type
-    end
-
-    def call(env)
-      @status, @headers, response = @app.call(env)
-      @headers = HeaderHash.new(@headers)
-
-      if has_body && not_encoded && headers['content-type'] &&
-        headers['content-type'].index(content_type)
-
-        content = Array(response).join('')
-
-        if content =~ rxp
-          pre, match, post = $`, $&, $'
-          new_body = pre + match + string + post
-          headers['Content-Length'] = new_body.bytesize.to_s
-          return [status, headers, [new_body]]
-        end
-      end
-
-      [status, headers, response]
-    end
-
-    private
-
-    def has_body
-      !STATUS_WITH_NO_ENTITY_BODY.include?(status)
-    end
-
-    def not_encoded
-      !headers['transfer-encoding']
-    end
-  end
-end

data/lib/stoor/decorate.rb

@@ -1,63 +0,0 @@
-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/spec/lib/stoor/add_after_spec.rb

@@ -1,99 +0,0 @@
-require 'stoor/add_after'
-require 'spec_helper'
-
-module Stoor
-
-  describe AddAfter, 'content-type matching' do
-
-    context 'default with text/plain response' do
-      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/plain' }, '<body>'] } }
-      let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-      it "skips" do
-        get '/'
-        expect(last_response.body).to eq('<body>')
-      end
-    end
-
-    context 'default with text/html response' do
-      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
-      let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-      it "processes" do
-        get '/'
-        expect(last_response.body).to eq('<body>stuff')
-      end
-    end
-
-    context 'specifying text/plain with text/html response' do
-      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
-      let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff', 'text/plain') }
-
-      it "skips" do
-        get '/'
-        expect(last_response.body).to eq('<body>')
-      end
-    end
-
-    context 'specifying regexp with text/html response' do
-      let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/whatever' }, '<body>'] } }
-      let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff', /\Atext\//) }
-
-      it "processes" do
-        get '/'
-        expect(last_response.body).to eq('<body>stuff')
-      end
-    end
-
-  end
-
-  describe AddAfter, 'insertion' do
-    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body>'] } }
-    let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-    it 'adds text after the first occurrence of a search string' do
-      get '/'
-      expect(last_response.body).to eq('<body>stuff')
-    end
-  end
-
-  describe AddAfter, 'insertion with two potential matches' do
-    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, '<body> <body>'] } }
-    let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-    it 'adds text only after the first occurrence of a search string' do
-      get '/'
-      expect(last_response.body).to eq('<body>stuff <body>')
-    end
-  end
-
-  describe AddAfter, 'insertion if response is an Array' do
-    let(:inner_app) { ->(env) { [200, { 'Content-Type' => 'text/html' }, [ '<bo', 'dy>' ] ] } }
-    let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-    it 'adds text after the first occurrence of a search string' do
-      get '/'
-      expect(last_response.body).to eq('<body>stuff')
-    end
-  end
-
-  describe AddAfter, 'status code implies no body' do
-    let(:inner_app) { ->(env) { [204, { 'Content-Type' => 'text/html' }, '<body>' ] } }
-    let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-    it 'skips' do
-      get '/'
-      expect(last_response.body).to eq('<body>')
-    end
-  end
-
-  describe AddAfter, 'response is transfer-encoded' do
-    let(:inner_app) { ->(env) { [200, { 'Transfer-Encoding' => 'Chunked', 'Content-Type' => 'text/html' }, '<body>' ] } }
-    let(:app) { AddAfter.new(inner_app, /<body>/, 'stuff') }
-
-    it 'skips' do
-      get '/'
-      expect(last_response.body).to eq('<body>')
-    end
-  end
-end