gollum-auth 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21e3fcbf6ef454027dd8f5b99eda8fc9ff17305c
-  data.tar.gz: b21cfd50602573f4333f7943e8675a9b5a2b0b41
+  metadata.gz: b7f60571c4203805ec7b26185234617736a60764
+  data.tar.gz: 0467e62c694fc7c8680145302abd5227e9ac52d5
 SHA512:
-  metadata.gz: 6d6b2b231c7c448a1c4a72f24d329df4e5ae9ca1f28ab2873c50541425a33cd3f702251817a3acae66aa86d75f263cc43f5128101d33c73a11549cf05bcdbf09
-  data.tar.gz: 0837e90a2b85b1d04a769e05c6ebfadb47bbd0089bc83fdd8f58ccd21b83d01e1226b1cb891c8ee1b00aa2ce172517e100963f74309e270fb31a14c7f19e6920
+  metadata.gz: c5fde9348967c6b9b1d657124795873ca80c077868e10548a755ac073df12056b7e368ba44b90b339c037b67a41d26d9085750647ac641d986c3ef166f0810fc
+  data.tar.gz: 744eadd845807e179ac0ff69695a167938f82efd109325f0cfdac2daee6126e6d1ebaa2adf703bcf9fc3a7b3efda3f91729addec94760ceed80985140aedc7cc

data/README.md

@@ -3,13 +3,15 @@
 [![Gem Version](https://badge.fury.io/rb/gollum-auth.svg)](https://badge.fury.io/rb/gollum-auth)
 [![Build Status](https://travis-ci.org/bjoernalbers/gollum-auth.svg?branch=master)](https://travis-ci.org/bjoernalbers/gollum-auth)
 
-`Gollum::Auth` is a Rack-Middleware to add
+[Gollum](https://github.com/gollum/gollum)
+is an excellent Wiki-software.
+But it does not include user authentication (on purpose).
+
+`Gollum::Auth` is a Rack-Middleware that add
 [HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
-to
-[gollum](https://github.com/gollum/gollum).
-This requires users to authenticate in order to change the wiki (create /
-edit / delete / rename / revert pages).
-Read-only access is permitted by default.
+to gollum.
+With this only authenticated users have access to your wiki.
+Optionally you can allow readonly-access for unauthenticated guests.
 
 
 ## Installation
@@ -43,7 +45,7 @@ require 'gollum/auth' # Don't forget to load the gem!
 require 'gollum/app'
 
 # Define list of authorized users where each must have a "name", "password"
-and "email":
+# and "email":
 users = YAML.load %q{
 ---
 - name: Rick Sanchez
@@ -54,9 +56,12 @@ users = YAML.load %q{
   email: morty@example.com
 }
 
-# Allow only authenticated users to access and change the wiki.
+# Allow unauthenticated users to read the wiki (disabled by default).
+options = { allow_guests: true }
+
+# Allow only authenticated users to change the wiki.
 # (NOTE: This must be loaded *before* Precious::App!)
-use Gollum::Auth, users
+use Gollum::Auth, users, options
 
 # That's it. The rest is for gollum only.
 gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO

data/lib/gollum/auth.rb

@@ -1,6 +1,7 @@
 require 'rack'
 require 'active_model'
 require 'gollum/auth/version'
+require 'gollum/auth/request'
 require 'gollum/auth/user'
 
 module Gollum
@@ -10,14 +11,14 @@ module Gollum
     end
 
     class App
-      def initialize(app, users)
+      def initialize(app, users, opts = { })
         @app = app
         users.each { |args| User.new(args).save! }
+        @opts = { allow_guests: false }.merge(opts)
       end
 
       def call(env)
-        request = Rack::Request.new(env)
-        if request.path_info =~ /^\/(create|edit|delete|rename|revert|upload)(\/.*)?$/
+        if Request.new(env).needs_authentication?(@opts[:allow_guests])
           auth = Rack::Auth::Basic::Request.new(env)
           unless auth.provided? && auth.basic? && valid?(auth.credentials)
             return [

data/lib/gollum/auth/request.rb

@@ -0,0 +1,15 @@
+module Gollum::Auth
+  class Request < Rack::Request
+    def needs_authentication?(allow_guests)
+      !allow_guests || is_change_request?
+    end
+
+    private
+
+    # Returns true if the request includes a path that would result in a change
+    # of the wiki.
+    def is_change_request?
+      !!(path_info =~ /^\/(create|edit|delete|rename|revert|upload)(\/.*)?$/)
+    end
+  end
+end

data/lib/gollum/auth/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   module Auth
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-auth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Björn Albers
@@ -142,6 +142,7 @@ files:
 - bin/setup
 - gollum-auth.gemspec
 - lib/gollum/auth.rb
+- lib/gollum/auth/request.rb
 - lib/gollum/auth/user.rb
 - lib/gollum/auth/version.rb
 homepage: https://github.com/bjoernalbers/gollum-auth
@@ -167,5 +168,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: gollum-auth-0.2.0
+summary: gollum-auth-0.3.0
 test_files: []