stoor 0.1.9 → 0.1.11

data/README.md

@@ -9,12 +9,10 @@ so that we can constrain access by GitHub Organization Team membership.
 
 ## Requirements
 
-Ruby 1.9.2 or greater.
-
-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.
+* Ruby 1.9.2 or greater. 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 older system Ruby on a Mac.
+* Persistent access to the filesystem (i.e., won't work on Heroku).
+* An operating system other than Windows (because Gollum doesn't work on Windows, because [grit doesn't work on Windows . . .](https://github.com/gollum/gollum#system-requirements)).
 
 ## Setup
 
@@ -46,6 +44,13 @@ If you don't have a repo yet for your wiki . . .
     git init .
     stoor
 
+### Configuration via environment variables
+
+Stoor is configured via environment variables of the form `<name>_<some token>`. `<name>` is taken from the name
+of the directory in which the application resides. If you clone the app or use it as a Gem, it will be: `STOOR`
+If you clone into a directory with a different name (e.g., `stoor2`) it will be: `STOOR2`. This facilitates running
+two instances of Stoor in the same process (see below regarding Apache).
+
 ### Specify the Wiki repo location
 
     STOOR_WIKI_PATH=/Users/admin/wiki stoor
@@ -150,6 +155,46 @@ and finally:
 
 Now browse your wiki at <http://wiki.local>
 
+### Running two instances of Stoor in the same Apache
+
+You may want to run two instances of Stoor in the same Apache. For instance, they might both use the same Wiki path,
+but one is set to be read-only, while the other allows edits.
+
+To do this, don't set the DocumentRoot to the Gem directory. Intead, clone the repo twice, once into a directory
+such as `stoor1` the other into `stoor2`. Then configure
+the two VirtualHosts with environment variables based on each directory. Something like this:
+
+    <VirtualHost *:80>
+      SetEnv STOOR1_GITHUB_CLIENT_ID 780ec06a331b4f61a345
+      SetEnv STOOR1_GITHUB_CLIENT_SECRET f1e5439aff166c34f707747120acbf66ef233fc2
+      SetEnv STOOR1_GITHUB_EMAIL_DOMAIN 7fff.com
+      SetEnv STOOR1_DOMAIN wiki.local
+      SetEnv STOOR1_EXPIRE_AFTER 60
+      SetEnv STOOR1_WIKI_PATH /Users/jgn/Dropbox/wiki
+      ServerName wiki.local
+      DocumentRoot "/Users/jgn/src/stoor1"
+      <Directory "/Users/jgn/src/stoor1">
+        Allow from all
+        Options -MultiViews
+      </Directory>
+    </VirtualHost>
+
+    <VirtualHost *:80>
+      SetEnv STOOR2_GITHUB_CLIENT_ID 780ec06a331b4f61a345
+      SetEnv STOOR2_GITHUB_CLIENT_SECRET f1e5439aff166c34f707747120acbf66ef233fc2
+      SetEnv STOOR2_GITHUB_EMAIL_DOMAIN 7fff.com
+      SetEnv STOOR2_DOMAIN wiki.local
+      SetEnv STOOR2_EXPIRE_AFTER 60
+      SetEnv STOOR2_WIKI_PATH /Users/jgn/Dropbox/wiki
+      SetEnv STOOR2_READONLY y
+      ServerName wiki-readonly.local
+      DocumentRoot "/Users/jgn/src/stoor2"
+      <Directory "/Users/jgn/src/stoor2">
+        Allow from all
+        Options -MultiViews
+      </Directory>
+    </VirtualHost>
+
 ## Links in the Wiki
 
 A bit of advice: Use the MediaWiki format for links internal to your wiki. This style is recommended by GitHub (see <https://help.github.com/articles/how-do-i-add-links-to-my-wiki>).
@@ -178,6 +223,8 @@ the displayed paths prefix URLs with an extra `base_path`.)
 
 ## Testing
 
+Ensure that you clone to a directory called `stoor`, because the ENV variables adopt the name of the home directory.
+
 To run the specs, create an application per "GitHub Authorization" above, and take note of the client id and client secret.
 
 Then set up Stoor so that you are running with GitHub authorization. Authorize.

data/bin/stoor

@@ -2,9 +2,12 @@
 
 require 'thin'
 
-config_ru = File.expand_path(File.join(File.dirname(__FILE__), '..', 'config.ru'))
+dirname = File.dirname(__FILE__)
+env_key = dirname.split(File::SEPARATOR).last.upcase
 
-ENV['STOOR_WIKI_PATH'] ||= '.'
+config_ru = File.expand_path(File.join(dirname, '..', 'config.ru'))
+
+ENV["#{@env_key}_WIKI_PATH"] ||= '.'
 
 ARGV.unshift config_ru
 ARGV.unshift '-R'

data/config.ru

@@ -2,67 +2,47 @@
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
 require 'rubygems'
-require 'logger'
 require 'bundler/setup'
 require 'sinatra_auth_github'
 require 'gollum/app'
 require 'stoor'
+require 'rack/null_logger'
 
-# 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
+ENV['RACK_ENV'] ||= 'development'
 
-    def call(env)
-      @app.call(env)
-    end
-  end
-end
+config = Stoor::Config.new(__FILE__)
 
-ENV['RACK_ENV'] ||= 'development'
+domain       = config.env('DOMAIN') || 'localhost'
+secret       = config.env('SECRET') || 'stoor'
+expire_after = (config.env('EXPIRE_AFTER') || '3600').to_i
 
-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
-  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
+gollum_path = config.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
+config.dump_env
+config.log "gollum_path = #{gollum_path}"
 
-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
-if repo_exists
+if message = config.repo_missing?(gollum_path)
+  puts message
+  run Proc.new { |env| [ 200, { 'Content-Type' => 'text/plain' }, [ message ] ] }
+else
+  use Rack::Session::Cookie, :domain => domain, :key => 'rack.session', :secret => secret, :expire_after => expire_after
+  use Rack::CommonLogger, config.access_logger
+  use Stoor::Logger, config.log_stream, Logger::INFO
+
+  scopes = [ 'user:email' ]
+  scopes << 'user' if config.env('GITHUB_TEAM_ID')
   Stoor::GithubAuth.set :github_options, {
-    scopes:    'user:email',
-    client_id: ENV['STOOR_GITHUB_CLIENT_ID'],
-    secret:    ENV['STOOR_GITHUB_CLIENT_SECRET']
+    scopes:    scopes.join(','),
+    client_id: config.env('GITHUB_CLIENT_ID'),
+    secret:    config.env('GITHUB_CLIENT_SECRET')
   }
   Stoor::GithubAuth.set :stoor_options, {
-    github_team_id:      ENV['STOOR_GITHUB_TEAM_ID'],
-    github_email_domain: ENV['STOOR_GITHUB_EMAIL_DOMAIN']
+    github_team_id:      config.env('GITHUB_TEAM_ID'),
+    github_email_domain: config.env('GITHUB_EMAIL_DOMAIN')
   }
   use Stoor::GithubAuth
+
   use Stoor::GitConfig, gollum_path
   use Stoor::TransformContent,
     pass_condition: ->(request) { request.session['gollum.author'].nil? },
@@ -82,12 +62,12 @@ if repo_exists
         </div>
       HTML
     end
-  if ENV['STOOR_WIDE']
+  if config.env('WIDE')
     use Stoor::TransformContent,
       regexp: /<body>/,
       after: '<style type="text/css">#wiki-wrapper { width: 90%; } .markdown-body table { width: 100%; }</style>'
   end
-  if ENV['STOOR_READONLY']
+  if config.env('READONLY')
     use Stoor::ReadOnly, '/sorry'
     use Stoor::TransformContent,
       regexp: /<body>/,
@@ -105,7 +85,4 @@ if repo_exists
   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

data/lib/rack/null_logger.rb

@@ -0,0 +1,13 @@
+# 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

data/lib/stoor.rb

@@ -1,4 +1,5 @@
 require 'stoor/logger'
+require 'stoor/config'
 require 'stoor/github_auth'
 require 'stoor/git_config'
 require 'stoor/read_only'

data/lib/stoor/config.rb

@@ -0,0 +1,68 @@
+require 'logger'
+
+module Stoor
+  class Config
+    def initialize(file)
+      @file = file
+    end
+
+    def dirname
+      @dirname ||= begin
+        dirname = File.dirname(@file)
+        dirname = `pwd`.chomp if dirname == '.'  # Probably being run by Apache
+        dirname
+      end
+    end
+
+    def env_prefix
+      @env_prefix ||= dirname.split(File::SEPARATOR).last.upcase
+    end
+
+    def env(token)
+      ENV["#{env_prefix}_#{token}"]
+    end
+
+    def log(m)
+      log_stream.write(m + "\n")
+    end
+
+    def log_frag
+      @log_frag ||= "#{dirname}/log/#{ENV['RACK_ENV']}"
+    end
+
+    def access_logger
+      @access_logger ||= begin
+        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
+        access_logger
+      end
+    end
+
+    def log_stream
+      @log_stream ||= begin
+        log_stream = File.open("#{log_frag}.log", 'a+')
+        log_stream.sync = true
+        log_stream
+      end
+    end
+
+    def dump_env
+      log "#{env_prefix} env"
+      ENV.each_pair do |k, v|
+        log "  #{k}: #{v}" if k =~ /\A#{env_prefix}/
+      end
+    end
+
+    def repo_missing?(path)
+      Gollum::Wiki.new(path)
+      return nil
+    rescue Gollum::InvalidGitRepositoryError, Gollum::NoSuchPathError
+      return "Sorry, #{path} is not a git repository; you might try `cd #{path}; git init .`."
+    rescue NameError
+      return "Sorry, #{path} doesn't exist; set the environment variable STOOR_WIKI_PATH to point to a git repository."
+    end
+  end
+end

data/lib/stoor/version.rb

@@ -1,3 +1,3 @@
 module Stoor
-  VERSION = '0.1.9'
+  VERSION = '0.1.11'
 end

data/stoor.gemspec

@@ -17,10 +17,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files spec`.split("\n")
   s.executables << 'stoor'
   s.add_dependency 'thin',                      '~> 1.5.1'
-  s.add_dependency 'gollum',                    '~> 2.5.0'
+  s.add_dependency 'gollum',                    '~> 2.5.2'
   s.add_dependency 'sinatra_auth_github',       '~> 1.0.0'
-  s.add_dependency 'json',                      '~> 1.8.0'
-  s.add_dependency 'grit',                      '~> 2.5.0'
 
   s.add_development_dependency 'warden-github', '~> 1.0.0'
   s.add_development_dependency 'rack-test',     '~> 0.6.2'

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: stoor
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
+  prerelease: 
 platform: ruby
 authors:
 - John G. Norman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,20 +30,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
   name: sinatra_auth_github
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,41 +54,15 @@ dependencies:
   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
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-- !ruby/object:Gem::Dependency
-  name: grit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    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
@@ -90,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -97,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -104,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,6 +102,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -136,7 +121,9 @@ files:
 - Rakefile
 - bin/stoor
 - config.ru
+- lib/rack/null_logger.rb
 - lib/stoor.rb
+- lib/stoor/config.rb
 - lib/stoor/git_config.rb
 - lib/stoor/github_auth.rb
 - lib/stoor/logger.rb
@@ -159,27 +146,28 @@ files:
 homepage: https://github.com/jgn/stoor
 licenses:
 - MIT
-metadata: {}
 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: 2.1.10
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Front-end for Gollum
 test_files:
 - spec/lib/stoor/git_config_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZmU2OTA0ZjI4ZjY4MWZlZWI1MTQ0OWE2YTI0MGIyYWQxNDk1Mjk4Ng==
-  data.tar.gz: !binary |-
-    YzVhZWM1MGU5Y2NhMGZkNGJiYmM5OGVhMGVhYzZkODYxYWY0ODQxNA==
-SHA512:
-  metadata.gz: !binary |-
-    ZDJmMDE1YjcyY2E4Yzc4MTEyZmE5MTUwMTg5ZmNjNzVhOWEwZmQyZDcxOGJk
-    M2E5NzVjZWMwM2VhOTRiZTZmNDkwNTIxOTQ2Mzc4MGIyMTNiMzJjODM1MDRi
-    MmQ3YTE4MGRmZTNkZmVkZjk2MDg4NGZiY2FhNTdlOGU3NGM5ZTg=
-  data.tar.gz: !binary |-
-    MTIwNzc0NGJhNzRkYWI5MjMzNDEzYmQ2MWY4N2NkOTgxNjgzMTNlNThlNDVl
-    NzI3NTBmMWYxMWYwYjJiNzljNmNiYmQ1Yzc1N2U0ZjZiNjkzMTNlYzIwYTgx
-    MDYwODRlYTU1ZWFlZWFkNTlkOTNkMDRhMWMxZjM5NTIzMjIwNTM=