RubyGems - stoor - Versions diffs - 0.1.8 → 0.1.9 - Mend

stoor 0.1.8 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml +15 -0
data/README.md +41 -0
data/config.ru +13 -0
data/lib/stoor.rb +2 -0
data/lib/stoor/github_auth.rb +4 -6
data/lib/stoor/read_only.rb +19 -0
data/lib/stoor/version.rb +1 -1
data/lib/stoor/views/sorry.mustache +5 -0
data/lib/stoor/views/sorry.rb +9 -0
metadata +8 -23

checksums.yaml ADDED

@@ -0,0 +1,15 @@
+---
+!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=

data/README.md CHANGED

@@ -106,6 +106,11 @@ If the user is not a member of the specified team, they aren't allowed access.
     STOOR_WIDE=y              # Main wiki content will take 90% of browser width; widens tables as well
+### Read-only
+    STOOR_READONLY=y          # Create, New, Delete buttons and links hidden;
+                              # /create/*, /delete/*, POST, and PUT requests redirected to "sorry" page
 ## 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`,
@@ -145,3 +150,39 @@ and finally:
 Now browse your wiki at <http://wiki.local>
+## 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>).
+For example, if you have a secondary page called `foo.md`, and want a link that displays "This is my foo page", write
+your page link like this
+```
+[[This is my foo page|foo]]
+```
+Notice that the Gollum docs say "The page file may exist anywhere in the directory structure of the repository. Gollum does a breadth first search and uses the first match that it finds" -- So
+keep your page names unique.
+If you want to use relative links of the form `[Display text](wiki/other)`, don't. The wikis on GitHub do some wrangling with the base path
+that are not compatible with local wikis managed by Gollum. If you peruse the Gollum documentation at <https://github.com/gollum/gollum/wiki#page-links>, you
+will see that they don't describe the Markdown format at all.
+(Within a Rack Builder, even if you set the Gollum `base_path` and wrap Gollum in a `map` with the same `base_path` you will find that
+the displayed paths prefix URLs with an extra `base_path`.)
+## Things left out
+* No support for changing the "base path."
+* No support for changing Gollum options - all the default options are taken
+## Testing
+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.
+Now run the specs like so:
+    STOOR_GITHUB_CLIENT_ID=780ec06a331b4f61a345 STOOR_GITHUB_CLIENT_SECRET=f1e5439aff166c34f707747120acbf66ef233fc2 bundle exec rspec

data/config.ru CHANGED

@@ -87,6 +87,19 @@ if repo_exists
       regexp: /<body>/,
       after: '<style type="text/css">#wiki-wrapper { width: 90%; } .markdown-body table { width: 100%; }</style>'
   end
+  if ENV['STOOR_READONLY']
+    use Stoor::ReadOnly, '/sorry'
+    use Stoor::TransformContent,
+      regexp: /<body>/,
+      after: <<-STYLE
+        <style type="text/css">
+          #minibutton-new-page    { display: none; }
+          #minibutton-rename-page { display: none; }
+          a.action-edit-page      { display: none; }
+          #delete-link            { display: none; }
+        </style>
+      STYLE
+  end
   Precious::App.set(:gollum_path, gollum_path)
   Precious::App.set(:default_markup, :markdown)

data/lib/stoor.rb CHANGED

@@ -1,9 +1,11 @@
 require 'stoor/logger'
 require 'stoor/github_auth'
 require 'stoor/git_config'
+require 'stoor/read_only'
 require 'stoor/transform_content'
 require 'stoor/views/layout'
 require 'stoor/views/logout'
+require 'stoor/views/sorry'
 # In at least gollum 2.4.13 and later:
 #   https://github.com/gollum/gollum/blob/master/lib/gollum/uri_encode_component.rb#L36

data/lib/stoor/github_auth.rb CHANGED

@@ -4,17 +4,15 @@ module Stoor
     register Sinatra::Auth::Github
     register Mustache::Sinatra
-#    def initialize(*)
-#      @github_options = {}
-#      @stoor_options = {}
-#      super
-#    end
     get '/logout' do
       logout!
       mustache :logout
     end
+    get '/sorry' do
+      mustache :sorry
+    end
     get '/*' do
       session['stoor.github.authorized'] = nil

data/lib/stoor/read_only.rb ADDED

@@ -0,0 +1,19 @@
+module Stoor
+  class ReadOnly
+    include Rack::Utils
+    def initialize(app, path)
+      @app, @path = app, path
+    end
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path_info =~ /\A\/(create|delete)/ || request.post? || request.put?
+        return [302, { 'Location' => @path }, []]
+      end
+      @app.call(env)
+    end
+  end
+end

data/lib/stoor/version.rb CHANGED

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

data/lib/stoor/views/sorry.mustache ADDED

@@ -0,0 +1,5 @@
+<div id="wiki-wrapper" class="page">
+  <div class="markdown-body">
+    <p>Hey, sorry, this Wiki is read-only.</p>
+  </div>
+</div>

data/lib/stoor/views/sorry.rb ADDED

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

metadata CHANGED

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: stoor
 version: !ruby/object:Gem::Version
-  version: 0.1.8
-  prerelease:
+  version: 0.1.9
 platform: ruby
 authors:
 - John G. Norman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra_auth_github
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: warden-github
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -157,11 +140,14 @@ files:
 - lib/stoor/git_config.rb
 - lib/stoor/github_auth.rb
 - lib/stoor/logger.rb
+- lib/stoor/read_only.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
+- lib/stoor/views/sorry.mustache
+- lib/stoor/views/sorry.rb
 - log/.gitignore
 - public/.gitignore
 - spec/lib/stoor/git_config_spec.rb
@@ -173,28 +159,27 @@ 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: 1.8.23
+rubygems_version: 2.1.10
 signing_key:
-specification_version: 3
+specification_version: 4
 summary: Front-end for Gollum
 test_files:
 - spec/lib/stoor/git_config_spec.rb